smtp__client_8h.html

Freescale mcu OpenTCP-1.0.4.doc.html.zip 文档

      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> #define SMTP_QUIT_ACKED&nbsp;&nbsp;&nbsp;21
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
SMTP Client state: Server has acked quit by 221 
<p>
Definition at line <a class="el" href="smtp__client_8h-source.html#l00098">98</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.    </td>
  </tr>
</table>
<a name="a22" doxytag="smtp_client.h::SMTP_CMD_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_CMD_SERVER_READY&nbsp;&nbsp;&nbsp;'2' + '2' + '0'
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Server outputs when connected 
<p>
Definition at line <a class="el" href="smtp__client_8h-source.html#l00103">103</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.    </td>
  </tr>
</table>
<a name="a23" doxytag="smtp_client.h::SMTP_CMD_OK"></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_CMD_OK&nbsp;&nbsp;&nbsp;'2' + '5' + '0'
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Command executed OK 
<p>
Definition at line <a class="el" href="smtp__client_8h-source.html#l00104">104</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.    </td>
  </tr>
</table>
<a name="a24" doxytag="smtp_client.h::SMTP_CMD_DATAOK"></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_CMD_DATAOK&nbsp;&nbsp;&nbsp;'3' + '5' + '4'
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
OK to send data 
<p>
Definition at line <a class="el" href="smtp__client_8h-source.html#l00105">105</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.    </td>
  </tr>
</table>
<a name="a25" doxytag="smtp_client.h::SMTP_CMD_QUITOK"></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_CMD_QUITOK&nbsp;&nbsp;&nbsp;'2' + '2' + '1'
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
OK to quit, close connection 
<p>
Definition at line <a class="el" href="smtp__client_8h-source.html#l00106">106</a> of file <a class="el" href="smtp__client_8h-source.html">smtp_client.h</a>.    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a26" doxytag="smtp_client.h::smtpc_connect"></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"> INT8 smtpc_connect </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">UINT32&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>ip</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>UINT16&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>port</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Jari Lahti (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
12.08.2002 </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ip</em>&nbsp;</td><td>
IP address of SMTP server </td></tr>
<tr><td valign=top><em>port</em>&nbsp;</td><td>
Port number on server (remote port) </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
 <ul>
<li> - 1 - Error <li> &gt;=0 - Connection procedure started (OK)</ul>
</dl>This function is called by user when she wants to start E-mail  sending procedure. The function is responsible of establishing connection to SMTP server. After connection is established the SMTP client engine starts to make callbacks to user functions in order to get E-mail address information, data etc. 
<p>
Definition at line <a class="el" href="smtp__client_8c-source.html#l00120">120</a> of file <a class="el" href="smtp__client_8c-source.html">smtp_client.c</a>.
<p>
References <a class="el" href="smtp__client_8c.html#a8">smtp_client</a>, <a class="el" href="smtp__client_8h-source.html#l00079">SMTP_CLOSED</a>, and <a class="el" href="smtp__client_8h-source.html#l00080">SMTP_OPEN_REQUESTED</a>.    </td>
  </tr>
</table>
<a name="a27" doxytag="smtp_client.h::smtpc_init"></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"> void smtpc_init </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Jari Lahti (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
12.08.2002</dl>This function should be called once when system starts. Make sure that system services e.g. timers, TCP are initialized before initializing applications! 
<p>
Definition at line <a class="el" href="smtp__client_8c-source.html#l00155">155</a> of file <a class="el" href="smtp__client_8c-source.html">smtp_client.c</a>.
<p>
References <a class="el" href="timers_8c-source.html#l00131">get_timer()</a>, <a class="el" href="system_8h-source.html#l00163">RESET_SYSTEM</a>, <a class="el" href="smtp__client_8c.html#a8">smtp_client</a>, <a class="el" href="smtp__client_8h-source.html#l00079">SMTP_CLOSED</a>, <a class="el" href="smtp__client_8c-source.html#l00075">smtpc_init_done</a>, <a class="el" href="tcp__ip_8h-source.html#l00459">TCP_APP_OFFSET</a>, <a class="el" href="tcp__ip_8h-source.html#l00225">TCP_DEF_TOUT</a>, <a class="el" href="tcp_8c-source.html#l00155">tcp_getsocket()</a>, <a class="el" href="tcp__ip_8h-source.html#l00214">TCP_TOS_NORMAL</a>, and <a class="el" href="tcp__ip_8h-source.html#l00320">TCP_TYPE_CLIENT</a>.    </td>
  </tr>
</table>
<a name="a30" doxytag="smtp_client.h::smtpc_getstate"></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"> UINT8 smtpc_getstate </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Jari Lahti (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
6.10.2002</dl>Returns the state of SMTP client 
<p>
Definition at line <a class="el" href="smtp__client_8c-source.html#l00193">193</a> of file <a class="el" href="smtp__client_8c-source.html">smtp_client.c</a>.
<p>
References <a class="el" href="smtp__client_8c.html#a8">smtp_client</a>.    </td>
  </tr>
</table>
<a name="a40" doxytag="smtp_client.h::smtpc_getdomain"></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"> INT8 smtpc_getdomain </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">UINT8 *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>dbuf</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Jari Lahti (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
12.08.2002 </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>dbuf</em>&nbsp;</td><td>
pointer to buffer to which the domain name will be stored </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
 <ul>
<li> -1 - Error <li> &gt;0 - Number of bytes inserted</ul>
</dl>This callback function is called by SMTP Client when it wants to know the local domain. The user is responsible of storing that domain to destbuf without NULL termination ('\0') and returning number of bytes on domain. 
<p>
Definition at line <a class="el" href="smtpc__callbacks_8c-source.html#l00120">120</a> of file <a class="el" href="smtpc__callbacks_8c-source.html">smtpc_callbacks.c</a>.    </td>
  </tr>
</table>
<a name="a41" doxytag="smtp_client.h::smtpc_getsender"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>