---

/opentcp/include/inet/pop3/pop3_client.h

Go to the documentation of this file.

/*
 *Copyright (c) 2000-2002 Viola Systems Ltd.
 *All rights reserved.
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions 
 *are met:
 *
 *1. Redistributions of source code must retain the above copyright 
 *notice, this list of conditions and the following disclaimer.
 *
 *2. Redistributions in binary form must reproduce the above copyright 
 *notice, this list of conditions and the following disclaimer in the 
 *documentation and/or other materials provided with the distribution.
 *
 *3. The end-user documentation included with the redistribution, if 
 *any, must include the following acknowledgment:
 *      "This product includes software developed by Viola 
 *      Systems (http://www.violasystems.com/)."
 *
 *Alternately, this acknowledgment may appear in the software itself, 
 *if and wherever such third-party acknowledgments normally appear.
 *
 *4. The names "OpenTCP" and "Viola Systems" must not be used to 
 *endorse or promote products derived from this software without prior 
 *written permission. For written permission, please contact 
 *opentcp@opentcp.org.
 *
 *5. Products derived from this software may not be called "OpenTCP", 
 *nor may "OpenTCP" appear in their name, without prior written 
 *permission of the Viola Systems Ltd.
 *
 *THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED 
 *WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 *MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 *IN NO EVENT SHALL VIOLA SYSTEMS LTD. OR ITS CONTRIBUTORS BE LIABLE 
 *FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 *CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 *SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
 *BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 *WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 *OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 *EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *====================================================================
 *
 *OpenTCP is the unified open source TCP/IP stack available on a series 
 *of 8/16-bit microcontrollers, please see <http://www.opentcp.org>.
 *
 *For more information on how to network-enable your devices, or how to 
 *obtain commercial technical support for OpenTCP, please see 
 *<http://www.violasystems.com/>.
 */
 
#ifndef INCLUDE_POP3_CLIENT_H
#define INCLUDE_POP3_CLIENT_H


#define POP3C_SENDERMAXLEN      30              
#define POP3C_SUBJECTMAXLEN     30              
#define POP3C_TOUT                      20      
struct pop3c_struct
{
        UINT8 state;                                            
        UINT32 remip;                                           
        UINT16 remport;                                         
        INT8 sochandle;                                         
        UINT8 tmrhandle;                                        
        UINT8 unacked;                                          
        UINT16 msgtotal;                                        
        UINT16 curmsgindex;                                     
        UINT32 curmsgtotlen;                            
        UINT16 curmsghlen;                                      
        UINT8 headerbuf[9];                                     
        UINT8 charsinheaderbuf;                         
        UINT8 from[POP3C_SENDERMAXLEN];         
        UINT8 subject[POP3C_SUBJECTMAXLEN];     
};


/* POP3 States                          */

#define POP3C_UNINITIALIZED                     1       
#define POP3C_CLOSED                            2       
#define POP3C_OPEN_REQUESTED            3       
#define POP3C_CONNECTIONOPEN_SENT       4       
#define POP3C_CONNECTION_OPENED         5       
#define POP3C_SERVER_READY                      6       
#define POP3C_USERNAME_SENT                     7       
#define POP3C_USERNAME_ACKED            8       
#define POP3C_PASSWORD_SENT                     9       
#define POP3C_PASSWORD_ACKED            10      
#define POP3C_STAT_SENT                         11      
#define POP3C_STAT_GET                          12      
#define POP3C_LIST_SENT                         13      
#define POP3C_LIST_GET                          14      
#define POP3C_TOP0_SENT                         15      
#define POP3C_RECEIVING_HEADER          16      
#define POP3C_RECEIVING_HDR_FROM        17      
#define POP3C_RECEIVING_HDR_SUBJ        18      
#define POP3C_TOP0_GET                          19      
#define POP3C_RETR_SENT                         20      
#define POP3C_RECEIVING_MSG_HEADER      21      
#define POP3C_RECEIVING_MSG                     22      
#define POP3C_MESSAGE_RECEIVED          23  
#define POP3C_DELE_SENT                         24      
#define POP3C_DELE_ACKED                        25      
#define POP3C_QUIT_SENT                         26      
#define POP3C_QUIT_ACKED                        27      
#define POP3C_OK        '+' 


/* Function prototypes (internal)       */

INT8 pop3c_connect(UINT32, UINT16);
void pop3c_init(void);
UINT8 pop3c_getstate(void);
INT32 pop3c_eventlistener(INT8, UINT8, UINT32, UINT32);
void pop3c_run(void);
void pop3c_senduser(void);
void pop3c_sendpassword(void);
void pop3c_sendstat(void);
void pop3c_sendlist(UINT16);
void pop3c_sendtop(UINT16);
void pop3c_sendretr(UINT16);
void pop3c_senddele(UINT16);
void pop3c_sendquit(void);
void pop3c_changestate(UINT8);
INT16 pop3c_parsestat(void);
INT16 pop3c_parselist(void);



/* Function prototypes (callbacks, external)    */

void pop3c_error(void);
void pop3c_data(UINT8);
void pop3c_allok(void);
void pop3c_messages(UINT16);
INT16 pop3c_msgoffer(UINT16, UINT32, UINT8*, UINT8*);
INT8 pop3c_getusername(UINT8*);
INT8 pop3c_getpassword(UINT8*);

#endif

---