SIMAP Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SIMAP

Remarks

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

The SIMAP Control implements a standard IMAP client as specified in RFC 1730 and RFC 2060.

The first step in using the control 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 control's methods. Results are retrieved through events and a number of key properties.

Normally, after connecting to the server, a Mailbox is selected (or examined) using the ExamineMailbox method. After the Mailbox is selected, MessageCount and RecentMessageCount show the number of messages in the mailbox, and MailboxFlags show the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent using the control's methods. The primary arguments for most commands are the Mailbox property and the MessageSet property. The MessageSet property denotes either a single message, or a range of messages. Other arguments are specified through other properties, such as SortCriteria and MessageFlags.

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

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

The PITrail event traces the interaction between the client and the server. It includes all exchanges except for transfers of messages, message parts, and message headers.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AuthMechanism Property (SIMAP Control)

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

Syntax

simapcontrol.AuthMechanism[=integer]

Possible Values

amUserPassword(0), 
amCRAMMD5(1), 
amNTLM(2), 
amAPOP(3), 
amSASLPlain(4), 
amSASLDigestMD5(5), 
amKerberos(6), 
amXOAUTH2(7)

Default Value

0

Remarks

Data Type

Integer

AutoDecodeParts Property (SIMAP Control)

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

Syntax

simapcontrol.AutoDecodeParts[=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.

Data Type

Boolean

CertEffectiveDate Property (SIMAP Control)

The date on which this certificate becomes valid.

Syntax

simapcontrol.CertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

CertExpirationDate Property (SIMAP Control)

The date on which the certificate expires.

Syntax

simapcontrol.CertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

CertExtendedKeyUsage Property (SIMAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

simapcontrol.CertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CertFingerprint Property (SIMAP Control)

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

Syntax

simapcontrol.CertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

This property is read-only.

Data Type

String

CertFingerprintSHA1 Property (SIMAP Control)

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

Syntax

simapcontrol.CertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

CertFingerprintSHA256 Property (SIMAP Control)

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

Syntax

simapcontrol.CertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

CertIssuer Property (SIMAP Control)

The issuer of the certificate.

Syntax

simapcontrol.CertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

CertPrivateKey Property (SIMAP Control)

The private key of the certificate (if available).

Syntax

simapcontrol.CertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (SIMAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

simapcontrol.CertPrivateKeyAvailable

Default Value

False

Remarks

Whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (SIMAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

simapcontrol.CertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CertPublicKey Property (SIMAP Control)

The public key of the certificate.

Syntax

simapcontrol.CertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CertPublicKeyAlgorithm Property (SIMAP Control)

The textual description of the certificate's public key algorithm.

Syntax

simapcontrol.CertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

CertPublicKeyLength Property (SIMAP Control)

The length of the certificate's public key (in bits).

Syntax

simapcontrol.CertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

CertSerialNumber Property (SIMAP Control)

The serial number of the certificate encoded as a string.

Syntax

simapcontrol.CertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

CertSignatureAlgorithm Property (SIMAP Control)

The text description of the certificate's signature algorithm.

Syntax

simapcontrol.CertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

CertStore Property (SIMAP Control)

The name of the certificate store for the client certificate.

Syntax

simapcontrol.CertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertStoreB.

Data Type

Binary String

CertStorePassword Property (SIMAP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

simapcontrol.CertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

CertStoreType Property (SIMAP Control)

The type of certificate store for this certificate.

Syntax

simapcontrol.CertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubjectAltNames Property (SIMAP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

simapcontrol.CertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (SIMAP Control)

The MD5 hash of the certificate.

Syntax

simapcontrol.CertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA1 Property (SIMAP Control)

The SHA-1 hash of the certificate.

Syntax

simapcontrol.CertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA256 Property (SIMAP Control)

The SHA-256 hash of the certificate.

Syntax

simapcontrol.CertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertUsage Property (SIMAP Control)

The text description of UsageFlags .

Syntax

simapcontrol.CertUsage

Default Value

""

Remarks

The text description of CertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

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

This property is read-only.

Data Type

String

CertUsageFlags Property (SIMAP Control)

The flags that show intended use for the certificate.

Syntax

simapcontrol.CertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:

Please see the CertUsage property for a text representation of CertUsageFlags.

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

This property is read-only.

Data Type

Integer

CertVersion Property (SIMAP Control)

The certificate's version number.

Syntax

simapcontrol.CertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CertSubject Property (SIMAP Control)

The subject of the certificate used for client authentication.

Syntax

simapcontrol.CertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

CertEncoded Property (SIMAP Control)

The certificate (PEM/Base64 encoded).

Syntax

simapcontrol.CertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertEncodedB.

This property is not available at design time.

Data Type

Binary String

Connected Property (SIMAP Control)

Whether the control is connected.

Syntax

simapcontrol.Connected

Default Value

False

Remarks

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

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

Data Type

Boolean

EndByte Property (SIMAP Control)

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

Syntax

simapcontrol.EndByte[=long64]

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

FirewallAutoDetect Property (SIMAP Control)

Whether to automatically detect and use firewall system settings, if available.

Syntax

simapcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (SIMAP Control)

The type of firewall to connect through.

Syntax

simapcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SIMAP Control)

The name or IP address of the firewall (optional).

Syntax

simapcontrol.FirewallHost[=string]

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (SIMAP Control)

A password if authentication is to be used when connecting through the firewall.

Syntax

simapcontrol.FirewallPassword[=string]

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (SIMAP Control)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

simapcontrol.FirewallPort[=integer]

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (SIMAP Control)

A username if authentication is to be used when connecting through a firewall.

Syntax

simapcontrol.FirewallUser[=string]

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

Idle Property (SIMAP Control)

The current status of the control.

Syntax

simapcontrol.Idle

Default Value

True

Remarks

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

This property is read-only.

Data Type

Boolean

LastReply Property (SIMAP Control)

This property indicates the last reply received from the server.

Syntax

simapcontrol.LastReply

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

LocalFile Property (SIMAP Control)

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

Syntax

simapcontrol.LocalFile[=string]

Default Value

""

Remarks

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

If this property is empty, then the received data is provided through the MessageText property and the parameters for the Transfer event.

Data Type

String

LocalHost Property (SIMAP Control)

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

Syntax

simapcontrol.LocalHost[=string]

Default Value

""

Remarks

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

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

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

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

Data Type

String

Mailbox Property (SIMAP Control)

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

Syntax

simapcontrol.Mailbox[=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 control 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

Data Type

String

MailboxFlags Property (SIMAP Control)

This property defines flags in the selected mailbox.

Syntax

simapcontrol.MailboxFlags

Default Value

""

Remarks

This property defines flags in the selected mailbox. The control 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.

Data Type

String

MailboxListCount Property (SIMAP Control)

The number of records in the MailboxList arrays.

Syntax

simapcontrol.MailboxListCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• MailboxListFlags
• MailboxListName
• MailboxListSeparator

The array indices start at 0 and end at MailboxListCount - 1.

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

Data Type

Integer

MailboxListFlags Property (SIMAP Control)

This property contains the mailbox flags in a mailbox listing.

Syntax

simapcontrol.MailboxListFlags(MailboxListIndex)

Default Value

""

Remarks

This property contains the mailbox flags in a mailbox listing.

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

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailboxListName Property (SIMAP Control)

This property contains the mailbox name in a mailbox listing.

Syntax

simapcontrol.MailboxListName(MailboxListIndex)

Default Value

""

Remarks

This property contains the mailbox name in a mailbox listing.

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailboxListSeparator Property (SIMAP Control)

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

Syntax

simapcontrol.MailboxListSeparator(MailboxListIndex)

Default Value

""

Remarks

The MailboxListSeparator property contains the character that separates the different parts in the mailbox path hierarchy.

The MailboxListIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxListCount property.

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

Data Type

String

MailPort Property (SIMAP Control)

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

Syntax

simapcontrol.MailPort[=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.

Data Type

Integer

MailServer Property (SIMAP Control)

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

Syntax

simapcontrol.MailServer[=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 control 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.

Data Type

String

Message Property (SIMAP Control)

This property provides the raw message content.

Syntax

simapcontrol.Message[=string]

Default Value

""

Remarks

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .MessageB.

This property is not available at design time.

Data Type

Binary String

MessageContentEncoding Property (SIMAP Control)

This property includes the ContentEncoding of the selected message.

Syntax

simapcontrol.MessageContentEncoding

Default Value

""

Remarks

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

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

Data Type

String

MessageContentType Property (SIMAP Control)

This property includes the ContentType of the message.

Syntax

simapcontrol.MessageContentType

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.

Data Type

String

MessageCount Property (SIMAP Control)

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

Syntax

simapcontrol.MessageCount

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

MessageDate Property (SIMAP Control)

The property includes the time the message was created.

Syntax

simapcontrol.MessageDate

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.

Data Type

String

MessageDeliveryTime Property (SIMAP Control)

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

Syntax

simapcontrol.MessageDeliveryTime

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.

Data Type

String

MessageFlags Property (SIMAP Control)

This property contains the flags of the current message.

Syntax

simapcontrol.MessageFlags[=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:

Example. Setting MessageFlags:

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

This property is not available at design time.

Data Type

String

MessageFrom Property (SIMAP Control)

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

Syntax

simapcontrol.MessageFrom

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.

Data Type

String

MessageHeaderCount Property (SIMAP Control)

The number of records in the MessageHeader arrays.

Syntax

simapcontrol.MessageHeaderCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageHeaderField
• MessageHeaderValue

The array indices start at 0 and end at MessageHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MessageHeaderField Property (SIMAP Control)

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

Syntax

simapcontrol.MessageHeaderField(MessageHeaderIndex)[=string]

Default Value

""

Remarks

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

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeaderValue Property (SIMAP Control)

This property contains the header contents.

Syntax

simapcontrol.MessageHeaderValue(MessageHeaderIndex)[=string]

Default Value

""

Remarks

This property contains the Header contents.

The MessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageHeaderCount property.

This property is not available at design time.

Data Type

String

MessageHeadersString Property (SIMAP Control)

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

Syntax

simapcontrol.MessageHeadersString[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MessageId Property (SIMAP Control)

This property includes the message identifier of the current message.

Syntax

simapcontrol.MessageId

Default Value

""

Remarks

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

Data Type

String

MessageInfoCount Property (SIMAP Control)

The number of records in the MessageInfo arrays.

Syntax

simapcontrol.MessageInfoCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageInfoDate
• MessageInfoFlags
• MessageInfoFrom
• MessageInfoMessageId
• MessageInfoSize
• MessageInfoSubject

The array indices start at 0 and end at MessageInfoCount - 1.

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

Data Type

Integer

MessageInfoDate Property (SIMAP Control)

This property contains the date of a message in a message information listing.

Syntax

simapcontrol.MessageInfoDate(MessageInfoIndex)

Default Value

""

Remarks

This property contains the date of a message in a message information listing. This date is taken from the ENVELOPE structure of the message.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoFlags Property (SIMAP Control)

This property contains a message flag in a message information listing.

Syntax

simapcontrol.MessageInfoFlags(MessageInfoIndex)

Default Value

""

Remarks

This property contains a message flag in a message information listing.

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

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoFrom Property (SIMAP Control)

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

Syntax

simapcontrol.MessageInfoFrom(MessageInfoIndex)

Default Value

""

Remarks

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

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoMessageId Property (SIMAP Control)

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

Syntax

simapcontrol.MessageInfoMessageId(MessageInfoIndex)

Default Value

""

Remarks

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

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInfoSize Property (SIMAP Control)

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

Syntax

simapcontrol.MessageInfoSize(MessageInfoIndex)

Default Value

0

Remarks

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

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

Long64

MessageInfoSubject Property (SIMAP Control)

This property contains the subject of a message in a message information listing.

Syntax

simapcontrol.MessageInfoSubject(MessageInfoIndex)

Default Value

""

Remarks

This property contains the subject of a message in a message information listing.

The MessageInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageInfoCount property.

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

Data Type

String

MessageInReplyTo Property (SIMAP Control)

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

Syntax

simapcontrol.MessageInReplyTo

Default Value

""

Remarks

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

Data Type

String

MessageNetId Property (SIMAP Control)

This property includes the globally unique identifier of the message.

Syntax

simapcontrol.MessageNetId

Default Value

""

Remarks

This property contains the globally unique identifier of the message. The control 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.

Data Type

String

MessagePartCount Property (SIMAP Control)

The number of records in the MessagePart arrays.

Syntax

simapcontrol.MessagePartCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessagePartContentDisposition
• MessagePartContentEncoding
• MessagePartContentId
• MessagePartContentType
• MessagePartFileName
• MessagePartId
• MessagePartMultipartMode
• MessagePartParameters
• MessagePartSize

The array indices start at 0 and end at MessagePartCount - 1.

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

Data Type

Integer

MessagePartContentDisposition Property (SIMAP Control)

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

Syntax

simapcontrol.MessagePartContentDisposition(MessagePartIndex)

Default Value

""

Remarks

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

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentEncoding Property (SIMAP Control)

This property shows how the data are encoded.

Syntax

simapcontrol.MessagePartContentEncoding(MessagePartIndex)

Default Value

""

Remarks

This property shows how the data are encoded.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentId Property (SIMAP Control)

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

Syntax

simapcontrol.MessagePartContentId(MessagePartIndex)

Default Value

""

Remarks

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

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartContentType Property (SIMAP Control)

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

Syntax

simapcontrol.MessagePartContentType(MessagePartIndex)

Default Value

""

Remarks

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

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartFileName Property (SIMAP Control)

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

Syntax

simapcontrol.MessagePartFileName(MessagePartIndex)

Default Value

""

Remarks

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

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartId Property (SIMAP Control)

This property contains the identifier of a part listing that may be identified in other parts or messages.

Syntax

simapcontrol.MessagePartId(MessagePartIndex)

Default Value

""

Remarks

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

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartMultipartMode Property (SIMAP Control)

This property shows how this part relates to the message's whole multipart structure (e.

Syntax

simapcontrol.MessagePartMultipartMode(MessagePartIndex)

Default Value

""

Remarks

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

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartParameters Property (SIMAP Control)

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

Syntax

simapcontrol.MessagePartParameters(MessagePartIndex)

Default Value

""

Remarks

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

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

String

MessagePartSize Property (SIMAP Control)

This property contains the size of a part in a message part listing.

Syntax

simapcontrol.MessagePartSize(MessagePartIndex)

Default Value

0

Remarks

This property contains the size of a part in a message part listing.

The MessagePartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessagePartCount property.

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

Data Type

Long64

MessageRecipientCount Property (SIMAP Control)

The number of records in the MessageRecipient arrays.

Syntax

simapcontrol.MessageRecipientCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• MessageRecipientAddress
• MessageRecipientName
• MessageRecipientOptions
• MessageRecipientType

The array indices start at 0 and end at MessageRecipientCount - 1.

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

Data Type

Integer

MessageRecipientAddress Property (SIMAP Control)

This property contains the email address of the recipient.

Syntax

simapcontrol.MessageRecipientAddress(RecipientIndex)

Default Value

""

Remarks

This property contains the email address of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

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

Data Type

String

MessageRecipientName Property (SIMAP Control)

This property contains the name of the recipient.

Syntax

simapcontrol.MessageRecipientName(RecipientIndex)

Default Value

""

Remarks

This property contains the name of the recipient.

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

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

Data Type

String

MessageRecipientOptions Property (SIMAP Control)

This property contains the recipient sending options (used only by SMTP).

Syntax

simapcontrol.MessageRecipientOptions(RecipientIndex)

Default Value

""

Remarks

This property 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.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

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

Data Type

String

MessageRecipientType Property (SIMAP Control)

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

Syntax

simapcontrol.MessageRecipientType(RecipientIndex)

Possible Values

rtTo(0), 
rtCc(1), 
rtBCc(2)

Default Value

0

Remarks

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

The RecipientIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageRecipientCount property.

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

Data Type

Integer

MessageReplyTo Property (SIMAP Control)

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

Syntax

simapcontrol.MessageReplyTo

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.

Data Type

String

MessageSender Property (SIMAP Control)

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

Syntax

simapcontrol.MessageSender

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.

Data Type

String

MessageSet Property (SIMAP Control)

This property includes the set of messages to operate on.

Syntax

simapcontrol.MessageSet[=string]

Default Value

""

Remarks

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

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

Example 1. Setting MessageSet:

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

Data Type

String

MessageSize Property (SIMAP Control)

This property includes the size of the selected message.

Syntax

simapcontrol.MessageSize

Default Value

0

Remarks

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

Data Type

Long64

MessageSubject Property (SIMAP Control)

This property includes the subject of the message.

Syntax

simapcontrol.MessageSubject

Default Value

""

Remarks

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

Data Type

String

MessageText Property (SIMAP Control)

This property includes the body of the retrieved message.

Syntax

simapcontrol.MessageText[=string]

Default Value

""

Remarks

The control fills out this property with the contents of the message body (in RFC 822 format) when a call to RetrieveMessageText completes successfully and the LocalFile property is not set.

This property is not available at design time.

Data Type

String

Overwrite Property (SIMAP Control)

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

Syntax

simapcontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property is a value indicating whether or not the control 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.

Data Type

Boolean

Password Property (SIMAP Control)

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

Syntax

simapcontrol.Password[=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.

Data Type

String

PeekMode Property (SIMAP Control)

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

Syntax

simapcontrol.PeekMode[=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.

Data Type

Boolean

RecentMessageCount Property (SIMAP Control)

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

Syntax

simapcontrol.RecentMessageCount

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SignerCertEffectiveDate Property (SIMAP Control)

The date on which this certificate becomes valid.

Syntax

simapcontrol.SignerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SignerCertExpirationDate Property (SIMAP Control)

The date on which the certificate expires.

Syntax

simapcontrol.SignerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SignerCertExtendedKeyUsage Property (SIMAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

simapcontrol.SignerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SignerCertFingerprint Property (SIMAP Control)

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

Syntax

simapcontrol.SignerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

This property is read-only.

Data Type

String

SignerCertFingerprintSHA1 Property (SIMAP Control)

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

Syntax

simapcontrol.SignerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SignerCertFingerprintSHA256 Property (SIMAP Control)

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

Syntax

simapcontrol.SignerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SignerCertIssuer Property (SIMAP Control)

The issuer of the certificate.

Syntax

simapcontrol.SignerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SignerCertPrivateKey Property (SIMAP Control)

The private key of the certificate (if available).

Syntax

simapcontrol.SignerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SignerCertPrivateKey may be available but not exportable. In this case, SignerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SignerCertPrivateKeyAvailable Property (SIMAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

simapcontrol.SignerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SignerCertPrivateKeyContainer Property (SIMAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

simapcontrol.SignerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SignerCertPublicKey Property (SIMAP Control)

The public key of the certificate.

Syntax

simapcontrol.SignerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SignerCertPublicKeyAlgorithm Property (SIMAP Control)

The textual description of the certificate's public key algorithm.

Syntax

simapcontrol.SignerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SignerCertPublicKeyLength Property (SIMAP Control)

The length of the certificate's public key (in bits).

Syntax

simapcontrol.SignerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SignerCertSerialNumber Property (SIMAP Control)

The serial number of the certificate encoded as a string.

Syntax

simapcontrol.SignerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SignerCertSignatureAlgorithm Property (SIMAP Control)

The text description of the certificate's signature algorithm.

Syntax

simapcontrol.SignerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SignerCertStore Property (SIMAP Control)

The name of the certificate store for the client certificate.

Syntax

simapcontrol.SignerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertStoreB.

Data Type

Binary String

SignerCertStorePassword Property (SIMAP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

simapcontrol.SignerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SignerCertStoreType Property (SIMAP Control)

The type of certificate store for this certificate.

Syntax

simapcontrol.SignerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SignerCertSubjectAltNames Property (SIMAP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

simapcontrol.SignerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SignerCertThumbprintMD5 Property (SIMAP Control)

The MD5 hash of the certificate.

Syntax

simapcontrol.SignerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA1 Property (SIMAP Control)

The SHA-1 hash of the certificate.

Syntax

simapcontrol.SignerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA256 Property (SIMAP Control)

The SHA-256 hash of the certificate.

Syntax

simapcontrol.SignerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertUsage Property (SIMAP Control)

The text description of UsageFlags .

Syntax

simapcontrol.SignerCertUsage

Default Value

""

Remarks

The text description of SignerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

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

This property is read-only.

Data Type

String

SignerCertUsageFlags Property (SIMAP Control)

The flags that show intended use for the certificate.

Syntax

simapcontrol.SignerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SignerCertUsageFlags is a combination of the following flags:

Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SignerCertVersion Property (SIMAP Control)

The certificate's version number.

Syntax

simapcontrol.SignerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SignerCertSubject Property (SIMAP Control)

The subject of the certificate used for client authentication.

Syntax

simapcontrol.SignerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SignerCertEncoded Property (SIMAP Control)

The certificate (PEM/Base64 encoded).

Syntax

simapcontrol.SignerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SignerCertChainCount Property (SIMAP Control)

The number of records in the SignerCertChain arrays.

Syntax

simapcontrol.SignerCertChainCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignerCertChainEffectiveDate
• SignerCertChainEncoded
• SignerCertChainExpirationDate
• SignerCertChainExtendedKeyUsage
• SignerCertChainFingerprint
• SignerCertChainFingerprintSHA1
• SignerCertChainFingerprintSHA256
• SignerCertChainIssuer
• SignerCertChainPrivateKey
• SignerCertChainPrivateKeyAvailable
• SignerCertChainPrivateKeyContainer
• SignerCertChainPublicKey
• SignerCertChainPublicKeyAlgorithm
• SignerCertChainPublicKeyLength
• SignerCertChainSerialNumber
• SignerCertChainSignatureAlgorithm
• SignerCertChainStore
• SignerCertChainStorePassword
• SignerCertChainStoreType
• SignerCertChainSubject
• SignerCertChainSubjectAltNames
• SignerCertChainThumbprintMD5
• SignerCertChainThumbprintSHA1
• SignerCertChainThumbprintSHA256
• SignerCertChainUsage
• SignerCertChainUsageFlags
• SignerCertChainVersion

The array indices start at 0 and end at SignerCertChainCount - 1.

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

Data Type

Integer

SignerCertChainEffectiveDate Property (SIMAP Control)

The date on which this certificate becomes valid.

Syntax

simapcontrol.SignerCertChainEffectiveDate(SignerCertChainIndex)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainExpirationDate Property (SIMAP Control)

The date on which the certificate expires.

Syntax

simapcontrol.SignerCertChainExpirationDate(SignerCertChainIndex)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainExtendedKeyUsage Property (SIMAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

simapcontrol.SignerCertChainExtendedKeyUsage(SignerCertChainIndex)

Default Value

""

Remarks

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainFingerprint Property (SIMAP Control)

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

Syntax

simapcontrol.SignerCertChainFingerprint(SignerCertChainIndex)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainFingerprintSHA1 Property (SIMAP Control)

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

Syntax

simapcontrol.SignerCertChainFingerprintSHA1(SignerCertChainIndex)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainFingerprintSHA256 Property (SIMAP Control)

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

Syntax

simapcontrol.SignerCertChainFingerprintSHA256(SignerCertChainIndex)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainIssuer Property (SIMAP Control)

The issuer of the certificate.

Syntax

simapcontrol.SignerCertChainIssuer(SignerCertChainIndex)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainPrivateKey Property (SIMAP Control)

The private key of the certificate (if available).

Syntax

simapcontrol.SignerCertChainPrivateKey(SignerCertChainIndex)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SignerCertChainPrivateKey may be available but not exportable. In this case, SignerCertChainPrivateKey returns an empty string.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainPrivateKeyAvailable Property (SIMAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

simapcontrol.SignerCertChainPrivateKeyAvailable(SignerCertChainIndex)

Default Value

False

Remarks

Whether a SignerCertChainPrivateKey is available for the selected certificate. If SignerCertChainPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

Boolean

SignerCertChainPrivateKeyContainer Property (SIMAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

simapcontrol.SignerCertChainPrivateKeyContainer(SignerCertChainIndex)

Default Value

""

Remarks

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainPublicKey Property (SIMAP Control)

The public key of the certificate.

Syntax

simapcontrol.SignerCertChainPublicKey(SignerCertChainIndex)

Default Value

""

Remarks

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainPublicKeyAlgorithm Property (SIMAP Control)

The textual description of the certificate's public key algorithm.

Syntax

simapcontrol.SignerCertChainPublicKeyAlgorithm(SignerCertChainIndex)

Default Value

""

Remarks

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.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainPublicKeyLength Property (SIMAP Control)

The length of the certificate's public key (in bits).

Syntax

simapcontrol.SignerCertChainPublicKeyLength(SignerCertChainIndex)

Default Value

0

Remarks

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

Integer

SignerCertChainSerialNumber Property (SIMAP Control)

The serial number of the certificate encoded as a string.

Syntax

simapcontrol.SignerCertChainSerialNumber(SignerCertChainIndex)

Default Value

""

Remarks

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.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainSignatureAlgorithm Property (SIMAP Control)

The text description of the certificate's signature algorithm.

Syntax

simapcontrol.SignerCertChainSignatureAlgorithm(SignerCertChainIndex)

Default Value

""

Remarks

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.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainStore Property (SIMAP Control)

The name of the certificate store for the client certificate.

Syntax

simapcontrol.SignerCertChainStore(SignerCertChainIndex)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SignerCertChainStoreType property denotes the type of the certificate store specified by SignerCertChainStore. If the store is password-protected, specify the password in SignerCertChainStorePassword.

SignerCertChainStore is used in conjunction with the SignerCertChainSubject property to specify client certificates. If SignerCertChainStore has a value, and SignerCertChainSubject or SignerCertChainEncoded is set, a search for a certificate is initiated. Please see the SignerCertChainSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertChainStoreB.

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

Data Type

Binary String

SignerCertChainStorePassword Property (SIMAP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

simapcontrol.SignerCertChainStorePassword(SignerCertChainIndex)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainStoreType Property (SIMAP Control)

The type of certificate store for this certificate.

Syntax

simapcontrol.SignerCertChainStoreType(SignerCertChainIndex)

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

Integer

SignerCertChainSubjectAltNames Property (SIMAP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

simapcontrol.SignerCertChainSubjectAltNames(SignerCertChainIndex)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainThumbprintMD5 Property (SIMAP Control)

The MD5 hash of the certificate.

Syntax

simapcontrol.SignerCertChainThumbprintMD5(SignerCertChainIndex)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainThumbprintSHA1 Property (SIMAP Control)

The SHA-1 hash of the certificate.

Syntax

simapcontrol.SignerCertChainThumbprintSHA1(SignerCertChainIndex)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainThumbprintSHA256 Property (SIMAP Control)

The SHA-256 hash of the certificate.

Syntax

simapcontrol.SignerCertChainThumbprintSHA256(SignerCertChainIndex)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainUsage Property (SIMAP Control)

The text description of UsageFlags .

Syntax

simapcontrol.SignerCertChainUsage(SignerCertChainIndex)

Default Value

""

Remarks

The text description of SignerCertChainUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainUsageFlags Property (SIMAP Control)

The flags that show intended use for the certificate.

Syntax

simapcontrol.SignerCertChainUsageFlags(SignerCertChainIndex)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SignerCertChainUsageFlags is a combination of the following flags:

Please see the SignerCertChainUsage property for a text representation of SignerCertChainUsageFlags.

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

Integer

SignerCertChainVersion Property (SIMAP Control)

The certificate's version number.

Syntax

simapcontrol.SignerCertChainVersion(SignerCertChainIndex)

Default Value

""

Remarks

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainSubject Property (SIMAP Control)

The subject of the certificate used for client authentication.

Syntax

simapcontrol.SignerCertChainSubject(SignerCertChainIndex)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

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

Data Type

String

SignerCertChainEncoded Property (SIMAP Control)

The certificate (PEM/Base64 encoded).

Syntax

simapcontrol.SignerCertChainEncoded(SignerCertChainIndex)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertChainStore and SignerCertChainSubject properties also may be used to specify a certificate.

When SignerCertChainEncoded is set, a search is initiated in the current SignerCertChainStore for the private key of the certificate. If the key is found, SignerCertChainSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertChainSubject is set to an empty string.

The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertChainEncodedB.

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

Data Type

Binary String

SigningAlgorithm Property (SIMAP Control)

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

Syntax

simapcontrol.SigningAlgorithm[=string]

Default Value

"SHA256"

Remarks

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

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

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

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

Data Type

String

SortCriteria Property (SIMAP Control)

This property sorts criteria to use for message retrieval operations.

Syntax

simapcontrol.SortCriteria[=string]

Default Value

""

Remarks

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

Example. Setting SortCriteria:

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

Possible sort keys include the following:

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (SIMAP Control)

The date on which this certificate becomes valid.

Syntax

simapcontrol.SSLAcceptServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (SIMAP Control)

The date on which the certificate expires.

Syntax

simapcontrol.SSLAcceptServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (SIMAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

simapcontrol.SSLAcceptServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (SIMAP Control)

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

Syntax

simapcontrol.SSLAcceptServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (SIMAP Control)

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

Syntax

simapcontrol.SSLAcceptServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (SIMAP Control)

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

Syntax

simapcontrol.SSLAcceptServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (SIMAP Control)

The issuer of the certificate.

Syntax

simapcontrol.SSLAcceptServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (SIMAP Control)

The private key of the certificate (if available).

Syntax

simapcontrol.SSLAcceptServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (SIMAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

simapcontrol.SSLAcceptServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (SIMAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

simapcontrol.SSLAcceptServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (SIMAP Control)

The public key of the certificate.

Syntax

simapcontrol.SSLAcceptServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (SIMAP Control)

The textual description of the certificate's public key algorithm.

Syntax

simapcontrol.SSLAcceptServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (SIMAP Control)

The length of the certificate's public key (in bits).

Syntax

simapcontrol.SSLAcceptServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (SIMAP Control)

The serial number of the certificate encoded as a string.

Syntax

simapcontrol.SSLAcceptServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (SIMAP Control)

The text description of the certificate's signature algorithm.

Syntax

simapcontrol.SSLAcceptServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (SIMAP Control)

The name of the certificate store for the client certificate.

Syntax

simapcontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (SIMAP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

simapcontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (SIMAP Control)

The type of certificate store for this certificate.

Syntax

simapcontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (SIMAP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

simapcontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (SIMAP Control)

The MD5 hash of the certificate.

Syntax

simapcontrol.SSLAcceptServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (SIMAP Control)

The SHA-1 hash of the certificate.

Syntax

simapcontrol.SSLAcceptServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (SIMAP Control)

The SHA-256 hash of the certificate.

Syntax

simapcontrol.SSLAcceptServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (SIMAP Control)

The text description of UsageFlags .

Syntax

simapcontrol.SSLAcceptServerCertUsage

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (SIMAP Control)

The flags that show intended use for the certificate.

Syntax

simapcontrol.SSLAcceptServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (SIMAP Control)

The certificate's version number.

Syntax

simapcontrol.SSLAcceptServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (SIMAP Control)

The subject of the certificate used for client authentication.

Syntax

simapcontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (SIMAP Control)

The certificate (PEM/Base64 encoded).

Syntax

simapcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (SIMAP Control)

The date on which this certificate becomes valid.

Syntax

simapcontrol.SSLCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (SIMAP Control)

The date on which the certificate expires.

Syntax

simapcontrol.SSLCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (SIMAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

simapcontrol.SSLCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (SIMAP Control)

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

Syntax

simapcontrol.SSLCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (SIMAP Control)

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

Syntax

simapcontrol.SSLCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (SIMAP Control)

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

Syntax

simapcontrol.SSLCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (SIMAP Control)

The issuer of the certificate.

Syntax

simapcontrol.SSLCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (SIMAP Control)

The private key of the certificate (if available).

Syntax

simapcontrol.SSLCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (SIMAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

simapcontrol.SSLCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (SIMAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

simapcontrol.SSLCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (SIMAP Control)

The public key of the certificate.

Syntax

simapcontrol.SSLCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (SIMAP Control)

The textual description of the certificate's public key algorithm.

Syntax

simapcontrol.SSLCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (SIMAP Control)

The length of the certificate's public key (in bits).

Syntax

simapcontrol.SSLCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (SIMAP Control)

The serial number of the certificate encoded as a string.

Syntax

simapcontrol.SSLCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (SIMAP Control)

The text description of the certificate's signature algorithm.

Syntax

simapcontrol.SSLCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLCertStore Property (SIMAP Control)

The name of the certificate store for the client certificate.

Syntax

simapcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (SIMAP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

simapcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (SIMAP Control)

The type of certificate store for this certificate.

Syntax

simapcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (SIMAP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

simapcontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (SIMAP Control)

The MD5 hash of the certificate.

Syntax

simapcontrol.SSLCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (SIMAP Control)

The SHA-1 hash of the certificate.

Syntax

simapcontrol.SSLCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (SIMAP Control)

The SHA-256 hash of the certificate.

Syntax

simapcontrol.SSLCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (SIMAP Control)

The text description of UsageFlags .

Syntax

simapcontrol.SSLCertUsage

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (SIMAP Control)

The flags that show intended use for the certificate.

Syntax

simapcontrol.SSLCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (SIMAP Control)

The certificate's version number.

Syntax

simapcontrol.SSLCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (SIMAP Control)

The subject of the certificate used for client authentication.

Syntax

simapcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (SIMAP Control)

The certificate (PEM/Base64 encoded).

Syntax

simapcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLEnabled Property (SIMAP Control)

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

Syntax

simapcontrol.SSLEnabled[=boolean]

Default Value

False

Remarks

This property specifies whether TLS/SSL is enabled in the control. When False (default), the control 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.

Data Type

Boolean

SSLProvider Property (SIMAP Control)

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

Syntax

simapcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (SIMAP Control)

The date on which this certificate becomes valid.

Syntax

simapcontrol.SSLServerCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (SIMAP Control)

The date on which the certificate expires.

Syntax

simapcontrol.SSLServerCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (SIMAP Control)

A comma-delimited list of extended key usage identifiers.

Syntax

simapcontrol.SSLServerCertExtendedKeyUsage

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (SIMAP Control)

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

Syntax

simapcontrol.SSLServerCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (SIMAP Control)

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

Syntax

simapcontrol.SSLServerCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (SIMAP Control)

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

Syntax

simapcontrol.SSLServerCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (SIMAP Control)

The issuer of the certificate.

Syntax

simapcontrol.SSLServerCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (SIMAP Control)

The private key of the certificate (if available).

Syntax

simapcontrol.SSLServerCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (SIMAP Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

simapcontrol.SSLServerCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (SIMAP Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

simapcontrol.SSLServerCertPrivateKeyContainer

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (SIMAP Control)

The public key of the certificate.

Syntax

simapcontrol.SSLServerCertPublicKey

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (SIMAP Control)

The textual description of the certificate's public key algorithm.

Syntax

simapcontrol.SSLServerCertPublicKeyAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (SIMAP Control)

The length of the certificate's public key (in bits).

Syntax

simapcontrol.SSLServerCertPublicKeyLength

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (SIMAP Control)

The serial number of the certificate encoded as a string.

Syntax

simapcontrol.SSLServerCertSerialNumber

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (SIMAP Control)

The text description of the certificate's signature algorithm.

Syntax

simapcontrol.SSLServerCertSignatureAlgorithm

Default Value

""

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertStore Property (SIMAP Control)

The name of the certificate store for the client certificate.

Syntax

simapcontrol.SSLServerCertStore

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (SIMAP Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

simapcontrol.SSLServerCertStorePassword

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (SIMAP Control)

The type of certificate store for this certificate.

Syntax

simapcontrol.SSLServerCertStoreType

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (SIMAP Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

simapcontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (SIMAP Control)

The MD5 hash of the certificate.

Syntax

simapcontrol.SSLServerCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (SIMAP Control)

The SHA-1 hash of the certificate.

Syntax

simapcontrol.SSLServerCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (SIMAP Control)

The SHA-256 hash of the certificate.

Syntax

simapcontrol.SSLServerCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (SIMAP Control)

The text description of UsageFlags .

Syntax

simapcontrol.SSLServerCertUsage

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (SIMAP Control)

The flags that show intended use for the certificate.

Syntax

simapcontrol.SSLServerCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (SIMAP Control)

The certificate's version number.

Syntax

simapcontrol.SSLServerCertVersion

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (SIMAP Control)

The subject of the certificate used for client authentication.

Syntax

simapcontrol.SSLServerCertSubject

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (SIMAP Control)

The certificate (PEM/Base64 encoded).

Syntax

simapcontrol.SSLServerCertEncoded

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

SSLStartMode Property (SIMAP Control)

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

Syntax

simapcontrol.SSLStartMode[=integer]

Possible Values

sslAutomatic(0), 
sslImplicit(1), 
sslExplicit(2), 
sslNone(3)

Default Value

3

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

StartByte Property (SIMAP Control)

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

Syntax

simapcontrol.StartByte[=long64]

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

Timeout Property (SIMAP Control)

The timeout for the control.

Syntax

simapcontrol.Timeout[=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 control will wait for the operation to complete before returning control.

The control 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 control fails with an error.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UIDMode Property (SIMAP Control)

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

Syntax

simapcontrol.UIDMode[=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.

Data Type

Boolean

UIDValidity Property (SIMAP Control)

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

Syntax

simapcontrol.UIDValidity

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.

Data Type

String

User Property (SIMAP Control)

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

Syntax

simapcontrol.User[=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.

Data Type

String

AddMessageFlags Method (SIMAP Control)

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

Syntax

simapcontrol.AddMessageFlags Flags

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:

Example. Setting Adding Message Flags:

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

AppendToMailbox Method (SIMAP Control)

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

Syntax

simapcontrol.AppendToMailbox 

Remarks

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

Example. Append Message to Mailbox:

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

CheckMailbox Method (SIMAP Control)

This method sends a CHECK command to the server.

Syntax

simapcontrol.CheckMailbox 

Remarks

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

CheckMessageEncrypted Method (SIMAP Control)

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

Syntax

simapcontrol.CheckMessageEncrypted 

Remarks

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

CheckMessageSigned Method (SIMAP Control)

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

Syntax

simapcontrol.CheckMessageSigned 

Remarks

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

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

CloseMailbox Method (SIMAP Control)

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

Syntax

simapcontrol.CloseMailbox 

Remarks

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

Config Method (SIMAP Control)

Sets or retrieves a configuration setting.

Syntax

simapcontrol.Config ConfigurationString

Remarks

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

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

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

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

Connect Method (SIMAP Control)

This method connects to an IMAP server.

Syntax

simapcontrol.Connect 

Remarks

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

Example. Connect IMAP Server:

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

CopyToMailbox Method (SIMAP Control)

Copies the specified messages to another mailbox.

Syntax

simapcontrol.CopyToMailbox 

Remarks

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

CreateMailbox Method (SIMAP Control)

This method creates a new mailbox specified by Mailbox .

Syntax

simapcontrol.CreateMailbox 

Remarks

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

Decrypt Method (SIMAP Control)

This method decrypts the current Message .

Syntax

simapcontrol.Decrypt 

Remarks

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

DecryptAndVerifySignature Method (SIMAP Control)

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

Syntax

simapcontrol.DecryptAndVerifySignature 

Remarks

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

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

DeleteFromMailbox Method (SIMAP Control)

The method marks the messages specified by MessageSet as deleted.

Syntax

simapcontrol.DeleteFromMailbox 

Remarks

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

DeleteMailbox Method (SIMAP Control)

This method deletes a mailbox specified by Mailbox .

Syntax

simapcontrol.DeleteMailbox 

Remarks

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

DeleteMailboxACL Method (SIMAP Control)

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

Syntax

simapcontrol.DeleteMailboxACL User

Remarks

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

Disconnect Method (SIMAP Control)

This method disconnects from an IMAP server.

Syntax

simapcontrol.Disconnect 

Remarks

This method logs out and disconnects from the IMAP server.

DoEvents Method (SIMAP Control)

This method processes events from the internal message queue.

Syntax

simapcontrol.DoEvents 

Remarks

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

ExamineMailbox Method (SIMAP Control)

This method selects a mailbox in read-only mode.

Syntax

simapcontrol.ExamineMailbox 

Remarks

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

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

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

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

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

ExpungeMailbox Method (SIMAP Control)

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

Syntax

simapcontrol.ExpungeMailbox 

Remarks

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

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

GetMailboxACL Method (SIMAP Control)

This method retrieves mailbox access control rights.

Syntax

simapcontrol.GetMailboxACL 

Remarks

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

Interrupt Method (SIMAP Control)

This method interrupts the current method.

Syntax

simapcontrol.Interrupt 

Remarks

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

ListMailboxes Method (SIMAP Control)

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

Syntax

simapcontrol.ListMailboxes 

Remarks

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

Example 1. List All Mailboxes:

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

Example 2. List All Mailboxes Inside INBOX:

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

ListSubscribedMailboxes Method (SIMAP Control)

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

Syntax

simapcontrol.ListSubscribedMailboxes 

Remarks

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

Example 1. List All Subscribed Mailboxes:

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

Example 2. List All Subscribed Mailboxes Inside INBOX:

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

LocalizeDate Method (SIMAP Control)

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

Syntax

simapcontrol.LocalizeDate DateTime

Remarks

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

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

MoveToMailbox Method (SIMAP Control)

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

Syntax

simapcontrol.MoveToMailbox 

Remarks

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

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

Noop Method (SIMAP Control)

This method sends a NOOP command to the server.

Syntax

simapcontrol.Noop 

Remarks

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

RenameMailbox Method (SIMAP Control)

This method changes the name of Mailbox to NewName .

Syntax

simapcontrol.RenameMailbox NewName

Remarks

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

Reset Method (SIMAP Control)

This method will reset the control.

Syntax

simapcontrol.Reset 

Remarks

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

ResetMessageFlags Method (SIMAP Control)

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

Syntax

simapcontrol.ResetMessageFlags 

Remarks

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

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

RetrieveMessageHeaders Method (SIMAP Control)

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

Syntax

simapcontrol.RetrieveMessageHeaders 

Remarks

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

RetrieveMessageInfo Method (SIMAP Control)

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

Syntax

simapcontrol.RetrieveMessageInfo 

Remarks

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

RetrieveMessagePart Method (SIMAP Control)

This method retrieves the message part specified by PartID.

Syntax

simapcontrol.RetrieveMessagePart PartId

Remarks

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

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

RetrieveMessagePartHeaders Method (SIMAP Control)

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

Syntax

simapcontrol.RetrieveMessagePartHeaders PartId

Remarks

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

RetrieveMessageText Method (SIMAP Control)

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

Syntax

simapcontrol.RetrieveMessageText 

Remarks

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

SearchMailbox Method (SIMAP Control)

This method searches the selected mailbox for specified text.

Syntax

simapcontrol.SearchMailbox SearchCriteria

Remarks

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

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

Possible search keys include the following:

SelectMailbox Method (SIMAP Control)

This method selects a mailbox.

Syntax

simapcontrol.SelectMailbox 

Remarks

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

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

IMAPControl.Mailbox = "INBOX" IMAPControl.SelectMailbox

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

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

SendCommand Method (SIMAP Control)

This method sends the exact command directly to the server.

Syntax

simapcontrol.SendCommand Command

Remarks

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

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

SetMailboxACL Method (SIMAP Control)

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

Syntax

simapcontrol.SetMailboxACL User, Rights

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:

StartIdle Method (SIMAP Control)

This method begins idling.

Syntax

simapcontrol.StartIdle 

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.

If the control is being used in a formless application (such as a console application) be sure to call DoEvents in a loop after calling this method to ensure that incoming events are processed.

StopIdle Method (SIMAP Control)

This method stops idling.

Syntax

simapcontrol.StopIdle 

Remarks

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

SubscribeMailbox Method (SIMAP Control)

This method subscribes to the mailbox specified by Mailbox .

Syntax

simapcontrol.SubscribeMailbox 

Remarks

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

UnsetMessageFlags Method (SIMAP Control)

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

Syntax

simapcontrol.UnsetMessageFlags 

Remarks

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

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

UnsubscribeMailbox Method (SIMAP Control)

This method unsubscribes from the mailbox specified by Mailbox .

Syntax

simapcontrol.UnsubscribeMailbox 

Remarks

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

VerifySignature Method (SIMAP Control)

This method verifies the signature of the current message.

Syntax

simapcontrol.VerifySignature 

Remarks

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

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

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

ConnectionStatus Event (SIMAP Control)

Fired to indicate changes in the connection state.

Syntax

Sub simapcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

Remarks

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

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

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

EndTransfer Event (SIMAP Control)

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

Syntax

Sub simapcontrol_EndTransfer(Direction As Integer)

Remarks

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

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

Error Event (SIMAP Control)

Fired when information is available about errors during data delivery.

Syntax

Sub simapcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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

Header Event (SIMAP Control)

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

Syntax

Sub simapcontrol_Header(Field As String, Value As String)

Remarks

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

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

IdleInfo Event (SIMAP Control)

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

Syntax

Sub simapcontrol_IdleInfo(Message As String, Cancel As Boolean)

Remarks

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

Message holds the response received from the server.

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

The following are possible values returned by the server:

+ idling
* 43 EXISTS
* 1 RECENT

MailboxACL Event (SIMAP Control)

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

Syntax

Sub simapcontrol_MailboxACL(Mailbox As String, User As String, Rights As String)

Remarks

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

MailboxList Event (SIMAP Control)

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

Syntax

Sub simapcontrol_MailboxList(Mailbox As String, Separator As String, Flags As String)

Remarks

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

MessageInfo Event (SIMAP Control)

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

Syntax

Sub simapcontrol_MessageInfo(MessageId As String, Subject As String, MessageDate As String, From As String, Flags As String, Size As Long64)

Remarks

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

Id is the Id of the message.

Subject is the message subject.

MessageDate is the date of the message.

From is the email address of the sender.

Flags is a list of flags associated with this message.

Size is the size of the message.

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

MessagePart Event (SIMAP Control)

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

Syntax

Sub simapcontrol_MessagePart(PartId As String, Size As Long64, ContentType As String, FileName As String, ContentEncoding As String, Parameters As String, MultipartMode As String, ContentId As String, ContentDisposition As String)

Remarks

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

The Size parameter gives the size of this part.

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

The ContentEncoding parameter shows how data are encoded.

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

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

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

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

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

PITrail Event (SIMAP Control)

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

Syntax

Sub simapcontrol_PITrail(Direction As Integer, Message As String)

Remarks

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

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

SSLServerAuthentication Event (SIMAP Control)

Fired after the server presents its certificate to the client.

Syntax

Sub simapcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

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

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

SSLStatus Event (SIMAP Control)

Fired when secure connection progress messages are available.

Syntax

Sub simapcontrol_SSLStatus(Message As String)

Remarks

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

StartTransfer Event (SIMAP Control)

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

Syntax

Sub simapcontrol_StartTransfer(Direction As Integer)

Remarks

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

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

Transfer Event (SIMAP Control)

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

Syntax

Sub simapcontrol_Transfer(Direction As Integer, BytesTransferred As Long64, PercentDone As Integer, Text As String)

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.

Config Settings (SIMAP Control)

The control 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 control, access to these internal properties is provided through the Config method.

SIMAP Config Settings

IMAP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SIMAP Control)

IMAP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors