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