Unit POP3

Return to Unit Reference

Description

---

Ultibo POP3 Interface unit

Constants

---

[Expand]

POP3 specific constants POP3_*

POP3_LINE_END = Chr(13) + Chr(10);	CR LF
POP3_BUFFER_SIZE = SIZE_4K;

[Expand]

POP3 status POP3_STATUS_*

POP3_STATUS_NONE = 0;
POP3_STATUS_CONN = 1;
POP3_STATUS_USER = 2;
POP3_STATUS_PASS = 3;
POP3_STATUS_APOP = 4;
POP3_STATUS_DATA = 5;
POP3_STATUS_QUIT = 6;
POP3_MAX_STATUS = 6;

[Expand]

POP3 command POP3_COMMAND_*

POP3_COMMAND_STAT = 'STAT';
POP3_COMMAND_LIST = 'LIST';
POP3_COMMAND_RETR = 'RETR';
POP3_COMMAND_DELE = 'DELE';
POP3_COMMAND_NOOP = 'NOOP';
POP3_COMMAND_RSET = 'RSET';
POP3_COMMAND_QUIT = 'QUIT';
POP3_COMMAND_TOP = 'TOP';
POP3_COMMAND_UIDL = 'UIDL';
POP3_COMMAND_USER = 'USER';
POP3_COMMAND_PASS = 'PASS';
POP3_COMMAND_APOP = 'APOP';

[Expand]

POP3 string POP3_STRING_*

POP3_STRING_SUCCESS = '+OK ';
POP3_STRING_FAILURE = '-ERR ';
POP3_STRING_COMPLETE = '.';
POP3_STRING_SIGNON = 'Ultibo POP3 server (version ' + ULTIBO_RELEASE_VERSION + ')';
POP3_STRING_SIGNOFF = 'Ultibo POP3 server closing connection';
POP3_STRING_EMPTY_STAT = '0 0';
POP3_STRING_EMPTY_LIST = '0 messages (0 octets)';
POP3_STRING_BAD_COMMAND = 'Bad command';
POP3_STRING_BAD_MESSAGE = 'No such message';
POP3_STRING_BAD_USERNAME = 'Invalid username or password';
POP3_STRING_BAD_PASSWORD = 'Invalid username or password';
POP3_STRING_NO_PERMISSION = 'Permission denied';

[Expand]

POP3 logging POP3_LOG_*

POP3_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;	POP3 debugging messages
POP3_LOG_LEVEL_INFO = LOG_LEVEL_INFO;	POP3 informational messages
POP3_LOG_LEVEL_WARN = LOG_LEVEL_WARN;	POP3 warning messages
POP3_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;	POP3 error messages
POP3_LOG_LEVEL_NONE = LOG_LEVEL_NONE;	No POP3 messages

Type definitions

---

POP3 client notify event

TPOP3ClientNotifyEvent = procedure(const ARequest:String) of Object;

POP3 host event

TPOP3HostEvent = function(AConnection:TPOP3Connection):Boolean of Object;

POP3 count event

TPOP3CountEvent = function(AConnection:TPOP3Connection):Boolean of Object;

POP3 notify event

TPOP3NotifyEvent = procedure(AConnection:TPOP3Connection; const ARequest:String) of Object;

POP3 request event

TPOP3RequestEvent = function(AConnection:TPOP3Connection; const ARequest:String; var AReply:String):Boolean of Object;

POP3 request extended event

TPOP3RequestExEvent = function(AConnection:TPOP3Connection; const ARequest,AData:String; var AReply:String):Boolean of Object;

POP3 connection event

TPOP3ConnectionEvent = procedure(AConnection:TPOP3Connection) of Object;

Class definitions

---

POP3 helper classes

TPOP3Buffer = class(TObject)

POP3 client classes

TPOP3Client = class(TWinsock2TCPClient)

POP3 server classes

TPOP3Connection = class(TListObject)

TPOP3Listener = class(TWinsock2TCPListener)

Public variables

---

POP3 logging

POP3_DEFAULT_LOG_LEVEL:LongWord = POP3_LOG_LEVEL_DEBUG;

Minimum level for POP3 messages. Only messages with level greater than or equal to this will be printed.

POP3_LOG_ENABLED:Boolean;

Function declarations

---

Initialization functions

[Expand]

procedure POP3Init;

Description: To be documented

Note	None documented

POP3 helper functions

[Expand]

procedure POP3Log(Level:LongWord; const AText:String);

Description: To be documented

Note	None documented

[Expand]

procedure POP3LogInfo(const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure POP3LogWarn(const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure POP3LogError(const AText:String); inline;

Description: To be documented

Note	None documented

[Expand]

procedure POP3LogDebug(const AText:String); inline;

Description: To be documented

Note	None documented

Return to Unit Reference