IPWorks OpenPGP 2022 .NET Edition
Version 22.0 [Build 8369]

PIMAP Component

Properties   Methods   Events   Config Settings   Errors  

The PIMAP component is used to communicate with IMAP servers to retrieve and process OpenPGP encrypted and/or signed messages and any attachments.

Syntax

nsoftware.IPWorksOpenPGP.Pimap

Remarks

The PIMAP component offers an easy-to-use interface: it implements a standard IMAP client, as specified in RFC 1730 and RFC 2060, and supports decrypting and verifying signatures of encrypted and signed emails using OpenPGP. Additionally, it enables you to create messages bound for multiple recipients with different keys, simultaneously encrypt and compress with the most popular compression algorithms, and control other aspects such as the encrypting algorithm to use.

Connect to a Mail Server

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.

Examine a Mailbox

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 shows the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent via the component's methods. The 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, MessageFlags, etc.

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

Decrypt

To process an encrypted or signed message, first retrieve the message text and headers by calling FetchMessageHeaders and FetchMessageText. To decrypt a message specify the private key to be used for decryption by adding a key to Keys. For instance: pimap.Keys.Add(new Key("c:\\my_keyring_dir", "recipient@nsoftware.com")); pimap.Keys[0].Passphrase = "password"; The specified private key will be used to decrypt the message when calling Decrypt.

Verify

To verify the signature of a message specify the public key to be used for signature verification by adding a key to SignerKeys. For instance: pimap.Keys.Add(new Key("c:\\my_keyring_dir", "sender@nsoftware.com")); The specified public key will be used to verify the signature when calling VerifySignature. To decrypt and verify in one step call DecryptAndVerifySignature.

Retrieve MIME Message Parts

The MessagePart event describes the MIME structure of retrieved messages. One MessagePart event is fired for every message part, giving information about the particular part. Later on, message parts may be retrieved separately through the FetchMessagePart method. This speeds up processing by avoiding the need to retrieve full messages from the server.

Trace Client and Server Communication

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.

AuthMechanismThis property includes the authentication mechanism to be used when connecting to the mail server.
AutoDecodePartsThis property determines whether or not to automatically decode message parts.
Command*This property is deprecated. Please use the SendCommand method instead.
ConnectedThis shows whether the component is connected.
EndByteThis property includes the byte index of the position where the transfer should end.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
KeysA collection of keys used for cryptographic operations.
LastReplyThe last reply from the server.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MailboxThis property includes the name of the mailbox selected on the server.
MailboxFlagsThis property defines flags in the selected mailbox.
MailboxListThe property includes the collection of mailboxes listed by the server.
MailPortThis property includes the port of the IMAP server (default is 143).
MailServerThis property includes the name or address of the mail server (IMAP server).
MessageThis property provides the raw message content.
MessageContentEncodingThis property includes the ContentEncoding of the selected message.
MessageContentTypeThis property includes the ContentType of the message.
MessageCountThis property includes the total number of messages on the Mailbox .
MessageDateThe property includes the time the message was created.
MessageDeliveryTimeThis property includes the time the message was delivered to the mail server.
MessageFlagsThis property contains the flags of the current message.
MessageFromThis property includes the address of the author of the message.
MessageHeadersThis property includes the collection of RFC 822-encoded headers of the message.
MessageHeadersStringThis property includes the string version of the RFC 822-encoded headers in the message.
MessageIdThis property includes the message identifier of the current message.
MessageInfoThis property includes the collection of messages retrieved by FetchMessageInfo .
MessageInReplyToThis property includes the unique message identifier of the message being replied to.
MessageNetIdThis property includes the globally unique identifier of the message.
MessagePartsThis property includes a collection of message parts collected by FetchMessageInfo .
MessageRecipientsThis property includes a collection of recipients for the current message.
MessageReplyToThis property includes the email addresses to which replies to the message should be sent.
MessageSenderThis property includes the address of the sender of the message.
MessageSetThis property includes the set of messages to operate on.
MessageSizeThis property includes the size of the selected message.
MessageSubjectThis property includes the subject of the message.
MessageTextThis property includes the body of the retrieved message.
OverwriteThis property indicates whether or not the component should overwrite files during transfer.
PasswordThis property includes the password to be used to authenticate to the MailServer .
PeekModeWhen set to True, the message Seen flag is not changed during reading.
RecentMessageCountThis property includes the number of new messages in the Mailbox .
SignerKeysThe collection of keys belonging to the signer of the message.
SortCriteriaThis property sorts criteria to use for message retrieval operations.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLEnabledWhether TLS/SSL is enabled.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertThe server certificate for the last established connection.
SSLStartModeDetermines how the component starts the SSL negotiation.
StartByteThis property includes the byte index of the position where the transfer should start.
TimeoutA timeout for the component.
UIDModeIf True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers.
UIDValidityThis property includes the UIDValidity parameter sent from the server in response to SelectMailbox command.
UserThis 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.

AddMessageFlagsThis method adds the specified flags to the messages specified by MessageSet .
AppendToMailboxThis method appends the message in MessageText to the mailbox specified by Mailbox .
CheckMailboxThis method sends a CHECK command to the server.
CloseMailboxThis method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox.
ConfigSets or retrieves a configuration setting.
ConnectThis method connects to an IMAP server.
CopyToMailboxThis method copies the messages specified by MessageSet to the mailbox specified by Mailbox .
CreateMailboxThis method creates a new mailbox specified by Mailbox .
DecryptDecrypts the message.
DecryptAndVerifySignatureDecrypts and verifies the signature of the message.
DeleteFromMailboxThe method marks the messages specified by MessageSet as deleted.
DeleteMailboxThis method deletes a mailbox specified by Mailbox .
DeleteMailboxACLThis method deletes mailbox access control rights for a specific user.
DisconnectThis method disconnects from an IMAP server.
DoEventsProcesses events from the internal message queue.
ExamineMailboxThis method selects a mailbox in read-only mode.
ExpungeMailboxThis method removes all messages marked with a 'Deleted' flag from the currently selected mailbox.
FetchMessageHeadersThis method retrieves the message headers of the messages specified by the MessageSet property.
FetchMessageInfoThis method retrieves information about messages specified by the MessageSet property.
FetchMessagePartThis method retrieves the message part specified by PartID.
FetchMessagePartHeadersThis method retrieves the headers of message part specified by PartID.
FetchMessageTextThis method retrieves the message text of the messages specified by the MessageSet property.
GetMailboxACLThis method retrieves mailbox access control rights.
InterruptInterrupt the current method.
ListMailboxesThis method lists all of the mailboxes matching all criteria in the Mailbox property.
ListSubscribedMailboxesThis method lists all subscribed mailboxes matching all criteria in the Mailbox property.
LocalizeDateThis method converts a valid RFC 822 message date to a local date and time.
MoveToMailboxThis method moves the messages specified by MessageSet to the mailbox specified by Mailbox .
NoopThis method sends a NOOP command to the server.
RenameMailboxThis method changes the name of Mailbox to NewName .
ResetMessageFlagsThis method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags .
SearchMailboxThis method searches the selected mailbox for specified text.
SelectMailboxThis method selects a mailbox.
SetMailboxACLThis method sets mailbox access control rights for a specific user.
SetMessageStreamThis method sets the stream to which the message (or message part) downloaded from the server will be written.
StartIdleThis method begins idling.
StopIdleThis method stops idling.
SubscribeMailboxThis method subscribes to the mailbox specified by Mailbox .
UnsetMessageFlagsThis method removes the flags specified by MessageFlags from the messages specified by MessageSet .
UnsubscribeMailboxThis method unsubscribes from the mailbox specified by Mailbox .
VerifySignatureVerifies the signature of the current message.

