📄 pop3__client_8h.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>pop3_client.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindex" href="examples.html">Examples</a> </center><hr><h1>/opentcp/include/inet/pop3/pop3_client.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> <dl compact><dt><b>Author: </b></dt><dd> <ul><li> Jari Lahti (<a href="mailto:jari.lahti@violasystems.com">jari.lahti@violasystems.com</a>) </ul></dl><dl compact><dt><b>Version: </b></dt><dd>1.0 </dl><dl compact><dt><b>Date: </b></dt><dd>20.8.2002</dl>OpenTCP POP3 function declarations, constants, etc.<p><p>Definition in file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.<p><a href="pop3__client_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Data Structures</h2></td></tr><tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structpop3c__struct.html">pop3c_struct</a></td></tr><tr><td> </td><td><font size=-1><em>POP3 client structure.</em> <a href="structpop3c__struct.html#_details">More...</a><em></em></font><br><br></td></tr><tr><td colspan=2><br><h2>Defines</h2></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a0">POP3C_SENDERMAXLEN</a> 30</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a1">POP3C_SUBJECTMAXLEN</a> 30</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a2">POP3C_TOUT</a> 20</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a3">POP3C_UNINITIALIZED</a> 1</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a4">POP3C_CLOSED</a> 2</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a5">POP3C_OPEN_REQUESTED</a> 3</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a6">POP3C_CONNECTIONOPEN_SENT</a> 4</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a7">POP3C_CONNECTION_OPENED</a> 5</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a8">POP3C_SERVER_READY</a> 6</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a9">POP3C_USERNAME_SENT</a> 7</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a10">POP3C_USERNAME_ACKED</a> 8</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a11">POP3C_PASSWORD_SENT</a> 9</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a12">POP3C_PASSWORD_ACKED</a> 10</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a13">POP3C_STAT_SENT</a> 11</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a14">POP3C_STAT_GET</a> 12</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a15">POP3C_LIST_SENT</a> 13</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a16">POP3C_LIST_GET</a> 14</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a17">POP3C_TOP0_SENT</a> 15</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a18">POP3C_RECEIVING_HEADER</a> 16</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a19">POP3C_RECEIVING_HDR_FROM</a> 17</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a20">POP3C_RECEIVING_HDR_SUBJ</a> 18</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a21">POP3C_TOP0_GET</a> 19</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a22">POP3C_RETR_SENT</a> 20</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a23">POP3C_RECEIVING_MSG_HEADER</a> 21</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a24">POP3C_RECEIVING_MSG</a> 22</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a25">POP3C_MESSAGE_RECEIVED</a> 23</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a26">POP3C_DELE_SENT</a> 24</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a27">POP3C_DELE_ACKED</a> 25</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a28">POP3C_QUIT_SENT</a> 26</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a29">POP3C_QUIT_ACKED</a> 27</td></tr><tr><td colspan=2><br><h2>Functions</h2></td></tr><tr><td nowrap align=right valign=top>INT8 </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a31">pop3c_connect</a> (UINT32, UINT16)</td></tr><tr><td> </td><td><font size=-1><em>Start E-mail reading procedure.</em> <a href="#a31"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a32">pop3c_init</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>Initialize POP3 client.</em> <a href="#a32"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>UINT8 </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a33">pop3c_getstate</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>Get current POP3 client state.</em> <a href="#a33"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a47">pop3c_error</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>POP3 client error handler.</em> <a href="#a47"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a48">pop3c_data</a> (UINT8)</td></tr><tr><td> </td><td><font size=-1><em>Receives E-mail data.</em> <a href="#a48"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a49">pop3c_allok</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>Indicates succesfull reading of E-mails.</em> <a href="#a49"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a50">pop3c_messages</a> (UINT16)</td></tr><tr><td> </td><td><font size=-1><em>Invoked to inform user app about the number of new e-mails.</em> <a href="#a50"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT16 </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a51">pop3c_msgoffer</a> (UINT16, UINT32, UINT8 *, UINT8 *)</td></tr><tr><td> </td><td><font size=-1><em>Offers e-mail message to the user app.</em> <a href="#a51"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT8 </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a52">pop3c_getusername</a> (UINT8 *)</td></tr><tr><td> </td><td><font size=-1><em>Get user name that is to be used for loging to the server.</em> <a href="#a52"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT8 </td><td valign=bottom><a class="el" href="pop3__client_8h.html#a53">pop3c_getpassword</a> (UINT8 *)</td></tr><tr><td> </td><td><font size=-1><em>Get password that is to be used for loging to the server.</em> <a href="#a53"></a><em></em></font><br><br></td></tr></table><hr><h2>Define Documentation</h2><a name="a0" doxytag="pop3_client.h::POP3C_SENDERMAXLEN"></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"> #define POP3C_SENDERMAXLEN 30 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Maximum length for senders' e-mail address including '\0' <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00069">69</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>. </td> </tr></table><a name="a1" doxytag="pop3_client.h::POP3C_SUBJECTMAXLEN"></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"> #define POP3C_SUBJECTMAXLEN 30 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Maximum length of the subject field including '\0' <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00072">72</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>. </td> </tr></table><a name="a2" doxytag="pop3_client.h::POP3C_TOUT"></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"> #define POP3C_TOUT 20 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>POP3 client timeout in secs <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00076">76</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>. </td> </tr></table><a name="a3" doxytag="pop3_client.h::POP3C_UNINITIALIZED"></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"> #define POP3C_UNINITIALIZED 1 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>POP3 state: Not initialized yet <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00107">107</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>. </td> </tr></table><a name="a4" doxytag="pop3_client.h::POP3C_CLOSED"></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"> #define POP3C_CLOSED 2 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>POP3 state: TCP connection closed <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00108">108</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.<p>Referenced by <a class="el" href="pop3__client_8c-source.html#l00114">pop3c_connect()</a>, and <a class="el" href="pop3__client_8c-source.html#l00148">pop3c_init()</a>. </td> </tr></table><a name="a5" doxytag="pop3_client.h::POP3C_OPEN_REQUESTED"></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"> #define POP3C_OPEN_REQUESTED 3 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>POP3 state: User has requested mail read <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00109">109</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>.<p>Referenced by <a class="el" href="pop3__client_8c-source.html#l00114">pop3c_connect()</a>. </td> </tr></table><a name="a6" doxytag="pop3_client.h::POP3C_CONNECTIONOPEN_SENT"></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"> #define POP3C_CONNECTIONOPEN_SENT 4 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>POP3 state: TCP connection request sent <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00110">110</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>. </td> </tr></table><a name="a7" doxytag="pop3_client.h::POP3C_CONNECTION_OPENED"></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"> #define POP3C_CONNECTION_OPENED 5 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>POP3 state: TCP Connection opened <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00111">111</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>. </td> </tr></table><a name="a8" doxytag="pop3_client.h::POP3C_SERVER_READY"></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"> #define POP3C_SERVER_READY 6 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>POP3 state: POP3 server has indicated +OK <p>Definition at line <a class="el" href="pop3__client_8h-source.html#l00112">112</a> of file <a class="el" href="pop3__client_8h-source.html">pop3_client.h</a>. </td> </tr></table><a name="a9" doxytag="pop3_client.h::POP3C_USERNAME_SENT"></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"> #define POP3C_USERNAME_SENT 7 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -