SIMAP Component

Properties   Methods   Events   Config Settings   Errors  

The SIMAP Component is used to communicate with IMAP servers using the Internet Message Access Protocol (IMAP).

Syntax

nsoftware.IPWorksSMIME.SIMAP

Remarks

The SIMAP Component is the S/MIME-enabled equivalent of the IPWorks IMAP component. In addition to standard IMAP functions, the SIMAP component can decrypt 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 using the component's methods. The primary arguments for most commands are the Mailbox property and 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 and MessageFlags.

Responses are received through events, such as MessageInfo and MailboxList, and also are reflected to properties, such as MessageText and MessageSubject.

The MessagePart event describes the MIME structure of the 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 RetrieveMessagePart 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.

Method List

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

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.

Config Settings

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

AuthMechanism Property (SIMAP Component)

This property includes the authentication mechanism to be used when connecting to the mail server.

Syntax

• C#
• VB.NET

public SIMAPAuthMechanisms AuthMechanism { get; set; }

enum SIMAPAuthMechanisms {
  amUserPassword,
  amCRAMMD5,
  amNTLM,
  amAPOP,
  amSASLPlain,
  amSASLDigestMD5,
  amKerberos,
  amXOAUTH2
}

Public Property AuthMechanism As SimapAuthMechanisms

Enum SIMAPAuthMechanisms
  amUserPassword
  amCRAMMD5
  amNTLM
  amAPOP
  amSASLPlain
  amSASLDigestMD5
  amKerberos
  amXOAUTH2
End Enum

Default Value

0

Remarks

AutoDecodeParts Property (SIMAP Component)

This property determines whether or not to automatically decode message parts.

Syntax

• C#
• VB.NET

public bool AutoDecodeParts { get; set; }

Public Property AutoDecodeParts As Boolean

Default Value

False

Remarks

This property determines whether or not to automatically decode message parts. Message parts, especially binary message parts, are normally sent by the server encoded (Base64 or other format). If this setting is True, the parts are automatically decoded while being received.

Certificate Property (SIMAP Component)

This property includes the current selected certificate.

Syntax

• C#
• VB.NET

public Certificate Certificate { get; set; }

Public Property Certificate As Certificate

Remarks

This property is populated when a specified certificate is found or loaded by the component. This property is used to specify private keys. Set this property to a valid Certificate object to perform different operations, such as Sign, Decrypt, SignAndEncrypt, or DecryptAndVerifySignature.

Connected Property (SIMAP Component)

Whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; }

Public ReadOnly Property Connected As Boolean

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

EndByte Property (SIMAP Component)

This property includes the byte index of the position where the transfer should end.

Syntax

• C#
• VB.NET

public long EndByte { get; set; }

Public Property EndByte As Long

Default Value

0

Remarks

StartByte and EndByte are used together with the RetrieveMessagePart method to specify the portion of the message to be retrieved from the server.

