pop3__client_8h.html

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

<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 pop3c_error </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>
11.09.2002</dl>This callback function is called by POP3 Client when there  happens error of some kind (timeout, losing of connection etc.). 
<p>
Definition at line <a class="el" href="pop3c__callbacks_8c-source.html#l00082">82</a> of file <a class="el" href="pop3c__callbacks_8c-source.html">pop3c_callbacks.c</a>.    </td>
  </tr>
</table>
<a name="a48" doxytag="pop3_client.h::pop3c_data"></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 pop3c_data </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>data</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>
14.10.2002 </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>data</em>&nbsp;</td><td>
E-mail data as received by POP3 client</td></tr>
</table>
</dl>This callback function is called by POP3 Client in order to  give data to application 
<p>
Definition at line <a class="el" href="pop3c__callbacks_8c-source.html#l00183">183</a> of file <a class="el" href="pop3c__callbacks_8c-source.html">pop3c_callbacks.c</a>.    </td>
  </tr>
</table>
<a name="a49" doxytag="pop3_client.h::pop3c_allok"></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 pop3c_allok </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>
14.10.2002</dl>This callback function is called by POP3 Client to indicate  succesfull reading of E-mails 
<p>
Definition at line <a class="el" href="pop3c__callbacks_8c-source.html#l00169">169</a> of file <a class="el" href="pop3c__callbacks_8c-source.html">pop3c_callbacks.c</a>.    </td>
  </tr>
</table>
<a name="a50" doxytag="pop3_client.h::pop3c_messages"></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 pop3c_messages </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">UINT16&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>msgs</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>
11.09.2002 </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>msgs</em>&nbsp;</td><td>
Number of new e-mails waiting on the server</td></tr>
</table>
</dl>This callback function is called by POP3 Client in order to  indicate the number of new E-mails on server. 
<p>
Definition at line <a class="el" href="pop3c__callbacks_8c-source.html#l00096">96</a> of file <a class="el" href="pop3c__callbacks_8c-source.html">pop3c_callbacks.c</a>.    </td>
  </tr>
</table>
<a name="a51" doxytag="pop3_client.h::pop3c_msgoffer"></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"> INT16 pop3c_msgoffer </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">UINT16&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>index</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>UINT32&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>msglen</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>UINT8 *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>from</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>UINT8 *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>subject</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>
11.09.2002 </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>index</em>&nbsp;</td><td>
index number of message </td></tr>
<tr><td valign=top><em>msglen</em>&nbsp;</td><td>
Length of message data </td></tr>
<tr><td valign=top><em>from</em>&nbsp;</td><td>
Buffer containing sender (null terminated string) </td></tr>
<tr><td valign=top><em>subject</em>&nbsp;</td><td>
Buffer containing subject (null terminated string) </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
 <ul>
<li> -2 - Reject the e-mail (delete from server) <li> -1 - Skip the e-mail (leave it on server) <li> &gt;=0 - Read and delete the mail from server</ul>
</dl>This callback function is called by POP3 Client in order to  offer the e-mail message to user. User can reject this mail,  skip this, mail or read it as indicated with return value 
<p>
Definition at line <a class="el" href="pop3c__callbacks_8c-source.html#l00117">117</a> of file <a class="el" href="pop3c__callbacks_8c-source.html">pop3c_callbacks.c</a>.    </td>
  </tr>
</table>
<a name="a52" doxytag="pop3_client.h::pop3c_getusername"></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 pop3c_getusername </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>
11.09.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 username 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 POP3 Client when it wants to know the username of us. The user is responsible of  storing that name to destbuf without NULL termination ('\0')  and returning number of bytes on that username. 
<p>
Definition at line <a class="el" href="pop3c__callbacks_8c-source.html#l00135">135</a> of file <a class="el" href="pop3c__callbacks_8c-source.html">pop3c_callbacks.c</a>.    </td>
  </tr>
</table>
<a name="a53" doxytag="pop3_client.h::pop3c_getpassword"></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 pop3c_getpassword </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>
11.09.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 password 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 POP3 Client when it wants to know the password of us. The user is responsible of  storing that name to destbuf without NULL termination ('\0')  and returning number of bytes on the password. 
<p>
Definition at line <a class="el" href="pop3c__callbacks_8c-source.html#l00155">155</a> of file <a class="el" href="pop3c__callbacks_8c-source.html">pop3c_callbacks.c</a>.    </td>
  </tr>
</table>
<hr><address style="align: right;"><small>Generated on Sun Aug 3 20:33:00 2003 for OpenTCP by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>