1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>uIP 1.0: SMTP E-mail sender</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<!-- Generated by Doxygen 1.4.6 --> 8<div class="tabs"> 9 <ul> 10 <li><a href="main.html"><span>Main Page</span></a></li> 11 <li><a href="modules.html"><span>Modules</span></a></li> 12 <li><a href="classes.html"><span>Data Structures</span></a></li> 13 <li><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<h1>SMTP E-mail sender<br> 17<small> 18[<a class="el" href="a00143.html">Applications</a>]</small> 19</h1><hr><a name="_details"></a><h2>Detailed Description</h2> 20The Simple Mail Transfer Protocol (SMTP) as defined by RFC821 is the standard way of sending and transfering e-mail on the Internet. 21<p> 22This simple example implementation is intended as an example of how to implement protocols in uIP, and is able to send out e-mail but has not been extensively tested. 23<p> 24<table border="0" cellpadding="0" cellspacing="0"> 25<tr><td></td></tr> 26<tr><td colspan="2"><br><h2>Files</h2></td></tr> 27<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="a00105.html">smtp.h</a></td></tr> 28 29<tr><td class="mdescLeft"> </td><td class="mdescRight">SMTP header file. <br></td></tr> 30 31<p> 32<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="a00104.html">smtp.c</a></td></tr> 33 34<tr><td class="mdescLeft"> </td><td class="mdescRight">SMTP example implementation. <br></td></tr> 35 36<p> 37<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> 38<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="a00085.html">smtp_state</a></td></tr> 39 40<tr><td colspan="2"><br><h2>Defines</h2></td></tr> 41<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g029256bc17a12e1e86781887e11c0c7d"></a><!-- doxytag: member="smtp::SMTP_ERR_OK" ref="g029256bc17a12e1e86781887e11c0c7d" args="" --> 42#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g029256bc17a12e1e86781887e11c0c7d">SMTP_ERR_OK</a> 0</td></tr> 43 44<tr><td class="mdescLeft"> </td><td class="mdescRight">Error number that signifies a non-error condition. <br></td></tr> 45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcff75c8c930abd6ff168e85373a4eb92"></a><!-- doxytag: member="smtp::SMTP_SEND" ref="gcff75c8c930abd6ff168e85373a4eb92" args="(to, cc, from, subject, msg)" --> 46#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#gcff75c8c930abd6ff168e85373a4eb92">SMTP_SEND</a>(to, cc, from, subject, msg) smtp_send(to, cc, from, subject, msg, strlen(msg))</td></tr> 47 48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3212e70c55244608ac16316888c354f0"></a><!-- doxytag: member="smtp::ISO_nl" ref="g3212e70c55244608ac16316888c354f0" args="" --> 49#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g3212e70c55244608ac16316888c354f0">ISO_nl</a> 0x0a</td></tr> 50 51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6cda47c85ce1b58b501b44ac9cccc50e"></a><!-- doxytag: member="smtp::ISO_cr" ref="g6cda47c85ce1b58b501b44ac9cccc50e" args="" --> 52#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g6cda47c85ce1b58b501b44ac9cccc50e">ISO_cr</a> 0x0d</td></tr> 53 54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf7dd2757d1e766f65b01ba7c91c660a0"></a><!-- doxytag: member="smtp::ISO_period" ref="gf7dd2757d1e766f65b01ba7c91c660a0" args="" --> 55#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#gf7dd2757d1e766f65b01ba7c91c660a0">ISO_period</a> 0x2e</td></tr> 56 57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g34b924954ba5707d536df28d71a80d39"></a><!-- doxytag: member="smtp::ISO_2" ref="g34b924954ba5707d536df28d71a80d39" args="" --> 58#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g34b924954ba5707d536df28d71a80d39">ISO_2</a> 0x32</td></tr> 59 60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9e97c58fe35f750ad192774be9408ac8"></a><!-- doxytag: member="smtp::ISO_3" ref="g9e97c58fe35f750ad192774be9408ac8" args="" --> 61#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g9e97c58fe35f750ad192774be9408ac8">ISO_3</a> 0x33</td></tr> 62 63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g28cf9765e4b57451af559ab988ad7160"></a><!-- doxytag: member="smtp::ISO_4" ref="g28cf9765e4b57451af559ab988ad7160" args="" --> 64#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g28cf9765e4b57451af559ab988ad7160">ISO_4</a> 0x34</td></tr> 65 66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g17ccd786400fd08b941e11046df1668f"></a><!-- doxytag: member="smtp::ISO_5" ref="g17ccd786400fd08b941e11046df1668f" args="" --> 67#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g17ccd786400fd08b941e11046df1668f">ISO_5</a> 0x35</td></tr> 68 69<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 70<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#gb1fc692a2700b7a51517724364683f67">smtp_done</a> (unsigned char error)</td></tr> 71 72<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is called when an e-mail transmission is done. <a href="#gb1fc692a2700b7a51517724364683f67"></a><br></td></tr> 73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g64807ba7c221ddf735572d05021539f2"></a><!-- doxytag: member="smtp::smtp_init" ref="g64807ba7c221ddf735572d05021539f2" args="(void)" --> 74void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g64807ba7c221ddf735572d05021539f2">smtp_init</a> (void)</td></tr> 75 76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbc331f73107958428bf1c392ba19b6f4"></a><!-- doxytag: member="smtp::smtp_appcall" ref="gbc331f73107958428bf1c392ba19b6f4" args="(void)" --> 77void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#gbc331f73107958428bf1c392ba19b6f4">smtp_appcall</a> (void)</td></tr> 78 79<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#g37e3103b9591790d484a450525739661">smtp_configure</a> (char *lhostname, void *server)</td></tr> 80 81<tr><td class="mdescLeft"> </td><td class="mdescRight">Specificy an SMTP server and hostname. <a href="#g37e3103b9591790d484a450525739661"></a><br></td></tr> 82<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#gf0349a8481565e80f55a751e2b408d6d">smtp_send</a> (char *to, char *cc, char *from, char *subject, char *msg, <a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> msglen)</td></tr> 83 84<tr><td class="mdescLeft"> </td><td class="mdescRight">Send an e-mail. <a href="#gf0349a8481565e80f55a751e2b408d6d"></a><br></td></tr> 85</table> 86<hr><h2>Function Documentation</h2> 87<a class="anchor" name="g37e3103b9591790d484a450525739661"></a><!-- doxytag: member="smtp.c::smtp_configure" ref="g37e3103b9591790d484a450525739661" args="(char *lhostname, void *server)" --><p> 88<table class="mdTable" cellpadding="2" cellspacing="0"> 89 <tr> 90 <td class="mdRow"> 91 <table cellpadding="0" cellspacing="0" border="0"> 92 <tr> 93 <td class="md" nowrap valign="top">void smtp_configure </td> 94 <td class="md" valign="top">( </td> 95 <td class="md" nowrap valign="top">char * </td> 96 <td class="mdname" nowrap> <em>lhostname</em>, </td> 97 </tr> 98 <tr> 99 <td class="md" nowrap align="right"></td> 100 <td class="md"></td> 101 <td class="md" nowrap>void * </td> 102 <td class="mdname" nowrap> <em>server</em></td> 103 </tr> 104 <tr> 105 <td class="md"></td> 106 <td class="md">) </td> 107 <td class="md" colspan="2"></td> 108 </tr> 109 </table> 110 </td> 111 </tr> 112</table> 113<table cellspacing="5" cellpadding="0" border="0"> 114 <tr> 115 <td> 116 117 </td> 118 <td> 119 120<p> 121Specificy an SMTP server and hostname. 122<p> 123This function is used to configure the SMTP module with an SMTP server and the hostname of the host.<p> 124<dl compact><dt><b>Parameters:</b></dt><dd> 125 <table border="0" cellspacing="2" cellpadding="0"> 126 <tr><td valign="top"></td><td valign="top"><em>lhostname</em> </td><td>The hostname of the uIP host.</td></tr> 127 <tr><td valign="top"></td><td valign="top"><em>server</em> </td><td>A pointer to a 4-byte array representing the IP address of the SMTP server to be configured. </td></tr> 128 </table> 129</dl> 130 131<p> 132Definition at line <a class="el" href="a00174.html#l00216">216</a> of file <a class="el" href="a00174.html">smtp.c</a>. 133<p> 134References <a class="el" href="a00202.html#l00882">uip_ipaddr_copy</a>. </td> 135 </tr> 136</table> 137<a class="anchor" name="gb1fc692a2700b7a51517724364683f67"></a><!-- doxytag: member="smtp.h::smtp_done" ref="gb1fc692a2700b7a51517724364683f67" args="(unsigned char error)" --><p> 138<table class="mdTable" cellpadding="2" cellspacing="0"> 139 <tr> 140 <td class="mdRow"> 141 <table cellpadding="0" cellspacing="0" border="0"> 142 <tr> 143 <td class="md" nowrap valign="top">void smtp_done </td> 144 <td class="md" valign="top">( </td> 145 <td class="md" nowrap valign="top">unsigned char </td> 146 <td class="mdname1" valign="top" nowrap> <em>error</em> </td> 147 <td class="md" valign="top"> ) </td> 148 <td class="md" nowrap></td> 149 </tr> 150 </table> 151 </td> 152 </tr> 153</table> 154<table cellspacing="5" cellpadding="0" border="0"> 155 <tr> 156 <td> 157 158 </td> 159 <td> 160 161<p> 162Callback function that is called when an e-mail transmission is done. 163<p> 164This function must be implemented by the module that uses the SMTP module.<p> 165<dl compact><dt><b>Parameters:</b></dt><dd> 166 <table border="0" cellspacing="2" cellpadding="0"> 167 <tr><td valign="top"></td><td valign="top"><em>error</em> </td><td>The number of the error if an error occured, or SMTP_ERR_OK. </td></tr> 168 </table> 169</dl> 170<dl compact><dt><b>Examples: </b></dt><dd> 171<a class="el" href="a00038.html#a170">smtp.c</a>, and <a class="el" href="a00039.html#a195">smtp.h</a>.</dl> 172<p> 173Referenced by <a class="el" href="a00174.html#l00190">smtp_appcall()</a>. </td> 174 </tr> 175</table> 176<a class="anchor" name="gf0349a8481565e80f55a751e2b408d6d"></a><!-- doxytag: member="smtp.c::smtp_send" ref="gf0349a8481565e80f55a751e2b408d6d" args="(char *to, char *cc, char *from, char *subject, char *msg, u16_t msglen)" --><p> 177<table class="mdTable" cellpadding="2" cellspacing="0"> 178 <tr> 179 <td class="mdRow"> 180 <table cellpadding="0" cellspacing="0" border="0"> 181 <tr> 182 <td class="md" nowrap valign="top">unsigned char smtp_send </td> 183 <td class="md" valign="top">( </td> 184 <td class="md" nowrap valign="top">char * </td> 185 <td class="mdname" nowrap> <em>to</em>, </td> 186 </tr> 187 <tr> 188 <td class="md" nowrap align="right"></td> 189 <td class="md"></td> 190 <td class="md" nowrap>char * </td> 191 <td class="mdname" nowrap> <em>cc</em>, </td> 192 </tr> 193 <tr> 194 <td class="md" nowrap align="right"></td> 195 <td class="md"></td> 196 <td class="md" nowrap>char * </td> 197 <td class="mdname" nowrap> <em>from</em>, </td> 198 </tr> 199 <tr> 200 <td class="md" nowrap align="right"></td> 201 <td class="md"></td> 202 <td class="md" nowrap>char * </td> 203 <td class="mdname" nowrap> <em>subject</em>, </td> 204 </tr> 205 <tr> 206 <td class="md" nowrap align="right"></td> 207 <td class="md"></td> 208 <td class="md" nowrap>char * </td> 209 <td class="mdname" nowrap> <em>msg</em>, </td> 210 </tr> 211 <tr> 212 <td class="md" nowrap align="right"></td> 213 <td class="md"></td> 214 <td class="md" nowrap><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> 215 <td class="mdname" nowrap> <em>msglen</em></td> 216 </tr> 217 <tr> 218 <td class="md"></td> 219 <td class="md">) </td> 220 <td class="md" colspan="2"></td> 221 </tr> 222 </table> 223 </td> 224 </tr> 225</table> 226<table cellspacing="5" cellpadding="0" border="0"> 227 <tr> 228 <td> 229 230 </td> 231 <td> 232 233<p> 234Send an e-mail. 235<p> 236<dl compact><dt><b>Parameters:</b></dt><dd> 237 <table border="0" cellspacing="2" cellpadding="0"> 238 <tr><td valign="top"></td><td valign="top"><em>to</em> </td><td>The e-mail address of the receiver of the e-mail. </td></tr> 239 <tr><td valign="top"></td><td valign="top"><em>cc</em> </td><td>The e-mail address of the CC: receivers of the e-mail. </td></tr> 240 <tr><td valign="top"></td><td valign="top"><em>from</em> </td><td>The e-mail address of the sender of the e-mail. </td></tr> 241 <tr><td valign="top"></td><td valign="top"><em>subject</em> </td><td>The subject of the e-mail. </td></tr> 242 <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>The actual e-mail message. </td></tr> 243 <tr><td valign="top"></td><td valign="top"><em>msglen</em> </td><td>The length of the e-mail message. </td></tr> 244 </table> 245</dl> 246 247<p> 248Definition at line <a class="el" href="a00174.html#l00233">233</a> of file <a class="el" href="a00174.html">smtp.c</a>. 249<p> 250References <a class="el" href="a00175.html#l00084">smtp_state::from</a>, <a class="el" href="a00202.html#l01070">HTONS</a>, <a class="el" href="a00175.html#l00086">smtp_state::msg</a>, <a class="el" href="a00175.html#l00087">smtp_state::msglen</a>, <a class="el" href="a00172.html#l00069">NULL</a>, <a class="el" href="a00193.html#l00144">PSOCK_INIT</a>, <a class="el" href="a00175.html#l00085">smtp_state::subject</a>, <a class="el" href="a00175.html#l00083">smtp_state::to</a>, and <a class="el" href="a00201.html#l00407">uip_connect()</a>. </td> 251 </tr> 252</table> 253<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:02 2006 for uIP 1.0 by 254<a href="http://www.doxygen.org/index.html"> 255<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 256</body> 257</html> 258
