IP*Works! S/MIME simap Component : simap OCX, simap .NET Component, simap Class, simap Bean, simap Object

Available in: S/MIME

SIMAP Component [IP*Works! S/MIME V8]

Properties Methods Events Configuration Settings

The SIMAP 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.

Remarks

The SIMAP component is the S/MIME enabled equivalent of the IP*Works! IMAP component. In addition to standard IMAP functions the SIMAP component can decrypt and/or verify message signatures. The methods and properties for decrypting, and verifying signatures are identical to those provided with the S/MIME component. When attempting to verify a signed message or when decrypting a message call the Decrypt, VerifySignature, or DecryptAndVerifySignature methods and the resulting text will be replaced in Message.

The SIMAP 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.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


AuthMechanism	The authentication mechanism to be used when connecting to the mail server.
AutoDecodeParts	Determines whether to automatically decode message parts.
Certificate	The current selected certificate.
Command	Can be used to send additional commands directly to the server.
Connected	Shows whether the component is connected.
EndByte	The byte index of the position where the transfer should end.
Firewall	A set of properties related to firewall access.
Idle	The current status of the component.
LastReply	The last reply from the server.
LocalFile	The path to a local file for downloading the message body. If the file exists, it is overwritten (optional).
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Mailbox	Name of the mailbox selected on the server.
MailboxFlags	Defined flags in the selected mailbox.
MailboxList	Collection of mailboxes listed by the server.
MailPort	The port of the IMAP server (default is 143).
MailServer	The name or address of the mail server (IMAP server).
MessageContentEncoding	The ContentEncoding of the selected message.
MessageContentType	The ContentType of the message.
MessageCount	The total number of messages on the Mailbox .
MessageDate	The time the message was created.
MessageDeliveryTime	The time the message was delivered to the mail server.
MessageEncrypted	Whether or not the current message is encrypted.
MessageFlags	Contains the flags of the current message.
MessageFrom	The address of the author of the message.
MessageHeaders	Collection of RFC822-encoded headers of the message.
MessageHeadersString	String version of RFC822-encoded headers of the message.
MessageId	The message id of the current message.
MessageInfo	Collection of messages retrieved by FetchMessageInfo .
MessageInReplyTo	The unique message ID of the message this one is in reply to.
MessageNetId	The globally unique id of the message.
MessageParts	Collection of message parts collected by FetchMessageInfo .
MessageRecipients	Collection of recipients for the current message.
MessageReplyTo	Email address(s) where replies to the message should be sent.
MessageSender	The address of the sender of the message.
MessageSet	The set of messages to operate on.
MessageSigned	Whether or not the current message is signed.
MessageSize	The size of the selected message.
MessageSubject	The subject of the message.
MessageText	The body of the retrieved message
Password	The password used to authenticate to the MailServer .
PeekMode	When set to True, the message Seen flag is not changed during reading.
RecentMessageCount	Number of new messages on the Mailbox .
SignerCert	Contains the certificate of the message signer.
SignerCertChain	The certificate chain of the signing certificate.
SigningAlgorithm	Textual description of the signature hash algorithm.
SortCriteria	Sort criteria to use for message retrieval operations.
StartByte	The byte index of the position where the transfer should start.
Timeout	A timeout for the component.
UIDMode	If true, permanent message id-s are used instead of the default temporary id-s.
UIDValidity	The UIDValidity parameter sent from the server in response to SelectMailbox command.
User	The user name used to authenticate to the MailServer .

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


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 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 .
Decrypt	Decrypts the current Message .
DecryptAndVerifySignature	Decrypts and verifies the signature of the current Message .
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 .
VerifySignature	Verify the signature of the current Message .

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


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 ListMailboxes and ListSubscribedMailboxes methods.
MessageInfo	Fired with information for the message(s) retrieved by the server.
MessagePart	Fired for each message part when FetchMessageInfo 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 MailServer .

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


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.
HeaderLimit	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MailboxLimit	Instructs component to save the amount of mailboxes specified that are returned by the server after a ListMailboxes call has been made.
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.
AutoDecodeSubject	Instructs the component to automatically decode message subjects.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
TcpNoDelay	Whether or not to delay when sending packets
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).