a00175.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  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: apps/smtp/smtp.h Source File</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&nbsp;Page</span></a></li>
  11. <li><a href="modules.html"><span>Modules</span></a></li>
  12. <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
  13. <li id="current"><a href="files.html"><span>Files</span></a></li>
  14. <li><a href="examples.html"><span>Examples</span></a></li>
  15. </ul></div>
  16. <div class="tabs">
  17. <ul>
  18. <li><a href="files.html"><span>File&nbsp;List</span></a></li>
  19. <li><a href="globals.html"><span>Globals</span></a></li>
  20. </ul></div>
  21. <h1>apps/smtp/smtp.h</h1><a href="a00105.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment"></span>
  22. <a name="l00002"></a>00002 <span class="comment">/**</span>
  23. <a name="l00003"></a>00003 <span class="comment"> * \addtogroup smtp</span>
  24. <a name="l00004"></a>00004 <span class="comment"> * @{</span>
  25. <a name="l00005"></a>00005 <span class="comment"> */</span>
  26. <a name="l00006"></a>00006
  27. <a name="l00007"></a>00007 <span class="comment"></span>
  28. <a name="l00008"></a>00008 <span class="comment">/**</span>
  29. <a name="l00009"></a>00009 <span class="comment"> * \file</span>
  30. <a name="l00010"></a>00010 <span class="comment"> * SMTP header file</span>
  31. <a name="l00011"></a>00011 <span class="comment"> * \author Adam Dunkels &lt;adam@dunkels.com&gt;</span>
  32. <a name="l00012"></a>00012 <span class="comment"> */</span>
  33. <a name="l00013"></a>00013
  34. <a name="l00014"></a>00014 <span class="comment">/*</span>
  35. <a name="l00015"></a>00015 <span class="comment"> * Copyright (c) 2002, Adam Dunkels.</span>
  36. <a name="l00016"></a>00016 <span class="comment"> * All rights reserved.</span>
  37. <a name="l00017"></a>00017 <span class="comment"> *</span>
  38. <a name="l00018"></a>00018 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
  39. <a name="l00019"></a>00019 <span class="comment"> * modification, are permitted provided that the following conditions</span>
  40. <a name="l00020"></a>00020 <span class="comment"> * are met:</span>
  41. <a name="l00021"></a>00021 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
  42. <a name="l00022"></a>00022 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span>
  43. <a name="l00023"></a>00023 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
  44. <a name="l00024"></a>00024 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span>
  45. <a name="l00025"></a>00025 <span class="comment"> * documentation and/or other materials provided with the distribution.</span>
  46. <a name="l00026"></a>00026 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span>
  47. <a name="l00027"></a>00027 <span class="comment"> * products derived from this software without specific prior</span>
  48. <a name="l00028"></a>00028 <span class="comment"> * written permission.</span>
  49. <a name="l00029"></a>00029 <span class="comment"> *</span>
  50. <a name="l00030"></a>00030 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS</span>
  51. <a name="l00031"></a>00031 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span>
  52. <a name="l00032"></a>00032 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
  53. <a name="l00033"></a>00033 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span>
  54. <a name="l00034"></a>00034 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span>
  55. <a name="l00035"></a>00035 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span>
  56. <a name="l00036"></a>00036 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
  57. <a name="l00037"></a>00037 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span>
  58. <a name="l00038"></a>00038 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
  59. <a name="l00039"></a>00039 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
  60. <a name="l00040"></a>00040 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
  61. <a name="l00041"></a>00041 <span class="comment"> *</span>
  62. <a name="l00042"></a>00042 <span class="comment"> * This file is part of the uIP TCP/IP stack.</span>
  63. <a name="l00043"></a>00043 <span class="comment"> *</span>
  64. <a name="l00044"></a>00044 <span class="comment"> * $Id: smtp.h,v 1.4 2006/06/11 21:46:37 adam Exp $</span>
  65. <a name="l00045"></a>00045 <span class="comment"> *</span>
  66. <a name="l00046"></a>00046 <span class="comment"> */</span>
  67. <a name="l00047"></a>00047 <span class="preprocessor">#ifndef __SMTP_H__</span>
  68. <a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#define __SMTP_H__</span>
  69. <a name="l00049"></a>00049 <span class="preprocessor"></span>
  70. <a name="l00050"></a>00050 <span class="preprocessor">#include "<a class="code" href="a00140.html">uipopt.h</a>"</span>
  71. <a name="l00051"></a>00051 <span class="comment"></span>
  72. <a name="l00052"></a>00052 <span class="comment">/**</span>
  73. <a name="l00053"></a>00053 <span class="comment"> * Error number that signifies a non-error condition.</span>
  74. <a name="l00054"></a>00054 <span class="comment"> */</span>
  75. <a name="l00055"></a><a class="code" href="a00161.html#g029256bc17a12e1e86781887e11c0c7d">00055</a> <span class="preprocessor">#define SMTP_ERR_OK 0</span>
  76. <a name="l00056"></a>00056 <span class="preprocessor"></span><span class="comment"></span>
  77. <a name="l00057"></a>00057 <span class="comment">/**</span>
  78. <a name="l00058"></a>00058 <span class="comment"> * Callback function that is called when an e-mail transmission is</span>
  79. <a name="l00059"></a>00059 <span class="comment"> * done.</span>
  80. <a name="l00060"></a>00060 <span class="comment"> *</span>
  81. <a name="l00061"></a>00061 <span class="comment"> * This function must be implemented by the module that uses the SMTP</span>
  82. <a name="l00062"></a>00062 <span class="comment"> * module.</span>
  83. <a name="l00063"></a>00063 <span class="comment"> *</span>
  84. <a name="l00064"></a>00064 <span class="comment"> * \param error The number of the error if an error occured, or</span>
  85. <a name="l00065"></a>00065 <span class="comment"> * SMTP_ERR_OK.</span>
  86. <a name="l00066"></a>00066 <span class="comment"> */</span>
  87. <a name="l00067"></a>00067 <span class="keywordtype">void</span> <a class="code" href="a00161.html#gb1fc692a2700b7a51517724364683f67">smtp_done</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> error);
  88. <a name="l00068"></a>00068
  89. <a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="a00161.html#g64807ba7c221ddf735572d05021539f2">smtp_init</a>(<span class="keywordtype">void</span>);
  90. <a name="l00070"></a>00070
  91. <a name="l00071"></a>00071 <span class="comment">/* Functions. */</span>
  92. <a name="l00072"></a>00072 <span class="keywordtype">void</span> smtp_configure(<span class="keywordtype">char</span> *localhostname, <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> *smtpserver);
  93. <a name="l00073"></a>00073 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> smtp_send(<span class="keywordtype">char</span> *to, <span class="keywordtype">char</span> *from,
  94. <a name="l00074"></a>00074 <span class="keywordtype">char</span> *subject, <span class="keywordtype">char</span> *msg,
  95. <a name="l00075"></a>00075 <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> msglen);
  96. <a name="l00076"></a><a class="code" href="a00161.html#gcff75c8c930abd6ff168e85373a4eb92">00076</a> <span class="preprocessor">#define SMTP_SEND(to, cc, from, subject, msg) \</span>
  97. <a name="l00077"></a>00077 <span class="preprocessor"> smtp_send(to, cc, from, subject, msg, strlen(msg))</span>
  98. <a name="l00078"></a>00078 <span class="preprocessor"></span>
  99. <a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="a00161.html#gbc331f73107958428bf1c392ba19b6f4">smtp_appcall</a>(<span class="keywordtype">void</span>);
  100. <a name="l00080"></a>00080
  101. <a name="l00081"></a><a class="code" href="a00085.html">00081</a> <span class="keyword">struct </span><a class="code" href="a00085.html">smtp_state</a> {
  102. <a name="l00082"></a><a class="code" href="a00085.html#0bb4f34164e7207c2db26b77f23ccfff">00082</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00085.html#0bb4f34164e7207c2db26b77f23ccfff">state</a>;
  103. <a name="l00083"></a><a class="code" href="a00085.html#3592a1f5ae100db2ed9c0810b41c7bc7">00083</a> <span class="keywordtype">char</span> *<a class="code" href="a00085.html#3592a1f5ae100db2ed9c0810b41c7bc7">to</a>;
  104. <a name="l00084"></a><a class="code" href="a00085.html#668cab7d54ff0a2fc2a2179ca06b0798">00084</a> <span class="keywordtype">char</span> *<a class="code" href="a00085.html#668cab7d54ff0a2fc2a2179ca06b0798">from</a>;
  105. <a name="l00085"></a><a class="code" href="a00085.html#503c2994a4e52300516e2b820f0fc65b">00085</a> <span class="keywordtype">char</span> *<a class="code" href="a00085.html#503c2994a4e52300516e2b820f0fc65b">subject</a>;
  106. <a name="l00086"></a><a class="code" href="a00085.html#04833004cec509a41c502429df308e35">00086</a> <span class="keywordtype">char</span> *<a class="code" href="a00085.html#04833004cec509a41c502429df308e35">msg</a>;
  107. <a name="l00087"></a><a class="code" href="a00085.html#a312da7b5f6441140721ec7e55f345a8">00087</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00085.html#a312da7b5f6441140721ec7e55f345a8">msglen</a>;
  108. <a name="l00088"></a>00088
  109. <a name="l00089"></a><a class="code" href="a00085.html#0560495c60c68d62617ff1f3d0c424a4">00089</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00085.html#68204df6bde3e3c27271ebde10579a57">sentlen</a>, <a class="code" href="a00085.html#0560495c60c68d62617ff1f3d0c424a4">textlen</a>;
  110. <a name="l00090"></a><a class="code" href="a00085.html#5ed2615cec9e633d90ac5968771976eb">00090</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00085.html#5ed2615cec9e633d90ac5968771976eb">sendptr</a>;
  111. <a name="l00091"></a>00091
  112. <a name="l00092"></a>00092 };
  113. <a name="l00093"></a>00093
  114. <a name="l00094"></a>00094
  115. <a name="l00095"></a>00095 <span class="preprocessor">#ifndef UIP_APPCALL</span>
  116. <a name="l00096"></a><a class="code" href="a00153.html#g41aa744caa46913b3b3aedb2a4e78546">00096</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_APPCALL smtp_appcall</span>
  117. <a name="l00097"></a>00097 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
  118. <a name="l00098"></a><a class="code" href="a00153.html#g69646a81a922033c5281445a71f8ffed">00098</a> <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00085.html">smtp_state</a> <a class="code" href="a00153.html#g69646a81a922033c5281445a71f8ffed">uip_tcp_appstate_t</a>;
  119. <a name="l00099"></a>00099
  120. <a name="l00100"></a>00100
  121. <a name="l00101"></a>00101 <span class="preprocessor">#endif </span><span class="comment">/* __SMTP_H__ */</span>
  122. <a name="l00102"></a>00102 <span class="comment"></span>
  123. <a name="l00103"></a>00103 <span class="comment">/** @} */</span>
  124. </pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by&nbsp;
  125. <a href="http://www.doxygen.org/index.html">
  126. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
  127. </body>
  128. </html>