classpmail.html

pwlib开发文档

          <td class="md" nowrap valign="top"> <a class="el" href="classPString.html">PString</a> PMail::GetErrorText </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the internal error description for the last error by a function in this mail session.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 string error text for last operation. </dl>    </td>
  </tr>
</table>
<a name="z191_3" doxytag="PMail::GetMessageAttachments"></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::GetMessageAttachments </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>id</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPStringArray.html">PStringArray</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>filenames</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>includeBody</em> = FALSE, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>markAsRead</em> = FALSE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get all of the attachments for a message as disk files.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if attachments were successfully obtained. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>filenames</em>&nbsp;</td><td>
Identifier of message to get attachments. </td></tr>
<tr><td valign=top><em>includeBody</em>&nbsp;</td><td>
File names for each attachment. </td></tr>
<tr><td valign=top><em>markAsRead</em>&nbsp;</td><td>
Include the message body as first attachment Mark the message as read </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z191_2" doxytag="PMail::GetMessageBody"></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::GetMessageBody </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>id</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>body</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>BOOL&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>markAsRead</em> = FALSE</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the body text for a message into the body# string parameter.
<p>
Note that if the body text for the mail message is very large, the function will return FALSE. To tell between an error getting the message body and having a large message body the <a class="el" href="classPMail.html#z195_0">GetErrorCode()</a># function must be used.
<p>
To get a large message body, the <a class="el" href="classPMail.html#z191_3">GetMessageAttachments()</a># should be used with the includeBody# parameter set to TRUE so that the message body is placed into a disk file.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the body text was retrieved, FALSE if the body was too large or some other error occurred. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>body</em>&nbsp;</td><td>
Identifier of message to get body. </td></tr>
<tr><td valign=top><em>markAsRead</em>&nbsp;</td><td>
Body text of mail message. Mark the message as read. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z191_1" doxytag="PMail::GetMessageHeader"></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::GetMessageHeader </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>id</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="structPMail_1_1Header.html">Header</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>hdrInfo</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the header information for a message.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if header information was successfully obtained. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>hdrInfo</em>&nbsp;</td><td>
Identifier of message to get header. <a class="el" href="structPMail_1_1Header.html">Header</a> info for the message. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z191_0" doxytag="PMail::GetMessageIDs"></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"> <a class="el" href="classPStringArray.html">PStringArray</a> PMail::GetMessageIDs </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">BOOL&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>unreadOnly</em> = TRUE          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get a list of ID strings for all messages in the mail box.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 An array of ID strings. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>unreadOnly</em>&nbsp;</td><td>
Only get the IDs for unread messages. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z187_3" doxytag="PMail::IsLoggedOn"></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::IsLoggedOn </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Determine if the mail session is active and logged into the mail system.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if logged into the mail system. </dl>    </td>
  </tr>
</table>
<a name="z187_2" doxytag="PMail::LogOff"></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 BOOL PMail::LogOff </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Log off from the mail system.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if successfully logged off. </dl>    </td>
  </tr>
</table>
<a name="z187_1" doxytag="PMail::LogOn"></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::LogOn </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>username</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>password</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>service</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Attempt to log on to the mail system using the parameters provided.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if successfully logged on. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>password</em>&nbsp;</td><td>
User withing mail system to use. </td></tr>
<tr><td valign=top><em>service</em>&nbsp;</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="z187_0" doxytag="PMail::LogOn"></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::LogOn </td>