pop3.h File Reference

NetBurner POP3 API. More...

#include <nettypes.h>

Go to the source code of this file.

Macros
#define	POP_OK   (0)
	No errors occurred.
#define	POP_TIMEOUT   (-1)
	Time out.
#define	POP_PASSWORDERROR   (-2)
	Password error.
#define	POP_CONNECTFAIL   (-3)
	Connection failed.
#define	POP_COMMANDFAIL   (-4)
	Command failed.
#define	POP_BADSESSION   (-5)
	Session error.
#define	POP_NETWORKERROR   (-6)
	Network error.
#define	POP_BUFFER_FULL   (-7)
	Receive buffer full.

Functions
int	POPGetResultCode (int fd, uint32_t timeout)
	Returns the result code of the previous POP3 operation.
int	POP3_InitializeSession (IPADDR server_address, uint16_t port, PCSTR UserName, PCSTR Password, uint32_t timeout)
	Create a connection to the POP3 server and log in.
int	POP3_CloseSession (int session)
	Close a POP3 session.
int	POP3_StatCmd (int session, uint32_t *num_messages, uint32_t *total_bytes, uint32_t timeout)
	Returns the status of the mailstore on the POP3 server.
int	POP3_ListCmd (int session, uint32_t message_number, uint32_t *total_bytes, uint32_t timeout)
	Get the size of a message on the server.
int	POP3_DeleteCmd (int session, uint32_t message_number, uint32_t timeout)
	Delete a pending message on the server.
int	POP3_RetrieveMessage (int session, uint32_t message_number, char *buffer, char **subject_ptr, char **body_ptr, int max_bufferlen, uint32_t timeout)
	Retrieve a message from the server.
PCSTR	GetPOPErrorString (int err)
	Returns the error text for an error code.

Detailed Description

NetBurner POP3 API.