The Best Way To Buy!
IP*Works!
Microsoft .NET ActiveX / VB ASP Delphi C++ Builder C++ Java J2EE Unix / Linux Mac OS X .NET CF
IP*Works! SSL
IP*Works! S/MIME
Microsoft .NET ActiveX / VB ASP Delphi C++ Builder C++ Java J2EE
IP*Works! SSH
Microsoft .NET Java J2EE .NET CF
IP*Works! Zip
IP*Works! EDI/AS2
Microsoft .NET Java / J2EE
Secure SNMP
Microsoft .NET ActiveX / VB Delphi C++ Builder C++ Java J2EE .NET CF
QuickBooks Integrator
E-Payment Integrator
Vital/TSYS Integrator
Microsoft .NET ActiveX / VB ASP Delphi C++ Builder C++ Unix / Linux Mac OS X
Paymentech Integrator
FDMS Integrator
Microsoft .NET ActiveX / VB ASP Delphi C++ Builder C++ Java J2EE .NET CF
USPS Integrator
FedEx Integrator
E-Banking Integrator
Microsoft .NET ActiveX / VB ASP Delphi C++ Builder C++ Java J2EE Unix / Linux
PayPal Integrator
Amazon Integrator
Biztalk Adapters
SQL Server SSIS Tasks
3-D Secure MPI
Microsoft .NET ASP Delphi C++ Builder C++ Java / J2EE
"I love your controls so far. They're much easier to work with than the Microsoft Internet Control Pack."
-- B. McConnell
Properties Methods Events Configuration Settings
The IMAP component is used to communicate with IMAP servers using the IMAP (Internet Message Access) protocol.
NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.
The IMAP component implements a standard IMAP client as specified in RFC 1730 and RFC 2060.
The first step in using the component is specifying a MailServer, a User to connect as, and a Password to authenticate with. After that, one or more requests may be sent to the server via the component's methods. Results are retrieved through events and a number of key properties.
Normally, after connecting to the server a Mailbox is selected (or examined) using the ExamineMailbox method. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags show the flags pertaining to the mailbox.
A number of operations may be performed by the server in response to commands sent via the component's methods. The main arguments for most commands is the Mailbox property or the MessageSet property. The MessageSet property denotes either a single message, or a range of messages. Other arguments are specified through other properties such as SortCriteria, MessageFlags, etc.
Responses are received through events such as MessageInfo, MailboxList, and also reflected to properties such as MessageText, MessageSubject, etc.
The MessagePart event describes the MIME structure of retrieved messages. One MessagePart event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the FetchMessagePart method. This speeds up processing by avoiding the need to retrieve full messages from the server.
The PITrail event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers.
The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.
Method List The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions. AddMessageFlags Add the specified flags to the messages specified by MessageSet. AppendToMailbox Appends the message in MessageText to the mailbox specified by Mailbox. CheckMailbox Sends a 'CHECK' command to the server. CloseMailbox Remove all messages marked with 'Deleted' flag from the currently selected mailbox and unselect mailbox. Config Sets or retrieves a component configuration setting. Connect Connect to an IMAP server. CopyToMailbox Copies the messages specified by MessageSet to the mailbox specified by Mailbox. CreateMailbox Create a new mailbox specified by Mailbox. DeleteFromMailbox Marks the messages specified by MessageSet as deleted. DeleteMailbox Delete a mailbox specified by Mailbox. DeleteMailboxACL Deletes mailbox access control rights for a specific user. Disconnect Disconnect from an IMAP server. DoEvents Processes events from the internal message queue. ExamineMailbox Select a Mailbox (Read-only mode). ExpungeMailbox Remove all messages marked with 'Deleted' flag from the currently selected mailbox. FetchMessageHeaders Get the message headers of messages specified by the MessageSet property. FetchMessageInfo Get information about messages specified by the MessageSet property. FetchMessagePart Get the message part specified by PartId. FetchMessageText Get the message text of messages specified by the MessageSet property. GetMailboxACL Gets mailbox access control rights. Interrupt Interrupt the current method. ListMailboxes List all mailboxes matching all criteria in the Mailbox property. ListSubscribedMailboxes List all subscribed mailboxes matching all criteria in the Mailbox property. LocalizeDate Converts a valid RFC 822 message date to local date and time. MoveToMailbox Moves the messages specified by MessageSet to the mailbox specified by Mailbox. Noop Sends a 'NOOP' command to the server. RenameMailbox Change the name of Mailbox to NewName. ResetMessageFlags Replace the flags of the messages specified by MessageSet with the flags specified by MessageFlags. SearchMailbox Search selected mailbox for specified text. SelectMailbox Select a Mailbox. SetMailboxACL Sets mailbox access control rights for a specific user. SetMessageStream Sets the stream to which the message (or message part) downloaded from the server will be written. SubscribeMailbox Subscribe to the mailbox specified by Mailbox. UnsetMessageFlags Remove the flags specified by MessageFlags from the messages specified by MessageSet. UnsubscribeMailbox Unsubscribe from the mailbox specified by Mailbox. Event List The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions. ConnectionStatus Fired to indicate changes in connection state. EndTransfer Fired when the message or the part data finishes transferring. Error Information about errors during data delivery. Header Fired every time a header line comes in. MailboxACL Fires for each set of access control rights returned by the server MailboxList Fired for each mailbox received through the and methods. MessageInfo Fired with information for the message(s) retrieved by the server. MessagePart Fired for each message part when is called. PITrail Traces the commands sent to the mail server, and the respective replies. StartTransfer Fired when the message or the part data starts transferring. Transfer Fired while the message gets transferred from the . Configuration Settings The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions. AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts. AlwaysReturnUIDs Instructs the server to return UIDs even if not in UIDMode. AuthorizationIdentity The value to use as the authorization identity when SASL authentication is used. CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer. CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only). FirewallData Used to send extra data to the firewall. FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only). HeaderLimit Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. InBufferSize The size in bytes of the incoming queue of the socket. MailboxLimit Instructs component to save the amount of mailboxes specified that are returned by the server after a ListMailboxes call has been made. MaxLineLength The maximum amount of data to accumulate when no EOL is found. MessageInfoLimit Instructs component to save the amount of messages specified that are returned by the server after a FetchMessageInfo call has been made. MessagePartLimit Instructs component to save the amount of message parts specified that are returned by the server after a FetchMessageInfo call has been made. OutBufferSize The size in bytes of the outgoing queue of the socket. TcpNoDelay Whether or not to delay when sending packets
The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.
Event List The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions. ConnectionStatus Fired to indicate changes in connection state. EndTransfer Fired when the message or the part data finishes transferring. Error Information about errors during data delivery. Header Fired every time a header line comes in. MailboxACL Fires for each set of access control rights returned by the server MailboxList Fired for each mailbox received through the and methods. MessageInfo Fired with information for the message(s) retrieved by the server. MessagePart Fired for each message part when is called. PITrail Traces the commands sent to the mail server, and the respective replies. StartTransfer Fired when the message or the part data starts transferring. Transfer Fired while the message gets transferred from the . Configuration Settings The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions. AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts. AlwaysReturnUIDs Instructs the server to return UIDs even if not in UIDMode. AuthorizationIdentity The value to use as the authorization identity when SASL authentication is used. CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer. CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only). FirewallData Used to send extra data to the firewall. FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only). HeaderLimit Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. InBufferSize The size in bytes of the incoming queue of the socket. MailboxLimit Instructs component to save the amount of mailboxes specified that are returned by the server after a ListMailboxes call has been made. MaxLineLength The maximum amount of data to accumulate when no EOL is found. MessageInfoLimit Instructs component to save the amount of messages specified that are returned by the server after a FetchMessageInfo call has been made. MessagePartLimit Instructs component to save the amount of message parts specified that are returned by the server after a FetchMessageInfo call has been made. OutBufferSize The size in bytes of the outgoing queue of the socket. TcpNoDelay Whether or not to delay when sending packets
The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.
Configuration Settings The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions. AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts. AlwaysReturnUIDs Instructs the server to return UIDs even if not in UIDMode. AuthorizationIdentity The value to use as the authorization identity when SASL authentication is used. CloseStreamAfterTransfer If true, the component will close the upload or download stream after the transfer. CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only). FirewallData Used to send extra data to the firewall. FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only). HeaderLimit Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. InBufferSize The size in bytes of the incoming queue of the socket. MailboxLimit Instructs component to save the amount of mailboxes specified that are returned by the server after a ListMailboxes call has been made. MaxLineLength The maximum amount of data to accumulate when no EOL is found. MessageInfoLimit Instructs component to save the amount of messages specified that are returned by the server after a FetchMessageInfo call has been made. MessagePartLimit Instructs component to save the amount of message parts specified that are returned by the server after a FetchMessageInfo call has been made. OutBufferSize The size in bytes of the outgoing queue of the socket. TcpNoDelay Whether or not to delay when sending packets
The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.
