Indy 9 | Content | Index | Reference

TIdPOP3ServerThread
Hierarchy, Properties, Methods, Events, See Also, Unit: IdPOP3Server
Thread class used for client connections in a POP3 server implementation.

    TIdPOP3ServerThread = class(TIdPeerThread)

Unit
IdPOP3Server
Description
TIdPOP3ServerThread is a TIdPeerThread that represents the thread class created for POP3 client connections in a TIdPOP3Server server implementation. TIdPOP3ServerThread exposes properties that represents the identity and authentication credentials for the client connection, as well as the TIdPOP3ServerState fotr the connection.

TIdPOP3ServerThread is the class type assigned to the TIdPOP3Server.ThreadClass property in the constructor for TIdPOP3Server.

TIdPOP3ServerThread.Password
TIdPOP3ServerThread, See Also
Authentication credentials for the client connection.

    property Password: String;

Description
Password is a String property that represents the authentication credentials for the threaded client connection to the POP3 server. Password is updated when the command handler for the POP3 PASS command reads the value from the client connection.

Username and Password are used in the TIdPOP3Server.CheckUser method to verify the identity and authentication for the client connection, and set the POP3 state.

TIdPOP3ServerThread.State
TIdPOP3ServerThread, See Also
Indicates the POP3 state for the threaded client connection.

    property State: TIdPOP3ServerState;

Description
State is a TIdPOP3ServerState property that represents the POP3 state for the threaded client connection. State is updated by various event handlers during the lifetime of the threaded client connection.

When the client connection is established, State is set to Auth and the session enters the AUTHORIZATION state. In this state, the client must identify itself to the POP3 server to gain access to the associated maildrop.

When the client is successfully authorized, the client session enters the the TRANSACTION state, and State is set to Trans. In this state, the client requests actions on the maildrop on the POP3 server.

When the client has issued the QUIT command, the session enters the UPDATE state and STate is set to Update. In this state, the POP3 server releases any resources acquired during the TRANSACTION state and says goodbye. The client connection is then closed.

TIdPOP3ServerThread.Username
TIdPOP3ServerThread, See Also
Identity for the client connection.

    property Username: String;

Description
Username is a String property that represents the identification credentials for the threaded client connection to the POP3 server. Username is updated when the command handler for the POP3 USER command reads the value from the client connection.

Username and Password are used in the TIdPOP3Server.CheckUser method to verify the identity and authentication for the client connection, and set the POP3 state.

TIdPOP3ServerThread.Create
TIdPOP3ServerThread, See Also
Constructor for the thread instance.

    constructor Create(ACreateSuspended: Boolean = True); override;

Parameters
ACreateSuspended: Boolean = True
Indicates if the thread is created in a suspended state.
Description
Create is the constructor for the object instance, and creates a new client connection thread in the server implementation. Create calls the inherited Create method, and sets the default values for User to an empty string ('') and State to the TIdPOP3ServerState Auth.

When ACreateSuspended is False, the thread is executed immediately. If ACreateSuspended is True, the thread will not be executed until Resume is called.

TIdPOP3ServerThread.Destroy
TIdPOP3ServerThread, See Also
Frees a thread instance.

    destructor Destroy; override;

Description
Destroy is the destructor for the thread instance. Destroy calls the inherited Destroy method prior to exiting from the method.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.