Indy 9 | Content | Index | Reference

TIdIMAP4Commands
See Also, Unit: IdIMAP4
Represents the enumerated type for IMAP4 commands.

    TIdIMAP4Commands = (cmdCAPABILITY, cmdNOOP, cmdLOGOUT, cmdAUTHENTICATE, cmdLOGIN, cmdSELECT, cmdEXAMINE, cmdCREATE, cmdDELETE, cmdRENAME, cmdSUBSCRIBE, cmdUNSUBSCRIBE, cmdLIST, cmdLSUB, cmdSTATUS, cmdAPPEND, cmdCHECK, cmdCLOSE, cmdEXPUNGE, cmdSEARCH, cmdFETCH, cmdSTORE, cmdCOPY, cmdUID, cmdXCmd);

Unit
IdIMAP4
Description
TIdIMAP4Commands is an enumerated type that represents valid IMAP4 commands. Values in TIdIMAP4Commands are used as an Integer index, and the upper- and lower-bounds, for accessing the textual representation of the IMAP4 commands needed by the protocol.

cmdCAPABILITY represents the IMAP4 CAPABILITY command which requests the version number, optional authentication methods, and a list of capabilities supported by the IMAP4 server.

cmdNOOP represents the IMAP4 NOOP command which performs no specific operation, but allows the client to poll for new messages or message status updates during a period of inactivity, or to reset an inactivity autologout timer on the IMAP4 server. cmdNOOP always succeeds.

cmdLOGOUT represents the IMAP4 LOGOUT command which informs the server that the client is done with the connection. The IMAP4 server will send a BYE response before the (tagged) OK response, and then close the network connection.

cmdAUTHENTICATE represents the IMAP4 AUTHENTICATE command which indicates the optional authentication mechanism to use for the connection to the IMAP4 server, and initiates the authentication protocol exchange.

cmdLOGIN represents the IMAP4 LOGIN command which identifies the client to the IMAP4 server using a plaintext user name and password for authentication.

cmdSELECT represents the IMAP4 SELECT command which specifies the singular mailbox to be accessed on the IMAP4 server, and results in receipt of statistics and flags for the selected mailbox. Simultaneous access to multiple mailboxes requires multiple IMAP4 client connections.

cmdEXAMINE represents the IMAP4 EXAMINE command and is identical to cmdSELECT except the mailbox will allow only read-only access.

cmdCREATE represents the IMAP4 CREATE command which is used to initialize a new mailbox and/or hierarchy folder with a given name.

cmdDELETE represents the IMAP4 DELETE command which permanently removes a mailbox with a given name.

cmdRENAME represents the IMAP4 RENAME command which changes the name of a mailbox or hierarchy folder. Renaming the INBOX mailbox is permitted, but moves all messages in INBOX to a new mailbox with the given name and leaves INBOX intact and empty.

cmdSUBSCRIBE represents the IMAP4 SUBSCRIBE command which adds the specified mailbox to the set of "active" or "subscribed" mailboxes on the IMAP4 server.

cmdUNSUBSCRIBE represents the IMAP4 UNSUBSCRIBE command which removes the specified mailbox from set of "active" or "subscribed" mailboxes on the IMAP4 server.

cmdLIST represents the IMAP4 LIST command which returns a subset of mailbox names from the complete set of all mailbox names available to the client using optional reference names and mailbox wildcards.

cmdLSUB represents the IMAP4 LSUB command which returns a list contaiing a subset of mailbox names from the set of mailbox names that the user has declared as being "active" or "subscribed".

cmdSTATUS represents the IMAP4 STATUS command which requests the status of defined data items for an indicated mailbox.

cmdAPPEND represents the IMAP4 APPEND command which appends literal arguments and optional flags as a new message in the specified mailbox, but is not used for message delivery.

cmdCHECK represents the IMAP4 CHECK command which requests a checkpoint of the currently selected mailbox.

cmdCLOSE represents the IMAP4 CLOSE command which permanently removes messages flagged for deletion from the currently selected mailbox, and returns to an authenticated state.

cmdEXPUNGE represents the IMAP4 EXPUNGE command which permanently removes messages flagged for deletion from the currently selected mailbox after confirmation.

cmdSEARCH represents the IMAP4 SEARCH command which searches a mailbox for messages that match the given search criteria key(s).

cmdFETCH represents the IMAP4 FETCH command which retrieves defined data items associated with a message in a mailbox.

cmdSTORE represents the IMAP4 STORE command which alters defined data items associated with a message in a mailbox.

cmdCOPY represents the IMAP4 COPY command which copies the specified message(s) to the specified destination mailbox preserving the flags and internal date of the message(s).

cmdUID represents the IMAP4 UID command which indicates that messages are accessed by UID instead of message sequence number in IMAP4 commands.

cmdXCmd represents experimental IMAP4 commands.

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