TIdIMAP4 Members

Members exposed by TIdIMAP4.

Event	Description
OnAlert	Event handler triggered for IMAP4 ALERT response codes found in server responses.
OnStatus	Represents the current connection status event handler.
OnTLSHandShakeFailed
OnTLSNegCmdFailed
OnTLSNotAvailable
OnWorkBeginForPart	Event handler signalled when starting retrieval of a message part for the IMAP4 client.
OnWorkEndForPart	Event handler signalled when completing retrieval of a message part for the IMAP4 client.
OnWorkForPart	Event handler signalled during retrieval of a message part for the IMAP4 client.

Methods

Method	Description
AppendMsg
AppendMsgNoEncodeFromFile	Adds a message to the specified mailbox without encoding message parts.
AppendMsgNoEncodeFromStream
Capability
CheckMailBox	Requests a checkpoint for the currently selected mailbox.
CheckMsgSeen	Indicates if the specified message has been read.
CloseMailBox	Closes the currently selected mailbox.
Connect	Opens a connection and optionally logs in to to the IMAP server.
CopyMsg	Copies a message from the current mailbox to a specified mailbox.
CopyMsgs	Copies the indicated messages from the current mailbox to a specified mailbox.
CreateMailBox	Creates a new mailbox on the remote IMAP4 server for the current account.
DeleteMailBox	Removes the specified mailbox on the IMAP4 server.
DeleteMsgs	Marks the specified messages for subsequent deletion when a mailbox is purged.
Disconnect
DoAlert	Triggers the OnAlert event handler.
ExamineMailBox	Selects a mailbox for read-only access.
ExpungeMailBox	Removes messages marked for deletion in the currently selected mailbox.
FindHowServerCreatesFolders	Determine the method used to create folders on the remote IMAP4 server.
GetInternalResponse	Reads mutiple untagged responses or a single tagged response from the server.
GetResponse	Retrieves and checks a multiple line IMAP4 server response.
GetUID	Retrieves the unique identifier for a given relative message number.
InternalRetrieveStructure	Retrieves the body structure for a specified message.
KeepAlive	Prevents loss of a IMAP server connection due to a timeout.
ListInferiorMailBoxes
ListMailBoxes
ListSubscribedMailBoxes
Login	Attempts to login ajnd perform authentication on the IMAP4 server.
ReadLnWait	Pauses until a line of text is read from the connection.
RenameMailBox	Renames a specified mailbox on the IMAP4 server.
Retrieve	Retrieves a message from a mailbox and marks it as read on the server.
RetrieveAllEnvelopes	Retrieves RFC-822 envelope data for messages in a mailbox.
RetrieveAllHeaders	Retrieves headers for all messages in a mailbox and populates the specified message collection.
RetrieveAllMsgs	Retrieves all messages in a mailbox and populates the specified message collection.
RetrieveEnvelope	Retrieves SMTP envelope information for a message in the mailbox.
RetrieveEnvelopeRaw
RetrieveFlags	Retrieves stored message flags for a message on the IMAP4 server.
RetrieveHeader	Retrieves headers for a specified message number and populates the message instance.
RetrieveMailBoxSize	Indicates the size of all messages in the currently selected mailbox.
RetrieveMsgSize	Indicates the size of a specified message in the currently selected mailbox.
RetrieveNoDecodeToFile	Retrieves the raw encoded contents of a message and stores the contents in a file.
RetrieveNoDecodeToStream
RetrievePart
RetrievePartHeader	Retrieves RFC headers for a specified message and message part.
RetrievePartPeek
RetrievePartToFile
RetrievePartToFilePeek
RetrievePeek	Retrieves a message from a mailbox without marking it as read on the server.
RetrieveStructure
RetrieveText	Retrieves the text that makes up the body of a message.
RetrieveText2	Retrieves the text that makes up the body of a message.
RetrieveTextPeek	Retrieves the text that makes up the body of a message without updating the flags for the message.
RetrieveTextPeek2	Retrieves the text that makes up the body of a message without updating the flags for the message.
SearchMailBox
SelectMailBox	Selects a mailbox on the IMAP4 server as the current mailbox for message access.
SendCmd
StatusMailBox
StoreFlags	Updates the specified message flags for a list of message numbers.
SubscribeMailBox	Adds a mailbox to the list of "active" or "subscribed" mailboxes.
UIDCheckMsgSeen	Indicates if the specified message has been read.
UIDCopyMsg	Copies a message from the current mailbox to a specified mailbox.
UIDCopyMsgs
UIDDeleteMsg	Marks the specified message for subsequent deletion when a mailbox is purged.
UIDDeleteMsgs	Marks the specified messages for subsequent deletion when a mailbox is purged.
UIDInternalRetrieveStructure	Retrieves the body structure for a specified message.
UIDRetrieve	Retrieves a message from a mailbox and marks it as read on the server.
UIDRetrieveAllEnvelopes	Retrieves RFC-822 envelope data for messages in a mailbox.
UIDRetrieveEnvelope	Retrieves SMTP envelope information for a message in the mailbox.
UIDRetrieveEnvelopeRaw
UIDRetrieveFlags	Retrieves stored message flags for a message on the IMAP4 server.
UIDRetrieveHeader	Retrieves headers for a specified message and populates the message instance.
UIDRetrieveMailBoxSize	Indicates the size of all messages in the currently selected mailbox.
UIDRetrieveMsgSize	Indicates the size of a specified message in the currently selected mailbox.
UIDRetrieveNoDecodeToFile	Retrieves the raw encoded contents of a message and stores the contents in a file.
UIDRetrieveNoDecodeToStream
UIDRetrievePart
UIDRetrievePartHeader	Retrieves RFC headers for a specified message and message part.
UIDRetrievePartPeek
UIDRetrievePartToFile
UIDRetrievePartToFilePeek
UIDRetrievePeek	Retrieves a message from a mailbox without marking it as read on the server.
UIDRetrieveStructure
UIDRetrieveText	Retrieves the text that makes up the body of a message.
UIDRetrieveText2	Retrieves the text that makes up the body of a message.
UIDRetrieveTextPeek	Retrieves the text that makes up the body of a message without updating the flags for the message.
UIDRetrieveTextPeek2	Retrieves the text that makes up the body of a message without updating the flags for the message.
UIDSearchMailBox
UIDStoreFlags
UnsubscribeMailBox	Removes a mailbox from the list of "active" or "subscribed" mailboxes.
WriteLn	Used internally to send a command/request to an IMAP server.
ProcessMessage
SendMsg	Sends message headers and body content on the client connection.
Connect
ConnectAndGetAll	Opens a connection and reads all data.
CheckForGracefulDisconnect	Determines if the peer has been gracefully disconnected.
CheckResponse
Connected	Indicates if the peer connection has been opened.
CreateIOHandler	Creates the IOHandler for the connection.
Disconnect
DisconnectNotifyPeer	Disconnects the peer connection.
GetResponse
RaiseExceptionForLastCmdResult
SendCmd
WriteHeader	Sends the RFC protocol header values in a list to the connection.
WriteRFCStrings	Writes RFC-compliant message bodies on the connection.
BeginWork	Triggers the OnBeginWork event.
DoWork	Triggers the OnWork event handler.
EndWork	Triggers the OnEndWork event handler.
CType
GetVersion	Version number for Indy component suite.

