📄 smtp__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>smtp_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/smtp/smtp_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>9.8.2002</dl>OpenTCP SMTP client function declarations, constants, etc.<p><p>Definition in file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.<p><a href="smtp__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>Defines</h2></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a0">SMTPC_TOUT</a> 20</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a1">SMTP_UNINITIALIZED</a> 1</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a2">SMTP_CLOSED</a> 2</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a3">SMTP_OPEN_REQUESTED</a> 3</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a4">SMTP_CONNECTIONOPEN_SENT</a> 4</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a5">SMTP_CONNECTION_OPENED</a> 5</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a6">SMTP_SERVER_READY</a> 6</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a7">SMTP_HELO_SENT</a> 7</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a8">SMTP_HELO_ACKED</a> 8</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a9">SMTP_MAILFROM_SENT</a> 9</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a10">SMTP_MAILFROM_ACKED</a> 10</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a11">SMTP_RCPTTO_SENT</a> 11</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a12">SMTP_RCPTTO_ACKED</a> 12</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a13">SMTP_DATAREQ_SENT</a> 13</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a14">SMTP_DATAREQ_ACKED</a> 14</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a15">SMTP_BODY_SENT</a> 15</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a16">SMTP_SENDING_DATA</a> 16</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a17">SMTP_DATAEND_REACHED</a> 17</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a18">SMTP_DATAEND_SENT</a> 18</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a19">SMTP_DATAEND_ACKED</a> 19</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a20">SMTP_QUIT_SENT</a> 20</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a21">SMTP_QUIT_ACKED</a> 21</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a22">SMTP_CMD_SERVER_READY</a> '2' + '2' + '0'</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a23">SMTP_CMD_OK</a> '2' + '5' + '0'</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a24">SMTP_CMD_DATAOK</a> '3' + '5' + '4'</td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a25">SMTP_CMD_QUITOK</a> '2' + '2' + '1'</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="smtp__client_8h.html#a26">smtpc_connect</a> (UINT32, UINT16)</td></tr><tr><td> </td><td><font size=-1><em>Start E-mail sending procedure.</em> <a href="#a26"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a27">smtpc_init</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>Initializes SMTP client.</em> <a href="#a27"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>UINT8 </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a30">smtpc_getstate</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>Retrieves SMTP clients' state.</em> <a href="#a30"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT8 </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a40">smtpc_getdomain</a> (UINT8 *)</td></tr><tr><td> </td><td><font size=-1><em>Fills in local domain information.</em> <a href="#a40"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT8 </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a41">smtpc_getsender</a> (UINT8 *)</td></tr><tr><td> </td><td><font size=-1><em>Returns senders' e-mail address.</em> <a href="#a41"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT8 </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a42">smtpc_getreceiver</a> (UINT8 *)</td></tr><tr><td> </td><td><font size=-1><em>Returns receivers' e-mail address.</em> <a href="#a42"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT8 </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a43">smtpc_getsubject</a> (UINT8 *)</td></tr><tr><td> </td><td><font size=-1><em>Returns subject of the E-mail.</em> <a href="#a43"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>INT16 </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a44">smtpc_getdata</a> (UINT8 *, UINT16)</td></tr><tr><td> </td><td><font size=-1><em>Returns e-mail data (message) to be sent.</em> <a href="#a44"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a45">smtpc_dataacked</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>Last data received by remote host.</em> <a href="#a45"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a46">smtpc_error</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>SMTP client error handler.</em> <a href="#a46"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="smtp__client_8h.html#a47">smtpc_allok</a> (void)</td></tr><tr><td> </td><td><font size=-1><em>SMTP client success handler.</em> <a href="#a47"></a><em></em></font><br><br></td></tr></table><hr><h2>Define Documentation</h2><a name="a0" doxytag="smtp_client.h::SMTPC_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 SMTPC_TOUT 20 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP clients' timeout in seconds <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00071">71</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>. </td> </tr></table><a name="a1" doxytag="smtp_client.h::SMTP_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 SMTP_UNINITIALIZED 1 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: Not initialized yet <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00078">78</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>. </td> </tr></table><a name="a2" doxytag="smtp_client.h::SMTP_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 SMTP_CLOSED 2 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: TCP connection closed <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00079">79</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.<p>Referenced by <a class="el" href="smtp__client_8c-source.html#l00120">smtpc_connect()</a>, and <a class="el" href="smtp__client_8c-source.html#l00155">smtpc_init()</a>. </td> </tr></table><a name="a3" doxytag="smtp_client.h::SMTP_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 SMTP_OPEN_REQUESTED 3 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: User has requested mail read <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00080">80</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.<p>Referenced by <a class="el" href="smtp__client_8c-source.html#l00120">smtpc_connect()</a>. </td> </tr></table><a name="a4" doxytag="smtp_client.h::SMTP_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 SMTP_CONNECTIONOPEN_SENT 4 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: TCP connection request sent <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00081">81</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>. </td> </tr></table><a name="a5" doxytag="smtp_client.h::SMTP_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 SMTP_CONNECTION_OPENED 5 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: TCP Connection opened <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00082">82</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>. </td> </tr></table><a name="a6" doxytag="smtp_client.h::SMTP_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 SMTP_SERVER_READY 6 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: SMTP server has indicated 220 <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00083">83</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>. </td> </tr></table><a name="a7" doxytag="smtp_client.h::SMTP_HELO_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 SMTP_HELO_SENT 7 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: HELO sent by us <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00084">84</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>. </td> </tr></table><a name="a8" doxytag="smtp_client.h::SMTP_HELO_ACKED"></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 SMTP_HELO_ACKED 8 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>SMTP Client state: Server has acked HELO by 250 <p>Definition at line <a class="el" href="smtp__client_8h-source.html#l00085">85</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>. </td> </tr>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -