Indy 9 | Content | Index | Reference

TCommandEvent
See Also, Unit: IdIMAP4Server
IMAP4 command event type.

    TCommandEvent = procedure (Thread : TIdPeerThread; const Tag, CmdStr: String; var Handled: Boolean) of object;

Unit
IdIMAP4Server
Parameters
CmdStr
Command parameters for the event.
Handled
Indicates the command has been handled in the event handler.
Tag
Tag identifier for the command.
Thread
Client thread for the event notification.
Description
TCommandEvent is an event type signalled for IMAP4 commands supported in the TIdMAPI4Server implementation. TCommandEvent is the event type for the various event handlers in TIdIMAP4Server, like:

- ONCommandCAPABILITY

- ONCommandNOOP

- ONCommandLOGOUT

- ONCommandAUTHENTICATE

- ONCommandLOGIN

- ONCommandSELECT

- OnCommandEXAMINE

- ONCommandCREATE

- ONCommandDELETE

- OnCommandRENAME

- ONCommandSUBSCRIBE

- ONCommandUNSUBSCRIBE

- ONCommandLIST

- OnCommandLSUB

- ONCommandSTATUS

- OnCommandAPPEND

- ONCommandCHECK

- OnCommandCLOSE

- ONCommandEXPUNGE

- OnCommandSEARCH

- ONCommandFETCH

- OnCommandSTORE

- OnCommandCOPY

- ONCommandUID

- OnCommandX

- OnCommandError

Thread is the client thread for the event notification, and provides the client context during execution.

Tag is the IMAP4 command tag sent from the IMAP4 client. Tag is a 4-digit continuous number (e.g. 000A) which is sent by the IMAP client in front of the command, and is used to associate a server response with a specific client command.

Command contains command parameters parsed from the client connection in Thread. The complete list of IMAP4 commands and parameters can be found inL

- RFC 2060 - Internet Message Access Protocol - Version 4rev1 (http://www.rfc-editor.org/rfc/rfc2060.txt) .

Set Handled to True if the event handler has completed handling for the event notification.

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