Destructors

Destructor	Description
Destroy	Frees the object instance.

Constructors

Constructor	Description
Create	Constructor for the object instance.
Create

Properties

Property	Description
AuthType	Indicates the mechanism to use for authentication in the Login method.
BoundIP	Specifies the the local IP address to be used for the Socket connection.
BoundPort	Specifies the the port number to be used for the Socket connection.
BoundPortMax	Represents the upper bounds for local port numbers derived when establishing the client connection.
BoundPortMin	Represents the lowerr bounds for local port numbers derived when establishing the client connection.
Capabilities
ConnectionState	Indicates the IMAP4 connection state.
ConnectTimeout	Millseconds to wait for successful completion of a connection attempt.
Greeting	Banner or welcome message for a connection to a protocol server.
GreetingBanner	Identifies the server and its state during connection of the IMAP4 session.
Host	Identifies the host name or IP address for the remote IMAP4 server.
IOHandler	The input / output mechanism for the connection.
LastCmdResult	Response code and text for the last response from the peer connection.
MailBox	Represents the IMAP4 mailbox.
MailBoxSeparator	Identifies the character used to separate mailbox names in the hierarchical mailbox namespace.
ManagedIOHandler	Indicates tyhe IOHandler for the connection is maintained by the object instance.
MilliSecsToWaitToClearBuffer	Delay time for unhandled response data in the buffer for the client.
MsgLineFold	Identifies the line folding character sequence for the message client.
MsgLineLength	Maximum line length.
OnAfterBind	Event handler signalled after the socket handle is bound for the connection.
OnBeforeBind	Event handler signalled proper to binding the socket handle for the connection.
OnConnected	Event handler signalled to reflect the connection state for the client.
OnDisconnected	Event handler signalled when disconnecting the peer connection.
OnWork	Event handler signalled for read and / or write operations.
OnWorkBegin	Event handler signalled when beginning a read or write operation.
OnWorkEnd	Event handler signalled when completing a read or write operation.
Password	Identifies the credentials for IMAP4 server authentication.
Port	Identifies the port number used for the IMAP4 server connection.
ReadTimeout	Millseconds to wait for successful completion of a read attempt.
RetrieveOnSelect	Specifies data to automatically retrieve from the mailbox when a mailbox is selected.
SASLMechanisms	SASL authentication mechanisms supported on the remote IMAP4 server.
Socket	Provides access to the TIdIOHandlerSocket for the connection.
SupportsTLS
Username	Identifies the user name for IMAP4 server authentication.
UseTLS	Indicates Transport-Level Security is used on the connection.
Version	Identifies the version number for the Indy component suite.
WorkTarget	Indy component to receive work mode events for the current object instance.

Post feedback to the Indy Docs Newsgroup.