pop3.h

Go to the documentation of this file.

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _POP3_H_
#define _POP3_H_
 
#include <nettypes.h>
 
// #define POP3_DEBUG                  ( 1 )    // Library debug switch
 
#ifdef POP3_DEBUG
#define POP3_DEBUG_IPRINTF(...)                   \
    {                                             \
        iprintf("%s:%d", __FUNCTION__, __LINE__); \
        iprintf(__VA_ARGS__);                     \
        iprintf("\r\n");                          \
    }
#else /* #ifdef POP3_DEBUG */
#define POP3_DEBUG_IPRINTF(...) ((void)0)
#endif /* #ifdef POP3_DEBUG */
 
#define POP_OK (0)               
#define POP_TIMEOUT (-1)         
#define POP_PASSWORDERROR (-2)   
#define POP_CONNECTFAIL (-3)     
#define POP_COMMANDFAIL (-4)     
#define POP_BADSESSION (-5)      
#define POP_NETWORKERROR (-6)    
#define POP_BUFFER_FULL (-7)     
int POPGetResultCode(int fd, uint32_t timeout);
 
int POP3_InitializeSession(IPADDR server_address, uint16_t port, PCSTR UserName, PCSTR Password, uint32_t timeout);
 
int POP3_CloseSession(int session);
 
int POP3_StatCmd(int session, uint32_t *num_messages, uint32_t *total_bytes, uint32_t timeout);
 
int POP3_ListCmd(int session, uint32_t message_number, uint32_t *total_bytes, uint32_t timeout);
 
int POP3_DeleteCmd(int session, uint32_t message_number, uint32_t timeout);
 
int POP3_RetrieveMessage(int session,
                         uint32_t message_number,
                         char *buffer,
                         char **subject_ptr,
                         char **body_ptr,
                         int max_bufferlen,
                         uint32_t timeout);
 
PCSTR GetPOPErrorString(int err);
 
#endif /* #ifndef _POP3_H_ */