📄 classppop3client.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>PPOP3Client 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>PPOP3Client Class Reference</h1><code>#include <<a class="el" href="inetmail_8h-source.html">inetmail.h</a>></code><p><p>Inheritance diagram for PPOP3Client:<p><center><img src="classPPOP3Client.png" usemap="#PPOP3Client_map" border="0" alt=""></center><map name="PPOP3Client_map"><area href="classPPOP3.html" alt="PPOP3" shape="rect" coords="0,224,109,248"><area href="classPInternetProtocol.html" alt="PInternetProtocol" shape="rect" coords="0,168,109,192"><area href="classPIndirectChannel.html" alt="PIndirectChannel" shape="rect" coords="0,112,109,136"><area href="classPChannel.html" alt="PChannel" shape="rect" coords="0,56,109,80"><area href="classPObject.html" alt="PObject" shape="rect" coords="0,0,109,24"></map><a href="classPPOP3Client-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Public Types</h2></td></tr><tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classPPOP3Client.html#s3">LoginOptions</a> { <a class="el" href="classPPOP3Client.html#s3s0">AllowUserPass</a> = 1, <a class="el" href="classPPOP3Client.html#s3s1">UseSASL</a> = 2, <a class="el" href="classPPOP3Client.html#s3s2">AllowClearTextSASL</a> = 4 }</td></tr><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a0">PPOP3Client</a> ()</td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a1">~PPOP3Client</a> ()</td></tr><tr><td nowrap align=right valign=top>virtual BOOL </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a2">Close</a> ()</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a3">LogIn</a> (const <a class="el" href="classPString.html">PString</a> &username, const <a class="el" href="classPString.html">PString</a> &password, int options=AllowUserPass)</td></tr><tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a4">GetMessageCount</a> ()</td></tr><tr><td nowrap align=right valign=top><a class="el" href="classPUnsignedArray.html">PUnsignedArray</a> </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a5">GetMessageSizes</a> ()</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="classPPOP3Client.html#a6">GetMessageHeaders</a> ()</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a7">BeginMessage</a> (PINDEX messageNumber)</td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPPOP3Client.html#a8">DeleteMessage</a> (PINDEX messageNumber)</td></tr><tr><td colspan=2><br><h2>Protected Methods</h2></td></tr><tr><td nowrap align=right valign=top>BOOL </td><td valign=bottom><a class="el" href="classPPOP3Client.html#b0">OnOpen</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="classPPOP3Client.html#n0">loggedIn</a></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="classPPOP3Client.html#n1">apopBanner</a></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>A TCP/IP socket for the Post Office Protocol version 3.<p>When acting as a client, the procedure is to make the connection to a remote server, then to retrieve a message using the following procedure: <pre><code> PPOP3Client mail; if (mail.Connect("popserver")) { if (mail.LogIn("Me", "password")) { if (mail.GetMessageCount() > 0) { <a class="el" href="classPUnsignedArray.html">PUnsignedArray</a> sizes = mail.GetMessageSizes(); for (PINDEX i = 0; i < sizes.GetSize(); i++) { if (mail.BeginMessage(i+1)) mail.Read(myMessage, sizes[i]); else PError << "Error getting mail message." << endl; } } else PError << "No mail messages." << endl; } else PError << "Mail log in failed." << endl; } else PError << "Mail conection failed." << endl; </pre></code> <p><hr><h2>Member Enumeration Documentation</h2><a name="s3" doxytag="PPOP3Client::LoginOptions"></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 PPOP3Client::LoginOptions </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p><dl compact><dt><b>Enumeration values: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em><a name="s3s0" doxytag="AllowUserPass"></a><em>AllowUserPass</em></em> </td><td></td></tr><tr><td valign=top><em><a name="s3s1" doxytag="UseSASL"></a><em>UseSASL</em></em> </td><td></td></tr><tr><td valign=top><em><a name="s3s2" doxytag="AllowClearTextSASL"></a><em>AllowClearTextSASL</em></em> </td><td></td></tr></table></dl> </td> </tr></table><hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="PPOP3Client::PPOP3Client"></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"> PPOP3Client::PPOP3Client </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 TCP/IP POP3 protocol socket channel. The parameterless form creates an unopened socket, the form with the <code>address</code> parameter makes a connection to a remote system, opening the socket. The form with the <code>socket</code> parameter opens the socket to an incoming call from a "listening" socket. </td> </tr></table><a name="a1" doxytag="PPOP3Client::~PPOP3Client"></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"> PPOP3Client::~PPOP3Client </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>Destroy the channel object. This will close the channel and as a client, QUIT from remote POP3 server. </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="a7" doxytag="PPOP3Client::BeginMessage"></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 PPOP3Client::BeginMessage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">PINDEX </td> <td class="mdname1" valign="top" nowrap> <em>messageNumber</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><dl compact><dt><b>Parameters: </b></dt><dd><table border=0 cellspacing=2 cellpadding=0><tr><td valign=top><em>messageNumber</em> </td><td>Number of message to retrieve. This is an integer from 1 to the maximum number of messages available. </td></tr></table></dl> </td> </tr></table><a name="a2" doxytag="PPOP3Client::Close"></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 PPOP3Client::Close </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>Close the socket, and if connected as a client, QUITs from server.<p><dl compact><dt><b>Returns: </b></dt><dd> TRUE if the channel was closed and the QUIT accepted by the server. </dl><p>Reimplemented from <a class="el" href="classPIndirectChannel.html#z157_1">PIndirectChannel</a>. </td> </tr></table><a name="a8" doxytag="PPOP3Client::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 PPOP3Client::DeleteMessage </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">PINDEX </td> <td class="mdname1" valign="top" nowrap> <em>messageNumber</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>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -