# PIMAP Class

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

## Syntax

```text
PIMAP
```

## Remarks

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

**Connect to a Mail Server**

The first step in using the class is specifying a [MailServer](#mailserver-property-pimap-class), a [User](#user-property-pimap-class) to connect as, and a [Password](#password-property-pimap-class) to authenticate with. After that, one or more requests may be sent to the server via the class's methods. Results are retrieved through events and a number of key properties.

**Examine a Mailbox**

Normally, after connecting to the server a [Mailbox](#mailbox-property-pimap-class) is selected (or examined) using the [ExamineMailbox](#examinemailbox-method-pimap-class) method. After the [Mailbox](#mailbox-property-pimap-class) is selected, [MessageCount](#messagecount-property-pimap-class) and [RecentMessageCount](#recentmessagecount-property-pimap-class) show the number of messages in the mailbox, and [MailboxFlags](#mailboxflags-property-pimap-class) shows the flags pertaining to the mailbox.

A number of operations may be performed by the server in response to commands sent via the class's methods. The primary arguments for most commands are the [Mailbox](#mailbox-property-pimap-class) property and the [MessageSet](#messageset-property-pimap-class) property. The [MessageSet](#messageset-property-pimap-class) property denotes either a single message or a range of messages. Other arguments are specified through other properties such as [SortCriteria](#sortcriteria-property-pimap-class), [MessageFlags](#messageflags-property-pimap-class), etc.

Responses are received through events such as [MessageInfo](#messageinfo-event-pimap-class) and [MailboxList](#mailboxlist-event-pimap-class), and are also reflected in properties such as [MessageText](#messagetext-property-pimap-class), [MessageSubject](#messagesubject-property-pimap-class), etc.

**Decrypt**

To process an encrypted or signed message, first retrieve the message text and headers by calling [RetrieveMessageHeaders](#retrievemessageheaders-method-pimap-class) and [RetrieveMessageText](#retrievemessagetext-method-pimap-class). To decrypt a message specify the private key to be used for decryption by setting the **Key*** properties. For instance:

```text
PIMAP1.KeyCount = 1
PIMAP1.KeyKeyring(0) = "c:\my_keyring_dir"
PIMAP1.KeyUserId(0) = "recipient@nsoftware.com"
PIMAP1.KeyPassphrase(0) = "password"
```

 The specified private key will be used to decrypt the message when calling [Decrypt](#decrypt-method-pimap-class).

**Verify**

To verify the signature of a message specify the public key to be used for signature verification by setting the **SignerKey*** properties. For instance:

```text
PIMAP1.SignerKeyCount = 1
PIMAP1.SignerKeyKeyring(0) = "c:\my_keyring_dir"
PIMAP1.SignerKeyUserId(0) = "sender@nsoftware.com"
```

 The specified public key will be used to verify the signature when calling [VerifySignature](#verifysignature-method-pimap-class). To decrypt and verify in one step call [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class).

**Retrieve MIME Message Parts**

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

**Trace Client and Server Communication**

The [PITrail](#pitrail-event-pimap-class) 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 class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AuthMechanism](#authmechanism-property-pimap-class) | This property includes the authentication mechanism to be used when connecting to the mail server. |
| [AutoDecodeParts](#autodecodeparts-property-pimap-class) | This property determines whether or not to automatically decode message parts. |
| [Connected](#connected-property-pimap-class) | Whether the class is connected. |
| [EndByte](#endbyte-property-pimap-class) | This property includes the byte index of the position where the transfer should end. |
| [Firewall](#firewall-property-pimap-class) | A set of properties related to firewall access. |
| [Idle](#idle-property-pimap-class) | The current status of the class. |
| [Keys](#keys-property-pimap-class) | A collection of keys used for cryptographic operations. |
| [LastReply](#lastreply-property-pimap-class) | This property indicates the last reply received from the server. |
| [LocalHost](#localhost-property-pimap-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [Mailbox](#mailbox-property-pimap-class) | This property includes the name of the mailbox selected on the server. |
| [MailboxFlags](#mailboxflags-property-pimap-class) | This property defines flags in the selected mailbox. |
| [MailboxList](#mailboxlist-property-pimap-class) | The property includes the collection of mailboxes listed by the server. |
| [MailPort](#mailport-property-pimap-class) | This property includes the port of the IMAP server (default is 143). |
| [MailServer](#mailserver-property-pimap-class) | This property includes the name or address of the mail server (IMAP server). |
| [Message](#message-property-pimap-class) | This property provides the raw message content. |
| [MessageContentEncoding](#messagecontentencoding-property-pimap-class) | This property includes the ContentEncoding of the selected message. |
| [MessageContentType](#messagecontenttype-property-pimap-class) | This property includes the ContentType of the message. |
| [MessageCount](#messagecount-property-pimap-class) | This property includes the total number of messages on the Mailbox . |
| [MessageDate](#messagedate-property-pimap-class) | The property includes the time the message was created. |
| [MessageDeliveryTime](#messagedeliverytime-property-pimap-class) | This property includes the time the message was delivered to the mail server. |
| [MessageFlags](#messageflags-property-pimap-class) | This property contains the flags of the current message. |
| [MessageFrom](#messagefrom-property-pimap-class) | This property includes the address of the author of the message. |
| [MessageHeaders](#messageheaders-property-pimap-class) | This property includes the collection of RFC 822-encoded headers of the message. |
| [MessageHeadersString](#messageheadersstring-property-pimap-class) | This property includes the string version of the RFC 822-encoded headers in the message. |
| [MessageId](#messageid-property-pimap-class) | This property includes the message identifier of the current message. |
| [MessageInfo](#messageinfo-property-pimap-class) | This property includes the collection of messages retrieved by RetrieveMessageInfo . |
| [MessageInReplyTo](#messageinreplyto-property-pimap-class) | This property includes the unique message identifier of the message being replied to. |
| [MessageNetId](#messagenetid-property-pimap-class) | This property includes the globally unique identifier of the message. |
| [MessageParts](#messageparts-property-pimap-class) | This property includes a collection of message parts collected by RetrieveMessageInfo . |
| [MessageRecipients](#messagerecipients-property-pimap-class) | This property includes a collection of recipients for the current message. |
| [MessageReplyTo](#messagereplyto-property-pimap-class) | This property includes the email addresses to which replies to the message should be sent. |
| [MessageSender](#messagesender-property-pimap-class) | This property includes the address of the sender of the message. |
| [MessageSet](#messageset-property-pimap-class) | This property includes the set of messages to operate on. |
| [MessageSize](#messagesize-property-pimap-class) | This property includes the size of the selected message. |
| [MessageSubject](#messagesubject-property-pimap-class) | This property includes the subject of the message. |
| [MessageText](#messagetext-property-pimap-class) | This property includes the body of the retrieved message. |
| [OAuth](#oauth-property-pimap-class) | The OAuth settings. |
| [Overwrite](#overwrite-property-pimap-class) | This property indicates whether or not the class should overwrite files during transfer. |
| [Password](#password-property-pimap-class) | This property includes the password to be used to authenticate to the MailServer . |
| [PeekMode](#peekmode-property-pimap-class) | When set to True, the message Seen flag is not changed during reading. |
| [RecentMessageCount](#recentmessagecount-property-pimap-class) | This property includes the number of new messages in the Mailbox . |
| [SignerKeys](#signerkeys-property-pimap-class) | The collection of keys belonging to the signer of the message. |
| [SortCriteria](#sortcriteria-property-pimap-class) | This property sorts criteria to use for message retrieval operations. |
| [SSLAcceptServerCert](#sslacceptservercert-property-pimap-class) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#sslcert-property-pimap-class) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLEnabled](#sslenabled-property-pimap-class) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
| [SSLProvider](#sslprovider-property-pimap-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#sslservercert-property-pimap-class) | The server certificate for the last established connection. |
| [SSLStartMode](#sslstartmode-property-pimap-class) | This property determines how the class starts the Secure Sockets Layer (SSL) negotiation. |
| [StartByte](#startbyte-property-pimap-class) | This property includes the byte index of the position where the transfer should start. |
| [Timeout](#timeout-property-pimap-class) | The timeout for the class. |
| [UIDMode](#uidmode-property-pimap-class) | If True, this property indicates whether permanent message identifiers are used instead of the default temporary identifiers. |
| [UIDValidity](#uidvalidity-property-pimap-class) | This property includes the UIDValidity parameter sent from the server in response to SelectMailbox command. |
| [User](#user-property-pimap-class) | This property includes the username used to authenticate to the MailServer . |

## Method List

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

|  |  |
| --- | --- |
| [AddMessageFlags](#addmessageflags-method-pimap-class) | This method adds the specified flags to the messages specified by MessageSet . |
| [AppendToMailbox](#appendtomailbox-method-pimap-class) | This method appends the message in MessageText to the mailbox specified by Mailbox . |
| [CheckMailbox](#checkmailbox-method-pimap-class) | This method sends a CHECK command to the server. |
| [CloseMailbox](#closemailbox-method-pimap-class) | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox and closes the unselected mailbox. |
| [Config](#config-method-pimap-class) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-pimap-class) | This method connects to an IMAP server. |
| [CopyToMailbox](#copytomailbox-method-pimap-class) | Copies the specified messages to another mailbox. |
| [CreateMailbox](#createmailbox-method-pimap-class) | This method creates a new mailbox specified by Mailbox . |
| [Decrypt](#decrypt-method-pimap-class) | Decrypts the message. |
| [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class) | Decrypts and verifies the signature of the message. |
| [DeleteFromMailbox](#deletefrommailbox-method-pimap-class) | The method marks the messages specified by MessageSet as deleted. |
| [DeleteMailbox](#deletemailbox-method-pimap-class) | This method deletes a mailbox specified by Mailbox . |
| [DeleteMailboxACL](#deletemailboxacl-method-pimap-class) | This method deletes mailbox access control rights for a specific user. |
| [Disconnect](#disconnect-method-pimap-class) | This method disconnects from an IMAP server. |
| [DoEvents](#doevents-method-pimap-class) | This method processes events from the internal message queue. |
| [ExamineMailbox](#examinemailbox-method-pimap-class) | This method selects a mailbox in read-only mode. |
| [ExpungeMailbox](#expungemailbox-method-pimap-class) | This method removes all messages marked with a 'Deleted' flag from the currently selected mailbox. |
| [GetMailboxACL](#getmailboxacl-method-pimap-class) | This method retrieves mailbox access control rights. |
| [Interrupt](#interrupt-method-pimap-class) | This method interrupts the current method. |
| [ListMailboxes](#listmailboxes-method-pimap-class) | This method lists all of the mailboxes matching all criteria in the Mailbox property. |
| [ListSubscribedMailboxes](#listsubscribedmailboxes-method-pimap-class) | This method lists all subscribed mailboxes matching all criteria in the Mailbox property. |
| [LocalizeDate](#localizedate-method-pimap-class) | This method converts a valid RFC 822 message date to a local date and time. |
| [MoveToMailbox](#movetomailbox-method-pimap-class) | Copies the specified messages to another mailbox and marks the original messages as deleted. |
| [Noop](#noop-method-pimap-class) | This method sends a NOOP command to the server. |
| [RenameMailbox](#renamemailbox-method-pimap-class) | This method changes the name of Mailbox to NewName . |
| [ResetMessageFlags](#resetmessageflags-method-pimap-class) | This method replaces the flags of the messages specified by MessageSet with the flags specified by MessageFlags . |
| [RetrieveMessageHeaders](#retrievemessageheaders-method-pimap-class) | This method retrieves the message headers of the messages specified by the MessageSet property. |
| [RetrieveMessageInfo](#retrievemessageinfo-method-pimap-class) | This method retrieves information about messages specified by the MessageSet property. |
| [RetrieveMessagePart](#retrievemessagepart-method-pimap-class) | This method retrieves the message part specified by PartID. |
| [RetrieveMessagePartHeaders](#retrievemessagepartheaders-method-pimap-class) | This method retrieves the headers of message part specified by PartID. |
| [RetrieveMessageText](#retrievemessagetext-method-pimap-class) | This method retrieves the message text of the messages specified by the MessageSet property. |
| [SearchMailbox](#searchmailbox-method-pimap-class) | This method searches the selected mailbox for specified text. |
| [SelectMailbox](#selectmailbox-method-pimap-class) | This method selects a mailbox. |
| [SendCommand](#sendcommand-method-pimap-class) | This method sends the exact command directly to the server. |
| [SetMailboxACL](#setmailboxacl-method-pimap-class) | This method sets mailbox access control rights for a specific user. |
| [SetMessageStream](#setmessagestream-method-pimap-class) | This method sets the stream to which the message (or message part) downloaded from the server will be written. |
| [StartIdle](#startidle-method-pimap-class) | This method begins idling. |
| [StopIdle](#stopidle-method-pimap-class) | This method stops idling. |
| [SubscribeMailbox](#subscribemailbox-method-pimap-class) | This method subscribes to the mailbox specified by Mailbox . |
| [UnsetMessageFlags](#unsetmessageflags-method-pimap-class) | This method removes the flags specified by MessageFlags from the messages specified by MessageSet . |
| [UnsubscribeMailbox](#unsubscribemailbox-method-pimap-class) | This method unsubscribes from the mailbox specified by Mailbox . |
| [VerifySignature](#verifysignature-method-pimap-class) | Verifies the signature of the current message. |

## Event List

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

|  |  |
| --- | --- |
| [ConnectionStatus](#connectionstatus-event-pimap-class) | Fired to indicate changes in the connection state. |
| [EndTransfer](#endtransfer-event-pimap-class) | This event is fired when the message or the part data finishes transferring. |
| [Error](#error-event-pimap-class) | Fired when information is available about errors during data delivery. |
| [Header](#header-event-pimap-class) | This event is fired every time a header line comes in. |
| [IdleInfo](#idleinfo-event-pimap-class) | This event fires whenever responses from the server are received while idling. |
| [KeyPassphrase](#keypassphrase-event-pimap-class) | Fired if the passphrase of current key is incorrect or empty. |
| [LaunchBrowser](#launchbrowser-event-pimap-class) | Fires before launching a browser with the authorization URL. |
| [Log](#log-event-pimap-class) | Fired once for each log message. |
| [MailboxACL](#mailboxacl-event-pimap-class) | This event fires for each set of access control rights returned by the server. |
| [MailboxList](#mailboxlist-event-pimap-class) | This event fires for each mailbox received through the ListMailboxes and ListSubscribedMailboxes methods. |
| [MessageInfo](#messageinfo-event-pimap-class) | This event is fired with information for the messages retrieved by the server. |
| [MessagePart](#messagepart-event-pimap-class) | This event is fired for each message part when RetrieveMessageInfo is called. |
| [PITrail](#pitrail-event-pimap-class) | This event traces the commands sent to the mail server, and the respective replies. |
| [Progress](#progress-event-pimap-class) | Fired as progress is made. |
| [RecipientInfo](#recipientinfo-event-pimap-class) | Fired for each recipient key of the encrypted message. |
| [SignatureInfo](#signatureinfo-event-pimap-class) | Fired during verification of the signed message. |
| [SSLServerAuthentication](#sslserverauthentication-event-pimap-class) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-pimap-class) | Fired when secure connection progress messages are available. |
| [StartTransfer](#starttransfer-event-pimap-class) | This event is fired when the message body or the part data start transferring. |
| [Status](#status-event-pimap-class) | Shows the progress of the operation. |
| [Transfer](#transfer-event-pimap-class) | This event is fired while the message is transferred from the MailServer . |
| [VerificationStatus](#verificationstatus-event-pimap-class) | Fired after verification of the signed message. |

## Config Settings

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

|  |  |
| --- | --- |
| [Comment](#Comment) | The OpenPGP message comment. |
| [LogLevel](#LogLevel) | Specifies the level of detail that is logged. |
| [ProcessAttachments](#ProcessAttachments) | Whether or not to process attachments. |
| [RequireValidSignature](#RequireValidSignature) | Specifies if an invalid signature is considered an error condition. |
| [SymmetricPassphrase](#SymmetricPassphrase) | The password used for symmetric encryption or decryption. |
| [VerifyClearTextSignatureWithCache](#VerifyClearTextSignatureWithCache) | Whether the cleartext message is cached in memory when verifying a cleartext signature. |
| [VersionHeader](#VersionHeader) | The Version header value in the ASCII armored OpenPGP message. |
| [RedownloadHeaders](#RedownloadHeaders) | Whether or not to redownload the message headers when querying MessageEncrypted or MessageSigned. |
| [AlwaysReturnUIDs](#AlwaysReturnUIDs) | Instructs the server to return UIDs even if not in UIDMode. |
| [AppendToMailboxDateTime](#AppendToMailboxDateTime) | Specifies the date-time parameter used in the initial APPEND request. |
| [AuthorizationIdentity](#AuthorizationIdentity) | The value to use as the authorization identity when SASL authentication is used. |
| [AutoDecodeSubject](#AutoDecodeSubject) | Instructs the class to automatically decode message subjects. |
| [AutoDecodeText](#AutoDecodeText) | Whether to decode MessageText when AutoDecodeParts is True. |
| [IncludeHeaders](#IncludeHeaders) | Instructs the class to include the headers in the LocalFile. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive properties should be masked when logging. |
| [RetrieveAfterSearch](#RetrieveAfterSearch) | Determines if messages matching the SearchCriteria are retrieved after calling SearchMailbox. |
| [RetrieveTextAndHeaders](#RetrieveTextAndHeaders) | Specifies whether the message body and headers are retrieved in a single request. |
| [SendIDCommand](#SendIDCommand) | Instructs class to send the ID command if the server advertises support for it. |
| [UTF7MailboxNames](#UTF7MailboxNames) | Specifies whether or not to automatically encode and decode UTF-7 mailbox names. |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveRetryCount](#KeepAliveRetryCount) | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# AuthMechanism Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetAuthMechanism();int SetAuthMechanism(int iAuthMechanism);

Unicode (Windows)
INT GetAuthMechanism();INT SetAuthMechanism(INT iAuthMechanism);
```

## Possible Values

```text
AM_USER_PASSWORD(0), AM_CRAMMD5(1), AM_NTLM(2), AM_APOP(3), AM_SASLPLAIN(4), AM_SASLDIGEST_MD5(5), AM_KERBEROS(6), AM_XOAUTH2(7)
```

## Default Value

0

## Remarks

| Auth Mechanism | Description |
| --- | --- |
| 0 (amUserPassword - Default) | A user/password pair is sent in plaintext to login (default). |
| 1 (amCRAMMD5) | CRAM-MD5 authentication. |
| 2 (amNTLM) | NTLM authentication. |
| 4 (amSASLPlain) | SASLPlain. NOTE: Servers often require the Secure Sockets Layer (SSL) to be used when this authentication mechanism is requested. See [AuthorizationIdentity](#AuthorizationIdentity). |
| 5 (amSASLDigestMD5) | SASLDigestMD5. See [AuthorizationIdentity](#AuthorizationIdentity). |
| 6 (amKerberos) | Kerberos authentication. This option is available in Windows or other platforms when using the Java edition. |
| 7 (mXOAUTH) | XOAUTH2 authentication. See [AuthorizationIdentity](#AuthorizationIdentity). |

## Data Type

Integer

# AutoDecodeParts Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetAutoDecodeParts();int SetAutoDecodeParts(int bAutoDecodeParts);

Unicode (Windows)
BOOL GetAutoDecodeParts();INT SetAutoDecodeParts(BOOL bAutoDecodeParts);
```

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

# Connected Property ([PIMAP](#pimap-class) Class)

Whether the class is connected.

## Syntax

```text
ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();
```

## Default Value

FALSE

## Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the [Connect](#connect-method-pimap-class) and [Disconnect](#disconnect-method-pimap-class) methods to manage the connection.

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

## Data Type

Boolean

# EndByte Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int64 GetEndByte();int SetEndByte(int64 lEndByte);

Unicode (Windows)
LONG64 GetEndByte();INT SetEndByte(LONG64 lEndByte);
```

## Default Value

0

## Remarks

[StartByte](#startbyte-property-pimap-class) and EndByte are used together with the [RetrieveMessagePart](#retrievemessagepart-method-pimap-class) method to specify the portion of the message to be retrieved from the server.

When [StartByte](#startbyte-property-pimap-class) 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

# Firewall Property ([PIMAP](#pimap-class) Class)

A set of properties related to firewall access.

## Syntax

```text
IPWorksPGPFirewall* GetFirewall();
int SetFirewall(IPWorksPGPFirewall* val);
```

## Remarks

This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect.

## Data Type

[IPWorksPGPFirewall](#firewall-type)

# Idle Property ([PIMAP](#pimap-class) Class)

The current status of the class.

## Syntax

```text
ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();
```

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

# Keys Property ([PIMAP](#pimap-class) Class)

A collection of keys used for cryptographic operations.

## Syntax

```text
IPWorksPGPList<IPWorksPGPKey>* GetKeys();
int SetKeys(IPWorksPGPList<IPWorksPGPKey>* val);
```

## Remarks

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

This property is not available at design time.

## Data Type

[IPWorksPGPKey](#key-type)

# LastReply Property ([PIMAP](#pimap-class) Class)

This property indicates the last reply received from the server.

## Syntax

```text
ANSI (Cross Platform)
char* GetLastReply();

Unicode (Windows)
LPWSTR GetLastReply();
```

## 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](#pitrail-event-pimap-class) event.

This property is read-only.

## Data Type

String

# LocalHost Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetLocalHost();int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();INT SetLocalHost(LPCWSTR lpszLocalHost);
```

## 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 class initiate connections (or accept in the case of server classes) 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 class 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMailbox();int SetMailbox(const char* lpszMailbox);

Unicode (Windows)
LPWSTR GetMailbox();INT SetMailbox(LPCWSTR lpszMailbox);
```

## 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 class methods for more information.

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

```text
IMAPControl.Mailbox = "INBOX"
IMAPControl.SelectMailbox
```

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

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

## Data Type

String

# MailboxFlags Property ([PIMAP](#pimap-class) Class)

This property defines flags in the selected mailbox.

## Syntax

```text
ANSI (Cross Platform)
char* GetMailboxFlags();

Unicode (Windows)
LPWSTR GetMailboxFlags();
```

## Default Value

""

## Remarks

This property defines flags in the selected mailbox. The class fills out [MessageCount](#messagecount-property-pimap-class), [RecentMessageCount](#recentmessagecount-property-pimap-class), and MailboxFlags after connecting to the [MailServer](#mailserver-property-pimap-class) and selecting or examining a [Mailbox](#mailbox-property-pimap-class).

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

## Data Type

String

# MailboxList Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
IPWorksPGPList<IPWorksPGPMailbox>* GetMailboxList();
```

## Remarks

This collection contains a list of mailboxes returned by the server when [ListMailboxes](#listmailboxes-method-pimap-class) or [ListSubscribedMailboxes](#listsubscribedmailboxes-method-pimap-class) is called.

[MailboxLimit](#MailboxLimit) can be used to control the number of mailboxes saved.

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

## Data Type

[IPWorksPGPMailbox](#mailbox-type)

# MailPort Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetMailPort();int SetMailPort(int iMailPort);

Unicode (Windows)
INT GetMailPort();INT SetMailPort(INT iMailPort);
```

## 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](#sslstartmode-property-pimap-class) property for more information).

This property is not available at design time.

## Data Type

Integer

# MailServer Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMailServer();int SetMailServer(const char* lpszMailServer);

Unicode (Windows)
LPWSTR GetMailServer();INT SetMailServer(LPCWSTR lpszMailServer);
```

## 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 class 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 ([PIMAP](#pimap-class) Class)

This property provides the raw message content.

## Syntax

```text
ANSI (Cross Platform)
int GetMessage(char* &lpMessage, int &lenMessage);int SetMessage(const char* lpMessage, int lenMessage);

Unicode (Windows)
INT GetMessage(LPSTR &lpMessage, INT &lenMessage);INT SetMessage(LPCSTR lpMessage, INT lenMessage);
```

## Default Value

""

## Remarks

This property is populated after calling [RetrieveMessagePart](#retrievemessagepart-method-pimap-class) and holds the raw message content. This can be used to access the data before any processing is done by the class.

This property is not available at design time.

## Data Type

Binary String

# MessageContentEncoding Property ([PIMAP](#pimap-class) Class)

This property includes the ContentEncoding of the selected message.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageContentEncoding();

Unicode (Windows)
LPWSTR GetMessageContentEncoding();
```

## Default Value

""

## Remarks

The property is automatically set by the class when message information is retrieved through the [RetrieveMessageInfo](#retrievemessageinfo-method-pimap-class) method.

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

## Data Type

String

# MessageContentType Property ([PIMAP](#pimap-class) Class)

This property includes the ContentType of the message.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageContentType();

Unicode (Windows)
LPWSTR GetMessageContentType();
```

## 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](#messagecontentencoding-property-pimap-class) property or read the individual message parts.

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

## Data Type

String

# MessageCount Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetMessageCount();

Unicode (Windows)
INT GetMessageCount();
```

## Default Value

0

## Remarks

This property contains the total number of messages on the [Mailbox](#mailbox-property-pimap-class). The class fills out MessageCount, [RecentMessageCount](#recentmessagecount-property-pimap-class), and [MailboxFlags](#mailboxflags-property-pimap-class) after connecting to the [MailServer](#mailserver-property-pimap-class) and selecting or examining a [Mailbox](#mailbox-property-pimap-class).

This property is read-only.

## Data Type

Integer

# MessageDate Property ([PIMAP](#pimap-class) Class)

The property includes the time the message was created.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageDate();

Unicode (Windows)
LPWSTR GetMessageDate();
```

## 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageDeliveryTime();

Unicode (Windows)
LPWSTR GetMessageDeliveryTime();
```

## 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 ([PIMAP](#pimap-class) Class)

This property contains the flags of the current message.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageFlags();int SetMessageFlags(const char* lpszMessageFlags);

Unicode (Windows)
LPWSTR GetMessageFlags();INT SetMessageFlags(LPCWSTR lpszMessageFlags);
```

## Default Value

""

## Remarks

This property contains the flags of the current message. It also is used to specify flags when [AppendToMailbox](#appendtomailbox-method-pimap-class) is called.

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

|  |  |
| --- | --- |
| \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-pimap-class)). |
| \Seen | Mark a message as read. |
| \Answered | Mark a message as answered. |
| \Flagged | Mark a message as flagged. |
| \Draft | Mark a message as being incomplete (under composition). |

 **Example. Setting MessageFlags:**

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

This property is not available at design time.

## Data Type

String

# MessageFrom Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageFrom();

Unicode (Windows)
LPWSTR GetMessageFrom();
```

## Default Value

""

## Remarks

This property normally has the same value as [MessageSender](#messagesender-property-pimap-class).

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

# MessageHeaders Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
IPWorksPGPList<IPWorksPGPHeader>* GetMessageHeaders();
int SetMessageHeaders(IPWorksPGPList<IPWorksPGPHeader>* val);
```

## Remarks

This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the [RetrieveMessageHeaders](#retrievemessageheaders-method-pimap-class) or the [RetrieveMessagePartHeaders](#retrievemessagepartheaders-method-pimap-class) method.

This property is not available at design time.

## Data Type

[IPWorksPGPHeader](#header-type)

# MessageHeadersString Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageHeadersString();int SetMessageHeadersString(const char* lpszMessageHeadersString);

Unicode (Windows)
LPWSTR GetMessageHeadersString();INT SetMessageHeadersString(LPCWSTR lpszMessageHeadersString);
```

## Default Value

""

## Remarks

This property contains the full headers of the message in RFC 822 format. The headers are retrieved by calling the [RetrieveMessageHeaders](#retrievemessageheaders-method-pimap-class) or the [RetrieveMessagePartHeaders](#retrievemessagepartheaders-method-pimap-class) method.

This property is not available at design time.

## Data Type

String

# MessageId Property ([PIMAP](#pimap-class) Class)

This property includes the message identifier of the current message.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageId();

Unicode (Windows)
LPWSTR GetMessageId();
```

## Default Value

""

## Remarks

The class fills out this property when message information is retrieved from the [MailServer](#mailserver-property-pimap-class).

This Id is permanent if [UIDMode](#uidmode-property-pimap-class) is set, and otherwise is temporary.

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

## Data Type

String

# MessageInfo Property ([PIMAP](#pimap-class) Class)

This property includes the collection of messages retrieved by RetrieveMessageInfo .

## Syntax

```text
IPWorksPGPList<IPWorksPGPMessageInfo>* GetMessageInfo();
```

## Remarks

This property is populated when messages are searched or listed or when message information is received from the server. The collection contains a list of each message's [MessageInfo](#messageinfo-type) as returned by the server.

[MessageInfoLimit](#MessageInfoLimit) can be used to control the number of [MessageInfo](#messageinfo-type)s saved.

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

## Data Type

[IPWorksPGPMessageInfo](#messageinfo-type)

# MessageInReplyTo Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageInReplyTo();

Unicode (Windows)
LPWSTR GetMessageInReplyTo();
```

## Default Value

""

## Remarks

The class 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](#messagenetid-property-pimap-class) property.

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

## Data Type

String

# MessageNetId Property ([PIMAP](#pimap-class) Class)

This property includes the globally unique identifier of the message.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageNetId();

Unicode (Windows)
LPWSTR GetMessageNetId();
```

## Default Value

""

## Remarks

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

# MessageParts Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
IPWorksPGPList<IPWorksPGPMessagePart>* GetMessageParts();
```

## Remarks

This property contains a collection of message parts that is populated when you call [RetrieveMessageInfo](#retrievemessageinfo-method-pimap-class). Once the message is received from the server, the class parses the different parts and their corresponding information into the MESSAGEPARTS collection. Each [MessagePart](#messagepart-type) contains a unique [Id](#MessagePart_f_Id).

[MessagePartLimit](#MessagePartLimit) can be used to control the number of message parts saved.

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

## Data Type

[IPWorksPGPMessagePart](#messagepart-type)

# MessageRecipients Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
IPWorksPGPList<IPWorksPGPMessageRecipient>* GetMessageRecipients();
```

## Remarks

This property contains a collection of the people to whom the message was sent. Each [MessageRecipient](#messagerecipient-type) contains information describing that recipient, and what type of recipient it is. This collection is populated when the [RetrieveMessageInfo](#retrievemessageinfo-method-pimap-class) method is called.

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

## Data Type

[IPWorksPGPMessageRecipient](#messagerecipient-type)

# MessageReplyTo Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageReplyTo();

Unicode (Windows)
LPWSTR GetMessageReplyTo();
```

## 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageSender();

Unicode (Windows)
LPWSTR GetMessageSender();
```

## Default Value

""

## Remarks

This property contains the address of the sender of the message. This normally is the same value as [MessageFrom](#messagefrom-property-pimap-class).

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 ([PIMAP](#pimap-class) Class)

This property includes the set of messages to operate on.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageSet();int SetMessageSet(const char* lpszMessageSet);

Unicode (Windows)
LPWSTR GetMessageSet();INT SetMessageSet(LPCWSTR lpszMessageSet);
```

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

```text
IMAPControl.MessageSet = "1"
IMAPControl.RetrieveMessageInfo()

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

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

## Data Type

String

# MessageSize Property ([PIMAP](#pimap-class) Class)

This property includes the size of the selected message.

## Syntax

```text
ANSI (Cross Platform)
int64 GetMessageSize();

Unicode (Windows)
LONG64 GetMessageSize();
```

## Default Value

0

## Remarks

The class fills out this property with the size of the selected message when message information is retrieved from the [MailServer](#mailserver-property-pimap-class).

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

## Data Type

Long64

# MessageSubject Property ([PIMAP](#pimap-class) Class)

This property includes the subject of the message.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageSubject();

Unicode (Windows)
LPWSTR GetMessageSubject();
```

## Default Value

""

## Remarks

The class fills out this property with the subject of the message when message information is retrieved from the [MailServer](#mailserver-property-pimap-class).

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

## Data Type

String

# MessageText Property ([PIMAP](#pimap-class) Class)

This property includes the body of the retrieved message.

## Syntax

```text
ANSI (Cross Platform)
char* GetMessageText();int SetMessageText(const char* lpszMessageText);

Unicode (Windows)
LPWSTR GetMessageText();INT SetMessageText(LPCWSTR lpszMessageText);
```

## Default Value

""

## Remarks

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

This property is not available at design time.

## Data Type

String

# OAuth Property ([PIMAP](#pimap-class) Class)

The OAuth settings.

## Syntax

```text
IPWorksPGPMailOAuthSettings* GetOAuth();
```

## Remarks

This property is used to configure the necessary fields to authenticate with the service provider. See the introduction for more information.

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

## Data Type

[IPWorksPGPMailOAuthSettings](#mailoauthsettings-type)

# Overwrite Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetOverwrite();int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();INT SetOverwrite(BOOL bOverwrite);
```

## Default Value

FALSE

## Remarks

This property is a value indicating whether or not the class 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetPassword();int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();INT SetPassword(LPCWSTR lpszPassword);
```

## Default Value

""

## Remarks

This property contains the password used to authenticate to the [MailServer](#mailserver-property-pimap-class). Both the [User](#user-property-pimap-class) and Password properties must be set before connecting to the [MailServer](#mailserver-property-pimap-class).

## Data Type

String

# PeekMode Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetPeekMode();int SetPeekMode(int bPeekMode);

Unicode (Windows)
BOOL GetPeekMode();INT SetPeekMode(BOOL bPeekMode);
```

## 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetRecentMessageCount();

Unicode (Windows)
INT GetRecentMessageCount();
```

## Default Value

0

## Remarks

This property contains the number of new messages that are in the [Mailbox](#mailbox-property-pimap-class). The class fills out [MessageCount](#messagecount-property-pimap-class), RecentMessageCount, and [MailboxFlags](#mailboxflags-property-pimap-class) after connecting to the [MailServer](#mailserver-property-pimap-class) and selecting or examining a [Mailbox](#mailbox-property-pimap-class).

This property is read-only.

## Data Type

Integer

# SignerKeys Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
IPWorksPGPList<IPWorksPGPKey>* GetSignerKeys();
int SetSignerKeys(IPWorksPGPList<IPWorksPGPKey>* val);
```

## Remarks

This property contains the keys of the message signer.

Set this property before calling [VerifySignature](#verifysignature-method-pimap-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class).

This property is not available at design time.

## Data Type

[IPWorksPGPKey](#key-type)

# SortCriteria Property ([PIMAP](#pimap-class) Class)

This property sorts criteria to use for message retrieval operations.

## Syntax

```text
ANSI (Cross Platform)
char* GetSortCriteria();int SetSortCriteria(const char* lpszSortCriteria);

Unicode (Windows)
LPWSTR GetSortCriteria();INT SetSortCriteria(LPCWSTR lpszSortCriteria);
```

## Default Value

""

## Remarks

This property sorts criteria to use for message retrieval operations. When set, the class 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:**

```text
IMAPControl.SortCriteria = "DATE"

IMAPControl.SortCriteria = "SUBJECT FROM"

IMAPControl.SortCriteria = "REVERSE SUBJECT"
```

Possible sort keys include the following:

|  |  |
| --- | --- |
| ARRIVAL | Internal date and time of the message. |
| DATE | The value of the message's DATE header, adjusted by time zone. |
| CC | The value of the message's CC header. |
| FROM | The value of the message's FROM header. |
| SUBJECT | The value of the message's SUBJECT header. |
| TO | The value of the message's TO header. |
| SIZE | The size of the message |
| REVERSE <criterion> | Followed by another sort criterion, this sort key has the effect of that criterion but in reverse (descending) order. |

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

## Data Type

String

# SSLAcceptServerCert Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
IPWorksPGPCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksPGPCertificate* val);
```

## Remarks

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

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

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

## Data Type

[IPWorksPGPCertificate](#certificate-type)

# SSLCert Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
IPWorksPGPCertificate* GetSSLCert();
int SetSSLCert(IPWorksPGPCertificate* val);
```

## Remarks

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

## Data Type

[IPWorksPGPCertificate](#certificate-type)

# SSLEnabled Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetSSLEnabled();int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();INT SetSSLEnabled(BOOL bSSLEnabled);
```

## Default Value

FALSE

## Remarks

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

TLS/SSL may also be enabled by setting [SSLStartMode](#sslstartmode-property-pimap-class). Setting [SSLStartMode](#sslstartmode-property-pimap-class) will automatically update this property value.

This property is not available at design time.

## Data Type

Boolean

# SSLProvider Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetSSLProvider();int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();INT SetSSLProvider(INT iSSLProvider);
```

## Possible Values

```text
SSLP_AUTOMATIC(0), SSLP_PLATFORM(1), SSLP_INTERNAL(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 class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

 **Additional Notes**

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

## Data Type

Integer

# SSLServerCert Property ([PIMAP](#pimap-class) Class)

The server certificate for the last established connection.

## Syntax

```text
IPWorksPGPCertificate* GetSSLServerCert();
```

## Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

## Data Type

[IPWorksPGPCertificate](#certificate-type)

# SSLStartMode Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetSSLStartMode();int SetSSLStartMode(int iSSLStartMode);

Unicode (Windows)
INT GetSSLStartMode();INT SetSSLStartMode(INT iSSLStartMode);
```

## Possible Values

```text
SSL_AUTOMATIC(0), SSL_IMPLICIT(1), SSL_EXPLICIT(2), SSL_NONE(3)
```

## Default Value

3

## Remarks

The SSLStartMode property may have one of the following values:

|  |  |
| --- | --- |
| 0 (sslAutomatic) | If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit). |
| 1 (sslImplicit) | The SSL negotiation will start immediately after the connection is established. |
| 2 (sslExplicit) | The class will first connect in plaintext, and then will explicitly start SSL negotiation through a protocol command such as STARTTLS. |
| 3 (sslNone - default) | No SSL negotiation; no SSL security. All communication will be in plaintext mode. |

## Data Type

Integer

# StartByte Property ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int64 GetStartByte();int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();INT SetStartByte(LONG64 lStartByte);
```

## Default Value

0

## Remarks

StartByte and [EndByte](#endbyte-property-pimap-class) are used together with the [RetrieveMessagePart](#retrievemessagepart-method-pimap-class) method to specify the portion of the message to be retrieved from the server.

When StartByte or [EndByte](#endbyte-property-pimap-class) 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](#endbyte-property-pimap-class) is 0, which corresponds to the end of the message.

This property is not available at design time.

## Data Type

Long64

# Timeout Property ([PIMAP](#pimap-class) Class)

The timeout for the class.

## Syntax

```text
ANSI (Cross Platform)
int GetTimeout();int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();INT SetTimeout(INT iTimeout);
```

## 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 class will wait for the operation to complete before returning control.

The class will use [DoEvents](#doevents-method-pimap-class) 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 class 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetUIDMode();int SetUIDMode(int bUIDMode);

Unicode (Windows)
BOOL GetUIDMode();INT SetUIDMode(BOOL bUIDMode);
```

## 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetUIDValidity();

Unicode (Windows)
LPWSTR GetUIDValidity();
```

## 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 ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetUser();int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();INT SetUser(LPCWSTR lpszUser);
```

## Default Value

""

## Remarks

This property contains the username used to authenticate to the [MailServer](#mailserver-property-pimap-class). Both the User and [Password](#password-property-pimap-class) properties must be set before connecting to the [MailServer](#mailserver-property-pimap-class).

## Data Type

String

# AddMessageFlags Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int AddMessageFlags(const char* lpszFlags);

Unicode (Windows)
INT AddMessageFlags(LPCWSTR lpszFlags);
```

## Remarks

This method adds the specified flags to the messages specified by the [MessageSet](#messageset-property-pimap-class) property. The format of the flags is specified by the IMAP RFCs.

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

|  |  |
| --- | --- |
| \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-pimap-class)). |
| \Seen | Mark a message as read. |
| \Answered | Mark a message as answered. |
| \Flagged | Mark a message as flagged. |
| \Draft | Mark a message as being incomplete (under composition). |

 **Example. Setting Adding Message Flags:**

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# AppendToMailbox Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int AppendToMailbox();

Unicode (Windows)
INT AppendToMailbox();
```

## Remarks

This method appends the RFC 822-encoded message in [MessageText](#messagetext-property-pimap-class) to the mailbox specified by [Mailbox](#mailbox-property-pimap-class). If the [MessageFlags](#messageflags-property-pimap-class) property is not an empty string, its contents are supplied with the *APPEND* command sent to the server.

**Example. Append Message to Mailbox:**

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# CheckMailbox Method ([PIMAP](#pimap-class) Class)

This method sends a CHECK command to the server.

## Syntax

```text
ANSI (Cross Platform)
int CheckMailbox();

Unicode (Windows)
INT 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.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# CloseMailbox Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int CloseMailbox();

Unicode (Windows)
INT 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.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Config Method ([PIMAP](#pimap-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-pimap-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#config-settings-pimap-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Connect Method ([PIMAP](#pimap-class) Class)

This method connects to an IMAP server.

## Syntax

```text
ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();
```

## Remarks

This method connects to the IMAP server specified by [MailServer](#mailserver-property-pimap-class) and authenticates it using the username and password supplied in the [User](#user-property-pimap-class) and [Password](#password-property-pimap-class) properties.

**Example. Connect IMAP Server:**

```text
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()
```

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# CopyToMailbox Method ([PIMAP](#pimap-class) Class)

Copies the specified messages to another mailbox.

## Syntax

```text
ANSI (Cross Platform)
int CopyToMailbox();

Unicode (Windows)
INT CopyToMailbox();
```

## Remarks

This method copies the messages specified by the [MessageSet](#messageset-property-pimap-class) property to the mailbox specified by the [Mailbox](#mailbox-property-pimap-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# CreateMailbox Method ([PIMAP](#pimap-class) Class)

This method creates a new mailbox specified by Mailbox .

## Syntax

```text
ANSI (Cross Platform)
int CreateMailbox();

Unicode (Windows)
INT CreateMailbox();
```

## Remarks

This method creates a new mailbox. The mailbox name is specified by the [Mailbox](#mailbox-property-pimap-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Decrypt Method ([PIMAP](#pimap-class) Class)

Decrypts the message.

## Syntax

```text
ANSI (Cross Platform)
int Decrypt();

Unicode (Windows)
INT Decrypt();
```

## Remarks

This method decrypts the specified message.

The message will be decrypted using the keys specified in [Keys](#keys-property-pimap-class). Before decryption begins the class will fire the [RecipientInfo](#recipientinfo-event-pimap-class) event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into [Keys](#keys-property-pimap-class).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DecryptAndVerifySignature Method ([PIMAP](#pimap-class) Class)

Decrypts and verifies the signature of the message.

## Syntax

```text
ANSI (Cross Platform)
int DecryptAndVerifySignature();

Unicode (Windows)
INT DecryptAndVerifySignature();
```

## Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the [Decrypt](#decrypt-method-pimap-class) and [VerifySignature](#verifysignature-method-pimap-class) methods are affected in the same manner.

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

The message will be decrypted using the keys specified in [Keys](#keys-property-pimap-class). Before decryption begins the class will fire the [RecipientInfo](#recipientinfo-event-pimap-class) event with information about the encrypted message, including the key used to encrypt the message. Within this event you may use the available information to load the correct key into [Keys](#keys-property-pimap-class).

The message will be verified using the keys specified in [SignerKeys](#signerkeys-property-pimap-class). Before verification begins the class will fire the [SignatureInfo](#signatureinfo-event-pimap-class) event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into [SignerKeys](#signerkeys-property-pimap-class).

By default, if the signature is not valid the class fails with an error. The configuration setting [RequireValidSignature](#RequireValidSignature) may be set to False to disable this requirement. When [RequireValidSignature](#RequireValidSignature) is set to False, the *Status* parameter of the [VerificationStatus](#verificationstatus-event-pimap-class) event should be checked to determine the result of the operation.

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DeleteFromMailbox Method ([PIMAP](#pimap-class) Class)

The method marks the messages specified by MessageSet as deleted.

## Syntax

```text
ANSI (Cross Platform)
int DeleteFromMailbox();

Unicode (Windows)
INT DeleteFromMailbox();
```

## Remarks

This method marks the messages specified by [MessageSet](#messageset-property-pimap-class) as deleted. Calling this method is equivalent to calling [AddMessageFlags](#addmessageflags-method-pimap-class) with "\Deleted" as the *Flags* parameter.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DeleteMailbox Method ([PIMAP](#pimap-class) Class)

This method deletes a mailbox specified by Mailbox .

## Syntax

```text
ANSI (Cross Platform)
int DeleteMailbox();

Unicode (Windows)
INT DeleteMailbox();
```

## Remarks

This method deletes a mailbox. The mailbox name is specified by the [Mailbox](#mailbox-property-pimap-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DeleteMailboxACL Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int DeleteMailboxACL(const char* lpszUser);

Unicode (Windows)
INT DeleteMailboxACL(LPCWSTR lpszUser);
```

## Remarks

This message asks the server to remove all rights associated with *User* from the mailbox specified in the [Mailbox](#mailbox-property-pimap-class) property. Refer to [SetMailboxACL](#setmailboxacl-method-pimap-class) and [GetMailboxACL](#getmailboxacl-method-pimap-class) for more information on mailbox access rights.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Disconnect Method ([PIMAP](#pimap-class) Class)

This method disconnects from an IMAP server.

## Syntax

```text
ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();
```

## Remarks

This method logs out and disconnects from the IMAP server.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# DoEvents Method ([PIMAP](#pimap-class) Class)

This method processes events from the internal message queue.

## Syntax

```text
ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ExamineMailbox Method ([PIMAP](#pimap-class) Class)

This method selects a mailbox in read-only mode.

## Syntax

```text
ANSI (Cross Platform)
int ExamineMailbox();

Unicode (Windows)
INT ExamineMailbox();
```

## Remarks

This method asks the server to select the mailbox specified in the [Mailbox](#mailbox-property-pimap-class) property in read-only mode.

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

```text
IMAPControl.Mailbox = "INBOX"
IMAPControl.SelectMailbox
```

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

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ExpungeMailbox Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int ExpungeMailbox();

Unicode (Windows)
INT ExpungeMailbox();
```

## Remarks

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

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# GetMailboxACL Method ([PIMAP](#pimap-class) Class)

This method retrieves mailbox access control rights.

## Syntax

```text
ANSI (Cross Platform)
int GetMailboxACL();

Unicode (Windows)
INT GetMailboxACL();
```

## Remarks

This method retrieves the mailbox access control rights, which are provided through one or more [MailboxACL](#mailboxacl-event-pimap-class) events. Standard rights include the following:

|  |  |
| --- | --- |
| l | Lookup (Visible to be listed) |
| r | Read (Can be selected, retrieved, searched, and copied) |
| s | Keep (Seen/unseen information across sessions) |
| w | Write (Stores flags other than SEEN and DELETED) |
| i | Insert (Can be appended and copied into) |
| p | Post (Can send mail to submission address for mailbox) |
| c | Create (Can create new sub-mailboxes) |
| d | Delete (Stores DELETED flag and performs EXPUNGE) |
| a | Administer (Set access permissions) |

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Interrupt Method ([PIMAP](#pimap-class) Class)

This method interrupts the current method.

## Syntax

```text
ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ListMailboxes Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int ListMailboxes();

Unicode (Windows)
INT ListMailboxes();
```

## Remarks

This method lists all of the mailboxes matching the criteria in the [Mailbox](#mailbox-property-pimap-class) property. Matching mailboxes are returned through the [MailboxList](#mailboxlist-event-pimap-class) event.

**Example 1. List All Mailboxes:**

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

**Example 2. List All Mailboxes Inside INBOX:**

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ListSubscribedMailboxes Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int ListSubscribedMailboxes();

Unicode (Windows)
INT ListSubscribedMailboxes();
```

## Remarks

This method lists all *subscribed* mailboxes matching the criteria in the [Mailbox](#mailbox-property-pimap-class) property. Matching mailboxes are returned through [MailboxList](#mailboxlist-event-pimap-class) event.

**Example 1. List All Subscribed Mailboxes:**

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

**Example 2. List All Subscribed Mailboxes Inside INBOX:**

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# LocalizeDate Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* LocalizeDate(const char* lpszDateTime);

Unicode (Windows)
LPWSTR LocalizeDate(LPCWSTR lpszDateTime);
```

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

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# MoveToMailbox Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int MoveToMailbox();

Unicode (Windows)
INT MoveToMailbox();
```

## Remarks

This method copies the messages specified by the [MessageSet](#messageset-property-pimap-class) property to the mailbox specified by the [Mailbox](#mailbox-property-pimap-class) property. Additionally, the messages in the original mailbox are marked as deleted.

Calling this method is equivalent to calling the [CopyToMailbox](#copytomailbox-method-pimap-class) method immediately followed by the [DeleteFromMailbox](#deletefrommailbox-method-pimap-class) method.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Noop Method ([PIMAP](#pimap-class) Class)

This method sends a NOOP command to the server.

## Syntax

```text
ANSI (Cross Platform)
int Noop();

Unicode (Windows)
INT 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.)

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RenameMailbox Method ([PIMAP](#pimap-class) Class)

This method changes the name of Mailbox to NewName .

## Syntax

```text
ANSI (Cross Platform)
int RenameMailbox(const char* lpszNewName);

Unicode (Windows)
INT RenameMailbox(LPCWSTR lpszNewName);
```

## Remarks

This method allows a mailbox to be renamed. The mailbox is specified by the [Mailbox](#mailbox-property-pimap-class) property, and the new name is specified by the *NewName* parameter.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ResetMessageFlags Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int ResetMessageFlags();

Unicode (Windows)
INT ResetMessageFlags();
```

## Remarks

This method replaces the flags of the messages specified by the [MessageSet](#messageset-property-pimap-class) property with the flags specified by the [MessageFlags](#messageflags-property-pimap-class) property. The format of the flags is specified by the IMAP RFCs.

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

|  |  |
| --- | --- |
| \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-pimap-class)). |
| \Seen | Mark a message as read. |
| \Answered | Mark a message as answered. |
| \Flagged | Mark a message as flagged. |
| \Draft | Mark a message as being incomplete (under composition). |

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RetrieveMessageHeaders Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int RetrieveMessageHeaders();

Unicode (Windows)
INT RetrieveMessageHeaders();
```

## Remarks

This method retrieves RFC 822 headers of the messages specified by [MessageSet](#messageset-property-pimap-class) and stores them in the [MessageHeaders](#messageheaders-property-pimap-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RetrieveMessageInfo Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int RetrieveMessageInfo();

Unicode (Windows)
INT RetrieveMessageInfo();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RetrieveMessagePart Method ([PIMAP](#pimap-class) Class)

This method retrieves the message part specified by PartID.

## Syntax

```text
ANSI (Cross Platform)
int RetrieveMessagePart(const char* lpszPartId);

Unicode (Windows)
INT RetrieveMessagePart(LPCWSTR lpszPartId);
```

## Remarks

This method retrieves the contents of the message part specified by the *PartId* property of the messages specified by the [MessageSet](#messageset-property-pimap-class) property. If the LocalFile property contains a file name, the message part is stored in LocalFile. If the [SetMessageStream](#setmessagestream-method-pimap-class) property has been used to set a stream, the message part will be stored in the specified stream. If the LocalFile property is set to an empty string and the [SetMessageStream](#setmessagestream-method-pimap-class) property has not been set to a stream, then the message part is stored in the [MessageText](#messagetext-property-pimap-class) property. Additionally, the [Transfer](#transfer-event-pimap-class) 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](#messagepart-event-pimap-class) events. This method retrieves the RFC 822-encoded text of the messages specified by [MessageSet](#messageset-property-pimap-class).

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RetrieveMessagePartHeaders Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int RetrieveMessagePartHeaders(const char* lpszPartId);

Unicode (Windows)
INT RetrieveMessagePartHeaders(LPCWSTR lpszPartId);
```

## Remarks

This method retrieves RFC 822 headers of the message part specified by PartID and stores them in the [MessageHeaders](#messageheaders-property-pimap-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RetrieveMessageText Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int RetrieveMessageText();

Unicode (Windows)
INT RetrieveMessageText();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SearchMailbox Method ([PIMAP](#pimap-class) Class)

This method searches the selected mailbox for specified text.

## Syntax

```text
ANSI (Cross Platform)
int SearchMailbox(const char* lpszSearchCriteria);

Unicode (Windows)
INT SearchMailbox(LPCWSTR lpszSearchCriteria);
```

## Remarks

This method searches the selected mailbox using the criteria specified in the *SearchCriteria* parameter. For every message matching the criteria, the [RetrieveMessageInfo](#retrievemessageinfo-method-pimap-class) method is called and a [MessageInfo](#messageinfo-event-pimap-class) event is fired.

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

Possible search keys include the following:

|  |  |
| --- | --- |
| <message set> | Messages with message sequence numbers corresponding to the specified message sequence number set. |
| ALL | All messages in the mailbox; this is the default initial key for AND-ing. |
| ANSWERED | Messages with the \Answered flag set. |
| BCC <string> | Messages that contain the specified string in the envelope structure's BCC field. |
| BEFORE <date> | Messages whose internal date is earlier than the specified date. |
| BODY <string> | Messages that contain the specified string in the body of the message. |
| CC <string> | Messages that contain the specified string in the envelope structure's CC field. |
| DELETED | Messages with the \Deleted flag set. |
| DRAFT | Messages with the \Draft flag set. |
| FLAGGED | Messages with the \Flagged flag set. |
| FROM <string> | Messages that contain the specified string in the envelope structure's FROM field. |
| HEADER <field-name> <string> | Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body. |
| KEYWORD <flag> | Messages with the specified keyword set. |
| LARGER <n> | Messages with an RFC822.SIZE larger than the specified number of octets. |
| NEW | Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT UNSEEN)". |
| NOT <search-key> | Messages that do not match the specified search key. |
| OLD | Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW"). |
| ON <date> | Messages whose internal date is within the specified date. |
| OR <search-key1> <search-key2> | Messages that match either search key. |
| RECENT | Messages that have the \Recent flag set. |
| SEEN | Messages that have the \Seen flag set. |
| SENTBEFORE <date> | Messages whose [RFC-822] Date: header is earlier than the specified date. |
| SENTON <date> | Messages whose [RFC-822] Date: header is within the specified date. |
| SENTSINCE <date> | Messages whose [RFC-822] Date: header is within or later than the specified date. |
| SINCE <date> | Messages whose internal date is within or later than the specified date. |
| SMALLER <n> | Messages with an RFC822.SIZE smaller than the specified number of octets. |
| SUBJECT <string> | Messages that contain the specified string in the envelope structure's SUBJECT field. |
| TEXT <string> | Messages that contain the specified string in the header or body of the message. |
| TO <string> | Messages that contain the specified string in the envelope structure's TO field. |
| UID <message set> | Messages with unique identifiers corresponding to the specified unique identifier set. |
| UNANSWERED | Messages that do not have the \Answered flag set. |
| UNDELETED | Messages that do not have the \Deleted flag set. |
| UNDRAFT | Messages that do not have the \Draft flag set. |
| UNFLAGGED | Messages that do not have the \Flagged flag set. |
| UNKEYWORD <flag> | Messages that do not have the specified keyword set. |
| UNSEEN | Messages that do not have the \Seen flag set. |

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SelectMailbox Method ([PIMAP](#pimap-class) Class)

This method selects a mailbox.

## Syntax

```text
ANSI (Cross Platform)
int SelectMailbox();

Unicode (Windows)
INT SelectMailbox();
```

## Remarks

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

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

```text
IMAPControl.Mailbox = "INBOX"
IMAPControl.SelectMailbox
```

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

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SendCommand Method ([PIMAP](#pimap-class) Class)

This method sends the exact command directly to the server.

## Syntax

```text
ANSI (Cross Platform)
int SendCommand(const char* lpszCommand);

Unicode (Windows)
INT SendCommand(LPCWSTR lpszCommand);
```

## 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](#lastreply-property-pimap-class) property or monitor the [PITrail](#pitrail-event-pimap-class) event to obtain the server's response.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetMailboxACL Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int SetMailboxACL(const char* lpszUser, const char* lpszRights);

Unicode (Windows)
INT SetMailboxACL(LPCWSTR lpszUser, LPCWSTR lpszRights);
```

## Remarks

This method changes the access control list for the mailbox specified in the [Mailbox](#mailbox-property-pimap-class) property so that *User* is granted the permissions specified in *Rights*.

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

Standard rights include the following:

|  |  |
| --- | --- |
| l | Lookup (Visible to be listed) |
| r | Read (Can be selected, retrieved, searched, and copied) |
| s | Keep (Seen/unseen information across sessions) |
| w | Write (Stores flags other than SEEN and DELETED) |
| i | Insert (Can be appended and copied into) |
| p | Post (Can send mail to submission address for mailbox) |
| c | Create (Can create new sub-mailboxes) |
| d | Delete (Stores DELETED flag and performs EXPUNGE) |
| a | Administer (Set access permissions) |

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SetMessageStream Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int SetMessageStream(IPWorksPGPStream* sMessageStream);

Unicode (Windows)
INT SetMessageStream(IPWorksPGPStream* sMessageStream);
```

## Remarks

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

NOTE: SetMessageStream and LocalFile will reset the other.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StartIdle Method ([PIMAP](#pimap-class) Class)

This method begins idling.

## Syntax

```text
ANSI (Cross Platform)
int StartIdle();

Unicode (Windows)
INT StartIdle();
```

## Remarks

This method sends the *IDLE* command to the server and begins idling. As responses are received from the server the [IdleInfo](#idleinfo-event-pimap-class) event fires. To stop idling, call [StopIdle](#stopidle-method-pimap-class).

If the class is being used in a formless application (such as a console application) be sure to call [DoEvents](#doevents-method-pimap-class) in a loop after calling this method to ensure that incoming events are processed.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StopIdle Method ([PIMAP](#pimap-class) Class)

This method stops idling.

## Syntax

```text
ANSI (Cross Platform)
int StopIdle();

Unicode (Windows)
INT StopIdle();
```

## Remarks

This method stops idling if it was previously started via [StartIdle](#startidle-method-pimap-class). If the class is not idling, this method does nothing.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# SubscribeMailbox Method ([PIMAP](#pimap-class) Class)

This method subscribes to the mailbox specified by Mailbox .

## Syntax

```text
ANSI (Cross Platform)
int SubscribeMailbox();

Unicode (Windows)
INT SubscribeMailbox();
```

## Remarks

This method subscribes to the mailbox specified by the [Mailbox](#mailbox-property-pimap-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# UnsetMessageFlags Method ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int UnsetMessageFlags();

Unicode (Windows)
INT UnsetMessageFlags();
```

## Remarks

This method removes the flags specified by the [MessageFlags](#messageflags-property-pimap-class) property from the messages specified by the [MessageSet](#messageset-property-pimap-class) property. The format of the flags is specified by the IMAP RFCs.

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

|  |  |
| --- | --- |
| \Deleted | Mark a message as deleted (for removal later by [ExpungeMailbox](#expungemailbox-method-pimap-class)). |
| \Seen | Mark a message as read. |
| \Answered | Mark a message as answered. |
| \Flagged | Mark a message as flagged. |
| \Draft | Mark a message as being incomplete (under composition). |

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# UnsubscribeMailbox Method ([PIMAP](#pimap-class) Class)

This method unsubscribes from the mailbox specified by Mailbox .

## Syntax

```text
ANSI (Cross Platform)
int UnsubscribeMailbox();

Unicode (Windows)
INT UnsubscribeMailbox();
```

## Remarks

This method unsubscribes from the mailbox specified by the [Mailbox](#mailbox-property-pimap-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# VerifySignature Method ([PIMAP](#pimap-class) Class)

Verifies the signature of the current message.

## Syntax

```text
ANSI (Cross Platform)
int VerifySignature();

Unicode (Windows)
INT VerifySignature();
```

## Remarks

This method verifies the signature of the message.

The message will be verified using the keys specified in [SignerKeys](#signerkeys-property-pimap-class). Before verification begins the class will fire the [SignatureInfo](#signatureinfo-event-pimap-class) event with information about the signature including the key used to sign the message. Within this event you may use the information available to load the correct key into [SignerKeys](#signerkeys-property-pimap-class).

By default, if the signature is not valid the class fails with an error. The configuration setting [RequireValidSignature](#RequireValidSignature) may be set to False to disable this requirement. When [RequireValidSignature](#RequireValidSignature) is set to False, the *Status* parameter of the [VerificationStatus](#verificationstatus-event-pimap-class) event should be checked to determine the result of the operation.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ConnectionStatus Event ([PIMAP](#pimap-class) Class)

Fired to indicate changes in the connection state.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireConnectionStatus(PIMAPConnectionStatusEventParams *e);
typedef struct {  const char *ConnectionEvent;  int StatusCode;  const char *Description;
  int reserved;
} PIMAPConnectionStatusEventParams;

Unicode (Windows)
virtual INT FireConnectionStatus(PIMAPConnectionStatusEventParams *e);
typedef struct {  LPCWSTR ConnectionEvent;  INT StatusCode;  LPCWSTR Description;
  INT reserved;
} PIMAPConnectionStatusEventParams;
```

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

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | SSL or S/Shell connection broken. |
|  | Firewall host disconnected. |

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

# EndTransfer Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireEndTransfer(PIMAPEndTransferEventParams *e);
typedef struct {  int Direction;
  int reserved;
} PIMAPEndTransferEventParams;

Unicode (Windows)
virtual INT FireEndTransfer(PIMAPEndTransferEventParams *e);
typedef struct {  INT Direction;
  INT reserved;
} PIMAPEndTransferEventParams;
```

## Remarks

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

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

# Error Event ([PIMAP](#pimap-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(PIMAPErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} PIMAPErrorEventParams;

Unicode (Windows)
virtual INT FireError(PIMAPErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} PIMAPErrorEventParams;
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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](#trappable-errors-pimap-class) section.

# Header Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireHeader(PIMAPHeaderEventParams *e);
typedef struct {  const char *Field;  const char *Value;
  int reserved;
} PIMAPHeaderEventParams;

Unicode (Windows)
virtual INT FireHeader(PIMAPHeaderEventParams *e);
typedef struct {  LPCWSTR Field;  LPCWSTR Value;
  INT reserved;
} PIMAPHeaderEventParams;
```

## Remarks

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

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

# IdleInfo Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireIdleInfo(PIMAPIdleInfoEventParams *e);
typedef struct {  const char *Message;  int Cancel;
  int reserved;
} PIMAPIdleInfoEventParams;

Unicode (Windows)
virtual INT FireIdleInfo(PIMAPIdleInfoEventParams *e);
typedef struct {  LPCWSTR Message;  BOOL Cancel;
  INT reserved;
} PIMAPIdleInfoEventParams;
```

## Remarks

This event fires each time a response is received from the server after calling [StartIdle](#startidle-method-pimap-class). 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](#stopidle-method-pimap-class).

The following are possible values returned by the server:

```text
+ idling
* 43 EXISTS
* 1 RECENT
```

# KeyPassphrase Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireKeyPassphrase(PIMAPKeyPassphraseEventParams *e);
typedef struct {  const char *UserId;  const char *KeyId;  const char *Fingerprint;  char *Passphrase;
  int reserved;
} PIMAPKeyPassphraseEventParams;

Unicode (Windows)
virtual INT FireKeyPassphrase(PIMAPKeyPassphraseEventParams *e);
typedef struct {  LPCWSTR UserId;  LPCWSTR KeyId;  LPCWSTR Fingerprint;  LPWSTR Passphrase;
  INT reserved;
} PIMAPKeyPassphraseEventParams;
```

## Remarks

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

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

- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase

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

- [Decrypt](#decrypt-method-pimap-class)
- Sign
- SignAndEncrypt

*UserId* holds the user Id of the key the passphrase is required for.

The *UserId* format is:

```text
FirstName LastName (Comment) <Email>
```

 Not all values are required when selecting or generating a key, but at least FirstName or Email are required.

Note that for OpenPGP v6, a key may be created with or without a *UserId*, as the field is optional. If a key was created without a *UserId*, the key's *Fingerprint* can be used as its identifier instead.

*KeyId* is the hex-encoded, 4-byte or 8-byte Id of the key the passphrase is required for. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance:

```text
5E70662EA810E768
```

*Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key the passphrase is required for. This is in the form:

```text
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
```

# LaunchBrowser Event ([PIMAP](#pimap-class) Class)

Fires before launching a browser with the authorization URL.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireLaunchBrowser(PIMAPLaunchBrowserEventParams *e);
typedef struct {  char *URL;  char *Command;
  int reserved;
} PIMAPLaunchBrowserEventParams;

Unicode (Windows)
virtual INT FireLaunchBrowser(PIMAPLaunchBrowserEventParams *e);
typedef struct {  LPWSTR URL;  LPWSTR Command;
  INT reserved;
} PIMAPLaunchBrowserEventParams;
```

## Remarks

When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the class will fire this event with the *Command*, which will be executed by the class. The *URL* parameter will be the authorization URL that the user will be directed to authenticate.

Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If *Command* is not empty, the URL will be appended to the end.

In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to:

- edit
- explore
- find
- open
- print

# Log Event ([PIMAP](#pimap-class) Class)

Fired once for each log message.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireLog(PIMAPLogEventParams *e);
typedef struct {  int LogLevel;  const char *Message;  const char *LogType;
  int reserved;
} PIMAPLogEventParams;

Unicode (Windows)
virtual INT FireLog(PIMAPLogEventParams *e);
typedef struct {  INT LogLevel;  LPCWSTR Message;  LPCWSTR LogType;
  INT reserved;
} PIMAPLogEventParams;
```

## Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

*LogLevel* indicates the level of message. Possible values are as follows:

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

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

*Message* is the log entry.

*LogType* identifies the type of log entry. Possible values are as follows:

- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"

# MailboxACL Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireMailboxACL(PIMAPMailboxACLEventParams *e);
typedef struct {  const char *Mailbox;  const char *User;  const char *Rights;
  int reserved;
} PIMAPMailboxACLEventParams;

Unicode (Windows)
virtual INT FireMailboxACL(PIMAPMailboxACLEventParams *e);
typedef struct {  LPCWSTR Mailbox;  LPCWSTR User;  LPCWSTR Rights;
  INT reserved;
} PIMAPMailboxACLEventParams;
```

## Remarks

The event fires for each set of access control rights returned by the server after a call to [GetMailboxACL](#getmailboxacl-method-pimap-class). Standard rights include the following:

|  |  |
| --- | --- |
| l | Lookup (Visible to be listed) |
| r | Read (Can be selected, retrieved, searched, and copied) |
| s | Keep (Seen/unseen information across sessions) |
| w | Write (Stores flags other than SEEN and DELETED) |
| i | Insert (Can be appended and copied into) |
| p | Post (Can send mail to submission address for mailbox) |
| c | Create (Can create new sub-mailboxes) |
| d | Delete (Stores DELETED flag and performs EXPUNGE) |
| a | Administer (Set access permissions) |

# MailboxList Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireMailboxList(PIMAPMailboxListEventParams *e);
typedef struct {  const char *Mailbox;  const char *Separator;  const char *Flags;
  int reserved;
} PIMAPMailboxListEventParams;

Unicode (Windows)
virtual INT FireMailboxList(PIMAPMailboxListEventParams *e);
typedef struct {  LPCWSTR Mailbox;  LPCWSTR Separator;  LPCWSTR Flags;
  INT reserved;
} PIMAPMailboxListEventParams;
```

## Remarks

This method is fired for each mailbox received through the [ListMailboxes](#listmailboxes-method-pimap-class) and [ListSubscribedMailboxes](#listsubscribedmailboxes-method-pimap-class) methods. The *Separator* parameter contains the character that separates the different parts in the mailbox path hierarchy.

# MessageInfo Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireMessageInfo(PIMAPMessageInfoEventParams *e);
typedef struct {  const char *MessageId;  const char *Subject;  const char *MessageDate;  const char *From;  const char *Flags;  int64 Size;
  int reserved;
} PIMAPMessageInfoEventParams;

Unicode (Windows)
virtual INT FireMessageInfo(PIMAPMessageInfoEventParams *e);
typedef struct {  LPCWSTR MessageId;  LPCWSTR Subject;  LPCWSTR MessageDate;  LPCWSTR From;  LPCWSTR Flags;  LONG64 Size;
  INT reserved;
} PIMAPMessageInfoEventParams;
```

## 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](#messagecontenttype-property-pimap-class), [MessageContentEncoding](#messagecontentencoding-property-pimap-class), [MessageRecipients](#messagerecipients-property-pimap-class), [MessageDeliveryTime](#messagedeliverytime-property-pimap-class), [MessageFlags](#messageflags-property-pimap-class), [MessageHeaders](#messageheaders-property-pimap-class), [MessageInReplyTo](#messageinreplyto-property-pimap-class), [MessageNetId](#messagenetid-property-pimap-class), [MessageReplyTo](#messagereplyto-property-pimap-class), [MessageSender](#messagesender-property-pimap-class), [MessageSize](#messagesize-property-pimap-class), [MessageSubject](#messagesubject-property-pimap-class), [MessageText](#messagetext-property-pimap-class), etc.

# MessagePart Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireMessagePart(PIMAPMessagePartEventParams *e);
typedef struct {  const char *PartId;  int64 Size;  const char *ContentType;  const char *FileName;  const char *ContentEncoding;  const char *Parameters;  const char *MultipartMode;  const char *ContentId;  const char *ContentDisposition;
  int reserved;
} PIMAPMessagePartEventParams;

Unicode (Windows)
virtual INT FireMessagePart(PIMAPMessagePartEventParams *e);
typedef struct {  LPCWSTR PartId;  LONG64 Size;  LPCWSTR ContentType;  LPCWSTR FileName;  LPCWSTR ContentEncoding;  LPCWSTR Parameters;  LPCWSTR MultipartMode;  LPCWSTR ContentId;  LPCWSTR ContentDisposition;
  INT reserved;
} PIMAPMessagePartEventParams;
```

## Remarks

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

The *Size* parameter gives the size of this part.

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

The *ContentEncoding* parameter shows how data are encoded.

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

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

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

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

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

# PITrail Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FirePITrail(PIMAPPITrailEventParams *e);
typedef struct {  int Direction;  const char *Message;
  int reserved;
} PIMAPPITrailEventParams;

Unicode (Windows)
virtual INT FirePITrail(PIMAPPITrailEventParams *e);
typedef struct {  INT Direction;  LPCWSTR Message;
  INT reserved;
} PIMAPPITrailEventParams;
```

## Remarks

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

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

|  |  |
| --- | --- |
| 0 (Client) | The Message originates from the client. |
| 1 (Server) | The Message originates from the server. |
| 2 (Information) | The Message is an informative message originating from the client software (the class code). |

# Progress Event ([PIMAP](#pimap-class) Class)

Fired as progress is made.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireProgress(PIMAPProgressEventParams *e);
typedef struct {  int64 BytesProcessed;  int PercentProcessed;
  int reserved;
} PIMAPProgressEventParams;

Unicode (Windows)
virtual INT FireProgress(PIMAPProgressEventParams *e);
typedef struct {  LONG64 BytesProcessed;  INT PercentProcessed;
  INT reserved;
} PIMAPProgressEventParams;
```

## Remarks

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

The *PercentProcessed* parameter indicates the current status of the operation.

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

# RecipientInfo Event ([PIMAP](#pimap-class) Class)

Fired for each recipient key of the encrypted message.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRecipientInfo(PIMAPRecipientInfoEventParams *e);
typedef struct {  const char *KeyId;  const char *Fingerprint;  const char *PublicKeyAlgorithm;
  int reserved;
} PIMAPRecipientInfoEventParams;

Unicode (Windows)
virtual INT FireRecipientInfo(PIMAPRecipientInfoEventParams *e);
typedef struct {  LPCWSTR KeyId;  LPCWSTR Fingerprint;  LPCWSTR PublicKeyAlgorithm;
  INT reserved;
} PIMAPRecipientInfoEventParams;
```

## Remarks

This event fires when the [Decrypt](#decrypt-method-pimap-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class) method is called.

*KeyId* is the hex-encoded 4- or 8-byte Id of the key used to encrypt the message. If a subkey was used to encrypt the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance:

```text
5E70662EA810E768
```

*Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

```text
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
```

The *KeyId* and *Fingerprint* parameters can be used to identify the correct key to specify in [Keys](#keys-property-pimap-class). [Keys](#keys-property-pimap-class) can be set from within this event as this event fires directly before the decryption process begins.

It is recommended to use the *Fingerprint* to identify the correct key, as it is possible for different keys to have the same *KeyId*.

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

- *RSA*
- *DSA*
- *ECDSA*
- *EdDSA*
- *Ed25519*
- *Ed448*
- *RSA-Legacy*
- *ECDH* (Subkeys only)
- *X25519* (Subkeys only)
- *X448* (Subkeys only)
- *ML-KEM* (Subkeys only; LibrePGP/GnuPG)
- *ML-KEM-768+X25519* (Subkeys only)
- *ML-KEM-1024+X448* (Subkeys only)

# SignatureInfo Event ([PIMAP](#pimap-class) Class)

Fired during verification of the signed message.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSignatureInfo(PIMAPSignatureInfoEventParams *e);
typedef struct {  const char *KeyId;  const char *Fingerprint;  const char *SigningAlgorithm;  const char *PublicKeyAlgorithm;
  int reserved;
} PIMAPSignatureInfoEventParams;

Unicode (Windows)
virtual INT FireSignatureInfo(PIMAPSignatureInfoEventParams *e);
typedef struct {  LPCWSTR KeyId;  LPCWSTR Fingerprint;  LPCWSTR SigningAlgorithm;  LPCWSTR PublicKeyAlgorithm;
  INT reserved;
} PIMAPSignatureInfoEventParams;
```

## Remarks

This event fires when the [VerifySignature](#verifysignature-method-pimap-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class) method is called. It provides information about the signature of the message.

*KeyId* is the hex-encoded 4- or 8-byte Id of the key used to sign the message. If a subkey was used to sign the message this will be the Id of that subkey. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance:

```text
5E70662EA810E768
```

*Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

```text
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
```

The *KeyId* and *Fingerprint* parameters can be used to identify the correct key to specify in [SignerKeys](#signerkeys-property-pimap-class). [SignerKeys](#signerkeys-property-pimap-class) can be set from within this event as this event fires directly before the verification process begins.

It is recommended to use the *Fingerprint* to identify the correct key, as it is possible for different keys to have the same *KeyId*.

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

- *SHA1*
- *MD5*
- *SHA256*
- *SHA384*
- *SHA512*
- *SHA224*
- *RIPEMD160*
- *SHA3-256*
- *SHA3-512*

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

- *RSA*
- *DSA*
- *ECDSA*
- *EdDSA*
- *Ed25519*
- *Ed448*
- *RSA-Legacy*
- *ML-DSA-65+Ed25519*
- *ML-DSA-87+Ed448*
- *ECDH* (Subkeys only)
- *X25519* (Subkeys only)
- *X448* (Subkeys only)

# SSLServerAuthentication Event ([PIMAP](#pimap-class) Class)

Fired after the server presents its certificate to the client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(PIMAPSSLServerAuthenticationEventParams *e);
typedef struct {  const char *CertEncoded;
  int lenCertEncoded;  const char *CertSubject;  const char *CertIssuer;  const char *Status;  int Accept;
  int reserved;
} PIMAPSSLServerAuthenticationEventParams;

Unicode (Windows)
virtual INT FireSSLServerAuthentication(PIMAPSSLServerAuthenticationEventParams *e);
typedef struct {  LPCSTR CertEncoded;
  INT lenCertEncoded;  LPCWSTR CertSubject;  LPCWSTR CertIssuer;  LPCWSTR Status;  BOOL Accept;
  INT reserved;
} PIMAPSSLServerAuthenticationEventParams;
```

## 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 ([PIMAP](#pimap-class) Class)

Fired when secure connection progress messages are available.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSSLStatus(PIMAPSSLStatusEventParams *e);
typedef struct {  const char *Message;
  int reserved;
} PIMAPSSLStatusEventParams;

Unicode (Windows)
virtual INT FireSSLStatus(PIMAPSSLStatusEventParams *e);
typedef struct {  LPCWSTR Message;
  INT reserved;
} PIMAPSSLStatusEventParams;
```

## Remarks

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

# StartTransfer Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireStartTransfer(PIMAPStartTransferEventParams *e);
typedef struct {  int Direction;
  int reserved;
} PIMAPStartTransferEventParams;

Unicode (Windows)
virtual INT FireStartTransfer(PIMAPStartTransferEventParams *e);
typedef struct {  INT Direction;
  INT reserved;
} PIMAPStartTransferEventParams;
```

## 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](#transfer-event-pimap-class) and [EndTransfer](#endtransfer-event-pimap-class) events.

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

# Status Event ([PIMAP](#pimap-class) Class)

Shows the progress of the operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireStatus(PIMAPStatusEventParams *e);
typedef struct {  const char *Message;
  int reserved;
} PIMAPStatusEventParams;

Unicode (Windows)
virtual INT FireStatus(PIMAPStatusEventParams *e);
typedef struct {  LPCWSTR Message;
  INT reserved;
} PIMAPStatusEventParams;
```

## Remarks

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

The level of detail is controlled by the [LogLevel](#LogLevel) setting.

# Transfer Event ([PIMAP](#pimap-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTransfer(PIMAPTransferEventParams *e);
typedef struct {  int Direction;  int64 BytesTransferred;  int PercentDone;  const char *Text;
  int reserved;
} PIMAPTransferEventParams;

Unicode (Windows)
virtual INT FireTransfer(PIMAPTransferEventParams *e);
typedef struct {  INT Direction;  LONG64 BytesTransferred;  INT PercentDone;  LPCWSTR Text;
  INT reserved;
} PIMAPTransferEventParams;
```

## Remarks

The Transfer event is fired for every incoming line when receiving a message or part data from the [MailServer](#mailserver-property-pimap-class)

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](#messagesize-property-pimap-class) property.

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

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

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

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

# VerificationStatus Event ([PIMAP](#pimap-class) Class)

Fired after verification of the signed message.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireVerificationStatus(PIMAPVerificationStatusEventParams *e);
typedef struct {  const char *KeyId;  const char *Fingerprint;  int Status;
  int reserved;
} PIMAPVerificationStatusEventParams;

Unicode (Windows)
virtual INT FireVerificationStatus(PIMAPVerificationStatusEventParams *e);
typedef struct {  LPCWSTR KeyId;  LPCWSTR Fingerprint;  INT Status;
  INT reserved;
} PIMAPVerificationStatusEventParams;
```

## Remarks

This event fires when [VerifySignature](#verifysignature-method-pimap-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class) is called. It provides information about the result.

*KeyId* is the hex-encoded 4- or 8-byte Id of the key used to sign the message. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance:

```text
5E70662EA810E768
```

*Fingerprint* holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

```text
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
```

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

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

# Certificate Type

This is the digital certificate being used.

## Syntax

 *IPWorksPGPCertificate* (declared in *ipworkspgp.h*)

## Remarks

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

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *char* (read-only)*
*Default Value: ""*

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

23-Jan-2000 15:00:00.

 **ExpirationDate** *char* (read-only)*
*Default Value: ""*

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.

 **ExtendedKeyUsage** *char* (read-only)*
*Default Value: ""*

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

 **Fingerprint** *char* (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA1** *char* (read-only)*
*Default Value: ""*

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

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

 **FingerprintSHA256** *char* (read-only)*
*Default Value: ""*

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

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

 **Issuer** *char* (read-only)*
*Default Value: ""*

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

 **PrivateKey** *char* (read-only)*
*Default Value: ""*

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

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *int (read-only)*
*Default Value: FALSE*

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *char* (read-only)*
*Default Value: ""*

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *char* (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *char* (read-only)*
*Default Value: ""*

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

 **PublicKeyLength** *int (read-only)*
*Default Value: 0*

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

 **SerialNumber** *char* (read-only)*
*Default Value: ""*

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

 **SignatureAlgorithm** *char* (read-only)*
*Default Value: ""*

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

 **Store** *char**
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *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).

 **StorePassword** *char**
*Default Value: ""*

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

 **StoreType** *int*
*Default Value: 0*

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintMD5** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA1** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintSHA256** *char* (read-only)*
*Default Value: ""*

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

 **Usage** *char* (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_UsageFlags).

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.

 **UsageFlags** *int (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

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

 **Version** *char* (read-only)*
*Default Value: ""*

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

 **Subject** *char**
*Default Value: ""*

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 field 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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **Encoded** *char**
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
Certificate()
```

 Creates a instance whose properties can be set.

```text
Certificate(const char* lpEncoded, int lenEncoded)
```

 Parses * Encoded * as an X.509 public key.

```text
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

# Firewall Type

The firewall the component will connect through.

## Syntax

 *IPWorksPGPFirewall* (declared in *ipworkspgp.h*)

## Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType).

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *int*
*Default Value: FALSE*

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

 **FirewallType** *int*
*Default Value: 0*

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

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. |

 **Host** *char**
*Default Value: ""*

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

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

 **Password** *char**
*Default Value: ""*

A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

 **Port** *int*
*Default Value: 0*

The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details.

NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details.

 **User** *char**
*Default Value: ""*

A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class fails with an error.

## Constructors

```text
Firewall()
```

# Header Type

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

## Syntax

 *IPWorksPGPHeader* (declared in *ipworkspgp.h*)

## Remarks

When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value).

The following fields are available:

- [Field](#Header_f_Field)

- [Value](#Header_f_Value)

## Fields

 **Field** *char**
*Default Value: ""*

This field contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered).

 **Value** *char**
*Default Value: ""*

This field contains the [Header](#header-type) contents.

## Constructors

```text
Header()
```

```text
Header(const char* lpszField, const char* lpszValue)
```

# Key Type

The OpenPGP key being used.

## Syntax

 *IPWorksPGPKey* (declared in *ipworkspgp.h*)

## Remarks

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

The following fields are available:

- [Curve](#Key_f_Curve)

- [EffectiveDate](#Key_f_EffectiveDate)

- [ExpirationDate](#Key_f_ExpirationDate)

- [Keyring](#Key_f_Keyring)

- [OtherUserIds](#Key_f_OtherUserIds)

- [Passphrase](#Key_f_Passphrase)

- [PublicKey](#Key_f_PublicKey)

- [PublicKeyAlgorithm](#Key_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Key_f_PublicKeyLength)

- [Revoked](#Key_f_Revoked)

- [SecretKey](#Key_f_SecretKey)

- [SecretKeyAvailable](#Key_f_SecretKeyAvailable)

- [Usage](#Key_f_Usage)

- [UsageFlags](#Key_f_UsageFlags)

- [Version](#Key_f_Version)

- [UserId](#Key_f_UserId)

- [Id](#Key_f_Id)

- [Fingerprint](#Key_f_Fingerprint)

- [Encoded](#Key_f_Encoded)

## Fields

 **Curve** *char* (read-only)*
*Default Value: ""*

This field specifies the elliptic curve if [PublicKeyAlgorithm](#Key_f_PublicKeyAlgorithm) is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*. Possible values are:

| Curve | Valid Public Key Algorithms | Description |
| --- | --- | --- |
| secp256r1 | ECDSA | NIST curve P-256 |
| secp384r1 | ECDSA | NIST curve P-384 |
| secp521r1 | ECDSA | NIST curve P-521 |
| secp256k1 | ECDSA | Secp256k1 |
| brainpoolP256r1 | ECDSA | Brainpool curve P-256r1 |
| brainpoolP384r1 | ECDSA | Brainpool curve P-384r1 |
| brainpoolP512r1 | ECDSA | Brainpool curve P-512r1 |
| Ed25519 | EdDSA, Ed25519, ML-DSA-65+Ed25519 | Ed25519 |
| Ed448 | Ed448, ML-DSA-87+Ed448 | Ed448 |

 **EffectiveDate** *char* (read-only)*
*Default Value: ""*

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

23-Jan-2000 15:00:00.

 **ExpirationDate** *char* (read-only)*
*Default Value: ""*

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

23-Jan-2001 15:00:00.

 **Keyring** *char**
*Default Value: ""*

The location of the keyring.

If the keyring is stored in a directory, set this property to the directory. The directory must contain the files "secring.gpg" and "pubring.gpg". A keyring may also be stored in a single file. If the keyring is a file this property should be set to the path of the file.

When This field is set the class will read the keyring and populate the Key property with the first key found in the keyring. Set [UserId](#Key_f_UserId) to select a different key in the current keyring.

 **OtherUserIds** *char* (read-only)*
*Default Value: ""*

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

 **Passphrase** *char**
*Default Value: ""*

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

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

- AddUserId
- SignUserId
- ChangeExpirationDate
- ChangePassphrase

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

- Decrypt
- Sign
- SignAndEncrypt

 **PublicKey** *char* (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *char* (read-only)*
*Default Value: ""*

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

- RSA
- DSA
- ECDSA
- EdDSA
- Ed25519
- Ed448
- ML-DSA-65+Ed25519
- ML-DSA-87+Ed448
- RSA-Legacy

 **PublicKeyLength** *int (read-only)*
*Default Value: 0*

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

If the [PublicKeyAlgorithm](#Key_f_PublicKeyAlgorithm) field is *ECDSA*, *EdDSA*, *Ed25519*, *Ed448*, *ML-DSA-65+Ed25519*, or *ML-DSA-87+Ed448*, the length of the public key is determined by the [Curve](#Key_f_Curve). Possible lengths are:

| Curve | Public Key Length (bits) |
| --- | --- |
| secp256r1 | 256 |
| secp384r1 | 384 |
| secp521r1 | 528 |
| secp256k1 | 256 |
| Ed25519 | 256 |
| Ed448 | 456 |

 **Revoked** *int (read-only)*
*Default Value: FALSE*

Whether or not the key is revoked.

 **SecretKey** *char* (read-only)*
*Default Value: ""*

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

 **SecretKeyAvailable** *int (read-only)*
*Default Value: FALSE*

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

 **Usage** *char* (read-only)*
*Default Value: ""*

A text description of [UsageFlags](#Key_f_UsageFlags).

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

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

 **UsageFlags** *int (read-only)*
*Default Value: 47*

Flags that show the intended use for the key. The default value is 0x0F. The value of [UsageFlags](#Key_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x01 | This key may be used to certify other keys. |
| 0x02 | This key may be used to sign data. |
| 0x0C | This key may be used to encrypt communications and encrypt storage. |
| 0x10 | The private component of this key may have been split by a secret-sharing mechanism. |
| 0x20 | This key may be used for authentication. |
| 0x80 | The private component of this key may be in the possession of more than one person. |

Please refer to the [Usage](#Key_f_Usage) field for a text representation of [UsageFlags](#Key_f_UsageFlags).

 **Version** *int (read-only)*
*Default Value: 4*

This field can be used to query the OpenPGP version of the currently selected Key. Possible values are:

- *4* - OpenPGP v4 (default)
- *5* - LibrePGP v5
- *6* - OpenPGP v6

 **UserId** *char**
*Default Value: ""*

The user Id of the key. When a key is loaded this field is populated with the user Id associated with the key. This field may be set to load a key from the [Keyring](#Key_f_Keyring). When this field is set the class will search the [Keyring](#Key_f_Keyring) for a key associated with the UserId specified.

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

The *UserId* format is:

```text
FirstName LastName (Comment) <Email>
```

 Not all values are required when selecting or generating a key, but at least FirstName or Email are required.

Note that for OpenPGP v6, a key may be created with or without a *UserId*, as the field is optional. If a key was created without a *UserId*, the key's *Fingerprint* can be used as its identifier instead.

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

 **Id** *char**
*Default Value: ""*

The hex-encoded, 4-byte or 8-byte key Id. For OpenPGP v4 keys and earlier, the key Id corresponds to the last 4 or 8 bytes of the key's *Fingerprint*. For OpenPGP v6 keys, the key Id corresponds to the first 8 bytes of the key's *Fingerprint* instead. For instance:

```text
5E70662EA810E768
```

When a key is loaded, this field is populated with the Id associated with the key. This field may be set to load a key from the [Keyring](#Key_f_Keyring). When this field is set the class will search the [Keyring](#Key_f_Keyring) for a key associated with the Id specified.

The KeyIdLength setting may be set to control the length of the returned key Id.

NOTE: It is recommended to use the [Fingerprint](#Key_f_Fingerprint) field when loading a key from the [Keyring](#Key_f_Keyring), as it is possible for different keys to have the same Id.

 **Fingerprint** *char**
*Default Value: ""*

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

When a key is loaded, this field is populated with the Fingerprint associated with the key. This field may be set to load a key from the [Keyring](#Key_f_Keyring). When this field is set the class will search the [Keyring](#Key_f_Keyring) for a key associated with the Fingerprint specified.

This is in the form:

```text
5E70662EA810E768391A2FE8F7B7D49C89C9D7B1
```

 **Encoded** *char**
*Default Value: ""*

The key. This field can be used to assign a specific key. The [Fingerprint](#Key_f_Fingerprint), [Id](#Key_f_Id), and [UserId](#Key_f_UserId) fields may also be used to specify a key.

# Mailbox Type

This type includes mailboxes collected when calling **ListMailboxes** or **ListSubscribedMailboxes** .

## Syntax

 *IPWorksPGPMailbox* (declared in *ipworkspgp.h*)

## Remarks

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

The following fields are available:

- [Flags](#Mailbox_f_Flags)

- [Name](#Mailbox_f_Name)

- [Separator](#Mailbox_f_Separator)

## Fields

 **Flags** *char* (read-only)*
*Default Value: ""*

This field contains the mailbox flags in a mailbox listing.

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

|  |  |
| --- | --- |
| \Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
| \Seen | Mark a message as read. |
| \Answered | Mark a message as answered. |
| \Flagged | Mark a message as flagged. |
| \Draft | Mark a message as being incomplete (under composition). |

 **Name** *char* (read-only)*
*Default Value: ""*

This field contains the mailbox name in a mailbox listing.

 **Separator** *char* (read-only)*
*Default Value: ""*

The [Separator](#Mailbox_f_Separator) field contains the character that separates the different parts in the mailbox path hierarchy.

## Constructors

```text
Mailbox()
```

# MailOAuthSettings Type

The settings used to authenticate with the service provider.

## Syntax

 *IPWorksPGPMailOAuthSettings* (declared in *ipworkspgp.h*)

## Remarks

This type is used to give the class the necessary information needed to complete the OAuth process.

The following fields are available:

- [AccessToken](#MailOAuthSettings_f_AccessToken)

- [AuthorizationScope](#MailOAuthSettings_f_AuthorizationScope)

- [ClientId](#MailOAuthSettings_f_ClientId)

- [ClientSecret](#MailOAuthSettings_f_ClientSecret)

- [RefreshToken](#MailOAuthSettings_f_RefreshToken)

- [ReturnURL](#MailOAuthSettings_f_ReturnURL)

- [ServerAuthURL](#MailOAuthSettings_f_ServerAuthURL)

- [ServerTokenURL](#MailOAuthSettings_f_ServerTokenURL)

## Fields

 **AccessToken** *char**
*Default Value: ""*

The access token returned by the authorization server. This is set when the class makes a request to the token server.

 **AuthorizationScope** *char**
*Default Value: ""*

The scope request or response parameter used during authorization.

 **ClientId** *char**
*Default Value: ""*

The id of the client assigned when registering the application.

 **ClientSecret** *char**
*Default Value: ""*

The secret value for the client assigned when registering the application.

 **RefreshToken** *char**
*Default Value: ""*

Specifies the refresh token received from or sent to the authorization server. This field is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType field is set to a grant that can use refresh tokens.

 **ReturnURL** *char**
*Default Value: ""*

The URL where the user (browser) returns after authenticating. This field is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this field should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

 **ServerAuthURL** *char**
*Default Value: ""*

The URL of the authorization server.

 **ServerTokenURL** *char**
*Default Value: ""*

The URL of the token server used to obtain the access token.

## Constructors

```text
MailOAuthSettings()
```

# MessageInfo Type

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

## Syntax

 *IPWorksPGPMessageInfo* (declared in *ipworkspgp.h*)

## Remarks

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

The following fields are available:

- [Date](#MessageInfo_f_Date)

- [Flags](#MessageInfo_f_Flags)

- [From](#MessageInfo_f_From)

- [MessageId](#MessageInfo_f_MessageId)

- [Size](#MessageInfo_f_Size)

- [Subject](#MessageInfo_f_Subject)

## Fields

 **Date** *char* (read-only)*
*Default Value: ""*

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

 **Flags** *char* (read-only)*
*Default Value: ""*

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

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

|  |  |
| --- | --- |
| \Deleted | Mark a message as deleted (for removal later by ExpungeMailbox). |
| \Seen | Mark a message as read. |
| \Answered | Mark a message as answered. |
| \Flagged | Mark a message as flagged. |
| \Draft | Mark a message as being incomplete (under composition). |

 **From** *char* (read-only)*
*Default Value: ""*

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

 **MessageId** *char* (read-only)*
*Default Value: ""*

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

 **Size** *int64 (read-only)*
*Default Value: 0*

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

 **Subject** *char* (read-only)*
*Default Value: ""*

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

## Constructors

```text
MessageInfo()
```

# MessagePart Type

A message part of a message listing.

## Syntax

 *IPWorksPGPMessagePart* (declared in *ipworkspgp.h*)

## Remarks

Messages are split into message parts. Each [MessagePart](#messagepart-type) is specified by a unique identifier, namely, the [Id](#MessagePart_f_Id) field. Each part contains data and other fields describing that part.

The following fields are available:

- [ContentDisposition](#MessagePart_f_ContentDisposition)

- [ContentEncoding](#MessagePart_f_ContentEncoding)

- [ContentId](#MessagePart_f_ContentId)

- [ContentType](#MessagePart_f_ContentType)

- [FileName](#MessagePart_f_FileName)

- [Id](#MessagePart_f_Id)

- [MultipartMode](#MessagePart_f_MultipartMode)

- [Parameters](#MessagePart_f_Parameters)

- [Size](#MessagePart_f_Size)

## Fields

 **ContentDisposition** *char* (read-only)*
*Default Value: ""*

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

 **ContentEncoding** *char* (read-only)*
*Default Value: ""*

This field shows how the data are encoded.

 **ContentId** *char* (read-only)*
*Default Value: ""*

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

 **ContentType** *char* (read-only)*
*Default Value: ""*

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

 **FileName** *char* (read-only)*
*Default Value: ""*

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

 **Id** *char* (read-only)*
*Default Value: ""*

This field contains the identifier of a part listing that may be identified in other parts or messages. The format of part identifiers is specified by the IMAP RFCs.

 **MultipartMode** *char* (read-only)*
*Default Value: ""*

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

 **Parameters** *char* (read-only)*
*Default Value: ""*

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

 **Size** *int64 (read-only)*
*Default Value: 0*

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

## Constructors

```text
MessagePart()
```

# MessageRecipient Type

This types describes the message recipient.

## Syntax

 *IPWorksPGPMessageRecipient* (declared in *ipworkspgp.h*)

## Remarks

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

The following fields are available:

- [Address](#MessageRecipient_f_Address)

- [Name](#MessageRecipient_f_Name)

- [Options](#MessageRecipient_f_Options)

- [RecipientType](#MessageRecipient_f_RecipientType)

## Fields

 **Address** *char**
*Default Value: ""*

This field contains the email address of the recipient.

 **Name** *char**
*Default Value: ""*

This field contains the name of the recipient.

 **Options** *char**
*Default Value: ""*

This field contains the recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP).

One type of option is a delivery status notification sent per recipient, which is specified by RFC 1891.

```text
component.MessageRecipientOptions(0) = "NOTIFY SUCCESS,FAILURE,DELAY";
```

 **RecipientType** *int*
*Default Value: 0*

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

## Constructors

```text
MessageRecipient()
```

```text
MessageRecipient(const char* lpszAddress)
```

# IPWorksPGPList Type

## Syntax

 *IPWorksPGPList<T>* (declared in *ipworkspgp.h*)

## Remarks

 *IPWorksPGPList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the PIMAP class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |

# IPWorksPGPStream Type

## Syntax

 *IPWorksPGPStream* (declared in *ipworkspgp.h*)

## Remarks

 The PIMAP class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksPGPStream interface and pass the PIMAP class an instance of that concrete class.

 When implementing the IPWorksPGPStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

```text
int Read(void* buffer, int count) = 0;
```

```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```

```text
int Write(const void* buffer, int count) = 0;
```

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when an IPWorksPGPStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([PIMAP](#pimap-class) Class)

 The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-pimap-class) method.

### PIMAP Config Settings

**Comment**: The OpenPGP message comment.OpenPGP messages may contain a comment. This setting holds the comment (if any) after calling [Decrypt](#decrypt-method-pimap-class), [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class), or [VerifySignature](#verifysignature-method-pimap-class).

**LogLevel**: Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the [Status](#status-event-pimap-class) event. Possible values are:

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

**ProcessAttachments**: Whether or not to process attachments.This setting controls whether attachments are processed when calling [Decrypt](#decrypt-method-pimap-class), [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class), or [VerifySignature](#verifysignature-method-pimap-class). When set to True if an attachment is a valid OpenPGP message it will be decrypted and/or verified. If it is not a valid OpenPGP message it will be left as is. When set to False the attachments are not processed. The default value is True.

**RequireValidSignature**: Specifies if an invalid signature is considered an error condition.By default, if the signature is not valid the class fails with an error. This setting may be set to False to disable this requirement. When False, the *Status* parameter of the [VerificationStatus](#verificationstatus-event-pimap-class) event should be checked to determine the result of the operation. The default value is True.

**SymmetricPassphrase**: The password used for symmetric encryption or decryption.This setting specifies the passphrase when using symmetric encryption. If a value is provided, symmetric encryption/decryption will be attempted. In this case no keys are used for either encryption or decryption. Only Encrypt and [Decrypt](#decrypt-method-pimap-class) are valid operations when a value is set. Sign, SignAndEncrypt, [VerifySignature](#verifysignature-method-pimap-class), and [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class) are not valid operations when using this option.

**VerifyClearTextSignatureWithCache**: Whether the cleartext message is cached in memory when verifying a cleartext signature.When verifying a cleartext signature, this configuration setting determines whether the cleartext message is cached in memory.

This config is *True* by default, and **must** be true when verifying an OpenPGP v6 cleartext signature. When enabled, the cleartext portion will be cached in memory until the signature is fully processed.

NOTE: If the signature is known to be an OpenPGP v4 cleartext signature beforehand (i.e., signed with a v4 key), this config may be set to *False*. However, if this config is disabled, the class will be unable to verify OpenPGP v6 cleartext signatures. In this case, the class will throw an exception when calling [VerifySignature](#verifysignature-method-pimap-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class).

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

This setting will be populated after calling [Decrypt](#decrypt-method-pimap-class), [VerifySignature](#verifysignature-method-pimap-class), or [DecryptAndVerifySignature](#decryptandverifysignature-method-pimap-class).

### SIMAP Config Settings

**RedownloadHeaders**: Whether or not to redownload the message headers when querying MessageEncrypted or MessageSigned.When enabled (default), the class will redownload the message headers whenever CheckMessageEncrypted or CheckMessageSigned is called.

### IMAP Config Settings

**AlwaysReturnUIDs**: Instructs the server to return UIDs even if not in UIDMode. If [UIDMode](#uidmode-property-pimap-class) is set to False, the [MessageSet](#messageset-property-pimap-class) contains session message Ids, and the response from the server also will contain session message Ids. In some cases, it is desirable that the server sends back UIDs. Set the [AlwaysReturnUIDs](#AlwaysReturnUIDs) to True, to instruct the server to do so.

The default value for this setting is False.

**AppendToMailboxDateTime**: Specifies the date-time parameter used in the initial APPEND request. When appending to a mailbox using the [AppendToMailbox](#appendtomailbox-method-pimap-class) method, the IMAP RFC specifies a date-time parameter that can be used to set the internal date of the resulting message. This configuration setting can be used to specify the date-time parameter used in this case.

The date-time should be formatted according to the IMAP RFC specifications. For example, "22-Jan-2013 12:34:56 -0500" indicates January 22nd, 2013, at 12:34:56 PM EST.

By default, if this setting is not specified, no date-time is sent with the *APPEND* request, and the server will use the current time.

**AuthorizationIdentity**: The value to use as the authorization identity when SASL authentication is used. When [AuthMechanism](#authmechanism-property-pimap-class) is set to amSASLPlain, amSASLDigestMD5, or amXOAUTH2, you may use this setting to specify an authorization identity to be used when authenticating. In the case of amXOAUTH2, this should be your OAUTH authorization string. For instance:

```plaintext
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3Q
```

NOTE: When using amXOAUTH2, [User](#user-property-pimap-class) must be specified, but [Password](#password-property-pimap-class) is not required.

**AutoDecodeSubject**: Instructs the class to automatically decode message subjects.Subjects that have been Quoted-Printable or Base64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded.

**AutoDecodeText**: Whether to decode MessageText when AutoDecodeParts is True.When [AutoDecodeParts](#autodecodeparts-property-pimap-class) is True, this setting controls whether [MessageText](#messagetext-property-pimap-class) is also decoded. When [AutoDecodeText](#AutoDecodeText) is True (default), [MessageText](#messagetext-property-pimap-class) is decoded. When set to False, [MessageText](#messagetext-property-pimap-class) is not decoded. This setting is applicable only when [AutoDecodeParts](#autodecodeparts-property-pimap-class) is set to True.

**IncludeHeaders**: Instructs the class to include the headers in the LocalFile.When set to *true*, the headers for the message being retrieved will be written to the LocalFile before the message body. In this manner, the whole content of a MIME-encoded message will be written to the file.

**MaskSensitiveData**: Whether sensitive properties should be masked when logging.By default, the [PITrail](#pitrail-event-pimap-class) event will include the raw commands sent to the IMAP server, including sensitive values like passwords. To prevent passwords from appearing in plaintext when logging, set this option to True. The default value is True.

**RetrieveAfterSearch**: Determines if messages matching the SearchCriteria are retrieved after calling SearchMailbox.If set to False, [RetrieveMessageInfo](#retrievemessageinfo-method-pimap-class) will not be called for messages matching the *SearchCriteria* after calling [SearchMailbox](#searchmailbox-method-pimap-class). [MessageInfo](#messageinfo-event-pimap-class) will still fire, but the MessageId parameter will be the only parameter populated. The default value of this setting is True.

**RetrieveTextAndHeaders**: Specifies whether the message body and headers are retrieved in a single request.This setting specifies whether the [RetrieveMessageText](#retrievemessagetext-method-pimap-class) method retrieves both the message headers and text, or just the message text. By default this value is *false*, and [RetrieveMessageText](#retrievemessagetext-method-pimap-class) will retrieve only the message text from the server. When set to *true*, the class will retrieve both the message text and headers in a single request from the server and populate both [MessageHeadersString](#messageheadersstring-property-pimap-class) and [MessageText](#messagetext-property-pimap-class).

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

This configuration setting specifies whether the class will use the IMAP4 Id extension defined in RFC 2971 and send the Id command to the server. When set to *true*, the class will send the Id command with the value *IPWorksIMAP* if the server supports this as defined in the server's response to the *CAPABILITY* command.

The default value is *false*, and this command will not be sent.

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

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-pimap-class) for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

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

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

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

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

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

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

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

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

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

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

NOTE: This value is not applicable in macOS.

**KeepAliveRetryCount**: The number of keep-alive packets to be sent before the remotehost is considered disconnected.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

NOTE: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

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

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

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

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-pimap-class) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

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

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

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

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

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

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

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

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

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-pimap-class) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-pimap-class) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.

**SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

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

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-pimap-class) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-pimap-class) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#sslprovider-property-pimap-class) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#sslprovider-property-pimap-class) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-pimap-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-pimap-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-pimap-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-pimap-class) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-pimap-class) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-pimap-class) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-pimap-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

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

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#sslprovider-property-pimap-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

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

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-pimap-class) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

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

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

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

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-pimap-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

On Linux, the C++ edition requires installation of the FIPS-enabled OpenSSL library. The OpenSSL FIPS provider version must be at least 3.0.0. For additional information and instructions regarding the installation and activation of the FIPS-enabled OpenSSL library, please refer to the following link: [https://github.com/openssl/openssl/blob/master/README-FIPS.md](https://github.com/openssl/openssl/blob/master/README-FIPS.md)

To ensure the class utilizes the FIPS-enabled OpenSSL library, the obfuscated source code should first be compiled with OpenSSL enabled, as described in the Supported Platforms section. Additionally, the FIPS module should be enabled and active. If the obfuscated source code is not compiled as mentioned, or the FIPS module is inactive, the class will throw an appropriate error assuming FIPS mode is enabled.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([PIMAP](#pimap-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### IMAP Errors

|  |  |
| --- | --- |
| 118 | Firewall error. Error message contains detailed description. |
| 311 | Protocol error. |
| 312 | Busy executing current method. |
| 314 | A [Mailbox](#mailbox-property-pimap-class) must be selected before calling this method. |
| 315 | Invalid argument. Please specify a valid [MessageSet](#messageset-property-pimap-class). |
| 317 | Unknown content encoding. |
| 318 | LocalFile already exists and overwrite is False. |

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

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the RemotePort at this time. A connection is in progress. |
| 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
| 102 | The RemoteHost address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the LocalPort at this time. A connection is in progress. |
| 107 | You cannot change the [LocalHost](#localhost-property-pimap-class) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | RemotePort cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the class is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 302 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |

### OpenPGP Errors

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