When StartByte or EndByte contain values other than the default (0), only the corresponding portion of the message is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Firewall Property (SIMAP Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Idle Property (SIMAP Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

LastReply Property (SIMAP Component)

This property indicates the last reply received from the server.

Syntax

• C#
• VB.NET

public string LastReply { get; }

Public ReadOnly Property LastReply As String

Default Value

""

Remarks

This property indicates the last reply received from the server. It can be used for informational purposes. The same information and more also can be retrieved through the PITrail event.

This property is read-only.

LocalFile Property (SIMAP Component)

This property includes the path to a local file for downloading the message body.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

Default Value

""

Remarks

This property is used when retrieving a message. If the file exists, and the Overwrite property is set to true, then the component will overwrite the file.

If this property is empty and the SetMessageStream method has not been used to set a stream, then the received data is provided through the MessageText property and the parameters for the Transfer event. The SetMessageStream method and the LocalFile property will reset each other when set.

LocalHost Property (SIMAP Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Mailbox Property (SIMAP Component)

This property includes the name of the mailbox selected on the server.

Syntax

• C#
• VB.NET

public string Mailbox { get; set; }

Public Property Mailbox As String

Default Value

"Inbox"

Remarks

This method contains the name of the mailbox selected on the server and also is used as argument to most methods. Please refer to the component methods for more information.

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

MailboxFlags Property (SIMAP Component)

This property defines flags in the selected mailbox.

Syntax

• C#
• VB.NET

public string MailboxFlags { get; }

Public ReadOnly Property MailboxFlags As String

Default Value

""

Remarks

This property defines flags in the selected mailbox. The component fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only and not available at design time.

MailboxList Property (SIMAP Component)

The property includes the collection of mailboxes listed by the server.

Syntax

• C#
• VB.NET

public MailboxList MailboxList { get; }

Public ReadOnly Property MailboxList As MailboxList

Remarks

This collection contains a list of mailboxes returned by the server when ListMailboxes or ListSubscribedMailboxes is called.

MailboxLimit can be used to control the number of mailboxes saved.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

MailPort Property (SIMAP Component)

This property includes the port of the IMAP server (default is 143).

Syntax

• C#
• VB.NET

public int MailPort { get; set; }

Public Property MailPort As Integer

Default Value

143

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For the implicit Secure Sockets Layer (SSL), use port 993 (please refer to the SSLStartMode property for more information).

This property is not available at design time.

MailServer Property (SIMAP Component)

This property includes the name or address of the mail server (IMAP server).

Syntax

• C#
• VB.NET

public string MailServer { get; set; }

Public Property MailServer As String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or domain name of the mail server. It must be set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the MailServer property is set to the corresponding address. If the search is not successful, an error is returned.

If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Message Property (SIMAP Component)

This property provides the raw message content.

Syntax

• C#
• VB.NET

public string Message { get; set; }
public byte[] MessageB { get; set; }

Public Property Message As String
Public Property MessageB As Byte()

Default Value

""

Remarks

This property is populated after calling RetrieveMessagePart and holds the raw message content. This can be used to access the data before any processing is done by the component.

This property is not available at design time.

MessageContentEncoding Property (SIMAP Component)

This property includes the ContentEncoding of the selected message.

Syntax

• C#
• VB.NET

public string MessageContentEncoding { get; }

Public ReadOnly Property MessageContentEncoding As String

Default Value

""

Remarks

The property is automatically set by the component when message information is retrieved through the RetrieveMessageInfo method.

This property is read-only and not available at design time.

MessageContentType Property (SIMAP Component)

This property includes the ContentType of the message.

Syntax

• C#
• VB.NET

public string MessageContentType { get; }

Public ReadOnly Property MessageContentType As String

Default Value

""

Remarks

This property denotes the type of content contained in the message, such as plain, multipart, or multipart/alternative. You also may need to check the MessageContentEncoding property or read the individual message parts.

This property is read-only and not available at design time.

MessageCount Property (SIMAP Component)

This property includes the total number of messages on the Mailbox .

Syntax

• C#
• VB.NET

public int MessageCount { get; }

Public ReadOnly Property MessageCount As Integer

Default Value

0

Remarks

This property contains the total number of messages on the Mailbox. The component fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

MessageDate Property (SIMAP Component)

The property includes the time the message was created.

Syntax

• C#
• VB.NET

public string MessageDate { get; }

Public ReadOnly Property MessageDate As String

Default Value

""

Remarks

This property contains the date and time when the message was created. This value is taken from the ENVELOPE structure of the message corresponding to the date.

RFC 822 contains detailed date format specifications. An example of a valid date is "Fri, 1 Mar 96 21:24:52 EST".

This property is read-only and not available at design time.

MessageDeliveryTime Property (SIMAP Component)

This property includes the time the message was delivered to the mail server.

Syntax

• C#
• VB.NET

public string MessageDeliveryTime { get; }

Public ReadOnly Property MessageDeliveryTime As String

Default Value

""

Remarks

This property contains the time the message was delivered to the mail server. This value is taken from the INTERNALDATE property of the message. The time format is defined in RFC 821.

This property is read-only and not available at design time.

MessageFlags Property (SIMAP Component)

This property contains the flags of the current message.

Syntax

• C#
• VB.NET

public string MessageFlags { get; set; }

Public Property MessageFlags As String

Default Value

""

Remarks

This property contains the flags of the current message. It also is used to specify flags when AppendToMailbox is called.

Examples of possible flag values are server dependent, but they can include the following:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

This property is not available at design time.

MessageFrom Property (SIMAP Component)

This property includes the address of the author of the message.

Syntax

• C#
• VB.NET

public string MessageFrom { get; }

Public ReadOnly Property MessageFrom As String

Default Value

""

Remarks

This property normally has the same value as MessageSender.

In some cases, a message may have more than one From address. If this is the case, the addresses are provided in the MessageFrom property and are separated by commas.

This property is read-only and not available at design time.

MessageHeaders Property (SIMAP Component)

This property includes the collection of RFC 822-encoded headers of the message.

Syntax

• C#
• VB.NET

public HeaderList MessageHeaders { get; }

Public Property MessageHeaders As HeaderList

Remarks

This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the RetrieveMessageHeaders or the RetrieveMessagePartHeaders method.

This property is not available at design time.

MessageHeadersString Property (SIMAP Component)

This property includes the string version of the RFC 822-encoded headers in the message.

Syntax

• C#
• VB.NET

public string MessageHeadersString { get; set; }

Public Property MessageHeadersString As String

Default Value

""

Remarks

This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the RetrieveMessageHeaders or the RetrieveMessagePartHeaders method.

This property is not available at design time.

MessageId Property (SIMAP Component)

This property includes the message identifier of the current message.

Syntax

• C#
• VB.NET

public string MessageId { get; }

Public ReadOnly Property MessageId As String

Default Value

""

Remarks

The component fills out this property when message information is retrieved from the MailServer.

This Id is permanent if UIDMode is set, and otherwise is temporary.

This property is read-only and not available at design time.

MessageInfo Property (SIMAP Component)

This property includes the collection of messages retrieved by RetrieveMessageInfo .

Syntax

• C#
• VB.NET

public MessageInfoList MessageInfo { get; }

Public ReadOnly Property MessageInfo As MessageInfoList

Remarks

This property is populated when messages are searched or listed or when message information is received from the server. The collection contains a list of each message's MessageInfo as returned by the server.

MessageInfoLimit can be used to control the number of MessageInfos saved.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

MessageInReplyTo Property (SIMAP Component)

This property includes the unique message identifier of the message being replied to.

Syntax

• C#
• VB.NET

public string MessageInReplyTo { get; }

Public ReadOnly Property MessageInReplyTo As String

Default Value

""

Remarks

The component fills out this property with the value of the In-Reply-To: message header.

This value can be useful when threading messages by referring to the message being replied to.

The unique message identifier of the message itself is given by the MessageNetId property.

This property is read-only and not available at design time.

MessageNetId Property (SIMAP Component)

This property includes the globally unique identifier of the message.

Syntax

• C#
• VB.NET

public string MessageNetId { get; }

Public ReadOnly Property MessageNetId As String

Default Value

""

Remarks

This property contains the globally unique identifier of the message. The component fills the MessageNetId with the value of the Message-Id: header. This is a globally unique value normally created by the first mail server the message is sent to.

This property is read-only and not available at design time.

MessageParts Property (SIMAP Component)

This property includes a collection of message parts collected by RetrieveMessageInfo .

Syntax

• C#
• VB.NET

public MessagePartList MessageParts { get; }

Public ReadOnly Property MessageParts As MessagePartList

Remarks

This property contains a collection of message parts that is populated when you call RetrieveMessageInfo. Once the message is received from the server, the component parses the different parts and their corresponding information into the MESSAGEPARTS collection. Each MessagePart contains a unique Id.

MessagePartLimit can be used to control the number of message parts saved.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

MessageRecipients Property (SIMAP Component)

This property includes a collection of recipients for the current message.

Syntax

• C#
• VB.NET

public MessageRecipientList MessageRecipients { get; }

Public ReadOnly Property MessageRecipients As MessageRecipientList

Remarks

This property contains a collection of the people to whom the message was sent. Each MessageRecipient contains information describing that recipient, and what type of recipient it is. This collection is populated when the RetrieveMessageInfo method is called.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

MessageReplyTo Property (SIMAP Component)

This property includes the email addresses to which replies to the message should be sent.

Syntax

• C#
• VB.NET

public string MessageReplyTo { get; }

Public ReadOnly Property MessageReplyTo As String

Default Value

""

Remarks

This property contains the email addresses to which replies to the message should be sent. In some cases, a message may have more than one Reply-To address. If this is the case, the addresses are provided in this property and are separated by commas.

This property is read-only and not available at design time.

MessageSender Property (SIMAP Component)

This property includes the address of the sender of the message.

Syntax

• C#
• VB.NET

public string MessageSender { get; }

Public ReadOnly Property MessageSender As String

Default Value

""

Remarks

This property contains the address of the sender of the message. This normally is the same value as MessageFrom.

In some cases, a message may have more than one sender. If this is the case, the addresses are provided in the MessageSender property and are separated by commas.

This property is read-only and not available at design time.

MessageSet Property (SIMAP Component)

This property includes the set of messages to operate on.

Syntax

• C#
• VB.NET

public string MessageSet { get; set; }

Public Property MessageSet As String

Default Value

""

Remarks

This property indicates the set of messages to operate on. This is used as an argument to most method calls.

It may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g. "1:5"), and/or individual message numbers separated by ',' (e.g. "1:5,7,10").

Example 1. Setting MessageSet:

IMAPControl.MessageSet = "1" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1:5" IMAPControl.RetrieveMessageInfo() IMAPControl.MessageSet = "1,5,7" IMAPControl.RetrieveMessageInfo()

MessageSize Property (SIMAP Component)

This property includes the size of the selected message.

Syntax

• C#
• VB.NET

public long MessageSize { get; }

Public ReadOnly Property MessageSize As Long

Default Value

0

Remarks

The component fills out this property with the size of the selected message when message information is retrieved from the MailServer.

This property is read-only and not available at design time.

MessageSubject Property (SIMAP Component)

This property includes the subject of the message.

Syntax

• C#
• VB.NET

public string MessageSubject { get; }

Public ReadOnly Property MessageSubject As String

Default Value

""

Remarks

The component fills out this property with the subject of the message when message information is retrieved from the MailServer.

This property is read-only and not available at design time.

MessageText Property (SIMAP Component)

This property includes the body of the retrieved message.

Syntax

• C#
• VB.NET

public string MessageText { get; set; }

Public Property MessageText As String

Default Value

""

Remarks

The component fills out this property with the contents of the message body (in RFC 822 format) when a call to RetrieveMessageText completes successfully and the LocalFile property is not set or the SetMessageStream method has not been used to set a stream.

This property is not available at design time.

Overwrite Property (SIMAP Component)

This property indicates whether or not the component should overwrite files during transfer.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

This property is a value indicating whether or not the component should overwrite files when downloading the message text or a message part and LocalFile is set. If Overwrite is False, an error will be thrown whenever LocalFile exists.

Password Property (SIMAP Component)

This property includes the password to be used to authenticate to the MailServer .

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

This property contains the password used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

PeekMode Property (SIMAP Component)

When set to True, the message Seen flag is not changed during reading.

Syntax

• C#
• VB.NET

public bool PeekMode { get; set; }

Public Property PeekMode As Boolean

Default Value

False

Remarks

This property contains a True or False to determine whether or not this message should be seen. When this property is set to True, a PEEK option is added to all IMAP FETCH commands sent to the server. In this case, an RFC-compliant IMAP server should not set the Seen flag on the message.

This property is not available at design time.

RecentMessageCount Property (SIMAP Component)

This property includes the number of new messages in the Mailbox .

Syntax

• C#
• VB.NET

public int RecentMessageCount { get; }

Public ReadOnly Property RecentMessageCount As Integer

Default Value

0

Remarks

This property contains the number of new messages that are in the Mailbox. The component fills out MessageCount, RecentMessageCount, and MailboxFlags after connecting to the MailServer and selecting or examining a Mailbox.

This property is read-only.

SignerCert Property (SIMAP Component)

This property contains the certificate of the message signer.

Syntax

• C#
• VB.NET

public Certificate SignerCert { get; set; }

Public Property SignerCert As Certificate

Remarks

This property contains the certificate of the message signer. When calling VerifySignature or DecryptAndVerifySignature, this property will contain the certificate of the sender, if attached.

To verify messages without an attached certificate, set this property before calling VerifySignature or DecryptAndVerifySignature.

SignerCertChain Property (SIMAP Component)

This property includes the certificate chain of the signing certificate.

Syntax

• C#
• VB.NET

public CertificateList SignerCertChain { get; }

Public ReadOnly Property SignerCertChain As CertificateList

Remarks

This property contains the certificate chain of the signing certificate. When calling VerifySignature or DecryptAndVerifySignature, this property will be populated with the certificate chain of the sender if attached.

Note: The SignerCert property will contain the signing certificate. The certificates in the signing certificate's chain will be placed in this property's collection.

This property is read-only and not available at design time.

SigningAlgorithm Property (SIMAP Component)

This property includes a textual description of the signature hash algorithm.

Syntax

• C#
• VB.NET

public string SigningAlgorithm { get; set; }

Public Property SigningAlgorithm As String

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm used to prepare the message digest for signature.

This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:

• sha1
• md5
• sha-256 (default)
• sha-384
• sha-512
• sha-224

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

SortCriteria Property (SIMAP Component)

This property sorts criteria to use for message retrieval operations.

Syntax

• C#
• VB.NET

public string SortCriteria { get; set; }

Public Property SortCriteria As String

Default Value

""

Remarks

This property sorts criteria to use for message retrieval operations. When set, the component will send the SORT command to the server before any retrieval. If the server supports the SORT command, the results from the retrieve operation will be sorted according to SortCriteria. The format of the SortCriteria property consists of a parenthesized list of one or more sort keys.

Example. Setting SortCriteria:

IMAPControl.SortCriteria = "DATE" IMAPControl.SortCriteria = "SUBJECT FROM" IMAPControl.SortCriteria = "REVERSE SUBJECT"

Possible sort keys include the following:

Note: IMAP SORT functionality is relatively new and not all servers may implement it.

SSLAcceptServerCert Property (SIMAP Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (SIMAP Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLEnabled Property (SIMAP Component)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C#
• VB.NET

public bool SSLEnabled { get; set; }

Public Property SSLEnabled As Boolean

Default Value

False

Remarks

This property specifies whether TLS/SSL is enabled in the component. When False (default), the component operates in plaintext mode. When True, TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

This property is not available at design time.

SSLProvider Property (SIMAP Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C#
• VB.NET

public SIMAPSSLProviders SSLProvider { get; set; }

enum SIMAPSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As SimapSSLProviders

Enum SIMAPSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (SIMAP Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

SSLStartMode Property (SIMAP Component)

This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public SIMAPSSLStartModes SSLStartMode { get; set; }

enum SIMAPSSLStartModes {
  sslAutomatic,
  sslImplicit,
  sslExplicit,
  sslNone
}

Public Property SSLStartMode As SimapSSLStartModes

Enum SIMAPSSLStartModes
  sslAutomatic
  sslImplicit
  sslExplicit
  sslNone
End Enum

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

StartByte Property (SIMAP Component)

This property includes the byte index of the position where the transfer should start.

Syntax

• C#
• VB.NET

public long StartByte { get; set; }

Public Property StartByte As Long

Default Value

0

Remarks

StartByte and EndByte are used together with the RetrieveMessagePart method to specify the portion of the message to be retrieved from the server.

When StartByte or EndByte contain values other than the default (0), only the corresponding portion of the message is retrieved from the server.

Byte indexes start from 1. The default value for EndByte is 0, which corresponds to the end of the message.

This property is not available at design time.

Timeout Property (SIMAP Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

UIDMode Property (SIMAP Component)

If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.

Syntax

• C#
• VB.NET

public bool UIDMode { get; set; }

Public Property UIDMode As Boolean

Default Value

False

Remarks

This property indicates if a permanent identifier should be used. Normally, the IMAP server uses temporary message identifiers that are valid only during the current session. If UIDMode is True, permanent message identifiers are used instead.

The following IMAP protocol operations use the UID mode: COPY, FETCH, STORE, and SEARCH.

This property is not available at design time.

UIDValidity Property (SIMAP Component)

This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.

Syntax

• C#
• VB.NET

public string UIDValidity { get; }

Public ReadOnly Property UIDValidity As String

Default Value

""

Remarks

Every time a mailbox is selected, a UIDValidity is returned from the server. Most of the time, this value will not change from call to call. If it does change, this means that all previously returned UIDs for messages inside this mailbox are now invalid.

This property is read-only and not available at design time.

User Property (SIMAP Component)

This property includes the username used to authenticate to the MailServer .

Syntax

• C#
• VB.NET

public string User { get; set; }

Public Property User As String

Default Value

""

Remarks

This property contains the username used to authenticate to the MailServer. Both the User and Password properties must be set before connecting to the MailServer.

AddMessageFlags Method (SIMAP Component)

This method adds the specified flags to the messages specified by MessageSet .

Syntax

• C#
• VB.NET

public void AddMessageFlags(string flags);

Async Version
public async Task AddMessageFlags(string flags);
public async Task AddMessageFlags(string flags, CancellationToken cancellationToken);

Public Sub AddMessageFlags(ByVal Flags As String)

Async Version
Public Sub AddMessageFlags(ByVal Flags As String) As Task
Public Sub AddMessageFlags(ByVal Flags As String, cancellationToken As CancellationToken) As Task

Remarks

This method adds the specified flags to the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted")

AppendToMailbox Method (SIMAP Component)

This method appends the message in MessageText to the mailbox specified by Mailbox .

Syntax

• C#
• VB.NET

public void AppendToMailbox();

Async Version
public async Task AppendToMailbox();
public async Task AppendToMailbox(CancellationToken cancellationToken);

Public Sub AppendToMailbox()

Async Version
Public Sub AppendToMailbox() As Task
Public Sub AppendToMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method appends the RFC 822-encoded message in MessageText to the mailbox specified by Mailbox. If the MessageFlags property is not an empty string, its contents are supplied with the APPEND command sent to the server.

Example. Append Message to Mailbox:

IMAPControl.MessageText = MessageHeaders + CRLF + CRLF + MessageBody + CRLF IMAPControl.Mailbox = "INBOX" IMAPControl.MessageFlags = "\Deleted" IMAPControl.AppendToMailbox()

CheckMailbox Method (SIMAP Component)

This method sends a CHECK command to the server.

Syntax

• C#
• VB.NET

public void CheckMailbox();

Async Version
public async Task CheckMailbox();
public async Task CheckMailbox(CancellationToken cancellationToken);

Public Sub CheckMailbox()

Async Version
Public Sub CheckMailbox() As Task
Public Sub CheckMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method sends a CHECK command to the server, asking it to perform any necessary housekeeping operations on and to update the state of the currently selected mailbox.

CheckMessageEncrypted Method (SIMAP Component)

This method checks whether or not the current message is encrypted.

Syntax

• C#
• VB.NET

public bool CheckMessageEncrypted();

Async Version
public async Task<bool> CheckMessageEncrypted();
public async Task<bool> CheckMessageEncrypted(CancellationToken cancellationToken);

Public Function CheckMessageEncrypted() As Boolean

Async Version
Public Function CheckMessageEncrypted() As Task(Of Boolean)
Public Function CheckMessageEncrypted(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

This method is used to check whether or not the current message is encrypted. This method will return True, if the current message appears to be encrypted, according to the value of OutputMessageHeaders.

CheckMessageSigned Method (SIMAP Component)

This method checks whether or not the current message is signed.

Syntax

• C#
• VB.NET

public bool CheckMessageSigned();

Async Version
public async Task<bool> CheckMessageSigned();
public async Task<bool> CheckMessageSigned(CancellationToken cancellationToken);

Public Function CheckMessageSigned() As Boolean

Async Version
Public Function CheckMessageSigned() As Task(Of Boolean)
Public Function CheckMessageSigned(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

This method is used to check whether or not the current message is signed. This method will return True, if the current message appears to be signed, according to the value of OutputMessageHeaders.

Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.

CloseMailbox Method (SIMAP Component)

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.

Syntax

• C#
• VB.NET

public void CloseMailbox();

Async Version
public async Task CloseMailbox();
public async Task CloseMailbox(CancellationToken cancellationToken);

Public Sub CloseMailbox()

Async Version
Public Sub CloseMailbox() As Task
Public Sub CloseMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method permanently removes all messages that have a 'Deleted' flag that have been set from the current (selected) mailbox. It then closes (deselected) the mailbox.

Config Method (SIMAP Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SIMAP Component)

This method connects to an IMAP server.

Syntax

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

Remarks

This method connects to the IMAP server specified by MailServer and authenticates it using the username and password supplied in the User and Password properties.

Example. Connect IMAP Server:

IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect() IMAPControl.MailServer = "myserver" IMAPControl.Mailbox = "DOMAIN/USERNT/INBOX" IMAPControl.User = "myusername" IMAPControl.Password = "mypassword" IMAPControl.Connect()

CopyToMailbox Method (SIMAP Component)

Copies the specified messages to another mailbox.

Syntax

• C#
• VB.NET

public void CopyToMailbox();

Async Version
public async Task CopyToMailbox();
public async Task CopyToMailbox(CancellationToken cancellationToken);

Public Sub CopyToMailbox()

Async Version
Public Sub CopyToMailbox() As Task
Public Sub CopyToMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.

CreateMailbox Method (SIMAP Component)

This method creates a new mailbox specified by Mailbox .

Syntax

• C#
• VB.NET

public void CreateMailbox();

Async Version
public async Task CreateMailbox();
public async Task CreateMailbox(CancellationToken cancellationToken);

Public Sub CreateMailbox()

Async Version
Public Sub CreateMailbox() As Task
Public Sub CreateMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method creates a new mailbox. The mailbox name is specified by the Mailbox property.

Decrypt Method (SIMAP Component)

This method decrypts the current Message .

Syntax

• C#
• VB.NET

public void Decrypt();

Async Version
public async Task Decrypt();
public async Task Decrypt(CancellationToken cancellationToken);

Public Sub Decrypt()

Async Version
Public Sub Decrypt() As Task
Public Sub Decrypt(cancellationToken As CancellationToken) As Task

Remarks

This method attempts to decrypt the encrypted message using the certificate in Certificate.

DecryptAndVerifySignature Method (SIMAP Component)

This method decrypts and verifies the signature of the current message.

Syntax

• C#
• VB.NET

public void DecryptAndVerifySignature();

Async Version
public async Task DecryptAndVerifySignature();
public async Task DecryptAndVerifySignature(CancellationToken cancellationToken);

Public Sub DecryptAndVerifySignature()

Async Version
Public Sub DecryptAndVerifySignature() As Task
Public Sub DecryptAndVerifySignature(cancellationToken As CancellationToken) As Task

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature methods are affected in the same manner.

Note: This function does not attempt to check the validity of the signing certificate.

DeleteFromMailbox Method (SIMAP Component)

The method marks the messages specified by MessageSet as deleted.

Syntax

• C#
• VB.NET

public void DeleteFromMailbox();

Async Version
public async Task DeleteFromMailbox();
public async Task DeleteFromMailbox(CancellationToken cancellationToken);

Public Sub DeleteFromMailbox()

Async Version
Public Sub DeleteFromMailbox() As Task
Public Sub DeleteFromMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method marks the messages specified by MessageSet as deleted. Calling this method is equivalent to calling AddMessageFlags with "\Deleted" as the Flags parameter.

DeleteMailbox Method (SIMAP Component)

This method deletes a mailbox specified by Mailbox .

Syntax

• C#
• VB.NET

public void DeleteMailbox();

Async Version
public async Task DeleteMailbox();
public async Task DeleteMailbox(CancellationToken cancellationToken);

Public Sub DeleteMailbox()

Async Version
Public Sub DeleteMailbox() As Task
Public Sub DeleteMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method deletes a mailbox. The mailbox name is specified by the Mailbox property.

DeleteMailboxACL Method (SIMAP Component)

This method deletes mailbox access control rights for a specific user.

Syntax

• C#
• VB.NET

public void DeleteMailboxACL(string user);

Async Version
public async Task DeleteMailboxACL(string user);
public async Task DeleteMailboxACL(string user, CancellationToken cancellationToken);

Public Sub DeleteMailboxACL(ByVal User As String)

Async Version
Public Sub DeleteMailboxACL(ByVal User As String) As Task
Public Sub DeleteMailboxACL(ByVal User As String, cancellationToken As CancellationToken) As Task

Remarks

This message asks the server to remove all rights associated with User from the mailbox specified in the Mailbox property. Refer to SetMailboxACL and GetMailboxACL for more information on mailbox access rights.

Disconnect Method (SIMAP Component)

This method disconnects from an IMAP server.

Syntax

• C#
• VB.NET

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);

Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

Remarks

This method logs out and disconnects from the IMAP server.

DoEvents Method (SIMAP Component)

This method processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

ExamineMailbox Method (SIMAP Component)

This method selects a mailbox in read-only mode.

Syntax

• C#
• VB.NET

public void ExamineMailbox();

Async Version
public async Task ExamineMailbox();
public async Task ExamineMailbox(CancellationToken cancellationToken);

Public Sub ExamineMailbox()

Async Version
Public Sub ExamineMailbox() As Task
Public Sub ExamineMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method asks the server to select the mailbox specified in the Mailbox property in read-only mode.

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

ExpungeMailbox Method (SIMAP Component)

This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.

Syntax

• C#
• VB.NET

public void ExpungeMailbox();

Async Version
public async Task ExpungeMailbox();
public async Task ExpungeMailbox(CancellationToken cancellationToken);

Public Sub ExpungeMailbox()

Async Version
Public Sub ExpungeMailbox() As Task
Public Sub ExpungeMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method permanently removes all messages that have a 'Deleted' flag from the current (selected) mailbox. Example. Set "Deleted" Flag and Expunge:

IMAPControl.MessageSet = "1" IMAPControl.AddMessageFlags("\Deleted") IMAPControl.ExpungeMailbox()

GetMailboxACL Method (SIMAP Component)

This method retrieves mailbox access control rights.

Syntax

• C#
• VB.NET

public void GetMailboxACL();

Async Version
public async Task GetMailboxACL();
public async Task GetMailboxACL(CancellationToken cancellationToken);

Public Sub GetMailboxACL()

Async Version
Public Sub GetMailboxACL() As Task
Public Sub GetMailboxACL(cancellationToken As CancellationToken) As Task

Remarks

This method retrieves the mailbox access control rights, which are provided through one or more MailboxACL events. Standard rights include the following:

Interrupt Method (SIMAP Component)

This method interrupts the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListMailboxes Method (SIMAP Component)

This method lists all of the mailboxes matching all criteria in the Mailbox property.

Syntax

• C#
• VB.NET

public void ListMailboxes();

Async Version
public async Task ListMailboxes();
public async Task ListMailboxes(CancellationToken cancellationToken);

Public Sub ListMailboxes()

Async Version
Public Sub ListMailboxes() As Task
Public Sub ListMailboxes(cancellationToken As CancellationToken) As Task

Remarks

This method lists all of the mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through the MailboxList event.

Example 1. List All Mailboxes:

IMAPControl.Mailbox = "*" IMAPControl.ListMailboxes()

Example 2. List All Mailboxes Inside INBOX:

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListMailboxes()

ListSubscribedMailboxes Method (SIMAP Component)

This method lists all subscribed mailboxes matching all criteria in the Mailbox property.

Syntax

• C#
• VB.NET

public void ListSubscribedMailboxes();

Async Version
public async Task ListSubscribedMailboxes();
public async Task ListSubscribedMailboxes(CancellationToken cancellationToken);

Public Sub ListSubscribedMailboxes()

Async Version
Public Sub ListSubscribedMailboxes() As Task
Public Sub ListSubscribedMailboxes(cancellationToken As CancellationToken) As Task

Remarks

This method lists all subscribed mailboxes matching the criteria in the Mailbox property. Matching mailboxes are returned through MailboxList event.

Example 1. List All Subscribed Mailboxes:

IMAPControl.Mailbox = "*" IMAPControl.ListSubscribedMailboxes()

Example 2. List All Subscribed Mailboxes Inside INBOX:

IMAPControl.Mailbox = "INBOX.*" IMAPControl.ListSubscribedMailboxes()

LocalizeDate Method (SIMAP Component)

This method converts a valid RFC 822 message date to a local date and time.

Syntax

• C#
• VB.NET

public string LocalizeDate(string dateTime);

Async Version
public async Task<string> LocalizeDate(string dateTime);
public async Task<string> LocalizeDate(string dateTime, CancellationToken cancellationToken);

Public Function LocalizeDate(ByVal DateTime As String) As String

Async Version
Public Function LocalizeDate(ByVal DateTime As String) As Task(Of String)
Public Function LocalizeDate(ByVal DateTime As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method can be used to convert an RFC 822 date and time string to the corresponding local date and time.

Note: Dates will be returned in the format: "MM/dd/yyyy hh:mm:ss".

MoveToMailbox Method (SIMAP Component)

Copies the specified messages to another mailbox and marks the original messages as deleted.

Syntax

• C#
• VB.NET

public void MoveToMailbox();

Async Version
public async Task MoveToMailbox();
public async Task MoveToMailbox(CancellationToken cancellationToken);

Public Sub MoveToMailbox()

Async Version
Public Sub MoveToMailbox() As Task
Public Sub MoveToMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method copies the messages specified by the MessageSet property to the mailbox specified by the Mailbox property. Additionally, the messages in the original mailbox are marked as deleted.

Calling this method is equivalent to calling the CopyToMailbox method immediately followed by the DeleteFromMailbox method.

Noop Method (SIMAP Component)

This method sends a NOOP command to the server.

Syntax

• C#
• VB.NET

public void Noop();

Async Version
public async Task Noop();
public async Task Noop(CancellationToken cancellationToken);

Public Sub Noop()

Async Version
Public Sub Noop() As Task
Public Sub Noop(cancellationToken As CancellationToken) As Task

Remarks

This method sends an IMAP NOOP command to the server. This is useful when the connection needs to be kept alive for long periods of time. (Normally, servers break the connection automatically after 30 minutes of inactivity.)

RenameMailbox Method (SIMAP Component)

This method changes the name of Mailbox to NewName .

Syntax

• C#
• VB.NET

public void RenameMailbox(string newName);

Async Version
public async Task RenameMailbox(string newName);
public async Task RenameMailbox(string newName, CancellationToken cancellationToken);

Public Sub RenameMailbox(ByVal NewName As String)

Async Version
Public Sub RenameMailbox(ByVal NewName As String) As Task
Public Sub RenameMailbox(ByVal NewName As String, cancellationToken As CancellationToken) As Task

Remarks

This method allows a mailbox to be renamed. The mailbox is specified by the Mailbox property, and the new name is specified by the NewName parameter.

Reset Method (SIMAP Component)

This method will reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

ResetMessageFlags Method (SIMAP Component)

This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .

Syntax

• C#
• VB.NET

public void ResetMessageFlags();

Async Version
public async Task ResetMessageFlags();
public async Task ResetMessageFlags(CancellationToken cancellationToken);

Public Sub ResetMessageFlags()

Async Version
Public Sub ResetMessageFlags() As Task
Public Sub ResetMessageFlags(cancellationToken As CancellationToken) As Task

Remarks

This method replaces the flags of the messages specified by the MessageSet property with the flags specified by the MessageFlags property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

RetrieveMessageHeaders Method (SIMAP Component)

This method retrieves the message headers of the messages specified by the MessageSet property.

Syntax

• C#
• VB.NET

public void RetrieveMessageHeaders();

Async Version
public async Task RetrieveMessageHeaders();
public async Task RetrieveMessageHeaders(CancellationToken cancellationToken);

Public Sub RetrieveMessageHeaders()

Async Version
Public Sub RetrieveMessageHeaders() As Task
Public Sub RetrieveMessageHeaders(cancellationToken As CancellationToken) As Task

Remarks

This method retrieves RFC 822 headers of the messages specified by MessageSet and stores them in the MessageHeaders property.

RetrieveMessageInfo Method (SIMAP Component)

This method retrieves information about messages specified by the MessageSet property.

Syntax

• C#
• VB.NET

public void RetrieveMessageInfo();

Async Version
public async Task RetrieveMessageInfo();
public async Task RetrieveMessageInfo(CancellationToken cancellationToken);

Public Sub RetrieveMessageInfo()

Async Version
Public Sub RetrieveMessageInfo() As Task
Public Sub RetrieveMessageInfo(cancellationToken As CancellationToken) As Task

Remarks

This method retrieves information for the messages specified by the MessageSet property. This includes information about the message envelope as well as message structure. Every time a message envelope is retrieved, a MessageInfo event is fired, and message envelope information is stored in properties, such as the following: MessageSubject, MessageFrom, and MessageRecipients. If the message is a multipart message, one or more MessagePart events will be fired before the MessageInfo event (one for each message part).

RetrieveMessagePart Method (SIMAP Component)

This method retrieves the message part specified by PartID.

Syntax

• C#
• VB.NET

public void RetrieveMessagePart(string partId);

Async Version
public async Task RetrieveMessagePart(string partId);
public async Task RetrieveMessagePart(string partId, CancellationToken cancellationToken);

Public Sub RetrieveMessagePart(ByVal PartId As String)

Async Version
Public Sub RetrieveMessagePart(ByVal PartId As String) As Task
Public Sub RetrieveMessagePart(ByVal PartId As String, cancellationToken As CancellationToken) As Task

Remarks

This method retrieves the contents of the message part specified by the PartId property of the messages specified by the MessageSet property. If the LocalFile property contains a file name, the message part is stored in LocalFile. If the SetMessageStream property has been used to set a stream, the message part will be stored in the specified stream. If the LocalFile property is set to an empty string and the SetMessageStream property has not been set to a stream, then the message part is stored in the MessageText property. Additionally, the Transfer will also provide the message part and denote the progress of the retrieval.

The part identifiers for each message part (if any) are provided through the corresponding MessagePart events. This method retrieves the RFC 822-encoded text of the messages specified by MessageSet.

RetrieveMessagePartHeaders Method (SIMAP Component)

This method retrieves the headers of message part specified by PartID.

Syntax

• C#
• VB.NET

public void RetrieveMessagePartHeaders(string partId);

Async Version
public async Task RetrieveMessagePartHeaders(string partId);
public async Task RetrieveMessagePartHeaders(string partId, CancellationToken cancellationToken);

Public Sub RetrieveMessagePartHeaders(ByVal PartId As String)

Async Version
Public Sub RetrieveMessagePartHeaders(ByVal PartId As String) As Task
Public Sub RetrieveMessagePartHeaders(ByVal PartId As String, cancellationToken As CancellationToken) As Task

Remarks

This method retrieves RFC 822 headers of the message part specified by PartID and stores them in the MessageHeaders property.

RetrieveMessageText Method (SIMAP Component)

This method retrieves the message text of the messages specified by the MessageSet property.

Syntax

• C#
• VB.NET

public void RetrieveMessageText();

Async Version
public async Task RetrieveMessageText();
public async Task RetrieveMessageText(CancellationToken cancellationToken);

Public Sub RetrieveMessageText()

Async Version
Public Sub RetrieveMessageText() As Task
Public Sub RetrieveMessageText(cancellationToken As CancellationToken) As Task

Remarks

This method retrieves the RFC 822-encoded text of the messages specified by MessageSet. If the LocalFile property contains a file name, the text is stored in LocalFile. If the SetMessageStream property has been used to set a stream, the text will be stored in the specified stream. If the LocalFile property is set to an empty string and the SetMessageStream property has not been set to a stream, then the text is stored in the MessageText property. Additionally, the Transfer event will also provide the text and denote the progress of the retrieval.

SearchMailbox Method (SIMAP Component)

This method searches the selected mailbox for specified text.

Syntax

• C#
• VB.NET

public void SearchMailbox(string searchCriteria);

Async Version
public async Task SearchMailbox(string searchCriteria);
public async Task SearchMailbox(string searchCriteria, CancellationToken cancellationToken);

Public Sub SearchMailbox(ByVal SearchCriteria As String)

Async Version
Public Sub SearchMailbox(ByVal SearchCriteria As String) As Task
Public Sub SearchMailbox(ByVal SearchCriteria As String, cancellationToken As CancellationToken) As Task

Remarks

This method searches the selected mailbox using the criteria specified in the SearchCriteria parameter. For every message matching the criteria, the RetrieveMessageInfo method is called and a MessageInfo event is fired.

The exact format of the search criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include the following:

SelectMailbox Method (SIMAP Component)

This method selects a mailbox.

Syntax

• C#
• VB.NET

public void SelectMailbox();

Async Version
public async Task SelectMailbox();
public async Task SelectMailbox(CancellationToken cancellationToken);

Public Sub SelectMailbox()

Async Version
Public Sub SelectMailbox() As Task
Public Sub SelectMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method asks the server to select the mailbox specified in the Mailbox property. The mailbox is selected in read/write mode (if the server permits).

Example 1. Open a Mailbox in Read/Write Mode:

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

Example 2. Open a Mailbox in Read-Only Mode:

IMAPControl.Mailbox = "INBOX.Folder" IMAPControl.ExamineMailbox

SendCommand Method (SIMAP Component)

This method sends the exact command directly to the server.

Syntax

• C#
• VB.NET

public void SendCommand(string command);

Async Version
public async Task SendCommand(string command);
public async Task SendCommand(string command, CancellationToken cancellationToken);

Public Sub SendCommand(ByVal Command As String)

Async Version
Public Sub SendCommand(ByVal Command As String) As Task
Public Sub SendCommand(ByVal Command As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends the command specified by Command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method, check the LastReply property or monitor the PITrail event to obtain the server's response.

SetMailboxACL Method (SIMAP Component)

This method sets mailbox access control rights for a specific user.

Syntax

• C#
• VB.NET

public void SetMailboxACL(string user, string rights);

Async Version
public async Task SetMailboxACL(string user, string rights);
public async Task SetMailboxACL(string user, string rights, CancellationToken cancellationToken);

Public Sub SetMailboxACL(ByVal User As String, ByVal Rights As String)

Async Version
Public Sub SetMailboxACL(ByVal User As String, ByVal Rights As String) As Task
Public Sub SetMailboxACL(ByVal User As String, ByVal Rights As String, cancellationToken As CancellationToken) As Task

Remarks

This method changes the access control list for the mailbox specified in the Mailbox property so that User is granted the permissions specified in Rights.

Rights is a string containing an optional plus ("+") or minus ("-") prefix, followed by zero or more rights characters. If the string starts with a plus, the rights are added to any existing rights for the identifier. If the string starts with a minus, the rights are removed from any existing rights for the identifier. If the string does not start with a plus or minus, the rights replace any existing rights for the identifier.

Standard rights include the following:

SetMessageStream Method (SIMAP Component)

This method sets the stream to which the message (or message part) downloaded from the server will be written.

Syntax

• C#
• VB.NET

public void SetMessageStream(System.IO.Stream messageStream);

Async Version
public async Task SetMessageStream(System.IO.Stream messageStream);
public async Task SetMessageStream(System.IO.Stream messageStream, CancellationToken cancellationToken);

Public Sub SetMessageStream(ByVal MessageStream As System.IO.Stream)

Async Version
Public Sub SetMessageStream(ByVal MessageStream As System.IO.Stream) As Task
Public Sub SetMessageStream(ByVal MessageStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

This method sets the stream to which the message (or message part) downloaded from the server will be written. If a download stream is set before the RetrieveMessageText or RetrieveMessagePart methods are called, the downloaded data will be written to the stream. The stream should be open and normally set to position 0. The component will automatically close this stream if CloseStreamAfterTransfer is True (default). If the stream is closed, you will need to call SetMessageStream again before calling RetrieveMessageText or RetrieveMessagePart. The downloaded content will be written starting at the current position in the stream.

Note: SetMessageStream and LocalFile will reset the other.

StartIdle Method (SIMAP Component)

This method begins idling.

Syntax

• C#
• VB.NET

public void StartIdle();

Async Version
public async Task StartIdle();
public async Task StartIdle(CancellationToken cancellationToken);

Public Sub StartIdle()

Async Version
Public Sub StartIdle() As Task
Public Sub StartIdle(cancellationToken As CancellationToken) As Task

Remarks

This method sends the IDLE command to the server and begins idling. As responses are received from the server the IdleInfo event fires. To stop idling, call StopIdle.

StopIdle Method (SIMAP Component)

This method stops idling.

Syntax

• C#
• VB.NET

public void StopIdle();

Async Version
public async Task StopIdle();
public async Task StopIdle(CancellationToken cancellationToken);

Public Sub StopIdle()

Async Version
Public Sub StopIdle() As Task
Public Sub StopIdle(cancellationToken As CancellationToken) As Task

Remarks

This method stops idling if it was previously started via StartIdle. If the component is not idling, this method does nothing.

SubscribeMailbox Method (SIMAP Component)

This method subscribes to the mailbox specified by Mailbox .

Syntax

• C#
• VB.NET

public void SubscribeMailbox();

Async Version
public async Task SubscribeMailbox();
public async Task SubscribeMailbox(CancellationToken cancellationToken);

Public Sub SubscribeMailbox()

Async Version
Public Sub SubscribeMailbox() As Task
Public Sub SubscribeMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method subscribes to the mailbox specified by the Mailbox property.

UnsetMessageFlags Method (SIMAP Component)

This method removes the flags specified by MessageFlags from the messages specified by MessageSet .

Syntax

• C#
• VB.NET

public void UnsetMessageFlags();

Async Version
public async Task UnsetMessageFlags();
public async Task UnsetMessageFlags(CancellationToken cancellationToken);

Public Sub UnsetMessageFlags()

Async Version
Public Sub UnsetMessageFlags() As Task
Public Sub UnsetMessageFlags(cancellationToken As CancellationToken) As Task

Remarks

This method removes the flags specified by the MessageFlags property from the messages specified by the MessageSet property. The format of the flags is specified by the IMAP RFCs.

Examples of possible flag values are server dependent, but they can include the following:

UnsubscribeMailbox Method (SIMAP Component)

This method unsubscribes from the mailbox specified by Mailbox .

Syntax

• C#
• VB.NET

public void UnsubscribeMailbox();

Async Version
public async Task UnsubscribeMailbox();
public async Task UnsubscribeMailbox(CancellationToken cancellationToken);

Public Sub UnsubscribeMailbox()

Async Version
Public Sub UnsubscribeMailbox() As Task
Public Sub UnsubscribeMailbox(cancellationToken As CancellationToken) As Task

Remarks

This method unsubscribes from the mailbox specified by the Mailbox property.

VerifySignature Method (SIMAP Component)

This method verifies the signature of the current message.

Syntax

• C#
• VB.NET

public void VerifySignature();

Async Version
public async Task VerifySignature();
public async Task VerifySignature(CancellationToken cancellationToken);

Public Sub VerifySignature()

Async Version
Public Sub VerifySignature() As Task
Public Sub VerifySignature(cancellationToken As CancellationToken) As Task

Remarks

This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the component will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the component throws an exception.

If this method is successful, the SignerCert property will contain the certificate information of the message signer.

Note: This function does not attempt to check the validity of the signing certificate.

ConnectionStatus Event (SIMAP Component)

Fired to indicate changes in the connection state.

Syntax

• C#
• VB.NET

public event OnConnectionStatusHandler OnConnectionStatus;

public delegate void OnConnectionStatusHandler(object sender, SIMAPConnectionStatusEventArgs e);

public class SIMAPConnectionStatusEventArgs : EventArgs {
  public string ConnectionEvent { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnectionStatus As OnConnectionStatusHandler

Public Delegate Sub OnConnectionStatusHandler(sender As Object, e As SIMAPConnectionStatusEventArgs)

Public Class SIMAPConnectionStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionEvent As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

EndTransfer Event (SIMAP Component)

This event is fired when the message or the part data finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, SIMAPEndTransferEventArgs e);

public class SIMAPEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As SIMAPEndTransferEventArgs)

Public Class SIMAPEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The EndTransfer event is fired when the requested message body or part completes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (SIMAP Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SIMAPErrorEventArgs e);

public class SIMAPErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SIMAPErrorEventArgs)

Public Class SIMAPErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (SIMAP Component)

This event is fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, SIMAPHeaderEventArgs e);

public class SIMAPHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As SIMAPHeaderEventArgs)

Public Class SIMAPHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

The Field parameter contains the name of the HTTP header (in the same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

IdleInfo Event (SIMAP Component)

This event fires whenever responses from the server are received while idling.

Syntax

• C#
• VB.NET

public event OnIdleInfoHandler OnIdleInfo;

public delegate void OnIdleInfoHandler(object sender, SIMAPIdleInfoEventArgs e);

public class SIMAPIdleInfoEventArgs : EventArgs {
  public string Message { get; }
  public bool Cancel { get; set; }
}

Public Event OnIdleInfo As OnIdleInfoHandler

Public Delegate Sub OnIdleInfoHandler(sender As Object, e As SIMAPIdleInfoEventArgs)

Public Class SIMAPIdleInfoEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
  Public Property Cancel As Boolean
End Class

Remarks

This event fires each time a response is received from the server after calling StartIdle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling StopIdle.

The following are possible values returned by the server:

+ idling
* 43 EXISTS
* 1 RECENT

MailboxACL Event (SIMAP Component)

This event fires for each set of access control rights returned by the server.

Syntax

• C#
• VB.NET

public event OnMailboxACLHandler OnMailboxACL;

public delegate void OnMailboxACLHandler(object sender, SIMAPMailboxACLEventArgs e);

public class SIMAPMailboxACLEventArgs : EventArgs {
  public string Mailbox { get; }
  public string User { get; }
  public string Rights { get; }
}

Public Event OnMailboxACL As OnMailboxACLHandler

Public Delegate Sub OnMailboxACLHandler(sender As Object, e As SIMAPMailboxACLEventArgs)

Public Class SIMAPMailboxACLEventArgs Inherits EventArgs
  Public ReadOnly Property Mailbox As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Rights As String
End Class

Remarks

The event fires for each set of access control rights returned by the server after a call to GetMailboxACL. Standard rights include the following:

MailboxList Event (SIMAP Component)

This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.

Syntax

• C#
• VB.NET

public event OnMailboxListHandler OnMailboxList;

public delegate void OnMailboxListHandler(object sender, SIMAPMailboxListEventArgs e);

public class SIMAPMailboxListEventArgs : EventArgs {
  public string Mailbox { get; }
  public string Separator { get; }
  public string Flags { get; }
}

Public Event OnMailboxList As OnMailboxListHandler

Public Delegate Sub OnMailboxListHandler(sender As Object, e As SIMAPMailboxListEventArgs)

Public Class SIMAPMailboxListEventArgs Inherits EventArgs
  Public ReadOnly Property Mailbox As String
  Public ReadOnly Property Separator As String
  Public ReadOnly Property Flags As String
End Class

Remarks

This method is fired for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. The Separator parameter contains the character that separates the different parts in the mailbox path hierarchy.

MessageInfo Event (SIMAP Component)

This event is fired with information for the messages retrieved by the server.

Syntax

• C#
• VB.NET

public event OnMessageInfoHandler OnMessageInfo;

public delegate void OnMessageInfoHandler(object sender, SIMAPMessageInfoEventArgs e);

public class SIMAPMessageInfoEventArgs : EventArgs {
  public string MessageId { get; }
  public string Subject { get; }
  public string MessageDate { get; }
  public string From { get; }
  public string Flags { get; }
  public long Size { get; }
}

Public Event OnMessageInfo As OnMessageInfoHandler

Public Delegate Sub OnMessageInfoHandler(sender As Object, e As SIMAPMessageInfoEventArgs)

Public Class SIMAPMessageInfoEventArgs Inherits EventArgs
  Public ReadOnly Property MessageId As String
  Public ReadOnly Property Subject As String
  Public ReadOnly Property MessageDate As String
  Public ReadOnly Property From As String
  Public ReadOnly Property Flags As String
  Public ReadOnly Property Size As Long
End Class

Remarks

The MessageInfo event is fired when messages are searched, listed, or message information is received.

Id is the Id of the message.

Subject is the message subject.

MessageDate is the date of the message.

From is the email address of the sender.

Flags is a list of flags associated with this message.

Size is the size of the message.

More information may be received from the respective properties, such as the following: MessageContentType, MessageContentEncoding, MessageRecipients, MessageDeliveryTime, MessageFlags, MessageHeaders, MessageInReplyTo, MessageNetId, MessageReplyTo, MessageSender, MessageSize, MessageSubject, MessageText, etc.

MessagePart Event (SIMAP Component)

This event is fired for each message part when RetrieveMessageInfo is called.

Syntax

• C#
• VB.NET

public event OnMessagePartHandler OnMessagePart;

public delegate void OnMessagePartHandler(object sender, SIMAPMessagePartEventArgs e);

public class SIMAPMessagePartEventArgs : EventArgs {
  public string PartId { get; }
  public long Size { get; }
  public string ContentType { get; }
  public string FileName { get; }
  public string ContentEncoding { get; }
  public string Parameters { get; }
  public string MultipartMode { get; }
  public string ContentId { get; }
  public string ContentDisposition { get; }
}

Public Event OnMessagePart As OnMessagePartHandler

Public Delegate Sub OnMessagePartHandler(sender As Object, e As SIMAPMessagePartEventArgs)

Public Class SIMAPMessagePartEventArgs Inherits EventArgs
  Public ReadOnly Property PartId As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property ContentType As String
  Public ReadOnly Property FileName As String
  Public ReadOnly Property ContentEncoding As String
  Public ReadOnly Property Parameters As String
  Public ReadOnly Property MultipartMode As String
  Public ReadOnly Property ContentId As String
  Public ReadOnly Property ContentDisposition As String
End Class

Remarks

The PartId parameter denotes the PartId that may be identified in other parts or messages. The format of PartIds is specified by the IMAP RFCs.

The Size parameter gives the size of this part.

The ContentType parameter shows the type of data contained in the part.

The ContentEncoding parameter shows how data are encoded.

The FileName parameter shows the filename corresponding to the part (if the part was included in the message as an attached file).

The Parameters parameter contains the additional parameters passed to the ContentType header, such as the part charset.

The MultipartMode parameter shows the how this part relates to the message's whole multipart structure (e.g., 'mixed', 'alternative', etc.).

The ContentId parameter shows the value of the Content-Id header for the part.

The ContentDisposition parameter shows the value of the Content-Disposition header for the part.

PITrail Event (SIMAP Component)

This event traces the commands sent to the mail server, and the respective replies.

Syntax

• C#
• VB.NET

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, SIMAPPITrailEventArgs e);

public class SIMAPPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Message { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As SIMAPPITrailEventArgs)

Public Class SIMAPPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Message As String
End Class

Remarks

The PITrail event is useful for debugging and learning purposes. It shows all of the interactions between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

SSLServerAuthentication Event (SIMAP Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, SIMAPSSLServerAuthenticationEventArgs e);

public class SIMAPSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As SIMAPSSLServerAuthenticationEventArgs)

Public Class SIMAPSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (SIMAP Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, SIMAPSSLStatusEventArgs e);

public class SIMAPSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As SIMAPSSLStatusEventArgs)

Public Class SIMAPSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (SIMAP Component)

This event is fired when the message body or the part data start transferring.

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, SIMAPStartTransferEventArgs e);

public class SIMAPStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As SIMAPStartTransferEventArgs)

Public Class SIMAPStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The StartTransfer event is fired when the message body or the part data start transferring from the server to the local host. Further progress information is provided by the Transfer and EndTransfer events.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (SIMAP Component)

This event is fired while the message is transferred from the MailServer .

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, SIMAPTransferEventArgs e);

public class SIMAPTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As SIMAPTransferEventArgs)

Public Class SIMAPTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
End Class

Remarks

The Transfer event is fired for every incoming line when receiving a message or part data from the MailServer

The Text parameter contains the portion of the message or the part data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e., when the last Transfer event is fired), BytesTransferred equals the value of the MessageSize property.

The Transfer event is fired for every line of the message. There is no terminating newline at the end of the Text parameter. A faster way to retrieve a message is to assign a value to the LocalFile property and use the Transfer event to check the progress only rather than to get the actual data.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

Mailbox Type

This type includes mailboxes collected when calling or .

Remarks

This type includes the information for each mailbox as it is returned by the server after either ListMailboxes or ListSubscribedMailboxes have been called.

Fields

Constructors

• C#
• VB.NET

public Mailbox();

Public Mailbox()

MessageInfo Type

This is a listing of information for a message returned by the server.

Remarks

The MessageInfo event is fired when messages are searched or listed or when message information is received. When a MessageInfo event is fired, this type is returned, which contains all of the information from the message.

Fields

Constructors

• C#
• VB.NET

public MessageInfo();

Public MessageInfo()

MessagePart Type

A message part of a message listing.

Remarks

Messages are split into message parts. Each MessagePart is specified by a unique identifier, namely, the Id field. Each part contains data and other fields describing that part.

Fields

Constructors

• C#
• VB.NET

public MessagePart();

Public MessagePart()

MessageRecipient Type

This types describes the message recipient.

Remarks

This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the component is sending the message.

Fields

Constructors

• C#
• VB.NET

public MessageRecipient();

Public MessageRecipient()

• C#
• VB.NET

public MessageRecipient(string address);

Public MessageRecipient(ByVal Address As String)

• C#
• VB.NET

public MessageRecipient(string address, int recipientType);