Event List


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

ConnectionStatusThis event is fired to indicate changes in the connection state.
EndTransferThis event is fired when the message or the part data finishes transferring.
ErrorInformation about errors during data delivery.
HeaderThis event is fired every time a header line comes in.
IdleInfoThis event fires whenever responses from the server are received while idling.
KeyPassphraseFired if the passphrase of current key is incorrect or empty.
MailboxACLThis event fires for each set of access control rights returned by the server.
MailboxListThis event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods.
MessageInfoThis event is fired with information for the messages retrieved by the server.
MessagePartThis event is fired for each message part when FetchMessageInfo is called.
PITrailThis event traces the commands sent to the mail server, and the respective replies.
ProgressFired as progress is made.
RecipientInfoFired for each recipient key of the encrypted message.
SignatureInfoFired during verification of the signed message.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferThis event is fired when the message body or the part data start transferring.
StatusShows the progress of the operation.
TransferThis event is fired while the message is transferred from the MailServer .
VerificationStatusFired after verification of the signed message.

Config Settings


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

CommentThe OpenPGP message comment.
LogLevelSpecifies the level of detail that is logged.
ProcessAttachmentsWhether or not to process attachments.
RequireValidSignatureSpecifies if an invalid signature is considered an error condition.
SymmetricPassphraseThe password used for symmetric encryption or decryption.
VersionHeaderThe Version header value in the ASCII armored OpenPGP message.
AlwaysReturnUIDsInstructs the server to return UIDs even if not in UIDMode.
AppendToMailboxDateTimeSpecifies the date-time parameter used in the initial APPEND request.
AuthorizationIdentityThe value to use as the authorization identity when SASL authentication is used.
AutoDecodeTextWhether to decode MessageText when AutoDecodeParts is True.
FetchAfterSearchDetermines if messages matching the SearchCriteria are fetched after calling SearchMailbox.
FetchTextAndHeadersSpecifies whether the message body and headers are fetched in a single request.
HeaderLimitInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
IncludeHeadersInstructs the component to include the headers in the LocalFile.
MailboxLimitInstructs component to save the amount of mailboxes specified that are returned by the server after a ListMailboxes call has been made.
MaskSensitiveWhether sensitive properties should be masked when logging.
MessageHeadersStringFoldedWhether the MessageHeadersString property should contain folded headers.
MessageInfoLimitInstructs component to save the amount of messages specified that are returned by the server after a FetchMessageInfo call has been made.
MessagePartLimitInstructs component to save the amount of message parts specified that are returned by the server after a FetchMessageInfo call has been made.
SendIDCommandInstructs component to send the ID command if the server advertises support for it.
UTF7MailboxNamesSpecifies whether or not to automatically encode and decode UTF-7 mailbox names.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (TCPClient only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

AuthMechanism Property (PIMAP Component)

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

Syntax

public PimapAuthMechanisms AuthMechanism { get; set; }

enum PimapAuthMechanisms { amUserPassword, amCRAMMD5, amNTLM, amAPOP, amSASLPlain, amSASLDigestMD5, amKerberos, amXOAUTH2 }
Public Property AuthMechanism As PimapAuthMechanisms

Enum PimapAuthMechanisms 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 (PIMAP Component)

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

Syntax

public bool AutoDecodeParts { get; set; }
Public Property AutoDecodeParts As Boolean

Default Value

False

Remarks

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

Command Property (PIMAP Component)

This property can be used to send additional commands directly to the server.

Syntax

public string Command { set; }
Public WriteOnly Property Command As String

Default Value

""

Remarks

Setting this property directs the component to send the assigned command to the MailServer.

Check the LastReply property or trap the PITrail events coming from the server to get the responses.

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

Connected Property (PIMAP Component)

This shows whether the component is connected.

Syntax

public bool Connected { get; set; }
Public Property Connected As Boolean

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

EndByte Property (PIMAP Component)

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

Syntax

public long EndByte { get; set; }
Public Property EndByte As Long

Default Value

0

Remarks

StartByte and EndByte are used together with the FetchMessagePart 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 (PIMAP Component)

A set of properties related to firewall access.

Syntax

public Firewall Firewall { get; set; }
Public Property Firewall As Firewall

Remarks

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

Idle Property (PIMAP Component)

The current status of the component.

Syntax

public bool Idle { get; }
Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

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

This property is read-only.

Keys Property (PIMAP Component)

A collection of keys used for cryptographic operations.

Syntax

public KeyList Keys { get; }
Public Property Keys As KeyList

Remarks

This collection holds keys that are used for signing and decrypting. In most cases only one key will be specified, however multiple keys may be needed in some cases.

This property is not available at design time.

LastReply Property (PIMAP Component)

The last reply from the server.

Syntax

public string LastReply { get; }
Public ReadOnly Property LastReply As String

Default Value

""

Remarks

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

This property is read-only.

LocalHost Property (PIMAP Component)

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

Syntax

public string LocalHost { get; set; }
Public Property LocalHost As String

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 multi-homed 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 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 multi-homed 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 (PIMAP Component)

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

Syntax

public string Mailbox { get; set; }
Public Property Mailbox As String

Default Value

"Inbox"

Remarks

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

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

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

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

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

MailboxFlags Property (PIMAP Component)

This property defines flags in the selected mailbox.

Syntax

public string MailboxFlags { get; }
Public ReadOnly Property MailboxFlags As String

Default Value

""

Remarks

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

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

MailboxList Property (PIMAP 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.

MailPort Property (PIMAP Component)

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

Syntax

public int MailPort { get; set; }
Public Property MailPort As Integer

Default Value

143

Remarks

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

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

This property is not available at design time.

MailServer Property (PIMAP Component)

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

Syntax

public string MailServer { get; set; }
Public Property MailServer As String

Default Value

""

Remarks

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

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

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

Message Property (PIMAP Component)

This property provides the raw message content.

Syntax

public string Message { get; set; }
public byte[] MessageB { get; set; }
Public Property Message As String
Public Property MessageB As Byte()

Default Value

""

Remarks

This property is populated after calling FetchMessagePart 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 (PIMAP 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 FetchMessageInfo method.

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

MessageContentType Property (PIMAP Component)

This property includes the ContentType of the message.

Syntax

public string MessageContentType { get; }
Public ReadOnly Property MessageContentType As String

Default Value

""

Remarks

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

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

MessageCount Property (PIMAP Component)

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

Syntax

public int MessageCount { get; }
Public ReadOnly Property MessageCount As Integer

Default Value

0

Remarks

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

This property is read-only.

MessageDate Property (PIMAP Component)

The property includes the time the message was created.

Syntax

public string MessageDate { get; }
Public ReadOnly Property MessageDate As String

Default Value

""

Remarks

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

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

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

MessageDeliveryTime Property (PIMAP Component)

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

Syntax

public string MessageDeliveryTime { get; }
Public ReadOnly Property MessageDeliveryTime As String

Default Value

""

Remarks

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

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

MessageFlags Property (PIMAP Component)

This property contains the flags of the current message.

Syntax

public string MessageFlags { get; set; }
Public Property MessageFlags As String

Default Value

""

Remarks

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

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

\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).

Example. Setting MessageFlags:

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

This property is not available at design time.

MessageFrom Property (PIMAP Component)

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

Syntax

public string MessageFrom { get; }
Public ReadOnly Property MessageFrom As String

Default Value

""

Remarks

This property normally has the same value as MessageSender.

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

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

MessageHeaders Property (PIMAP 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 FetchMessageHeaders or the FetchMessagePartHeaders method.

This property is not available at design time.

MessageHeadersString Property (PIMAP Component)

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

Syntax

public string MessageHeadersString { get; set; }
Public Property MessageHeadersString As String

Default Value

""

Remarks

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

This property is not available at design time.

MessageId Property (PIMAP Component)

This property includes the message identifier of the current message.

Syntax

public string MessageId { get; }
Public ReadOnly Property MessageId As String

Default Value

""

Remarks

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

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

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

MessageInfo Property (PIMAP Component)

This property includes the collection of messages retrieved by FetchMessageInfo .

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.

MessageInReplyTo Property (PIMAP Component)

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

Syntax

public string MessageInReplyTo { get; }
Public ReadOnly Property MessageInReplyTo As String

Default Value

""

Remarks

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

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

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

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

MessageNetId Property (PIMAP Component)

This property includes the globally unique identifier of the message.

Syntax

public string MessageNetId { get; }
Public ReadOnly Property MessageNetId As String

Default Value

""

Remarks

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

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

MessageParts Property (PIMAP Component)

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

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 FetchMessageInfo. Once the message is received from the server, the component parses the different parts and their corresponding information into the MESSAGEPARTS collection. Each MessagePart contains a unique Id.

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

This collection is indexed from 0 to count -1.

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

MessageRecipients Property (PIMAP 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 FetchMessageInfo method is called.

This collection is indexed from 0 to count -1.

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

MessageReplyTo Property (PIMAP Component)

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

Syntax

public string MessageReplyTo { get; }
Public ReadOnly Property MessageReplyTo As String

Default Value

""

Remarks

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

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

MessageSender Property (PIMAP Component)

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

Syntax

public string MessageSender { get; }
Public ReadOnly Property MessageSender As String

Default Value

""

Remarks

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

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

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

MessageSet Property (PIMAP Component)

This property includes the set of messages to operate on.

Syntax

public string MessageSet { get; set; }
Public Property MessageSet As String

Default Value

""

Remarks

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

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

Example 1. Setting MessageSet:

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

MessageSize Property (PIMAP Component)

This property includes the size of the selected message.

Syntax

public long MessageSize { get; }
Public ReadOnly Property MessageSize As Long

Default Value

0

Remarks

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

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

MessageSubject Property (PIMAP Component)

This property includes the subject of the message.

Syntax

public string MessageSubject { get; }
Public ReadOnly Property MessageSubject As String

Default Value

""

Remarks

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

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

MessageText Property (PIMAP Component)

This property includes the body of the retrieved message.

Syntax

public string MessageText { get; set; }
Public Property MessageText As String

Default Value

""

Remarks

The component fills out this property with the contents of the message body (in RFC 822 format) when a call to FetchMessageText completes successfully.

This property is not available at design time.

Overwrite Property (PIMAP Component)

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

Syntax

public bool Overwrite { get; set; }
Public Property Overwrite As Boolean

Default Value

False

Remarks

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

Password Property (PIMAP Component)

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

Syntax

public string Password { get; set; }
Public Property Password As String

Default Value

""

Remarks

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

PeekMode Property (PIMAP Component)

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

Syntax

public bool PeekMode { get; set; }
Public Property PeekMode As Boolean

Default Value

False

Remarks

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

This property is not available at design time.

RecentMessageCount Property (PIMAP Component)

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

Syntax

public int RecentMessageCount { get; }
Public ReadOnly Property RecentMessageCount As Integer

Default Value

0

Remarks

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

This property is read-only.

SignerKeys Property (PIMAP Component)

The collection of keys belonging to the signer of the message.

Syntax

public KeyList SignerKeys { get; }
Public Property SignerKeys As KeyList

Remarks

This property contains the keys of the message signer.

Set this property before calling VerifySignature or DecryptAndVerifySignature.

This property is not available at design time.

SortCriteria Property (PIMAP Component)

This property sorts criteria to use for message retrieval operations.

Syntax

public string SortCriteria { get; set; }
Public Property SortCriteria As String

Default Value

""

Remarks

This property sorts criteria to use for message retrieval operations. When set, the component will send the SORT command to the server before any retrieval. If the server supports the SORT command, the results from the fetch 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:

ARRIVALInternal date and time of the message.
DATEThe 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.
SIZEThe 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 (PIMAP Component)

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.

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

SSLCert Property (PIMAP Component)

The certificate to be used during SSL negotiation.

Syntax

public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate

Remarks

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

SSLEnabled Property (PIMAP Component)

Whether TLS/SSL is enabled.

Syntax

public bool SSLEnabled { get; set; }
Public Property SSLEnabled As Boolean

Default Value

False

Remarks

This setting 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 (PIMAP Component)

This specifies the SSL/TLS implementation to use.

Syntax

public PimapSSLProviders SSLProvider { get; set; }

enum PimapSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As PimapSSLProviders

Enum PimapSSLProviders 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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.

Additional Notes

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 async library does not support the platform implementation on Linux or macOS and will use the internal provider on those platforms.

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

SSLServerCert Property (PIMAP Component)

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.

SSLStartMode Property (PIMAP Component)

Determines how the component starts the SSL negotiation.

Syntax

public PimapSSLStartModes SSLStartMode { get; set; }

enum PimapSSLStartModes { sslAutomatic, sslImplicit, sslExplicit, sslNone }
Public Property SSLStartMode As PimapSSLStartModes

Enum PimapSSLStartModes 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 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 (PIMAP Component)

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

Syntax

public long StartByte { get; set; }
Public Property StartByte As Long

Default Value

0

Remarks

StartByte and EndByte are used together with the FetchMessagePart 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 (PIMAP Component)

A timeout for the component.

Syntax

public int Timeout { get; set; }
Public Property Timeout As Integer

Default Value

60

Remarks

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

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 (PIMAP Component)

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

Syntax

public bool UIDMode { get; set; }
Public Property UIDMode As Boolean

Default Value

False

Remarks

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

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

This property is not available at design time.

UIDValidity Property (PIMAP Component)

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

Syntax

public string UIDValidity { get; }
Public ReadOnly Property UIDValidity As String

Default Value

""

Remarks

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

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

User Property (PIMAP Component)

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

Syntax

public string User { get; set; }
Public Property User As String

Default Value

""

Remarks

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

AddMessageFlags Method (PIMAP 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).

Example. Setting Adding Message Flags:

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

AppendToMailbox Method (PIMAP 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 (PIMAP 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 (PIMAP 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 (PIMAP Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);
Public Function Config(ByVal ConfigurationString As String) As String

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

Remarks

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

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

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

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

Connect Method (PIMAP 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 (PIMAP 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 (PIMAP 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.

Decrypt Method (PIMAP Component)

Decrypts the message.

Syntax

public void Decrypt();

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

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

Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in Keys. Before decryption begins the component will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

DecryptAndVerifySignature Method (PIMAP Component)

Decrypts and verifies the signature of the message.

Syntax

public void DecryptAndVerifySignature();

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

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

Remarks

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

This method may be used when the data is signed, encrypted, or signed and encrypted. For instance, if the data is encrypted but not signed you may still use this method and the component will perform the decryption without error.

The message will be decrypted using the keys specified in Keys. Before decryption begins the component will fire the RecipientInfo event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into Keys.

The message will be verified using the keys specified in SignerKeys. Before verification begins the component will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the component throws an exception. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

NOTE: This method does not attempt to check the validity of the signing key itself.

DeleteFromMailbox Method (PIMAP 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 (PIMAP 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 (PIMAP 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 (PIMAP 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 (PIMAP Component)

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 (PIMAP 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 (PIMAP 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()

FetchMessageHeaders Method (PIMAP Component)

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

Syntax

public void FetchMessageHeaders();

Async Version
public async Task FetchMessageHeaders();
public async Task FetchMessageHeaders(CancellationToken cancellationToken);
Public Sub FetchMessageHeaders()

Async Version
Public Sub FetchMessageHeaders() As Task
Public Sub FetchMessageHeaders(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.

FetchMessageInfo Method (PIMAP Component)

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

Syntax

public void FetchMessageInfo();

Async Version
public async Task FetchMessageInfo();
public async Task FetchMessageInfo(CancellationToken cancellationToken);
Public Sub FetchMessageInfo()

Async Version
Public Sub FetchMessageInfo() As Task
Public Sub FetchMessageInfo(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).

FetchMessagePart Method (PIMAP Component)

This method retrieves the message part specified by PartID.

Syntax

public void FetchMessagePart(string partId);

Async Version
public async Task FetchMessagePart(string partId);
public async Task FetchMessagePart(string partId, CancellationToken cancellationToken);
Public Sub FetchMessagePart(ByVal PartId As String)

Async Version
Public Sub FetchMessagePart(ByVal PartId As String) As Task
Public Sub FetchMessagePart(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, and the Transfer events denote the progress. If the LocalFile property contains an empty string, the message part is stored in the MessageText property and also is provided through the Transfer event.

The part identifiers for each message part (if any) are provided through the corresponding MessagePart events.

FetchMessagePartHeaders Method (PIMAP Component)

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

Syntax

public void FetchMessagePartHeaders(string partId);

Async Version
public async Task FetchMessagePartHeaders(string partId);
public async Task FetchMessagePartHeaders(string partId, CancellationToken cancellationToken);
Public Sub FetchMessagePartHeaders(ByVal PartId As String)

Async Version
Public Sub FetchMessagePartHeaders(ByVal PartId As String) As Task
Public Sub FetchMessagePartHeaders(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.

FetchMessageText Method (PIMAP Component)

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

Syntax

public void FetchMessageText();

Async Version
public async Task FetchMessageText();
public async Task FetchMessageText(CancellationToken cancellationToken);
Public Sub FetchMessageText()

Async Version
Public Sub FetchMessageText() As Task
Public Sub FetchMessageText(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, and the Transfer events denote the progress. If the LocalFile property contains an empty string, the text is stored in the MessageText property and also is provided through the Transfer event.

GetMailboxACL Method (PIMAP 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:

lLookup (Visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep (Seen/unseen information across sessions)
wWrite (Stores flags other than SEEN and DELETED)
iInsert (Can be appended and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Stores DELETED flag and performs EXPUNGE)
aAdminister (Set access permissions)

Interrupt Method (PIMAP Component)

Interrupt 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 (PIMAP 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 (PIMAP 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 (PIMAP Component)

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

Syntax

public string LocalizeDate(string dateTime);

Async Version
public async Task<string> LocalizeDate(string dateTime);
public async Task<string> LocalizeDate(string dateTime, CancellationToken cancellationToken);
Public Function LocalizeDate(ByVal DateTime As String) As String

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

Remarks

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

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

MoveToMailbox Method (PIMAP 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 (PIMAP 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 (PIMAP 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.

ResetMessageFlags Method (PIMAP 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).

SearchMailbox Method (PIMAP 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 FetchMessageInfo 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.
ALLAll messages in the mailbox; this is the default initial key for AND-ing.
ANSWEREDMessages 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 (PIMAP 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

SetMailboxACL Method (PIMAP Component)

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

Syntax

public void SetMailboxACL(string user, string rights);

Async Version
public async Task SetMailboxACL(string user, string rights);
public async Task SetMailboxACL(string user, string rights, CancellationToken cancellationToken);
Public Sub SetMailboxACL(ByVal User As String, ByVal Rights As String)

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

Remarks

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

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

Standard rights include the following:

lLookup (Visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep (Seen/unseen information across sessions)
wWrite (Stores flags other than SEEN and DELETED)
iInsert (Can be appended and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Stores DELETED flag and performs EXPUNGE)
aAdminister (Set access permissions)

SetMessageStream Method (PIMAP 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 Retrieve method is 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 Retrieve. The downloaded content will be written starting at the current position in the stream.

Note: SetMessageStream and LocalFile will reset the other.

StartIdle Method (PIMAP 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 (PIMAP 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 (PIMAP 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 (PIMAP 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 (PIMAP 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.

VerifySignature Method (PIMAP Component)

Verifies the signature of the current message.

Syntax

public void VerifySignature();

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

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

Remarks

This method verifies the signature of the message.

The message will be verified using the keys specified in SignerKeys. Before verification begins the component will fire the SignatureInfo event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into SignerKeys.

By default, if the signature is not valid the component throws an exception. The configuration setting RequireValidSignature may be set to False to disable this requirement. When RequireValidSignature is set to False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation.

ConnectionStatus Event (PIMAP Component)

This event is fired to indicate changes in the connection state.

Syntax

public event OnConnectionStatusHandler OnConnectionStatus;

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

public class PimapConnectionStatusEventArgs : 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 PimapConnectionStatusEventArgs)

Public Class PimapConnectionStatusEventArgs 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.

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

EndTransfer Event (PIMAP 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, PimapEndTransferEventArgs e);

public class PimapEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}
Public Event OnEndTransfer As OnEndTransferHandler

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

Public Class PimapEndTransferEventArgs 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 (PIMAP Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

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

public class PimapErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}
Public Event OnError As OnErrorHandler

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

Public Class PimapErrorEventArgs 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.

ErrorCode contains an error code and Description 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 (PIMAP Component)

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

Syntax

public event OnHeaderHandler OnHeader;

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

public class PimapHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}
Public Event OnHeader As OnHeaderHandler

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

Public Class PimapHeaderEventArgs 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 (PIMAP Component)

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

Syntax

public event OnIdleInfoHandler OnIdleInfo;

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

public class PimapIdleInfoEventArgs : EventArgs {
  public string Message { get; }
  public bool Cancel { get; set; }
}
Public Event OnIdleInfo As OnIdleInfoHandler

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

Public Class PimapIdleInfoEventArgs 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

KeyPassphrase Event (PIMAP Component)

Fired if the passphrase of current key is incorrect or empty.

Syntax

public event OnKeyPassphraseHandler OnKeyPassphrase;

public delegate void OnKeyPassphraseHandler(object sender, PimapKeyPassphraseEventArgs e);

public class PimapKeyPassphraseEventArgs : EventArgs {
  public string UserId { get; }
  public string KeyId { get; }
  public string Passphrase { get; set; }
}
Public Event OnKeyPassphrase As OnKeyPassphraseHandler

Public Delegate Sub OnKeyPassphraseHandler(sender As Object, e As PimapKeyPassphraseEventArgs)

Public Class PimapKeyPassphraseEventArgs Inherits EventArgs
  Public ReadOnly Property UserId As String
  Public ReadOnly Property KeyId As String
  Public Property Passphrase As String
End Class

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the Passphrase field before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

  • AddUserId
  • SignUserId
  • ChangeExpirationDate
  • ChangePassphrase

When using the OpenPGP component, or an email-based component, the following methods require a passphrase for the key:

MailboxACL Event (PIMAP 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, PimapMailboxACLEventArgs e);

public class PimapMailboxACLEventArgs : 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 PimapMailboxACLEventArgs)

Public Class PimapMailboxACLEventArgs 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:

lLookup (Visible to be listed)
rRead (Can be selected, fetched, searched, and copied)
sKeep (Seen/unseen information across sessions)
wWrite (Stores flags other than SEEN and DELETED)
iInsert (Can be appended and copied into)
pPost (Can send mail to submission address for mailbox)
cCreate (Can create new sub-mailboxes)
dDelete (Stores DELETED flag and performs EXPUNGE)
aAdminister (Set access permissions)

MailboxList Event (PIMAP 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, PimapMailboxListEventArgs e);

public class PimapMailboxListEventArgs : 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 PimapMailboxListEventArgs)

Public Class PimapMailboxListEventArgs 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 (PIMAP 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, PimapMessageInfoEventArgs e);

public class PimapMessageInfoEventArgs : 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 PimapMessageInfoEventArgs)

Public Class PimapMessageInfoEventArgs 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 (PIMAP Component)

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

Syntax

public event OnMessagePartHandler OnMessagePart;

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

public class PimapMessagePartEventArgs : 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 PimapMessagePartEventArgs)

Public Class PimapMessagePartEventArgs 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 (PIMAP 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, PimapPITrailEventArgs e);

public class PimapPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Message { get; }
}
Public Event OnPITrail As OnPITrailHandler

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

Public Class PimapPITrailEventArgs 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).

Progress Event (PIMAP Component)

Fired as progress is made.

Syntax

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, PimapProgressEventArgs e);

public class PimapProgressEventArgs : EventArgs {
  public long BytesProcessed { get; }
  public int PercentProcessed { get; }
}
Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As PimapProgressEventArgs)

Public Class PimapProgressEventArgs Inherits EventArgs
  Public ReadOnly Property BytesProcessed As Long
  Public ReadOnly Property PercentProcessed As Integer
End Class

Remarks

This event is fired automatically as data is processed by the component.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

RecipientInfo Event (PIMAP Component)

Fired for each recipient key of the encrypted message.

Syntax

public event OnRecipientInfoHandler OnRecipientInfo;

public delegate void OnRecipientInfoHandler(object sender, PimapRecipientInfoEventArgs e);

public class PimapRecipientInfoEventArgs : EventArgs {
  public string KeyId { get; }
  public string PublicKeyAlgorithm { get; }
}
Public Event OnRecipientInfo As OnRecipientInfoHandler

Public Delegate Sub OnRecipientInfoHandler(sender As Object, e As PimapRecipientInfoEventArgs)

Public Class PimapRecipientInfoEventArgs Inherits EventArgs
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property PublicKeyAlgorithm As String
End Class

Remarks

This event fires when the Decrypt or DecryptAndVerifySignature method is called.

KeyId is the Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. It is the hex-encoded, 4- or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the fingerprint. For instance:

BF52A0AB
This can be used to identify the correct key to specify in Keys. Keys can be set from within this event as this event fires directly before the decryption process begins.

SignatureInfo Event (PIMAP Component)

Fired during verification of the signed message.

Syntax

public event OnSignatureInfoHandler OnSignatureInfo;

public delegate void OnSignatureInfoHandler(object sender, PimapSignatureInfoEventArgs e);

public class PimapSignatureInfoEventArgs : EventArgs {
  public string KeyId { get; }
  public string SigningAlgorithm { get; }
  public string PublicKeyAlgorithm { get; }
}
Public Event OnSignatureInfo As OnSignatureInfoHandler

Public Delegate Sub OnSignatureInfoHandler(sender As Object, e As PimapSignatureInfoEventArgs)

Public Class PimapSignatureInfoEventArgs Inherits EventArgs
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property SigningAlgorithm As String
  Public ReadOnly Property PublicKeyAlgorithm As String
End Class

Remarks

This event fires when the VerifySignature or DecryptAndVerifySignature method is called. It provides information about the signature of the message.

KeyId is the Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. It is the hex-encoded, 4- or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the Fingerprint. For instance:

BF52A0AB
This can be used to identify the correct key to specify in SignerKeys. This property can be set from within this event as this event fires directly before the verification process begins.

SigningAlgorithm describes the hash algorithm used when the message was originally signed. This value is applicable only to the message signature, not the key used to sign the message. Possible values are:

  • SHA1
  • SHA256
  • SHA384
  • SHA512
  • SHA224
  • MD5

PublicKeyAlgorithm is the algorithm of the public key used to sign the message. Possible values are:

  • RSA
  • DSA
  • ECDSA
  • EdDSA

SSLServerAuthentication Event (PIMAP Component)

Fired after the server presents its certificate to the client.

Syntax

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

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

public class PimapSSLServerAuthenticationEventArgs : 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 PimapSSLServerAuthenticationEventArgs)

Public Class PimapSSLServerAuthenticationEventArgs 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

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 (PIMAP Component)

Shows the progress of the secure connection.

Syntax

public event OnSSLStatusHandler OnSSLStatus;

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

public class PimapSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}
Public Event OnSSLStatus As OnSSLStatusHandler

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

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (PIMAP 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, PimapStartTransferEventArgs e);

public class PimapStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}
Public Event OnStartTransfer As OnStartTransferHandler

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

Public Class PimapStartTransferEventArgs 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.

Status Event (PIMAP Component)

Shows the progress of the operation.

Syntax

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, PimapStatusEventArgs e);

public class PimapStatusEventArgs : EventArgs {
  public string Message { get; }
}
Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As PimapStatusEventArgs)

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

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

Transfer Event (PIMAP Component)

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

Syntax

public event OnTransferHandler OnTransfer;

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

public class PimapTransferEventArgs : 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 PimapTransferEventArgs)

Public Class PimapTransferEventArgs 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.

VerificationStatus Event (PIMAP Component)

Fired after verification of the signed message.

Syntax

public event OnVerificationStatusHandler OnVerificationStatus;

public delegate void OnVerificationStatusHandler(object sender, PimapVerificationStatusEventArgs e);

public class PimapVerificationStatusEventArgs : EventArgs {
  public string KeyId { get; }
  public int Status { get; }
}
Public Event OnVerificationStatus As OnVerificationStatusHandler

Public Delegate Sub OnVerificationStatusHandler(sender As Object, e As PimapVerificationStatusEventArgs)

Public Class PimapVerificationStatusEventArgs Inherits EventArgs
  Public ReadOnly Property KeyId As String
  Public ReadOnly Property Status As Integer
End Class

Remarks

This event fires when VerifySignature or DecryptAndVerifySignature is called. It provides information about the result.

KeyId is the Id of the key used to sign the message. It is the hex-encoded, 4-or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the Fingerprint. For instance:

BF52A0AB

Status holds the result of the operation. Possible values are:

0Verification succeeded
1Verification failed
2The required key could not be found
3Verification succeeded but the key is expired.

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

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
String

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 []

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.

ExpirationDate
String

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
String

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
String

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

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

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

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

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

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
Boolean

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

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
String

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String

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
Integer

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
String

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

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

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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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. PKCS12 certificate store).

StoreB
Byte []

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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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. PKCS12 certificate store).

StorePassword
String

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

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 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 cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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 certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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

Subject
String

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 displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

SubjectAltNames
String

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String

This field contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA1
String

This field contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA256
String

This field contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.

Usage
String

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 Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
Integer

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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( certificateFile);
Public Certificate(ByVal CertificateFile As )

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate( certificateData);
Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);
Public Certificate(ByVal CertStoreType As , ByVal Store As , ByVal StorePassword As , ByVal Subject As )

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 X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);
Public Certificate(ByVal CertStoreType As , ByVal Store As , ByVal StorePassword As , ByVal Subject As , ByVal ConfigurationString As )

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 CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 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 X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);
Public Certificate(ByVal CertStoreType As , ByVal Store As , ByVal StorePassword As , 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 X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);
Public Certificate(ByVal CertStoreType As , ByVal StoreBlob As Byte(), ByVal StorePassword As , ByVal Subject As )

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob 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 X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);
Public Certificate(ByVal CertStoreType As , ByVal StoreBlob As Byte(), ByVal StorePassword As , ByVal Subject As , ByVal ConfigurationString As )

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob 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 X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);
Public Certificate(ByVal CertStoreType As , ByVal StoreBlob As Byte(), ByVal StorePassword As , 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 X509 certificate and search the opened store for a corresponding private key.

Firewall Type

This is 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
Boolean

This field tells the component whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes

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

This field contains the name or IP address of 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

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
Integer

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

This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.

Constructors

public Firewall();
Public Firewall()

Header Type

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

Remarks

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

Fields

Field
String

This field contains the name of the HTTP Header (this is the same case as it is delivered).

Value
String

This field contains the Header contents.

Constructors

public Header();
Public Header()
public Header( field,  value);
Public Header(ByVal Field As , ByVal Value As )

Key Type

The OpenPGP key being used.

Remarks

This type describes the current key. The key may be a public or secret key. The fields are used to identify or select the key.

Fields

Curve
String

This field specifies the elliptic curve used in the ECDSA or EdDSA key. This field is only applicable if PublicKeyAlgorithm is ECDSA or EdDSA. Possible values are:

ValuePublicKeyAlgorithmDescription
secp256r1 ECDSA NIST curve P-256
secp384r1 ECDSA NIST curve P-384
secp521r1 ECDSA NIST curve P-521
Ed25519 EdDSA Ed25519
secp256k1 EdDSA Secp256k1

EffectiveDate
String

The date when this key becomes valid. Prior to this it is not valid. The following is an example of a valid encoded date:

23-Jan-2000 15:00:00.

Encoded
String

The key. This field is used to assign a specific key. The UserId fields may also be used to specify a key.

EncodedB
Byte []

The key. This field is used to assign a specific key. The UserId fields may also be used to specify a key.

ExpirationDate
String

The date the key expires. After this date the key will no longer be valid. The following is an example of a valid encoded date:

23-Jan-2001 15:00:00.

Fingerprint
String

The hex-encoded, 20-byte fingerprint of the key.

This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

Id
String

The hex-encoded, 4-byte key Id. It is same as last 4 bytes of Fingerprint.

This is in the form:

89C9D7B1
The KeyIdLength setting may be set to a value of 8 to return the last 8 bytes instead of the last 4 bytes.

OtherUserIds
String

If the specified key has alternate user Ids associated with it, this field returns a comma-separated list of the other user Ids.

Passphrase
String

The passphrase for the key's secret key (if any). This must be specified before operations requiring the secret key are attempted. The passphrase may be supplied in this field or through the KeyPassphrase event, which will fire when a passphrase is required.

The passphrase is required when using the following methods in KeyMgr:

  • AddUserId
  • SignUserId
  • ChangeExpirationDate
  • ChangePassphrase

When using the OpenPGP component, or an email-based component, the following methods require a passphrase for the key:

  • Decrypt
  • Sign
  • SignAndEncrypt

PublicKey
String

The public key of the key. The key is provided as ASCII armored data.

PublicKeyAlgorithm
String

A text description of the public key algorithm of the key. Possible values are:

  • RSA
  • DSA
  • ECDSA
  • EdDSA
  • RSA-Legacy

PublicKeyLength
Integer

The length of the public key in bits. Common values are 512, 1024, and 2048.

If the PublicKeyAlgorithm field is ECDSA or EcDSA the length of the public key is determined by the Curve. Possible lenghts are:

CurvePublic Key Length (bits)
secp256r1256
secp384r1384
secp521r1521
Ed25519 256
secp256k1256

Revoked
Boolean

Whether or not the key is revoked.

SecretKey
String

The secret key of the key (if available). The key is provided as ASCII armored data.

SecretKeyAvailable
Boolean

Whether or not a secret key is available for the selected key.

Usage
String

A text description of UsageFlags.

The value will be of one or more of the following strings, separated by commas:

  • Certifying Other Certificates
  • Signing Emails and Files
  • Encrypting Emails and Files
  • Split Key
  • Authenticate Against Servers
  • Group Key

UsageFlags
Integer

Flags that show the intended use for the key. The default value is 0x0F. The value of UsageFlags is a combination of the following flags:

0x01This key may be used to certify other keys.
0x02This key may be used to sign data.
0x0CThis key may be used to encrypt communications and encrypt storage.
0x10The private component of this key may have been split by a secret-sharing mechanism.
0x20This key may be used for authentication.
0x80The private component of this key may be in the possession of more than one person.

Please refer to the Usage field for a text representation of UsageFlags.

UserId
String

The user Id of the key. When a key is loaded this field is populated with the user Id associated with the key. This field may be set to load a key from the Keyring. When this field is set the component will search the Keyring for a key associated with the UserId specified.

When loading a key with multiple user Ids, this field will be populated with the UserId that was most recently added to the key. To discover all of the UserIds associated with a key query this field and OtherUserIds after loading the key.

The UserId format is:

FirstName LastName (Comment) <Email>
Not all values are required when selecting or generating a key, but at least FirstName or Email are required.

When using this field to select a key you may also specify the key's Id, or any of its subkeys' Ids, instead of a user Id. The component will then search for a key with a matching Id. This is helpful in situations where you do not have the UserId but still need to load the key, such as within the OpenPGP component's RecipientInfo event.

Constructors

public Key( keyPath);
Public Key(ByVal KeyPath As )

Reads the OpenPGP public key from the specified KeyPath . If multiple keys are present only the first one is used.

public Key( keyData);
Public Key(ByVal KeyData As Byte())

Reads the OpenPGP key from the specified KeyData . Both binary-formatted and ASCII-armored data are accepted.

public Key( keyPath,  userId);
Public Key(ByVal KeyPath As , ByVal UserId As )

Searches the KeyPath for an OpenPGP key with a matching UserId . If UserId is set to "*" the first key will be used.

public Key( keyPath,  secretKeyringFile,  publicKeyringFile,  userId);
Public Key(ByVal KeyPath As , ByVal SecretKeyringFile As , ByVal PublicKeyringFile As , ByVal UserId As )

Searches the KeyPath for the specified SecretKeyRingFile and PublicKeyringFile . If UserId is set to "*" the first key will be used.

public Key( keyData,  userId);
Public Key(ByVal KeyData As Byte(), ByVal UserId As )

Searches the KeyData for an OpenPGP key with a matching UserId . If UserId is set to "*" the first key will be used.

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

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

This field contains the mailbox name in a mailbox listing.

Separator
String

The Separator field contains the character that separates the different parts in the mailbox path hierarchy.

Constructors

public Mailbox();
Public Mailbox()

MessageInfo Type

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

Remarks

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

Fields

Date
String

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

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

This field contains the sender of a message in a message information listing.

MessageId
String

The unique identifier of a message in a message information listing.

Size
Long

This field contains the size of a message in a message information listing.

Subject
String

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

This field shows the value of the Content-Disposition header of the message part.

ContentEncoding
String

This field shows how the data are encoded.

ContentId
String

This field shows the value of the Content-Id header of the message part.

ContentType
String

This field shows the type of data contained in the message part.

Filename
String

This field shows the filename corresponding to the part (if the part was included in the message as an attached file).

Id
String

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

This field shows how this part relates to the message's whole multipart structure (e.g., 'mixed' or 'alternative').

Parameters
String

This field contains the additional parameters passed to the ContentType header, such as the part charset.

Size
Long

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

This field contains the email address of the recipient.

Name
String

This field contains the name of the recipient.

Options
String

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

This field contains the recipient type: To, Cc, or Bcc.

Constructors

public MessageRecipient();
Public MessageRecipient()
public MessageRecipient( address);
Public MessageRecipient(ByVal Address As )
public MessageRecipient( address,  recipientType);
Public MessageRecipient(ByVal Address As , ByVal RecipientType As )

Config Settings (PIMAP 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.

PIMAP Config Settings

Comment:   The OpenPGP message comment.

OpenPGP messages may contain a comment. This setting holds the comment (if any) after calling Decrypt, DecryptAndVerifySignature, or VerifySignature.

LogLevel:   Specifies the level of detail that is logged.

This setting controls the level of detail that is logged through the Status event. Possible values are:

0 (None)No events are logged.
1 (Info - default)Informational events are logged.
2 (Verbose)Detailed data is logged.
3 (Debug)Debug data is logged.

ProcessAttachments:   Whether or not to process attachments.

This setting controls whether attachments are processed when calling Decrypt, DecryptAndVerifySignature, or VerifySignature. When set to True if an attachment is a valid OpenPGP message it will be decrypted and/or verified. If it is not a valid OpenPGP message it will be left as is. When set to False the attachments are not processed. The default value is True.

RequireValidSignature:   Specifies if an invalid signature is considered an error condition.

By default, if the signature is not valid the component throws an exception. This setting may be set to False to disable this requirement. When False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation. The default value is True.

SymmetricPassphrase:   The password used for symmetric encryption or decryption.

This setting specifies the passphrase when using symmetric encryption. If a value is provided, symmetric encryption/decryption will be attempted. In this case no keys are used for either encryption or decryption. Only Encrypt and Decrypt are valid operations when a value is set. Sign, SignAndEncrypt, VerifySignature, and DecryptAndVerifySignature are not valid operations when using this option.

VersionHeader:   The Version header value in the ASCII armored OpenPGP message.

This setting specifies the Version header value included in the ASCII armored OpenPGP message. This may be set before calling Encrypt, Sign, or SignAndEncrypt. The default value is "IPWorks! OpenPGP 2016".

This setting will be populated after calling Decrypt, VerifySignature, or DecryptAndVerifySignature.

IMAP Config Settings

AlwaysReturnUIDs:   Instructs the server to return UIDs even if not in UIDMode.

If UIDMode is set to False, the MessageSet contains session message Ids, and the response from the server also will contain session message Ids. In some cases, it is desirable that the server sends back UIDs. Set the AlwaysReturnUIDs to True, to instruct the server to do so.

The default value for this setting is False.

AppendToMailboxDateTime:   Specifies the date-time parameter used in the initial APPEND request.

When appending to a mailbox using the AppendToMailbox method, the IMAP RFC specifies a date-time parameter that can be used to set the internal date of the resulting message. This configuration setting can be used to specify the date-time parameter used in this case.

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.

AuthorizationIdentity:   The value to use as the authorization identity when SASL authentication is used.

When AuthMechanism is set to amSASLPlain, amSASLDigestMD5, or amXOAUTH2, you may use this setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2, this should be your OAUTH authorization string. For instance:

Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q

Note: When using amXOAUTH2, User must be specified, but Password is not required.

AutoDecodeText:   Whether to decode MessageText when AutoDecodeParts is True.

When AutoDecodeParts is True, this setting controls whether MessageText is also decoded. When AutoDecodeText is True (default), MessageText is decoded. When set to False, MessageText is not decoded. This setting is applicable only when AutoDecodeParts is set to True.

FetchAfterSearch:   Determines if messages matching the SearchCriteria are fetched after calling SearchMailbox.

If set to False, FetchMessageInfo will not be called for messages matching the SearchCriteria after calling SearchMailbox. MessageInfo will still fire, but the MessageId parameter will be the only parameter populated. The default value of this setting is True.

FetchTextAndHeaders:   Specifies whether the message body and headers are fetched in a single request.

This setting specifies whether the FetchMessageText method fetches both the message headers and text, or just the message text. By default this value is false, and FetchMessageText will fetch only the message text from the server. When set to true, the component will fetch both the message text and headers in a single request from the server and populate both MessageHeadersString and MessageText.

HeaderLimit:   Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when populating the MessageHeaders collection as a result of retrieving message headers. This value represents the number of headers that are to be saved 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.

IncludeHeaders:   Instructs the component to include the headers in the LocalFile.

When set to True, the headers for the message you are fetching will be written to the LocalFile before the message body. In this manner, the whole content of a MIME-encoded message will be written to the file.

MailboxLimit:   Instructs component to save the amount of mailboxes specified that are returned by the server after a ListMailboxes call has been made.

This configuration setting should be set when populating the MailboxList collection as a result of a call to either ListMailboxes or ListSubscribedMailboxes. This value represents the number of mailboxes that are to be saved 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.

MaskSensitive:   Whether sensitive properties should be masked when logging.

By default, the PITrail event will include the raw commands sent to the IMAP server, including sensitive values like passwords. To prevent passwords from appearing in plaintext when logging, set this option to True. The default value is False.

MessageHeadersStringFolded:   Whether the MessageHeadersString property should contain folded headers.

By default, accessing the MessageHeadersString property will return the unfolded message headers as a string. To retrieve folded headers as a string, set this configuration setting to True before accessing MessageHeadersString.

MessageInfoLimit:   Instructs component to save the amount of messages specified that are returned by the server after a FetchMessageInfo call has been made.

This configuration setting should be set when populating the MessageInfo collection as a result of a call to FetchMessageInfo. This value represents the number of messages that are to be saved 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.

MessagePartLimit:   Instructs component to save the amount of message parts specified that are returned by the server after a FetchMessageInfo call has been made.

This configuration setting should be set when populating the MessageParts collection as a result of a call to FetchMessageInfo. This value represents the number of message parts that are to be saved 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.

SendIDCommand:   Instructs component to send the ID command if the server advertises support for it.

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.

UTF7MailboxNames:   Specifies whether or not to automatically encode and decode UTF-7 mailbox names.

IMAP servers may represent some characters in a mailbox name in UTF-7 format. This setting determines whether or not the component should automatically encode and decode these values. When set to False, no encoding or decoding will be performed by the component. The default value is True.

TCPClient Config Settings

CloseStreamAfterTransfer:   If true, the component will close the upload or download stream after the transfer.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the component whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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.

FirewallListener:   If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

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.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect 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.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

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.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 multi-homed 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 multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the component binds.

This must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

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.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

UseNTLMv2:   Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

CACertFilePaths:   The paths to CA certificate files when using Mono on Unix/Linux.

This setting specifies the paths on disk to CA certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

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:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

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 setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession:   Determines if the SSL session is reused.

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.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the component will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

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 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this 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 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 config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

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: 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:

  • 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
Example values when SSLProvider is set to Internal: 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_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • 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.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the component will use the internal TLS implementation.

In editions which 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 only supported 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 only available 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 the above 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.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

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.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

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 traffice for debugging purposes. When writing to this file the component will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this 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: TCPClient.SSLProvider = TCPClientSSLProviders.sslpInternal; TCPClient.Config("SSLEnabledProtocols=3072"); //TLS 1.2 TCPClient.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this 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.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

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)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

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 setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified 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"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "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 rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

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

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

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.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • 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.
UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions where applicable. When set to false calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to true. Setting this to true tells the component to use the internal implementation instead of using the system's security API.

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 DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (PIMAP 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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

OpenPGP Errors

101   Cannot decode ASCII Armor data.
102   Unknown ASCII Armor data type.
103   Checksum failed.
104   Unknown ASCII Armor header.
105   Cannot decode PGP packet.
106   Cannot encode PGP packet.
107   Unknown PGP packet tag.
108   Unsupported version.
109   Unsupported algorithm.
110   Unknown subpacket.
111   Internal error.
112   Feature not supported.
113   Secret data was not encrypted.
114   Cannot find the key.
115   Error reading file.
116   Error writing file.
117   Error reading key.
118   Error writing key.
119   Cannot verify signature.
120   Cannot create signature.
121   Invalid UserId.
122   Invalid passphrase.
123   Data encryption failed.
124   Error creating key.
125   Unsupported symmetric algorithm.
126   Unsupported hash.
127   Unsupported compression algorithm.
128   Invalid key usage.
129   Component is busy.
130   Error decrypting data.
131   Data is not compressed.
132   Error decompressing data.
133   Error compressing data.
134   Unsupported signature.
141   No input.
142   Signing was required, but the message was not signed.
143   Encryption was required, but the message was not encrypted.
146   No data integrity packet was found (MDC), but one was required.
200   Out of memory.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2022 .NET Edition - Version 22.0 [Build 8369]