Difference between revisions of "Unit POP3"

From Ultibo.org
Jump to: navigation, search
 
Line 5: Line 5:
 
----
 
----
  
'''Ultibo POP3 interface unit'''
+
'''Ultibo POP3 Interface unit'''
 
+
''To be documented''
+
  
 
=== Constants ===
 
=== Constants ===

Latest revision as of 05:28, 31 August 2021

Return to Unit Reference


Description


Ultibo POP3 Interface unit

Constants



[Expand]
POP3 specific constants POP3_*


[Expand]
POP3 status POP3_STATUS_*


[Expand]
POP3 command POP3_COMMAND_*


[Expand]
POP3 string POP3_STRING_*


[Expand]
POP3 logging POP3_LOG_*


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


POP3 helper functions

[Expand]
procedure POP3Log(Level:LongWord; const AText:String);
Description: To be documented


[Expand]
procedure POP3LogInfo(const AText:String); inline;
Description: To be documented


[Expand]
procedure POP3LogWarn(const AText:String); inline;
Description: To be documented


[Expand]
procedure POP3LogError(const AText:String); inline;
Description: To be documented


[Expand]
procedure POP3LogDebug(const AText:String); inline;
Description: To be documented


Return to Unit Reference