📄 classpmail.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>PMail class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>PMail Class Reference</h1><code>#include <<a class="el" href="mail_8h-source.html">mail.h</a>></code><p><p>Inheritance diagram for PMail:<p><center><img src="classPMail.png" usemap="#PMail_map" border="0" alt=""></center><map name="PMail_map"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,57,24"></map><a href="classPMail-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>User look up functions</h2></td></tr><tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classPMail.html#z193_0">LookUpResult</a> { <a class="el" href="classPMail.html#z193_0s0">UnknownUser</a>, <a class="el" href="classPMail.html#z193_0s1">AmbiguousUser</a>, <a class="el" href="classPMail.html#z193_0s2">ValidUser</a>, <a class="el" href="classPMail.html#z193_0s3">LookUpError</a> }</td></tr><tr><td> </td><td><font size=-1><em>Result of a lookup operation with the <a class="el" href="classPMail.html#z193_1">LookUp()</a># function.</em> <a href="#z193_0">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPMail.html#z193_0">LookUpResult</a> </td><td valign=bottom><a class="el" href="classPMail.html#z193_1">LookUp</a> (const <a class="el" href="classPString.html">PString</a> &name, <a class="el" href="classPString.html">PString</a> *fullName=NULL)</td></tr><tr><td colspan=2><br><h2>Public Types</h2></td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td colspan="2"><div class="groupHeader">Construction</div></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPMail.html#z185_0">PMail</a> ()</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPMail.html#z185_1">PMail</a> (const <a class="el" href="classPString.html">PString</a> &username, const <a class="el" href="classPString.html">PString</a> &password)</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPMail.html#z185_2">PMail</a> (const <a class="el" href="classPString.html">PString</a> &username, const <a class="el" href="classPString.html">PString</a> &password, const <a class="el" href="classPString.html">PString</a> &service)</td></tr><tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classPMail.html#z185_3">~PMail</a> ()</td></tr><tr><td colspan="2"><div class="groupHeader">Log in/out functions</div></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z187_0">LogOn</a> (const <a class="el" href="classPString.html">PString</a> &username, const <a class="el" href="classPString.html">PString</a> &password)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z187_1">LogOn</a> (const <a class="el" href="classPString.html">PString</a> &username, const <a class="el" href="classPString.html">PString</a> &password, const <a class="el" href="classPString.html">PString</a> &service)</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z187_2">LogOff</a> ()</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z187_3">IsLoggedOn</a> () const</td></tr><tr><td colspan="2"><div class="groupHeader">Send message functions</div></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z189_0">SendNote</a> (const <a class="el" href="classPString.html">PString</a> &recipient, const <a class="el" href="classPString.html">PString</a> &subject, const char *body)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z189_1">SendNote</a> (const <a class="el" href="classPString.html">PString</a> &recipient, const <a class="el" href="classPString.html">PString</a> &subject, const char *body, const <a class="el" href="classPStringList.html">PStringList</a> &attachments)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z189_2">SendNote</a> (const <a class="el" href="classPString.html">PString</a> &recipient, const <a class="el" href="classPStringList.html">PStringList</a> &carbonCopies, const <a class="el" href="classPStringList.html">PStringList</a> &blindCarbons, const <a class="el" href="classPString.html">PString</a> &subject, const char *body, const <a class="el" href="classPStringList.html">PStringList</a> &attachments)</td></tr><tr><td colspan="2"><div class="groupHeader">Read message functions</div></td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPStringArray.html">PStringArray</a> </td><td valign=bottom><a class="el" href="classPMail.html#z191_0">GetMessageIDs</a> (BOOL unreadOnly=TRUE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z191_1">GetMessageHeader</a> (const <a class="el" href="classPString.html">PString</a> &id, <a class="el" href="structPMail_1_1Header.html">Header</a> &hdrInfo)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z191_2">GetMessageBody</a> (const <a class="el" href="classPString.html">PString</a> &id, <a class="el" href="classPString.html">PString</a> &body, BOOL markAsRead=FALSE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z191_3">GetMessageAttachments</a> (const <a class="el" href="classPString.html">PString</a> &id, <a class="el" href="classPStringArray.html">PStringArray</a> &filenames, BOOL includeBody=FALSE, BOOL markAsRead=FALSE)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z191_4">MarkMessageRead</a> (const <a class="el" href="classPString.html">PString</a> &id)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#z191_5">DeleteMessage</a> (const <a class="el" href="classPString.html">PString</a> &id)</td></tr><tr><td colspan="2"><div class="groupHeader">Error functions</div></td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classPMail.html#z195_0">GetErrorCode</a> () const</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPString.html">PString</a> </td><td valign=bottom><a class="el" href="classPMail.html#z195_1">GetErrorText</a> () const</td></tr><tr><td colspan=2><br><h2>Protected Methods</h2></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPMail.html#b0">Construct</a> ()</td></tr><tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPMail.html#n0">loggedOn</a></td></tr><tr><td> </td><td><font size=-1><em>Flag indicating the session is active.</em> <a href="#n0"></a><em></em></font><br><br></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>This class establishes a mail session with the platforms mail system. <p><hr><h2>Member Enumeration Documentation</h2><a name="z193_0" doxytag="PMail::LookUpResult"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> enum PMail::LookUpResult </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Result of a lookup operation with the <a class="el" href="classPMail.html#z193_1">LookUp()</a># function.<p><dl compact><dt><b>Enumeration values: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em><a name="z193_0s0" doxytag="UnknownUser"></a><em>UnknownUser</em></em> </td><td>User name is unknown in mail system.</td></tr><tr><td valign=top><em><a name="z193_0s1" doxytag="AmbiguousUser"></a><em>AmbiguousUser</em></em> </td><td>User is ambiguous in mail system.</td></tr><tr><td valign=top><em><a name="z193_0s2" doxytag="ValidUser"></a><em>ValidUser</em></em> </td><td>User is a valid, unique name in mail system.</td></tr><tr><td valign=top><em><a name="z193_0s3" doxytag="LookUpError"></a><em>LookUpError</em></em> </td><td>An error occurred during the look up.</td></tr></table></dl> </td> </tr></table><hr><h2>Constructor & Destructor Documentation</h2><a name="z185_0" doxytag="PMail::PMail"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PMail::PMail </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a mail session. It is initially not logged in. </td> </tr></table><a name="z185_1" doxytag="PMail::PMail"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PMail::PMail </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>username</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>password</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a mail session. Attempt to log in using the parameters provided. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>password</em> </td><td>User withing mail system to use. Password for user in mail system. </td></tr></table></dl> </td> </tr></table><a name="z185_2" doxytag="PMail::PMail"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> PMail::PMail </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>username</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>password</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname" nowrap> <em>service</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Create a mail session. Attempt to log in using the parameters provided. <dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>password</em> </td><td>User withing mail system to use. </td></tr><tr><td valign=top><em>service</em> </td><td>Password for user in mail system.A platform dependent string indicating the location of the underlying messaging service, eg the path to a message store or node name of the mail server. </td></tr></table></dl> </td> </tr></table><a name="z185_3" doxytag="PMail::~PMail"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual PMail::~PMail </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="b0" doxytag="PMail::Construct"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void PMail::Construct </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap><code> [protected]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p> </td> </tr></table><a name="z191_5" doxytag="PMail::DeleteMessage"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> BOOL PMail::DeleteMessage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> & </td> <td class="mdname1" valign="top" nowrap> <em>id</em> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Delete the message from the system.<p><dl compact><dt><b>Returns: </b></dt><dd> TRUE if message was successfully deleted. </dl><dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>id</em> </td><td>Identifier of message to get header. </td></tr></table></dl> </td> </tr></table><a name="z195_0" doxytag="PMail::GetErrorCode"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int PMail::GetErrorCode </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get the internal error code for the last error by a function in this mail session.<p><dl compact><dt><b>Returns: </b></dt><dd> integer error code for last operation. </dl> </td> </tr></table><a name="z195_1" doxytag="PMail::GetErrorText"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -