IMAP Component
Properties Methods Events Config Settings Errors
The IMAP Component is used to communicate with IMAP servers using the Internet Message Access Protocol (IMAP).
Syntax
nsoftware.IPWorks.IMAP
Remarks
The IMAP Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections (RFC 2595). When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.
The IMAP Component implements a standard IMAP client as specified in RFC 1730 and RFC 2060.
The first step in using the component is specifying a MailServer, a User to connect as, and a Password to authenticate with. After that, one or more requests may be sent to the server via the component's methods. Results are retrieved through events and a number of key properties.
Normally, after connecting to the server, a Mailbox is selected (or examined) using the ExamineMailbox method. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags show the flags pertaining to the mailbox.
A number of operations may be performed by the server in response to commands sent 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.
AuthMechanism | This property includes the authentication mechanism to be used when connecting to the mail server. |
AutoDecodeParts | This property determines whether or not to automatically decode message parts. |
Connected | This property shows whether the component is connected. |
EndByte | This property includes the byte index of the position where the transfer should end. |
Firewall | A set of properties related to firewall access. |
Idle | This property specifies the current status of the component. |
LastReply | This property indicates the last reply received from the server. |
LocalFile | This property includes the path to a local file for downloading the message body. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Mailbox | This property includes the name of the mailbox selected on the server. |
MailboxFlags | This property defines flags in the selected mailbox. |
MailboxList | The property includes the collection of mailboxes listed by the server. |
MailPort | This property includes the port of the IMAP server (default is 143). |
MailServer | This property includes the name or address of the mail server (IMAP server). |
Message | This property provides the raw message content. |
MessageContentEncoding | This property includes the ContentEncoding of the selected message. |
MessageContentType | This property includes the ContentType of the message. |
MessageCount | This property includes the total number of messages on the Mailbox . |
MessageDate | The property includes the time the message was created. |
MessageDeliveryTime | This property includes the time the message was delivered to the mail server. |
MessageFlags | This property contains the flags of the current message. |
MessageFrom | This property includes the address of the author of the message. |
MessageHeaders | This property includes the collection of RFC 822-encoded headers of the message. |
MessageHeadersString | This property includes the string version of the RFC 822-encoded headers in the message. |
MessageId | This property includes the message identifier of the current message. |
MessageInfo | This property includes the collection of messages retrieved by RetrieveMessageInfo . |
MessageInReplyTo | This property includes the unique message identifier of the message being replied to. |
MessageNetId | This property includes the globally unique identifier of the message. |
MessageParts | This property includes a collection of message parts collected by RetrieveMessageInfo . |
MessageRecipients | This property includes a collection of recipients for the current message. |
MessageReplyTo | This property includes the email addresses to which replies to the message should be sent. |
MessageSender | This property includes the address of the sender of the message. |
MessageSet | This property includes the set of messages to operate on. |
MessageSize | This property includes the size of the selected message. |
MessageSubject | This property includes the subject of the message. |
MessageText | This property includes the body of the retrieved message. |
Overwrite | This property indicates whether or not the component should overwrite files during transfer. |
Password | This property includes the password to be used to authenticate to the MailServer . |
PeekMode | When set to True, the message Seen flag is not changed during reading. |
RecentMessageCount | This property includes the number of new messages in the Mailbox . |
SortCriteria | This property sorts criteria to use for message retrieval operations. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLEnabled | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
SSLStartMode | This property determines how the component starts the Secure Sockets Layer (SSL) negotiation. |
StartByte | This property includes the byte index of the position where the transfer should start. |
Timeout | This property includes the timeout for the component. |
UIDMode | If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers. |
UIDValidity | This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command. |
User | This property includes the username used to authenticate to the MailServer . |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddMessageFlags | This method adds the specified flags to the messages specified by MessageSet . |
AppendToMailbox | This method appends the message in MessageText to the mailbox specified by Mailbox . |
CheckMailbox | This method sends a CHECK command to the server. |
CloseMailbox | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox. |
Config | Sets or retrieves a configuration setting. |
Connect | This method connects to an IMAP server. |
CopyToMailbox | This method copies the messages specified by MessageSet to the mailbox specified by Mailbox . |
CreateMailbox | This method creates a new mailbox specified by Mailbox . |
DeleteFromMailbox | The method marks the messages specified by MessageSet as deleted. |
DeleteMailbox | This method deletes a mailbox specified by Mailbox . |
DeleteMailboxACL | This method deletes mailbox access control rights for a specific user. |
Disconnect | This method disconnects from an IMAP server. |
DoEvents | This method processes events from the internal message queue. |
ExamineMailbox | This method selects a mailbox in read-only mode. |
ExpungeMailbox | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox. |
GetMailboxACL | This method retrieves mailbox access control rights. |
Interrupt | This method interrupts the current method. |
ListMailboxes | This method lists all of the mailboxes matching all criteria in the Mailbox property. |
ListSubscribedMailboxes | This method lists all subscribed mailboxes matching all criteria in the Mailbox property. |
LocalizeDate | This method converts a valid RFC 822 message date to a local date and time. |
MoveToMailbox | This method moves the messages specified by MessageSet to the mailbox specified by Mailbox . |
Noop | This method sends a NOOP command to the server. |
RenameMailbox | This method changes the name of Mailbox to NewName . |
Reset | This method will reset the component. |
ResetMessageFlags | This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags . |
RetrieveMessageHeaders | This method retrieves the message headers of the messages specified by the MessageSet property. |
RetrieveMessageInfo | This method retrieves information about messages specified by the MessageSet property. |
RetrieveMessagePart | This method retrieves the message part specified by PartID. |
RetrieveMessagePartHeaders | This method retrieves the headers of message part specified by PartID. |
RetrieveMessageText | This method retrieves the message text of the messages specified by the MessageSet property. |
SearchMailbox | This method searches the selected mailbox for specified text. |
SelectMailbox | This method selects a mailbox. |
SendCommand | This method sends the exact command directly to the server. |
SetMailboxACL | This method sets mailbox access control rights for a specific user. |
SetMessageStream | This method sets the stream to which the message (or message part) downloaded from the server will be written. |
StartIdle | This method begins idling. |
StopIdle | This method stops idling. |
SubscribeMailbox | This method subscribes to the mailbox specified by Mailbox . |
UnsetMessageFlags | This method removes the flags specified by MessageFlags from the messages specified by MessageSet . |
UnsubscribeMailbox | This method unsubscribes from the mailbox specified by Mailbox . |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
ConnectionStatus | This event is fired to indicate changes in the connection state. |
EndTransfer | This event is fired when the message or the part data finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
IdleInfo | This event fires whenever responses from the server are received while idling. |
MailboxACL | This event fires for each set of access control rights returned by the server. |
MailboxList | This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. |
MessageInfo | This event is fired with information for the messages retrieved by the server. |
MessagePart | This event is fired for each message part when RetrieveMessageInfo is called. |
PITrail | This event traces the commands sent to the mail server, and the respective replies. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when the message body or the part data start transferring. |
Transfer | This event is fired while the message is transferred from the MailServer . |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AlwaysReturnUIDs | Instructs the server to return UIDs even if not in UIDMode. |
AppendToMailboxDateTime | Specifies the date-time parameter used in the initial APPEND request. |
AuthorizationIdentity | The value to use as the authorization identity when SASL authentication is used. |
AutoDecodeText | Whether to decode MessageText when AutoDecodeParts is True. |
HeaderLimit | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
IncludeHeaders | Instructs the component to include the headers in the LocalFile. |
MailboxLimit | Instructs component to save the amount of mailboxes specified that are returned by the server after a ListMailboxes call has been made. |
MaskSensitiveData | Whether sensitive properties should be masked when logging. |
MessageHeadersStringFolded | Whether the MessageHeadersString property should contain folded headers. |
MessageInfoLimit | Instructs component to save the amount of messages specified that are returned by the server after a RetrieveMessageInfo call has been made. |
MessagePartLimit | Instructs component to save the amount of message parts specified that are returned by the server after a RetrieveMessageInfo call has been made. |
RetrieveAfterSearch | Determines if messages matching the SearchCriteria are retrieved after calling SearchMailbox. |
RetrieveTextAndHeaders | Specifies whether the message body and headers are retrieved in a single request. |
SendIDCommand | Instructs component to send the ID command if the server advertises support for it. |
UTF7MailboxNames | Specifies whether or not to automatically encode and decode UTF-7 mailbox names. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthMechanism Property (IMAP Component)
This property includes the authentication mechanism to be used when connecting to the mail server.
Syntax
public IMAPAuthMechanisms AuthMechanism { get; set; }
enum IMAPAuthMechanisms { amUserPassword, amCRAMMD5, amNTLM, amAPOP, amSASLPlain, amSASLDigestMD5, amKerberos, amXOAUTH2 }
Public Property AuthMechanism As ImapAuthMechanisms
Enum IMAPAuthMechanisms amUserPassword amCRAMMD5 amNTLM amAPOP amSASLPlain amSASLDigestMD5 amKerberos amXOAUTH2 End Enum
Default Value
0
Remarks
Auth Mechanism | Description |
0 (amUserPassword - Default) | A user/password pair is sent in plaintext to login (default). |
1 (amCRAMMD5) | CRAM-MD5 authentication. |
2 (amNTLM) | NTLM authentication. |
4 (amSASLPlain) | SASLPlain. Note: Servers often require the Secure Sockets Layer (SSL) to be used when this authentication mechanism is requested. See AuthorizationIdentity. |
5 (amSASLDigestMD5) | SASLDigestMD5. See AuthorizationIdentity. |
6 (amKerberos) | Kerberos authentication. This option is available in Windows or other platforms when using the Java edition. |
7 (mXOAUTH) | XOAUTH2 authentication. See AuthorizationIdentity. |
AutoDecodeParts Property (IMAP Component)
This property determines whether or not to automatically decode message parts.
Syntax
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.
Connected Property (IMAP Component)
This property shows whether the component is connected.
Syntax
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 (IMAP Component)
This property includes the byte index of the position where the transfer should end.
Syntax
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 (IMAP Component)
A set of properties related to firewall access.
Syntax
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Idle Property (IMAP Component)
This property specifies the current status of the component.
Syntax
Default Value
True
Remarks
Idle 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 (IMAP Component)
This property indicates the last reply received from the server.
Syntax
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 (IMAP Component)
This property includes the path to a local file for downloading the message body.
Syntax
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 (IMAP Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
Default Value
""
Remarks
The LocalHost 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 (IMAP Component)
This property includes the name of the mailbox selected on the server.
Syntax
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 (IMAP Component)
This property defines flags in the selected mailbox.
Syntax
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 (IMAP Component)
The property includes the collection of mailboxes listed by the server.
Syntax
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.
Please refer to the Mailbox type for a complete list of fields.MailPort Property (IMAP Component)
This property includes the port of the IMAP server (default is 143).
Syntax
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 (IMAP Component)
This property includes the name or address of the mail server (IMAP server).
Syntax
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 (IMAP Component)
This property provides the raw message content.
Syntax
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 (IMAP Component)
This property includes the ContentEncoding of the selected message.
Syntax
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 (IMAP Component)
This property includes the ContentType of the message.
Syntax
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 (IMAP Component)
This property includes the total number of messages on the Mailbox .
Syntax
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 (IMAP Component)
The property includes the time the message was created.
Syntax
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 (IMAP Component)
This property includes the time the message was delivered to the mail server.
Syntax
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 (IMAP Component)
This property contains the flags of the current message.
Syntax
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:
\Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")
This property is not available at design time.
MessageFrom Property (IMAP Component)
This property includes the address of the author of the message.
Syntax
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 (IMAP Component)
This property includes the collection of RFC 822-encoded headers of the message.
Syntax
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.
Please refer to the Header type for a complete list of fields.MessageHeadersString Property (IMAP Component)
This property includes the string version of the RFC 822-encoded headers in the message.
Syntax
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 (IMAP Component)
This property includes the message identifier of the current message.
Syntax
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 (IMAP Component)
This property includes the collection of messages retrieved by RetrieveMessageInfo .
Syntax
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.
Please refer to the MessageInfo type for a complete list of fields.MessageInReplyTo Property (IMAP Component)
This property includes the unique message identifier of the message being replied to.
Syntax
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 (IMAP Component)
This property includes the globally unique identifier of the message.
Syntax
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 (IMAP Component)
This property includes a collection of message parts collected by RetrieveMessageInfo .
Syntax
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.
Please refer to the MessagePart type for a complete list of fields.MessageRecipients Property (IMAP Component)
This property includes a collection of recipients for the current message.
Syntax
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.
Please refer to the MessageRecipient type for a complete list of fields.MessageReplyTo Property (IMAP Component)
This property includes the email addresses to which replies to the message should be sent.
Syntax
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 (IMAP Component)
This property includes the address of the sender of the message.
Syntax
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 (IMAP Component)
This property includes the set of messages to operate on.
Syntax
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 (IMAP Component)
This property includes the size of the selected message.
Syntax
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 (IMAP Component)
This property includes the subject of the message.
Syntax
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 (IMAP Component)
This property includes the body of the retrieved message.
Syntax
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 (IMAP Component)
This property indicates whether or not the component should overwrite files during transfer.
Syntax
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 (IMAP Component)
This property includes the password to be used to authenticate to the MailServer .
Syntax
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 (IMAP Component)
When set to True, the message Seen flag is not changed during reading.
Syntax
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 (IMAP Component)
This property includes the number of new messages in the Mailbox .
Syntax
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.
SortCriteria Property (IMAP Component)
This property sorts criteria to use for message retrieval operations.
Syntax
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:
ARRIVAL | Internal date and time of the message. |
DATE | The value of the message's DATE header, adjusted by time zone. |
CC | The value of the message's CC header. |
FROM | The value of the message's FROM header. |
SUBJECT | The value of the message's SUBJECT header. |
TO | The value of the message's TO header. |
SIZE | The size of the message |
REVERSE <criterion> | Followed by another sort criterion, this sort key has the effect of that criterion but in reverse (descending) order. |
Note: IMAP SORT functionality is relatively new and not all servers may implement it.
SSLAcceptServerCert Property (IMAP Component)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
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.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (IMAP Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
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.
Please refer to the Certificate type for a complete list of fields.SSLEnabled Property (IMAP Component)
This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.
Syntax
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 (IMAP Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public IMAPSSLProviders SSLProvider { get; set; }
enum IMAPSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As ImapSSLProviders
Enum IMAPSSLProviders 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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 (IMAP Component)
This property includes the server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.SSLStartMode Property (IMAP Component)
This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.
Syntax
public IMAPSSLStartModes SSLStartMode { get; set; }
enum IMAPSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone }
Public Property SSLStartMode As ImapSSLStartModes
Enum IMAPSSLStartModes sslAutomatic sslImplicit sslExplicit sslNone End Enum
Default Value
3
Remarks
The SSLStartMode property may have one of the following values:
0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the component will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
2 (sslExplicit) | The component will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. |
3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. |
StartByte Property (IMAP Component)
This property includes the byte index of the position where the transfer should start.
Syntax
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 (IMAP Component)
This property includes the timeout for the component.
Syntax
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 (IMAP Component)
If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.
Syntax
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 (IMAP Component)
This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.
Syntax
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 (IMAP Component)
This property includes the username used to authenticate to the MailServer .
Syntax
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 (IMAP Component)
This method adds the specified flags to the messages specified by MessageSet .
Syntax
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:
\Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
IMAPControl.MessageSet = "1"
IMAPControl.AddMessageFlags("\Deleted")
AppendToMailbox Method (IMAP Component)
This method appends the message in MessageText to the mailbox specified by Mailbox .
Syntax
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 (IMAP Component)
This method sends a CHECK command to the server.
Syntax
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.
CloseMailbox Method (IMAP Component)
This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.
Syntax
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 (IMAP Component)
Sets or retrieves a configuration setting.
Syntax
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 (IMAP Component)
This method connects to an IMAP server.
Syntax
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 (IMAP Component)
This method copies the messages specified by MessageSet to the mailbox specified by Mailbox .
Syntax
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 (IMAP Component)
This method creates a new mailbox specified by Mailbox .
Syntax
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.
DeleteFromMailbox Method (IMAP Component)
The method marks the messages specified by MessageSet as deleted.
Syntax
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 (IMAP Component)
This method deletes a mailbox specified by Mailbox .
Syntax
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 (IMAP Component)
This method deletes mailbox access control rights for a specific user.
Syntax
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 (IMAP Component)
This method disconnects from an IMAP server.
Syntax
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 (IMAP Component)
This method processes events from the internal message queue.
Syntax
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 (IMAP Component)
This method selects a mailbox in read-only mode.
Syntax
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 (IMAP Component)
This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.
Syntax
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 (IMAP Component)
This method retrieves mailbox access control rights.
Syntax
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:
l | Lookup (Visible to be listed) |
r | Read (Can be selected, retrieved, searched, and copied) |
s | Keep (Seen/unseen information across sessions) |
w | Write (Stores flags other than SEEN and DELETED) |
i | Insert (Can be appended and copied into) |
p | Post (Can send mail to submission address for mailbox) |
c | Create (Can create new sub-mailboxes) |
d | Delete (Stores DELETED flag and performs EXPUNGE) |
a | Administer (Set access permissions) |
Interrupt Method (IMAP Component)
This method interrupts the current method.
Syntax
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 (IMAP Component)
This method lists all of the mailboxes matching all criteria in the Mailbox property.
Syntax
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 (IMAP Component)
This method lists all subscribed mailboxes matching all criteria in the Mailbox property.
Syntax
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 (IMAP Component)
This method converts a valid RFC 822 message date to a local date and time.
Syntax
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 (IMAP Component)
This method moves the messages specified by MessageSet to the mailbox specified by Mailbox .
Syntax
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 moves the messages specified by the MessageSet property to the mailbox specified by the Mailbox property.
Noop Method (IMAP Component)
This method sends a NOOP command to the server.
Syntax
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 (IMAP Component)
This method changes the name of Mailbox to NewName .
Syntax
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 (IMAP Component)
This method will reset the component.
Syntax
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 (IMAP Component)
This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .
Syntax
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:
\Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
RetrieveMessageHeaders Method (IMAP Component)
This method retrieves the message headers of the messages specified by the MessageSet property.
Syntax
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 (IMAP Component)
This method retrieves information about messages specified by the MessageSet property.
Syntax
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 (IMAP Component)
This method retrieves the message part specified by PartID.
Syntax
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 (IMAP Component)
This method retrieves the headers of message part specified by PartID.
Syntax
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 (IMAP Component)
This method retrieves the message text of the messages specified by the MessageSet property.
Syntax
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 (IMAP Component)
This method searches the selected mailbox for specified text.
Syntax
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:
<message set> | Messages with message sequence numbers corresponding to the specified message sequence number set. |
ALL | All messages in the mailbox; this is the default initial key for AND-ing. |
ANSWERED | Messages with the \Answered flag set. |
BCC <string> | Messages that contain the specified string in the envelope structure's BCC field. |
BEFORE <date> | Messages whose internal date is earlier than the specified date. |
BODY <string> | Messages that contain the specified string in the body of the message. |
CC <string> | Messages that contain the specified string in the envelope structure's CC field. |
DELETED | Messages with the \Deleted flag set. |
DRAFT | Messages with the \Draft flag set. |
FLAGGED | Messages with the \Flagged flag set. |
FROM <string> | Messages that contain the specified string in the envelope structure's FROM field. |
HEADER <field-name> <string> | Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body. |
KEYWORD <flag> | Messages with the specified keyword set. |
LARGER <n> | Messages with an RFC822.SIZE larger than the specified number of octets. |
NEW | Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT UNSEEN)". |
NOT <search-key> | Messages that do not match the specified search key. |
OLD | Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW"). |
ON <date> | Messages whose internal date is within the specified date. |
OR <search-key1> <search-key2> | Messages that match either search key. |
RECENT | Messages that have the \Recent flag set. |
SEEN | Messages that have the \Seen flag set. |
SENTBEFORE <date> | Messages whose [RFC-822] Date: header is earlier than the specified date. |
SENTON <date> | Messages whose [RFC-822] Date: header is within the specified date. |
SENTSINCE <date> | Messages whose [RFC-822] Date: header is within or later than the specified date. |
SINCE <date> | Messages whose internal date is within or later than the specified date. |
SMALLER <n> | Messages with an RFC822.SIZE smaller than the specified number of octets. |
SUBJECT <string> | Messages that contain the specified string in the envelope structure's SUBJECT field. |
TEXT <string> | Messages that contain the specified string in the header or body of the message. |
TO <string> | Messages that contain the specified string in the envelope structure's TO field. |
UID <message set> | Messages with unique identifiers corresponding to the specified unique identifier set. |
UNANSWERED | Messages that do not have the \Answered flag set. |
UNDELETED | Messages that do not have the \Deleted flag set. |
UNDRAFT | Messages that do not have the \Draft flag set. |
UNFLAGGED | Messages that do not have the \Flagged flag set. |
UNKEYWORD <flag> | Messages that do not have the specified keyword set. |
UNSEEN | Messages that do not have the \Seen flag set. |
SelectMailbox Method (IMAP Component)
This method selects a mailbox.
Syntax
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 (IMAP Component)
This method sends the exact command directly to the server.
Syntax
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 (IMAP Component)
This method sets mailbox access control rights for a specific user.
Syntax
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:
l | Lookup (Visible to be listed) |
r | Read (Can be selected, retrieved, searched, and copied) |
s | Keep (Seen/unseen information across sessions) |
w | Write (Stores flags other than SEEN and DELETED) |
i | Insert (Can be appended and copied into) |
p | Post (Can send mail to submission address for mailbox) |
c | Create (Can create new sub-mailboxes) |
d | Delete (Stores DELETED flag and performs EXPUNGE) |
a | Administer (Set access permissions) |
SetMessageStream Method (IMAP Component)
This method sets the stream to which the message (or message part) downloaded from the server will be written.
Syntax
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 (IMAP Component)
This method begins idling.
Syntax
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 (IMAP Component)
This method stops idling.
Syntax
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 (IMAP Component)
This method subscribes to the mailbox specified by Mailbox .
Syntax
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 (IMAP Component)
This method removes the flags specified by MessageFlags from the messages specified by MessageSet .
Syntax
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:
\Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
UnsubscribeMailbox Method (IMAP Component)
This method unsubscribes from the mailbox specified by Mailbox .
Syntax
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.
ConnectionStatus Event (IMAP Component)
This event is fired to indicate changes in the connection state.
Syntax
public event OnConnectionStatusHandler OnConnectionStatus; public delegate void OnConnectionStatusHandler(object sender, IMAPConnectionStatusEventArgs e); public class IMAPConnectionStatusEventArgs : 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 IMAPConnectionStatusEventArgs) Public Class IMAPConnectionStatusEventArgs Inherits EventArgs Public ReadOnly Property ConnectionEvent As String Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The ConnectionStatus 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:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
EndTransfer Event (IMAP Component)
This event is fired when the message or the part data finishes transferring.
Syntax
public event OnEndTransferHandler OnEndTransfer; public delegate void OnEndTransferHandler(object sender, IMAPEndTransferEventArgs e); public class IMAPEndTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnEndTransfer As OnEndTransferHandler Public Delegate Sub OnEndTransferHandler(sender As Object, e As IMAPEndTransferEventArgs) Public Class IMAPEndTransferEventArgs 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 (IMAP Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, IMAPErrorEventArgs e); public class IMAPErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As IMAPErrorEventArgs) Public Class IMAPErrorEventArgs 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 (IMAP Component)
This event is fired every time a header line comes in.
Syntax
public event OnHeaderHandler OnHeader; public delegate void OnHeaderHandler(object sender, IMAPHeaderEventArgs e); public class IMAPHeaderEventArgs : EventArgs { public string Field { get; } public string Value { get; } }
Public Event OnHeader As OnHeaderHandler Public Delegate Sub OnHeaderHandler(sender As Object, e As IMAPHeaderEventArgs) Public Class IMAPHeaderEventArgs 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 (IMAP Component)
This event fires whenever responses from the server are received while idling.
Syntax
public event OnIdleInfoHandler OnIdleInfo; public delegate void OnIdleInfoHandler(object sender, IMAPIdleInfoEventArgs e); public class IMAPIdleInfoEventArgs : EventArgs { public string Message { get; } public bool Cancel { get; set; } }
Public Event OnIdleInfo As OnIdleInfoHandler Public Delegate Sub OnIdleInfoHandler(sender As Object, e As IMAPIdleInfoEventArgs) Public Class IMAPIdleInfoEventArgs 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 (IMAP Component)
This event fires for each set of access control rights returned by the server.
Syntax
public event OnMailboxACLHandler OnMailboxACL; public delegate void OnMailboxACLHandler(object sender, IMAPMailboxACLEventArgs e); public class IMAPMailboxACLEventArgs : 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 IMAPMailboxACLEventArgs) Public Class IMAPMailboxACLEventArgs 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:
l | Lookup (Visible to be listed) |
r | Read (Can be selected, retrieved, searched, and copied) |
s | Keep (Seen/unseen information across sessions) |
w | Write (Stores flags other than SEEN and DELETED) |
i | Insert (Can be appended and copied into) |
p | Post (Can send mail to submission address for mailbox) |
c | Create (Can create new sub-mailboxes) |
d | Delete (Stores DELETED flag and performs EXPUNGE) |
a | Administer (Set access permissions) |
MailboxList Event (IMAP Component)
This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.
Syntax
public event OnMailboxListHandler OnMailboxList; public delegate void OnMailboxListHandler(object sender, IMAPMailboxListEventArgs e); public class IMAPMailboxListEventArgs : 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 IMAPMailboxListEventArgs) Public Class IMAPMailboxListEventArgs 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 (IMAP Component)
This event is fired with information for the messages retrieved by the server.
Syntax
public event OnMessageInfoHandler OnMessageInfo; public delegate void OnMessageInfoHandler(object sender, IMAPMessageInfoEventArgs e); public class IMAPMessageInfoEventArgs : 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 IMAPMessageInfoEventArgs) Public Class IMAPMessageInfoEventArgs 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 (IMAP Component)
This event is fired for each message part when RetrieveMessageInfo is called.
Syntax
public event OnMessagePartHandler OnMessagePart; public delegate void OnMessagePartHandler(object sender, IMAPMessagePartEventArgs e); public class IMAPMessagePartEventArgs : 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 IMAPMessagePartEventArgs) Public Class IMAPMessagePartEventArgs 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 (IMAP Component)
This event traces the commands sent to the mail server, and the respective replies.
Syntax
public event OnPITrailHandler OnPITrail; public delegate void OnPITrailHandler(object sender, IMAPPITrailEventArgs e); public class IMAPPITrailEventArgs : EventArgs { public int Direction { get; } public string Message { get; } }
Public Event OnPITrail As OnPITrailHandler Public Delegate Sub OnPITrailHandler(sender As Object, e As IMAPPITrailEventArgs) Public Class IMAPPITrailEventArgs 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:
0 (Client) | The Message originates from the client. |
1 (Server) | The Message originates from the server. |
2 (Information) | The Message is an informative message originating from the client software (the component code). |
SSLServerAuthentication Event (IMAP Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, IMAPSSLServerAuthenticationEventArgs e); public class IMAPSSLServerAuthenticationEventArgs : 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 IMAPSSLServerAuthenticationEventArgs) Public Class IMAPSSLServerAuthenticationEventArgs 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 (IMAP Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, IMAPSSLStatusEventArgs e); public class IMAPSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As IMAPSSLStatusEventArgs) Public Class IMAPSSLStatusEventArgs 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 (IMAP Component)
This event is fired when the message body or the part data start transferring.
Syntax
public event OnStartTransferHandler OnStartTransfer; public delegate void OnStartTransferHandler(object sender, IMAPStartTransferEventArgs e); public class IMAPStartTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnStartTransfer As OnStartTransferHandler Public Delegate Sub OnStartTransferHandler(sender As Object, e As IMAPStartTransferEventArgs) Public Class IMAPStartTransferEventArgs 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 (IMAP Component)
This event is fired while the message is transferred from the MailServer .
Syntax
public event OnTransferHandler OnTransfer; public delegate void OnTransferHandler(object sender, IMAPTransferEventArgs e); public class IMAPTransferEventArgs : 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 IMAPTransferEventArgs) Public Class IMAPTransferEventArgs 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
EffectiveDate
string (read-only)
Default: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
string (read-only)
Default: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string (read-only)
Default: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
bool (read-only)
Default: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
string (read-only)
Default: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
string (read-only)
Default: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
string
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte []
Default: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
string (read-only)
Default: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string (read-only)
Default: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
string
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte []
Default: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Public Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
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)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
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)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
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())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
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)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
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)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
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())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
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
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
string
Default: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the component throws an exception.
Password
string
Default: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.
Port
int
Default: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
string
Default: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
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
Field
string
Default: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
string
Default: ""
This field contains the Header contents.
Constructors
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
Flags
string (read-only)
Default: ""
This field contains the mailbox flags in a mailbox listing.
Examples of possible flag values are server dependent, but they can include the following:
\Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
Name
string (read-only)
Default: ""
This field contains the mailbox name in a mailbox listing.
Separator
string (read-only)
Default: ""
The Separator field contains the character that separates the different parts in the mailbox path hierarchy.
Constructors
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
Date
string (read-only)
Default: ""
This field contains the date of a message in a message information listing. This date is taken from the ENVELOPE structure of the message.
Flags
string (read-only)
Default: ""
This field contains a message flag in a message information listing.
Examples of possible flag values are server dependent, but they can include the following:
\Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
\Seen | Mark a message as read. |
\Answered | Mark a message as answered. |
\Flagged | Mark a message as flagged. |
\Draft | Mark a message as being incomplete (under composition). |
From
string (read-only)
Default: ""
This field contains the sender of a message in a message information listing.
MessageId
string (read-only)
Default: ""
The unique identifier of a message in a message information listing.
Size
long (read-only)
Default: 0
This field contains the size of a message in a message information listing.
Subject
string (read-only)
Default: ""
This field contains the subject of a message in a message information listing.
Constructors
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
ContentDisposition
string (read-only)
Default: ""
This field shows the value of the Content-Disposition header of the message part.
ContentEncoding
string (read-only)
Default: ""
This field shows how the data are encoded.
ContentId
string (read-only)
Default: ""
This field shows the value of the Content-Id header of the message part.
ContentType
string (read-only)
Default: ""
This field shows the type of data contained in the message part.
FileName
string (read-only)
Default: ""
This field shows the filename corresponding to the part (if the part was included in the message as an attached file).
Id
string (read-only)
Default: ""
This field contains the identifier of a part listing that may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs.
MultipartMode
string (read-only)
Default: ""
This field shows how this part relates to the message's whole multipart structure (e.g., 'mixed' or 'alternative').
Parameters
string (read-only)
Default: ""
This field contains the additional parameters passed to the ContentType header, such as the part charset.
Size
long (read-only)
Default: 0
This field contains the size of a part in a message part listing.
Constructors
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
Address
string
Default: ""
This field contains the email address of the recipient.
Name
string
Default: ""
This field contains the name of the recipient.
Options
string
Default: ""
This field contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).
One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.
component.MessageRecipients(0).Options = "NOTIFY SUCCESS,FAILURE,DELAY";
RecipientType
EmailRecipientTypes
Default: 0
This field contains the recipient type: To, Cc, or Bcc.
Constructors
public MessageRecipient();
Public MessageRecipient()
public MessageRecipient(string address);
Public MessageRecipient(ByVal Address As String)
public MessageRecipient(string address, int recipientType);
Public MessageRecipient(ByVal Address As String, ByVal RecipientType As Integer)
Config Settings (IMAP Component)
The component accepts one or more of the following configuration settings. Configuration 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.
IMAP Config Settings
The default value for this setting is False.
The date-time should be formatted according to the IMAP RFC specifications. For example, "22-Jan-2013 12:34:56 -0500" indicates January 22nd, 2013, at 12:34:56 PM EST.
By default, if this setting is not specified, no date-time is sent with the APPEND request, and the server will use the current time.
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q
Note: When using amXOAUTH2, User must be specified, but Password is not required.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
This configuration setting specifies whether the component will use the IMAP4 Id extension defined in RFC 2971 and send the Id command to the server. When set to true, the component will send the Id command with the value IPWorksIMAP if the server supports this as defined in the server's response to the CAPABILITY command.
The default value is false, and this command will not be sent.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
If set to True, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (IMAP Component)
IMAP Errors
118 | Firewall error. Error message contains detailed description. |
311 | Protocol error. |
312 | Busy executing current method. |
314 | A Mailbox must be selected before calling this method. |
315 | Invalid argument. Please specify a valid MessageSet. |
317 | Unknown content encoding. |
318 | LocalFile already exists and overwrite is False. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the component is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
303 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |