# IMAPClient Class

The IMAPClient class provides client-side functionality for IMAP4 (Internet Message Access Protocol).

## Syntax

```text
IMAPClient
```

## Remarks

Use this class to manage e-mail and retrieve e-mail messages from the remote IMAP servers. Please see the [OAuthClient](OAuthClient.md#OAuthClient) topic for more details about using the OAuth2 authentication type.

Downloading only the recent messages to local files

```text
  IMAPClient client = new IMAPClient();

  client.Username= "user";
  client.Password= "password";
  client.Connect("mail.domain.com", 993);

  client.OpenMailbox("INBOX", true);
  client.ListMessages(Constants.imapMessageRecent, 0);
  foreach (IMAPMessageInfo info in client.Messages)
    client.ReceiveFile(info.UID, $"path\\{info.UID}.eml");

  client.Disconnect();
```

Use [Command](#command-event-imapclient-class) and [CommandReply](#commandreply-event-imapclient-class) events to get a session log.

```text
  IMAPClient client = new IMAPClient();
  client.OnCommand += (s, e) =>
  {
    Console.WriteLine($"C: {e.Cmd}");
  };
  client.OnCommandReply += (s, e) =>
  {
    Console.WriteLine($"S: {e.Reply}");
  };
```

## Property List

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

|  |  |
| --- | --- |
| [AccessToken](#accesstoken-property-imapclient-class) | An OAuth 2.0 access token to authenticate to the server. |
| [BlockedCertificates](#blockedcertificates-property-imapclient-class) | The certificates that must be rejected as trust anchors. |
| [ConnectionInfo](#connectioninfo-property-imapclient-class) | Returns the details of the underlying network connection. |
| [FIPSMode](#fipsmode-property-imapclient-class) | Reserved. |
| [KnownCertificates](#knowncertificates-property-imapclient-class) | Additional certificates for chain validation. |
| [KnownCRLs](#knowncrls-property-imapclient-class) | Additional CRLs for chain validation. |
| [KnownOCSPs](#knownocsps-property-imapclient-class) | Additional OCSP responses for chain validation. |
| [Mailbox](#mailbox-property-imapclient-class) | Returns the selected (active) mailbox info. |
| [Message](#message-property-imapclient-class) | Contains a pinned e-mail message. |
| [Messages](#messages-property-imapclient-class) | Populates a list of messages returned by the last list call. |
| [Password](#password-property-imapclient-class) | The authentication password. |
| [Proxy](#proxy-property-imapclient-class) | The proxy server settings. |
| [ServerInfo](#serverinfo-property-imapclient-class) | Encapsulates information about the server. |
| [SessionLog](#sessionlog-property-imapclient-class) | Contains the complete log of the last session. |
| [SocketSettings](#socketsettings-property-imapclient-class) | Manages network connection settings. |
| [TLSClientChain](#tlsclientchain-property-imapclient-class) | The TLS client certificate chain. |
| [TLSServerChain](#tlsserverchain-property-imapclient-class) | The TLS server's certificate chain. |
| [TLSSettings](#tlssettings-property-imapclient-class) | Manages TLS layer settings. |
| [TrustedCertificates](#trustedcertificates-property-imapclient-class) | A list of trusted certificates for chain validation. |
| [Username](#username-property-imapclient-class) | The authentication username. |

## Method List

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

|  |  |
| --- | --- |
| [CloseMailbox](#closemailbox-method-imapclient-class) | Closes the current mailbox. |
| [Config](#config-method-imapclient-class) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-imapclient-class) | Establishes a connection to the IMAP server. |
| [CopyMessage](#copymessage-method-imapclient-class) | Copies a message to another mailbox. |
| [CreateMailbox](#createmailbox-method-imapclient-class) | Creates a new mailbox. |
| [DeleteMailbox](#deletemailbox-method-imapclient-class) | Deletes an existing mailbox. |
| [Disconnect](#disconnect-method-imapclient-class) | Closes connection to the IMAP server. |
| [DoAction](#doaction-method-imapclient-class) | Performs an additional action. |
| [GetMailboxInfo](#getmailboxinfo-method-imapclient-class) | Requests mailbox status. |
| [ListMailboxes](#listmailboxes-method-imapclient-class) | Queries a list of mailboxes available on the server. |
| [ListMessages](#listmessages-method-imapclient-class) | Queries a list of messages available in the currently selected on the server. |
| [OpenMailbox](#openmailbox-method-imapclient-class) | Opens the specified mailbox. |
| [Ping](#ping-method-imapclient-class) | Sends a NOOP command to the IMAP server. |
| [PostBytes](#postbytes-method-imapclient-class) | Uploads an e-mail message stored in a byte array. |
| [PostFile](#postfile-method-imapclient-class) | Uploads a message stored in a file to the current mailbox on the IMAP server. |
| [PostMessage](#postmessage-method-imapclient-class) | Uploads a pre-built message to the current mailbox on the IMAP server. |
| [PostStream](#poststream-method-imapclient-class) | Uploads a message stored in a stream to the current mailbox on the IMAP server. |
| [PurgeMessages](#purgemessages-method-imapclient-class) | Permanently removes all deleted messages from the current mailbox. |
| [ReceiveBytes](#receivebytes-method-imapclient-class) | Downloads a message to a byte array. |
| [ReceiveFile](#receivefile-method-imapclient-class) | Downloads a message to a file. |
| [ReceiveMessage](#receivemessage-method-imapclient-class) | Downloads a message. |
| [ReceiveStream](#receivestream-method-imapclient-class) | Downloads a message to a stream. |
| [RefreshMailbox](#refreshmailbox-method-imapclient-class) | Refreshes info about the currently selected mailbox. |
| [RenameMailbox](#renamemailbox-method-imapclient-class) | Renames an existing mailbox. |
| [Reset](#reset-method-imapclient-class) | Resets the class settings. |
| [UpdateMessage](#updatemessage-method-imapclient-class) | Alters flags associated with a message in the current mailbox on the IMAP server. |

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

|  |  |
| --- | --- |
| [AuthFailed](#authfailed-event-imapclient-class) | Fires when an authentication attempt has failed. |
| [AuthStart](#authstart-event-imapclient-class) | Fires when the authentication is about to be started. |
| [AuthSucceeded](#authsucceeded-event-imapclient-class) | Fires when the authentication has succeeded. |
| [Command](#command-event-imapclient-class) | Reports a command sent to the server. |
| [CommandData](#commanddata-event-imapclient-class) | Returns the data that accompanies the command. |
| [CommandReply](#commandreply-event-imapclient-class) | Reports the receipt of a reply to a command. |
| [CommandReplyData](#commandreplydata-event-imapclient-class) | Returns the data that accompanies a reply to a command. |
| [Error](#error-event-imapclient-class) | Provides information about errors during SMTP operations. |
| [MailboxFound](#mailboxfound-event-imapclient-class) | Provides mailbox details. |
| [MailboxInfo](#mailboxinfo-event-imapclient-class) | Reports mailbox information returned from the server. |
| [Notification](#notification-event-imapclient-class) | This event notifies the application about an underlying control flow event. |
| [Progress](#progress-event-imapclient-class) | Reports the progress of the data transfer operation. |
| [TLSCertNeeded](#tlscertneeded-event-imapclient-class) | Fires when a remote TLS party requests a client certificate. |
| [TLSCertValidate](#tlscertvalidate-event-imapclient-class) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| [TLSEstablished](#tlsestablished-event-imapclient-class) | Fires when a TLS handshake with Host successfully completes. |
| [TLSHandshake](#tlshandshake-event-imapclient-class) | Fires when a new TLS handshake is initiated, before the handshake commences. |
| [TLSPSK](#tlspsk-event-imapclient-class) | Notifies the application about the PSK key exchange. |
| [TLSShutdown](#tlsshutdown-event-imapclient-class) | Reports the graceful closure of a TLS connection. |

## Config Settings

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

|  |  |
| --- | --- |
| [Authentications](#Authentications) | Specifies enabled authentication methods and their priorities. |
| [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. |
| [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. |
| [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. |
| [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. |
| [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. |
| [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. |
| [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. |
| [IdleAuto](#IdleAuto) | Specifies whether idle mode should be requested automatically. |
| [IdleTimeout](#IdleTimeout) | Specifies idle timeout in seconds. |
| [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. |
| [ListCriteria](#ListCriteria) | Specifies an advanced criteria for listing messages on the server. |
| [MaxLineLength](#MaxLineLength) | Specifies maximum expected line length. |
| [MessageHeaderZZZ\[i\]](#MessageHeaderZZZ[i]) | A value of ZZZ header field for message i. |
| [OtherHeaders](#OtherHeaders) | Specifies header fields to request when lists messages on the server. |
| [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| [SendingBufferSize](#SendingBufferSize) | Specifies the size of the buffer used to post messages to the server. |
| [SessionLogDetails](#SessionLogDetails) | Specifies whether login credentials should be written to the session log. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the class for the current session. |
| [TLSExtensions](#TLSExtensions) | TBD. |
| [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the class. |
| [TLSPeerExtensions](#TLSPeerExtensions) | TBD. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the class. |
| [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. |
| [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. |
| [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# AccessToken Property ([IMAPClient](#imapclient-class) Class)

An OAuth 2.0 access token to authenticate to the server.

## Syntax

```text
ANSI (Cross Platform)
char* GetAccessToken();int SetAccessToken(const char* lpszAccessToken);

Unicode (Windows)
LPWSTR GetAccessToken();INT SetAccessToken(LPCWSTR lpszAccessToken);
```

## Default Value

""

## Remarks

Use this property to provide the access token to be used to authenticate to the destination server.

## Data Type

String

# BlockedCertificates Property ([IMAPClient](#imapclient-class) Class)

The certificates that must be rejected as trust anchors.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates();
int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
```

## Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# ConnectionInfo Property ([IMAPClient](#imapclient-class) Class)

Returns the details of the underlying network connection.

## Syntax

```text
SecureBlackboxTLSConnectionInfo* GetConnectionInfo();
```

## Remarks

Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way.

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

## Data Type

[SecureBlackboxTLSConnectionInfo](#tlsconnectioninfo-type)

# FIPSMode Property ([IMAPClient](#imapclient-class) Class)

Reserved.

## Syntax

```text
ANSI (Cross Platform)
int GetFIPSMode();int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode);
```

## Default Value

FALSE

## Remarks

This property is reserved for future use.

## Data Type

Boolean

# KnownCertificates Property ([IMAPClient](#imapclient-class) Class)

Additional certificates for chain validation.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates();
int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
```

## Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to [TrustedCertificates](#trustedcertificates-property-imapclient-class) instead.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# KnownCRLs Property ([IMAPClient](#imapclient-class) Class)

Additional CRLs for chain validation.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs();
int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
```

## Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

## Data Type

[SecureBlackboxCRL](#crl-type)

# KnownOCSPs Property ([IMAPClient](#imapclient-class) Class)

Additional OCSP responses for chain validation.

## Syntax

```text
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs();
int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);
```

## Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

## Data Type

[SecureBlackboxOCSPResponse](#ocspresponse-type)

# Mailbox Property ([IMAPClient](#imapclient-class) Class)

Returns the selected (active) mailbox info.

## Syntax

```text
SecureBlackboxIMAPMailboxInfo* GetMailbox();
```

## Remarks

Use this property to access the status of the mailbox that is currently selected (active).

To update information in this property call [RefreshMailbox](#refreshmailbox-method-imapclient-class).

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

## Data Type

[SecureBlackboxIMAPMailboxInfo](#imapmailboxinfo-type)

# Message Property ([IMAPClient](#imapclient-class) Class)

Contains a pinned e-mail message.

## Syntax

```text
SecureBlackboxMailMessage* GetMessage();
int SetMessage(SecureBlackboxMailMessage* val);
```

## Remarks

Use this property to access an e-mail message that was just downloaded with a [ReceiveMessage](#receivemessage-method-imapclient-class) call, or assign it with a message to be uploaded with [PostMessage](#postmessage-method-imapclient-class) call.

This property is not available at design time.

## Data Type

[SecureBlackboxMailMessage](#mailmessage-type)

# Messages Property ([IMAPClient](#imapclient-class) Class)

Populates a list of messages returned by the last list call.

## Syntax

```text
SecureBlackboxList<SecureBlackboxIMAPMessageInfo>* GetMessages();
```

## Remarks

Use this property to access the details of messages after a call to one of the list methods.

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

## Data Type

[SecureBlackboxIMAPMessageInfo](#imapmessageinfo-type)

# Password Property ([IMAPClient](#imapclient-class) Class)

The authentication password.

## Syntax

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

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

## Default Value

""

## Remarks

Use this property to provide the password for authenticating to the IMAP server.

In order to use OAuth 2.0 authentication to access the IMAP server, use the [AccessToken](#accesstoken-property-imapclient-class) property instead.

## Data Type

String

# Proxy Property ([IMAPClient](#imapclient-class) Class)

The proxy server settings.

## Syntax

```text
SecureBlackboxProxySettings* GetProxy();
```

## Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

## Data Type

[SecureBlackboxProxySettings](#proxysettings-type)

# ServerInfo Property ([IMAPClient](#imapclient-class) Class)

Encapsulates information about the server.

## Syntax

```text
SecureBlackboxIMAPServerInfo* GetServerInfo();
```

## Remarks

Use this property after establishing a connection to the server to learn about the IMAP server's capabilities.

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

## Data Type

[SecureBlackboxIMAPServerInfo](#imapserverinfo-type)

# SessionLog Property ([IMAPClient](#imapclient-class) Class)

Contains the complete log of the last session.

## Syntax

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

Unicode (Windows)
LPWSTR GetSessionLog();
```

## Default Value

""

## Remarks

Use this property to access the session log produced by the class. The log can be very useful when investigating connection issues.

See the *SessionLogDetails* config property for the log details settings.

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

## Data Type

String

# SocketSettings Property ([IMAPClient](#imapclient-class) Class)

Manages network connection settings.

## Syntax

```text
SecureBlackboxSocketSettings* GetSocketSettings();
```

## Remarks

Use this property to tune up network connection parameters.

This property is read-only.

## Data Type

[SecureBlackboxSocketSettings](#socketsettings-type)

# TLSClientChain Property ([IMAPClient](#imapclient-class) Class)

The TLS client certificate chain.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain();
int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
```

## Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use the [CertificateStorage](CertificateStorage.md#CertificateStorage) or [CertificateManager](CertificateManager.md#CertificateManager) components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# TLSServerChain Property ([IMAPClient](#imapclient-class) Class)

The TLS server's certificate chain.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
```

## Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the [TLSCertValidate](#tlscertvalidate-event-imapclient-class) event is fired by the client component.

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

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# TLSSettings Property ([IMAPClient](#imapclient-class) Class)

Manages TLS layer settings.

## Syntax

```text
SecureBlackboxTLSSettings* GetTLSSettings();
```

## Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

## Data Type

[SecureBlackboxTLSSettings](#tlssettings-type)

# TrustedCertificates Property ([IMAPClient](#imapclient-class) Class)

A list of trusted certificates for chain validation.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates();
int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
```

## Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# Username Property ([IMAPClient](#imapclient-class) Class)

The authentication username.

## Syntax

```text
ANSI (Cross Platform)
char* GetUsername();int SetUsername(const char* lpszUsername);

Unicode (Windows)
LPWSTR GetUsername();INT SetUsername(LPCWSTR lpszUsername);
```

## Default Value

""

## Remarks

Use this property to provide the username for authenticating to the IMAP server.

## Data Type

String

# CloseMailbox Method ([IMAPClient](#imapclient-class) Class)

Closes the current mailbox.

## Syntax

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

Unicode (Windows)
INT CloseMailbox();
```

## Remarks

Use this method to close (i.e. deselect) 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.)

# Config Method ([IMAPClient](#imapclient-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-imapclient-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-imapclient-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 ([IMAPClient](#imapclient-class) Class)

Establishes a connection to the IMAP server.

## Syntax

```text
ANSI (Cross Platform)
int Connect(const char* lpszAddress, int iPort);

Unicode (Windows)
INT Connect(LPCWSTR lpszAddress, INT iPort);
```

## Remarks

Use this method to establish a connection to the IMAP server at *Address* and *Port*.

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

# CopyMessage Method ([IMAPClient](#imapclient-class) Class)

Copies a message to another mailbox.

## Syntax

```text
ANSI (Cross Platform)
int CopyMessage(int iUID, const char* lpszMailboxName);

Unicode (Windows)
INT CopyMessage(INT iUID, LPCWSTR lpszMailboxName);
```

## Remarks

Copies a message specified by its *UID* to another 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.)

# CreateMailbox Method ([IMAPClient](#imapclient-class) Class)

Creates a new mailbox.

## Syntax

```text
ANSI (Cross Platform)
int CreateMailbox(const char* lpszName);

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

## Remarks

Call this method to create a new mailbox, providing the name via the *Name* 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 ([IMAPClient](#imapclient-class) Class)

Deletes an existing mailbox.

## Syntax

```text
ANSI (Cross Platform)
int DeleteMailbox(const char* lpszName);

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

## Remarks

Call this method to delete a 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.)

# Disconnect Method ([IMAPClient](#imapclient-class) Class)

Closes connection to the IMAP server.

## Syntax

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

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

## Remarks

Call this method to gracefully terminate the connection.

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

# DoAction Method ([IMAPClient](#imapclient-class) Class)

Performs an additional action.

## Syntax

```text
ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
```

## Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter.

*ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*.

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

|  |  |  |
| --- | --- | --- |
| Action | Parameters | Returned value |
| Search | A criteria for the SEARCH command. If the value is empty, the criteria is considered 'ALL'. For more details, see [SEARCH command in RFC 3501](https://tools.ietf.org/html/rfc3501#section-6.4.4) | UIDs of messages relevant to the criteria, separated by a space |

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

# GetMailboxInfo Method ([IMAPClient](#imapclient-class) Class)

Requests mailbox status.

## Syntax

```text
ANSI (Cross Platform)
int GetMailboxInfo(const char* lpszName);

Unicode (Windows)
INT GetMailboxInfo(LPCWSTR lpszName);
```

## Remarks

Requests status information of the specified mailbox and returns it using [MailboxInfo](#mailboxinfo-event-imapclient-class) event.

## 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 ([IMAPClient](#imapclient-class) Class)

Queries a list of mailboxes available on the server.

## Syntax

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

Unicode (Windows)
LPWSTR ListMailboxes();
```

## Remarks

Use this method to request a list of mailboxes currently available on the server. The mailbox names are separated from each other with a CRLF sequence.

Another way to handle mailboxes is to subscribe to the [MailboxFound](#mailboxfound-event-imapclient-class) event. Using the event, it's possible to get not only mailbox names but mailbox attributes as well.

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

# ListMessages Method ([IMAPClient](#imapclient-class) Class)

Queries a list of messages available in the currently selected on the server.

## Syntax

```text
ANSI (Cross Platform)
int ListMessages(int iFlagsSet, int iFlagsNotSet);

Unicode (Windows)
INT ListMessages(INT iFlagsSet, INT iFlagsNotSet);
```

## Remarks

Call this method to request a list of messages with the set or not set flags available in the current mailbox.

*FlagsSet* and *FlagsNotSet* are bit masks of the following values:

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

If listed messages should have a flag set, pass it to *FlagsSet*. If listed messages should not have a flag, pass it to *FlagsNotSet*.

For example:

- if you need messages with the "draft" flag set, add *imapMessageDraft* to *FlagsSet*;
- if you need messages with no "seen" flag set, add *imapMessageSeen* to *FlagsNotSet*.

The flags in the parameters can be combined. For example, if you need messages with "answered" flag set but with no "flagged" flag set, pass *imapMessageAnswered* to *FlagsSet* and *imapMessageFlagged* to *FlagsNotSet*.

To list all the messages available in the selected mailbox, pass 0 to both parameters.

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

# OpenMailbox Method ([IMAPClient](#imapclient-class) Class)

Opens the specified mailbox.

## Syntax

```text
ANSI (Cross Platform)
int OpenMailbox(const char* lpszName, int bReadOnly);

Unicode (Windows)
INT OpenMailbox(LPCWSTR lpszName, BOOL bReadOnly);
```

## Remarks

Use this method to open (select) the specified mailbox on the server. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the [Mailbox](#mailbox-property-imapclient-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.)

# Ping Method ([IMAPClient](#imapclient-class) Class)

Sends a NOOP command to the IMAP server.

## Syntax

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

Unicode (Windows)
INT Ping();
```

## Remarks

This method sends a NOOP command to the server, effectively pinging the server and keeping the connection alive.

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

# PostBytes Method ([IMAPClient](#imapclient-class) Class)

Uploads an e-mail message stored in a byte array.

## Syntax

```text
ANSI (Cross Platform)
int PostBytes(const char* lpBytes, int lenBytes, int iFlags, const char* lpszInternalDate);

Unicode (Windows)
INT PostBytes(LPCSTR lpBytes, INT lenBytes, INT iFlags, LPCWSTR lpszInternalDate);
```

## Remarks

Use this method to upload a message stored in a byte array specified by *Bytes* to [Mailbox](#mailbox-property-imapclient-class).

Supported flags are:

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

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

# PostFile Method ([IMAPClient](#imapclient-class) Class)

Uploads a message stored in a file to the current mailbox on the IMAP server.

## Syntax

```text
ANSI (Cross Platform)
int PostFile(const char* lpszFileName, int iFlags, const char* lpszInternalDate);

Unicode (Windows)
INT PostFile(LPCWSTR lpszFileName, INT iFlags, LPCWSTR lpszInternalDate);
```

## Remarks

Use this method to upload an e-mail message stored in a file to [Mailbox](#mailbox-property-imapclient-class).

Supported flags are:

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

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

# PostMessage Method ([IMAPClient](#imapclient-class) Class)

Uploads a pre-built message to the current mailbox on the IMAP server.

## Syntax

```text
ANSI (Cross Platform)
int PostMessage(int iFlags, const char* lpszInternalDate);

Unicode (Windows)
INT PostMessage(INT iFlags, LPCWSTR lpszInternalDate);
```

## Remarks

Use this message to upload [Message](#message-property-imapclient-class) to [Mailbox](#mailbox-property-imapclient-class).

Supported flags are:

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

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

# PostStream Method ([IMAPClient](#imapclient-class) Class)

Uploads a message stored in a stream to the current mailbox on the IMAP server.

## Syntax

```text
ANSI (Cross Platform)
int PostStream(SecureBlackboxStream* sStream, int iFlags, const char* lpszInternalDate);

Unicode (Windows)
INT PostStream(SecureBlackboxStream* sStream, INT iFlags, LPCWSTR lpszInternalDate);
```

## Remarks

Use this message to upload a message provided in *Stream* to [Mailbox](#mailbox-property-imapclient-class).

Supported flags are:

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

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

# PurgeMessages Method ([IMAPClient](#imapclient-class) Class)

Permanently removes all deleted messages from the current mailbox.

## Syntax

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

Unicode (Windows)
INT PurgeMessages();
```

## Remarks

Use this method to permanently remove all messages in [Mailbox](#mailbox-property-imapclient-class) marked with the Deleted flag.

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

# ReceiveBytes Method ([IMAPClient](#imapclient-class) Class)

Downloads a message to a byte array.

## Syntax

```text
ANSI (Cross Platform)
char* ReceiveBytes(int iUID, int *lpSize = NULL);

Unicode (Windows)
LPSTR ReceiveBytes(INT iUID, LPINT lpSize = NULL);
```

## Remarks

Use this method to download a server-side message to a byte array.

## Error Handling (C++)

This method returns a Byte Array value (with length *lpSize*); 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.

# ReceiveFile Method ([IMAPClient](#imapclient-class) Class)

Downloads a message to a file.

## Syntax

```text
ANSI (Cross Platform)
int ReceiveFile(int iUID, const char* lpszFileName);

Unicode (Windows)
INT ReceiveFile(INT iUID, LPCWSTR lpszFileName);
```

## Remarks

Use this method to download a server-side message to a local file.

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

# ReceiveMessage Method ([IMAPClient](#imapclient-class) Class)

Downloads a message.

## Syntax

```text
ANSI (Cross Platform)
int ReceiveMessage(int iUID);

Unicode (Windows)
INT ReceiveMessage(INT iUID);
```

## Remarks

Use this method to download a server-side message to the [Message](#message-property-imapclient-class) object.

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

# ReceiveStream Method ([IMAPClient](#imapclient-class) Class)

Downloads a message to a stream.

## Syntax

```text
ANSI (Cross Platform)
int ReceiveStream(int iUID, SecureBlackboxStream* sStream);

Unicode (Windows)
INT ReceiveStream(INT iUID, SecureBlackboxStream* sStream);
```

## Remarks

Use this method to download a server-side message to a stream object.

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

# RefreshMailbox Method ([IMAPClient](#imapclient-class) Class)

Refreshes info about the currently selected mailbox.

## Syntax

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

Unicode (Windows)
INT RefreshMailbox();
```

## Remarks

Use this method to refresh the [Mailbox](#mailbox-property-imapclient-class) info.

To request information about other mailbox, call [GetMailboxInfo](#getmailboxinfo-method-imapclient-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.)

# RenameMailbox Method ([IMAPClient](#imapclient-class) Class)

Renames an existing mailbox.

## Syntax

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

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

## Remarks

Use this method to rename an existing mailbox from *Name* to *NewName*.

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

# Reset Method ([IMAPClient](#imapclient-class) Class)

Resets the class settings.

## Syntax

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

Unicode (Windows)
INT Reset();
```

## Remarks

Reset is a generic method available in every 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.)

# UpdateMessage Method ([IMAPClient](#imapclient-class) Class)

Alters flags associated with a message in the current mailbox on the IMAP server.

## Syntax

```text
ANSI (Cross Platform)
int UpdateMessage(int iUID, int iSetFlags, int iClearFlags);

Unicode (Windows)
INT UpdateMessage(INT iUID, INT iSetFlags, INT iClearFlags);
```

## Remarks

Use this method to alter flags associated with a *UID* message in the currently selected mailbox.

Supported flags are:

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

 If a flag is to be set, pass it to the *SetFlags* parameter. If a flag is to be cleared for a message, pass it to the *ClearFlags* parameter.

Notice: flags are cleared first, then set. So if you pass the same flag to both parameter, the flag will be set for the message.

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

# AuthFailed Event ([IMAPClient](#imapclient-class) Class)

Fires when an authentication attempt has failed.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAuthFailed(IMAPClientAuthFailedEventParams *e);
typedef struct {  const char *Auth;  int ErrorCode;  const char *ErrorMessage;  const char *ServerReply;  int TryAgain;
  int reserved;
} IMAPClientAuthFailedEventParams;

Unicode (Windows)
virtual INT FireAuthFailed(IMAPClientAuthFailedEventParams *e);
typedef struct {  LPCWSTR Auth;  INT ErrorCode;  LPCWSTR ErrorMessage;  LPCWSTR ServerReply;  BOOL TryAgain;
  INT reserved;
} IMAPClientAuthFailedEventParams;
```

## Remarks

The class fires this event when an authentication attempt has failed for some reason.

*Auth* reports the authentication method that has failed. You can adjust the *Authentications* config property to try another method.

*ErrorCode* contains an error code, and *ErrorMessage* contains an error message.

*ServerReply* provides the error info reported by the server. This info depends on the transport protocol and on the authentication method.

Set the *TryAgain* parameter to *true* if the class should try to authenticate again. If the parameter remains *false*, the authentication will fail with an exception.

# AuthStart Event ([IMAPClient](#imapclient-class) Class)

Fires when the authentication is about to be started.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAuthStart(IMAPClientAuthStartEventParams *e);
typedef struct {  const char *UsableAuths;
  int reserved;
} IMAPClientAuthStartEventParams;

Unicode (Windows)
virtual INT FireAuthStart(IMAPClientAuthStartEventParams *e);
typedef struct {  LPCWSTR UsableAuths;
  INT reserved;
} IMAPClientAuthStartEventParams;
```

## Remarks

The class fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.

The *UsableAuths* parameter contains a comma-separated list of the authentication methods supported by both, the client and the server.

In this event handler it's possible to update the method list in the *Authentications* config property according to the provided list of usable methods. The full list of the authentication methods supported by the server is available in *ServerInfo.SupportedAuths*.

# AuthSucceeded Event ([IMAPClient](#imapclient-class) Class)

Fires when the authentication has succeeded.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAuthSucceeded(IMAPClientAuthSucceededEventParams *e);
typedef struct {  const char *Auth;
  int reserved;
} IMAPClientAuthSucceededEventParams;

Unicode (Windows)
virtual INT FireAuthSucceeded(IMAPClientAuthSucceededEventParams *e);
typedef struct {  LPCWSTR Auth;
  INT reserved;
} IMAPClientAuthSucceededEventParams;
```

## Remarks

The class fires this event when it has succeeded to authenticate to the server. *Auth* reports the authentication method that has succeeded.

# Command Event ([IMAPClient](#imapclient-class) Class)

Reports a command sent to the server.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCommand(IMAPClientCommandEventParams *e);
typedef struct {  const char *Cmd;
  int reserved;
} IMAPClientCommandEventParams;

Unicode (Windows)
virtual INT FireCommand(IMAPClientCommandEventParams *e);
typedef struct {  LPCWSTR Cmd;
  INT reserved;
} IMAPClientCommandEventParams;
```

## Remarks

The class fires this event whenever it sends an IMAP command to the server. Use [CommandReply](#commandreply-event-imapclient-class) and [CommandReplyData](#commandreplydata-event-imapclient-class) to track the server's responses.

# CommandData Event ([IMAPClient](#imapclient-class) Class)

Returns the data that accompanies the command.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCommandData(IMAPClientCommandDataEventParams *e);
typedef struct {  const char *Cmd;  const char *Data;
  int reserved;
} IMAPClientCommandDataEventParams;

Unicode (Windows)
virtual INT FireCommandData(IMAPClientCommandDataEventParams *e);
typedef struct {  LPCWSTR Cmd;  LPCWSTR Data;
  INT reserved;
} IMAPClientCommandDataEventParams;
```

## Remarks

Subscribe to this event to access data accompanying the outgoing commands.

# CommandReply Event ([IMAPClient](#imapclient-class) Class)

Reports the receipt of a reply to a command.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCommandReply(IMAPClientCommandReplyEventParams *e);
typedef struct {  const char *Cmd;  const char *Reply;
  int reserved;
} IMAPClientCommandReplyEventParams;

Unicode (Windows)
virtual INT FireCommandReply(IMAPClientCommandReplyEventParams *e);
typedef struct {  LPCWSTR Cmd;  LPCWSTR Reply;
  INT reserved;
} IMAPClientCommandReplyEventParams;
```

## Remarks

Use this event to track command replies sent in by the server. Use [Command](#command-event-imapclient-class) to track the commands sent out by the client, and [CommandReplyData](#commandreplydata-event-imapclient-class) to access the reply data for commands that assume it.

# CommandReplyData Event ([IMAPClient](#imapclient-class) Class)

Returns the data that accompanies a reply to a command.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCommandReplyData(IMAPClientCommandReplyDataEventParams *e);
typedef struct {  const char *Cmd;  const char *Data;
  int reserved;
} IMAPClientCommandReplyDataEventParams;

Unicode (Windows)
virtual INT FireCommandReplyData(IMAPClientCommandReplyDataEventParams *e);
typedef struct {  LPCWSTR Cmd;  LPCWSTR Data;
  INT reserved;
} IMAPClientCommandReplyDataEventParams;
```

## Remarks

Subscribe to this event to access data accompanying incoming command replies.

# Error Event ([IMAPClient](#imapclient-class) Class)

Provides information about errors during SMTP operations.

## Syntax

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

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

## Remarks

This event is fired in case of exceptional conditions occurred during SMTP operations.

*ErrorCode* contains an error code and *Description* contains a textual description of the error.

# MailboxFound Event ([IMAPClient](#imapclient-class) Class)

Provides mailbox details.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireMailboxFound(IMAPClientMailboxFoundEventParams *e);
typedef struct {  const char *Name;  const char *Delimiter;  int Attributes;
  int reserved;
} IMAPClientMailboxFoundEventParams;

Unicode (Windows)
virtual INT FireMailboxFound(IMAPClientMailboxFoundEventParams *e);
typedef struct {  LPCWSTR Name;  LPCWSTR Delimiter;  INT Attributes;
  INT reserved;
} IMAPClientMailboxFoundEventParams;
```

## Remarks

Subscribe to this event to get mailbox details published by [ListMailboxes](#listmailboxes-method-imapclient-class).

*Delimiter* is a mailbox hierarchy delimiter.

*Attributes* value is bit mask of the following values:

|  |  |  |
| --- | --- | --- |
| imapMailboxHasChildren | 0x0001 | Indicates whether the mailbox has \HasChildren attribute specified. |
| imapMailboxHasNoChildren | 0x0002 | Indicates whether the mailbox has \HasNoChildren attribute specified. |
| imapMailboxMarked | 0x0004 | Indicates whether the mailbox has \Marked attribute specified. |
| imapMailboxNoInferiors | 0x0008 | Indicates whether the mailbox has \NoInferiors attribute specified. |
| imapMailboxNoSelect | 0x0010 | Indicates whether the mailbox has \NoSelect attribute specified. |
| imapMailboxUnmarked | 0x0020 | Indicates whether the mailbox has \Unmarked attribute specified. |
| imapMailboxNonExistent | 0x0040 | Indicates whether the mailbox has \NonExistent attribute specified. |
| imapMailboxSubscribed | 0x0080 | Indicates whether the mailbox has \Subscribed attribute specified. |
| imapMailboxRemote | 0x0100 | Indicates whether the mailbox has \Remote attribute specified. |
| imapMailboxAll | 0x0200 | Indicates whether the mailbox has \All attribute specified. |
| imapMailboxArchive | 0x0400 | Indicates whether the mailbox has \Archive attribute specified. |
| imapMailboxDrafts | 0x0800 | Indicates whether the mailbox has \Drafts attribute specified. |
| imapMailboxFlagged | 0x1000 | Indicates whether the mailbox has \Flagged attribute specified. |
| imapMailboxJunk | 0x2000 | Indicates whether the mailbox has \Junk attribute specified. |
| imapMailboxSent | 0x4000 | Indicates whether the mailbox has \Sent attribute specified. |
| imapMailboxTrash | 0x8000 | Indicates whether the mailbox has \Trash attribute specified. |

# MailboxInfo Event ([IMAPClient](#imapclient-class) Class)

Reports mailbox information returned from the server.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireMailboxInfo(IMAPClientMailboxInfoEventParams *e);
typedef struct {  const char *Name;  int TotalMessages;  int RecentMessages;  int UnseenMessages;  int NextUID;  int UIDValidity;
  int reserved;
} IMAPClientMailboxInfoEventParams;

Unicode (Windows)
virtual INT FireMailboxInfo(IMAPClientMailboxInfoEventParams *e);
typedef struct {  LPCWSTR Name;  INT TotalMessages;  INT RecentMessages;  INT UnseenMessages;  INT NextUID;  INT UIDValidity;
  INT reserved;
} IMAPClientMailboxInfoEventParams;
```

## Remarks

Subscribe to this event to be notified of mailbox info as returned by the IMAP server on [GetMailboxInfo](#getmailboxinfo-method-imapclient-class) call.

# Notification Event ([IMAPClient](#imapclient-class) Class)

This event notifies the application about an underlying control flow event.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireNotification(IMAPClientNotificationEventParams *e);
typedef struct {  const char *EventID;  const char *EventParam;
  int reserved;
} IMAPClientNotificationEventParams;

Unicode (Windows)
virtual INT FireNotification(IMAPClientNotificationEventParams *e);
typedef struct {  LPCWSTR EventID;  LPCWSTR EventParam;
  INT reserved;
} IMAPClientNotificationEventParams;
```

## Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

|  |  |  |
| --- | --- | --- |
| EventID |  | EventParam |
| MessageAdded |  | Number of messages in the current mailbox. |
| MessageDeleted |  | UID of the deleted message if the message is in the current message list. |
| MessageUpdated |  | UID of the updated message if the message is in the current message list. |
| TLSExtensions.CertificateStatus | TBD |  |
| TLSExtensions.PreSharedIdentityHint | TBD |  |

# Progress Event ([IMAPClient](#imapclient-class) Class)

Reports the progress of the data transfer operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireProgress(IMAPClientProgressEventParams *e);
typedef struct {  int64 Total;  int64 Current;  int Cancel;
  int reserved;
} IMAPClientProgressEventParams;

Unicode (Windows)
virtual INT FireProgress(IMAPClientProgressEventParams *e);
typedef struct {  LONG64 Total;  LONG64 Current;  BOOL Cancel;
  INT reserved;
} IMAPClientProgressEventParams;
```

## Remarks

The class fires this event repeatedly to report the progress of the data transfer operation.

# TLSCertNeeded Event ([IMAPClient](#imapclient-class) Class)

Fires when a remote TLS party requests a client certificate.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSCertNeeded(IMAPClientTLSCertNeededEventParams *e);
typedef struct {  const char *Host;  const char *CANames;
  int reserved;
} IMAPClientTLSCertNeededEventParams;

Unicode (Windows)
virtual INT FireTLSCertNeeded(IMAPClientTLSCertNeededEventParams *e);
typedef struct {  LPCWSTR Host;  LPCWSTR CANames;
  INT reserved;
} IMAPClientTLSCertNeededEventParams;
```

## Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The *Host* parameter identifies the host that makes a request, and the *CANames* parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the [TLSClientChain](#tlsclientchain-property-imapclient-class) property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the [TLSHandshake](#tlshandshake-event-imapclient-class) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-imapclient-class) event.

# TLSCertValidate Event ([IMAPClient](#imapclient-class) Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSCertValidate(IMAPClientTLSCertValidateEventParams *e);
typedef struct {  const char *ServerHost;  const char *ServerIP;  int Accept;
  int reserved;
} IMAPClientTLSCertValidateEventParams;

Unicode (Windows)
virtual INT FireTLSCertValidate(IMAPClientTLSCertValidateEventParams *e);
typedef struct {  LPCWSTR ServerHost;  LPCWSTR ServerIP;  BOOL Accept;
  INT reserved;
} IMAPClientTLSCertValidateEventParams;
```

## Remarks

This event is fired during a TLS handshake. Use the [TLSServerChain](#tlsserverchain-property-imapclient-class) property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

*Accept* is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

# TLSEstablished Event ([IMAPClient](#imapclient-class) Class)

Fires when a TLS handshake with Host successfully completes.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSEstablished(IMAPClientTLSEstablishedEventParams *e);
typedef struct {  const char *Host;  const char *Version;  const char *Ciphersuite;  const char *ConnectionId;
  int lenConnectionId;  int Abort;
  int reserved;
} IMAPClientTLSEstablishedEventParams;

Unicode (Windows)
virtual INT FireTLSEstablished(IMAPClientTLSEstablishedEventParams *e);
typedef struct {  LPCWSTR Host;  LPCWSTR Version;  LPCWSTR Ciphersuite;  LPCSTR ConnectionId;
  INT lenConnectionId;  BOOL Abort;
  INT reserved;
} IMAPClientTLSEstablishedEventParams;
```

## Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The *Version*, *Ciphersuite*, and *ConnectionId* parameters indicate the security parameters of the new connection. Use the *Abort* parameter if you need to terminate the connection at this stage.

# TLSHandshake Event ([IMAPClient](#imapclient-class) Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSHandshake(IMAPClientTLSHandshakeEventParams *e);
typedef struct {  const char *Host;  int Abort;
  int reserved;
} IMAPClientTLSHandshakeEventParams;

Unicode (Windows)
virtual INT FireTLSHandshake(IMAPClientTLSHandshakeEventParams *e);
typedef struct {  LPCWSTR Host;  BOOL Abort;
  INT reserved;
} IMAPClientTLSHandshakeEventParams;
```

## Remarks

The class uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [TLSEstablished](#tlsestablished-event-imapclient-class) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-imapclient-class) event will also be fired.

# TLSPSK Event ([IMAPClient](#imapclient-class) Class)

Notifies the application about the PSK key exchange.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSPSK(IMAPClientTLSPSKEventParams *e);
typedef struct {  const char *Host;  const char *Hint;
  int reserved;
} IMAPClientTLSPSKEventParams;

Unicode (Windows)
virtual INT FireTLSPSK(IMAPClientTLSPSKEventParams *e);
typedef struct {  LPCWSTR Host;  LPCWSTR Hint;
  INT reserved;
} IMAPClientTLSPSKEventParams;
```

## Remarks

The class fires this event to notify the application about the beginning of TLS-PSK key exchange with *Host*. The *Hint* parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of [TLSSettings](#tlssettings-property-imapclient-class) to provide the pre-shared key to the component.

# TLSShutdown Event ([IMAPClient](#imapclient-class) Class)

Reports the graceful closure of a TLS connection.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSShutdown(IMAPClientTLSShutdownEventParams *e);
typedef struct {  const char *Host;
  int reserved;
} IMAPClientTLSShutdownEventParams;

Unicode (Windows)
virtual INT FireTLSShutdown(IMAPClientTLSShutdownEventParams *e);
typedef struct {  LPCWSTR Host;
  INT reserved;
} IMAPClientTLSShutdownEventParams;
```

## Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

# Certificate Type

Encapsulates an individual X.509 certificate.

## Syntax

 *SecureBlackboxCertificate* (declared in *secureblackbox.h*)

## Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

- [Bytes](#Certificate_f_Bytes)

- [CA](#Certificate_f_CA)

- [CAKeyID](#Certificate_f_CAKeyID)

- [CertType](#Certificate_f_CertType)

- [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints)

- [Curve](#Certificate_f_Curve)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FriendlyName](#Certificate_f_FriendlyName)

- [Handle](#Certificate_f_Handle)

- [HashAlgorithm](#Certificate_f_HashAlgorithm)

- [Issuer](#Certificate_f_Issuer)

- [IssuerRDN](#Certificate_f_IssuerRDN)

- [KeyAlgorithm](#Certificate_f_KeyAlgorithm)

- [KeyBits](#Certificate_f_KeyBits)

- [KeyFingerprint](#Certificate_f_KeyFingerprint)

- [KeyUsage](#Certificate_f_KeyUsage)

- [KeyValid](#Certificate_f_KeyValid)

- [OCSPLocations](#Certificate_f_OCSPLocations)

- [OCSPNoCheck](#Certificate_f_OCSPNoCheck)

- [Origin](#Certificate_f_Origin)

- [PolicyIDs](#Certificate_f_PolicyIDs)

- [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes)

- [PrivateKeyExists](#Certificate_f_PrivateKeyExists)

- [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable)

- [PublicKeyBytes](#Certificate_f_PublicKeyBytes)

- [Qualified](#Certificate_f_Qualified)

- [QualifiedStatements](#Certificate_f_QualifiedStatements)

- [Qualifiers](#Certificate_f_Qualifiers)

- [SelfSigned](#Certificate_f_SelfSigned)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SigAlgorithm](#Certificate_f_SigAlgorithm)

- [Source](#Certificate_f_Source)

- [Subject](#Certificate_f_Subject)

- [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName)

- [SubjectKeyID](#Certificate_f_SubjectKeyID)

- [SubjectRDN](#Certificate_f_SubjectRDN)

- [Valid](#Certificate_f_Valid)

- [ValidFrom](#Certificate_f_ValidFrom)

- [ValidTo](#Certificate_f_ValidTo)

## Fields

 **Bytes** *char* (read-only)*
*Default Value: *

Returns the raw certificate data in DER format.

 **CA** *int*
*Default Value: FALSE*

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

 **CAKeyID** *char* (read-only)*
*Default Value: *

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

Returns the type of the entity contained in the [Certificate](#certificate-type) object.

A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the [CertificateManager](CertificateManager.md#CertificateManager) class to load or create new certificate and certificate requests objects.

 **CRLDistributionPoints** *char**
*Default Value: ""*

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

 **Curve** *char**
*Default Value: ""*

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

|  |  |  |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 |  |
| SB_EC_SECP112R2 | SECP112R2 |  |
| SB_EC_SECP128R1 | SECP128R1 |  |
| SB_EC_SECP128R2 | SECP128R2 |  |
| SB_EC_SECP160K1 | SECP160K1 |  |
| SB_EC_SECP160R1 | SECP160R1 |  |
| SB_EC_SECP160R2 | SECP160R2 |  |
| SB_EC_SECP192K1 | SECP192K1 |  |
| SB_EC_SECP192R1 | SECP192R1 |  |
| SB_EC_SECP224K1 | SECP224K1 |  |
| SB_EC_SECP224R1 | SECP224R1 |  |
| SB_EC_SECP256K1 | SECP256K1 |  |
| SB_EC_SECP256R1 | SECP256R1 |  |
| SB_EC_SECP384R1 | SECP384R1 |  |
| SB_EC_SECP521R1 | SECP521R1 |  |
| SB_EC_SECT113R1 | SECT113R1 |  |
| SB_EC_SECT113R2 | SECT113R2 |  |
| SB_EC_SECT131R1 | SECT131R1 |  |
| SB_EC_SECT131R2 | SECT131R2 |  |
| SB_EC_SECT163K1 | SECT163K1 |  |
| SB_EC_SECT163R1 | SECT163R1 |  |
| SB_EC_SECT163R2 | SECT163R2 |  |
| SB_EC_SECT193R1 | SECT193R1 |  |
| SB_EC_SECT193R2 | SECT193R2 |  |
| SB_EC_SECT233K1 | SECT233K1 |  |
| SB_EC_SECT233R1 | SECT233R1 |  |
| SB_EC_SECT239K1 | SECT239K1 |  |
| SB_EC_SECT283K1 | SECT283K1 |  |
| SB_EC_SECT283R1 | SECT283R1 |  |
| SB_EC_SECT409K1 | SECT409K1 |  |
| SB_EC_SECT409R1 | SECT409R1 |  |
| SB_EC_SECT571K1 | SECT571K1 |  |
| SB_EC_SECT571R1 | SECT571R1 |  |
| SB_EC_PRIME192V1 | PRIME192V1 |  |
| SB_EC_PRIME192V2 | PRIME192V2 |  |
| SB_EC_PRIME192V3 | PRIME192V3 |  |
| SB_EC_PRIME239V1 | PRIME239V1 |  |
| SB_EC_PRIME239V2 | PRIME239V2 |  |
| SB_EC_PRIME239V3 | PRIME239V3 |  |
| SB_EC_PRIME256V1 | PRIME256V1 |  |
| SB_EC_C2PNB163V1 | C2PNB163V1 |  |
| SB_EC_C2PNB163V2 | C2PNB163V2 |  |
| SB_EC_C2PNB163V3 | C2PNB163V3 |  |
| SB_EC_C2PNB176W1 | C2PNB176W1 |  |
| SB_EC_C2TNB191V1 | C2TNB191V1 |  |
| SB_EC_C2TNB191V2 | C2TNB191V2 |  |
| SB_EC_C2TNB191V3 | C2TNB191V3 |  |
| SB_EC_C2ONB191V4 | C2ONB191V4 |  |
| SB_EC_C2ONB191V5 | C2ONB191V5 |  |
| SB_EC_C2PNB208W1 | C2PNB208W1 |  |
| SB_EC_C2TNB239V1 | C2TNB239V1 |  |
| SB_EC_C2TNB239V2 | C2TNB239V2 |  |
| SB_EC_C2TNB239V3 | C2TNB239V3 |  |
| SB_EC_C2ONB239V4 | C2ONB239V4 |  |
| SB_EC_C2ONB239V5 | C2ONB239V5 |  |
| SB_EC_C2PNB272W1 | C2PNB272W1 |  |
| SB_EC_C2PNB304W1 | C2PNB304W1 |  |
| SB_EC_C2TNB359V1 | C2TNB359V1 |  |
| SB_EC_C2PNB368W1 | C2PNB368W1 |  |
| SB_EC_C2TNB431R1 | C2TNB431R1 |  |
| SB_EC_NISTP192 | NISTP192 |  |
| SB_EC_NISTP224 | NISTP224 |  |
| SB_EC_NISTP256 | NISTP256 |  |
| SB_EC_NISTP384 | NISTP384 |  |
| SB_EC_NISTP521 | NISTP521 |  |
| SB_EC_NISTB163 | NISTB163 |  |
| SB_EC_NISTB233 | NISTB233 |  |
| SB_EC_NISTB283 | NISTB283 |  |
| SB_EC_NISTB409 | NISTB409 |  |
| SB_EC_NISTB571 | NISTB571 |  |
| SB_EC_NISTK163 | NISTK163 |  |
| SB_EC_NISTK233 | NISTK233 |  |
| SB_EC_NISTK283 | NISTK283 |  |
| SB_EC_NISTK409 | NISTK409 |  |
| SB_EC_NISTK571 | NISTK571 |  |
| SB_EC_GOSTCPTEST | GOSTCPTEST |  |
| SB_EC_GOSTCPA | GOSTCPA |  |
| SB_EC_GOSTCPB | GOSTCPB |  |
| SB_EC_GOSTCPC | GOSTCPC |  |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA |  |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB |  |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 |  |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 |  |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 |  |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 |  |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 |  |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 |  |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 |  |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 |  |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 |  |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 |  |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 |  |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 |  |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 |  |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 |  |
| SB_EC_CURVE25519 | CURVE25519 |  |
| SB_EC_CURVE448 | CURVE448 |  |

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

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

 **Handle** *int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **HashAlgorithm** *char**
*Default Value: ""*

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [SigAlgorithm](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature.

|  |  |  |
| --- | --- | --- |
| SB_HASH_ALGORITHM_SHA1 | SHA1 |  |
| SB_HASH_ALGORITHM_SHA224 | SHA224 |  |
| SB_HASH_ALGORITHM_SHA256 | SHA256 |  |
| SB_HASH_ALGORITHM_SHA384 | SHA384 |  |
| SB_HASH_ALGORITHM_SHA512 | SHA512 |  |
| SB_HASH_ALGORITHM_MD2 | MD2 |  |
| SB_HASH_ALGORITHM_MD4 | MD4 |  |
| SB_HASH_ALGORITHM_MD5 | MD5 |  |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 |  |
| SB_HASH_ALGORITHM_CRC32 | CRC32 |  |
| SB_HASH_ALGORITHM_SSL3 | SSL3 |  |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 |  |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL |  |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 |  |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 |  |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 |  |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 |  |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |  |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 |  |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 |  |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 |  |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 |  |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 |  |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 |  |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 |  |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 |  |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 |  |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN |  |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |  |

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

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN).

 **IssuerRDN** *char**
*Default Value: ""*

A list of *Property=Value* pairs that uniquely identify the certificate issuer.

Example: */C=US/O=Nationwide CA/CN=Web Certification Authority*

 **KeyAlgorithm** *char**
*Default Value: "0"*

Specifies the public key algorithm of this certificate.

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption |  |
| SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption |  |
| SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA | id-dsa |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 |  |
| SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber |  |
| SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption |  |
| SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS |  |
| SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP |  |
| SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA |  |
| SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 |  |
| SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 |  |
| SB_CERT_ALGORITHM_EC | id-ecPublicKey |  |
| SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified |  |
| SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 |  |
| SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 |  |
| SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 |  |
| SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 |  |
| SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 |  |
| SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 |  |
| SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 |  |
| SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 |  |
| SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 |  |
| SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 |  |
| SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 |  |
| SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 |  |
| SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 |  |
| SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 |  |
| SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 |  |
| SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 |  |
| SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 |  |
| SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 |  |
| SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 |  |
| SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 |  |
| SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 |  |
| SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 |  |
| SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 |  |
| SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 |  |
| SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph |  |
| SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph |  |
| SB_CERT_ALGORITHM_EDDSA | id-EdDSA |  |
| SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains.

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

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer.

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

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

 **KeyUsage** *int*
*Default Value: 0*

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

|  |  |  |
| --- | --- | --- |
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

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

Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise.

 **OCSPLocations** *char**
*Default Value: ""*

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

 **OCSPNoCheck** *int*
*Default Value: FALSE*

Accessor to the value of the certificate's ocsp-no-check extension.

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

Returns the location that the certificate was taken or loaded from.

 **PolicyIDs** *char**
*Default Value: ""*

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

 **PrivateKeyBytes** *char* (read-only)*
*Default Value: *

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

Indicates whether the private key is extractable (exportable).

 **PublicKeyBytes** *char* (read-only)*
*Default Value: *

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

Indicates whether the certificate is qualified.

This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified.

 **QualifiedStatements** *int*
*Default Value: 0*

Returns a simplified qualified status of the certificate.

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

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*.

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

Indicates whether the certificate is self-signed (root) or signed by an external CA.

 **SerialNumber** *char**
*Default Value: *

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

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

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*.

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

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [SubjectRDN](#Certificate_f_SubjectRDN).

 **SubjectAlternativeName** *char**
*Default Value: ""*

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main [SubjectRDN](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

 **SubjectKeyID** *char**
*Default Value: *

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

 **SubjectRDN** *char**
*Default Value: ""*

A list of *Property=Value* pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*.

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

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

 **ValidFrom** *char**
*Default Value: ""*

The time point at which the certificate becomes valid, in UTC.

 **ValidTo** *char**
*Default Value: ""*

The time point at which the certificate expires, in UTC.

## Constructors

```text
Certificate()
```

 Creates a new object with default field values.

# CRL Type

Represents a Certificate Revocation List.

## Syntax

 *SecureBlackboxCRL* (declared in *secureblackbox.h*)

## Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

The following fields are available:

- [Bytes](#CRL_f_Bytes)

- [CAKeyID](#CRL_f_CAKeyID)

- [EntryCount](#CRL_f_EntryCount)

- [Handle](#CRL_f_Handle)

- [Issuer](#CRL_f_Issuer)

- [IssuerRDN](#CRL_f_IssuerRDN)

- [Location](#CRL_f_Location)

- [NextUpdate](#CRL_f_NextUpdate)

- [SigAlgorithm](#CRL_f_SigAlgorithm)

- [Source](#CRL_f_Source)

- [TBS](#CRL_f_TBS)

- [ThisUpdate](#CRL_f_ThisUpdate)

## Fields

 **Bytes** *char* (read-only)*
*Default Value: *

Returns the raw CRL data in DER format.

 **CAKeyID** *char**
*Default Value: *

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

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

Returns the number of certificate status entries in the CRL.

 **Handle** *int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

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

The common name of the CRL issuer (CA), typically a company name.

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

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

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

The URL that the CRL was downloaded from.

 **NextUpdate** *char**
*Default Value: ""*

The planned time and date of the next version of this CRL to be published.

 **SigAlgorithm** *char**
*Default Value: "0"*

The public key algorithm that was used by the CA to sign this CRL.

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

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

 **TBS** *char* (read-only)*
*Default Value: *

The to-be-signed part of the CRL (the CRL without the signature part).

 **ThisUpdate** *char**
*Default Value: ""*

The date and time at which this version of the CRL was published.

## Constructors

```text
CRL()
```

 Creates an empty CRL object.

# IMAPMailboxInfo Type

Contains information about an IMAP mailbox.

## Syntax

 *SecureBlackboxIMAPMailboxInfo* (declared in *secureblackbox.h*)

## Remarks

This compound object provides details of an IMAP mailbox.

The following fields are available:

- [MessageFlags](#IMAPMailboxInfo_f_MessageFlags)

- [Name](#IMAPMailboxInfo_f_Name)

- [NextUID](#IMAPMailboxInfo_f_NextUID)

- [PermanentFlags](#IMAPMailboxInfo_f_PermanentFlags)

- [ReadOnly](#IMAPMailboxInfo_f_ReadOnly)

- [RecentMessages](#IMAPMailboxInfo_f_RecentMessages)

- [TotalMessages](#IMAPMailboxInfo_f_TotalMessages)

- [UIDValidity](#IMAPMailboxInfo_f_UIDValidity)

- [UnseenMessages](#IMAPMailboxInfo_f_UnseenMessages)

## Fields

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

Contains message flags defined in the mailbox.

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

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

Specifies mailbox name.

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

Returns the next unique identifier value.

Use this property to get or set the next unique identifier (corresponds to UIDNEXT status code).

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

Contains a list of message flags that can be changed permanently.

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

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

Specifies whether the mailbox is write-protected.

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

The number of recent messages in the mailbox.

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

Total number of messages in the mailbox.

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

Specifies UID validity value.

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

The number of unseen messages in the mailbox.

# IMAPMessageInfo Type

This type is a container for the server-side message details.

## Syntax

 *SecureBlackboxIMAPMessageInfo* (declared in *secureblackbox.h*)

## Remarks

Use this type to get the details of server-side messages after the list call.

The following fields are available:

- [Date](#IMAPMessageInfo_f_Date)

- [Flags](#IMAPMessageInfo_f_Flags)

- [From](#IMAPMessageInfo_f_From)

- [InternalDate](#IMAPMessageInfo_f_InternalDate)

- [Priority](#IMAPMessageInfo_f_Priority)

- [SentTo](#IMAPMessageInfo_f_SentTo)

- [Size](#IMAPMessageInfo_f_Size)

- [Subject](#IMAPMessageInfo_f_Subject)

- [UID](#IMAPMessageInfo_f_UID)

## Fields

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

Contains the value of the Date header field.

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

Returns the flags currently set to the mail message.

Supported flags are:

|  |  |  |
| --- | --- | --- |
| imapMessageAnswered | 0x0001 | Message has been answered. |
| imapMessageDeleted | 0x0002 | Message is 'deleted' for removal later. |
| imapMessageDraft | 0x0004 | Message has not completed composition (marked as a draft). |
| imapMessageFlagged | 0x0008 | Message is 'flagged' for urgent/special attention. |
| imapMessageRecent | 0x0010 | Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message. (Deprecated in IMAP4rev2) |
| imapMessageSeen | 0x0020 | Message has been read. |
| imapMessageForwarded | 0x0040 | Message has been forwarded to another email address by being embedded within, or attached to a new message. |
| imapMessageDNSent | 0x0080 | Message Disposition Notification was generated and sent for this message. |
| imapMessageJunk | 0x0100 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely containing junk. |
| imapMessageNotJunk | 0x0200 | The user (or a delivery agent on behalf of the user) may choose to mark a message as definitely NOT containing junk. |
| imapMessagePhishing | 0x0400 | Can be used by a delivery agent to mark a message as highly likely to be a phishing email. |

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

Contains the value of the From header field.

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

Returns the internal date of the mail message.

 **Priority** *int (read-only)*
*Default Value: 2*

Specifies the message priority.

Available options:

|  |  |
| --- | --- |
| mpLowest | 0 |
| mpLow | 1 |
| mpNormal | 2 |
| mpHigh | 3 |
| mpHighest | 4 |

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

Contains the value of the To header field.

 **Size** *int64 (read-only)*
*Default Value: 0*

Returns the size of the message in bytes.

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

Contains the value of the Subject header field.

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

Returns the unique ID of the mail message.

# IMAPServerInfo Type

Describes the IMAP server's capabilities.

## Syntax

 *SecureBlackboxIMAPServerInfo* (declared in *secureblackbox.h*)

## Remarks

Check this object to learn about the IMAP server's technical capabilities.

The following fields are available:

- [Capabilities](#IMAPServerInfo_f_Capabilities)

- [Features](#IMAPServerInfo_f_Features)

- [SupportedAuths](#IMAPServerInfo_f_SupportedAuths)

## Fields

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

Returns the list of server capabilities.

Use this property to get the list of IMAP capabilities (i.e., optional functionality of the server as defined in [RFC 3501]) obtained from the server.

 **Features** *int64 (read-only)*
*Default Value: 0*

Returns the list of capabilities supported by the server.

This value is bit mask of the following values:

|  |  |  |
| --- | --- | --- |
| imapLoginDisabled | 0x0001 | Specifies whether the server forbids login. |
| imapIdleSupported | 0x0002 | Indicates whether the IMAP server supports the IDLE command. |

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

Contains a comma-separated list of the authentication methods supported by the server.

Use this value to setup the *Authentications* config property if needed.

# MailMessage Type

Represents an e-mail message.

## Syntax

 *SecureBlackboxMailMessage* (declared in *secureblackbox.h*)

## Remarks

This object is a container for an e-mail message.

A message consists of a header and a body. The header, in turn, consists of several header fields. The names, syntax, and expected contents of the header fields are standardized.

The message body can contain anything you like (a message may not even have a body at all).

The following fields are available:

- [AttachmentCount](#MailMessage_f_AttachmentCount)

- [Bcc](#MailMessage_f_Bcc)

- [Cc](#MailMessage_f_Cc)

- [Comments](#MailMessage_f_Comments)

- [Date](#MailMessage_f_Date)

- [DeliveryReceipt](#MailMessage_f_DeliveryReceipt)

- [From](#MailMessage_f_From)

- [Handle](#MailMessage_f_Handle)

- [HtmlText](#MailMessage_f_HtmlText)

- [ID](#MailMessage_f_ID)

- [InReplyTo](#MailMessage_f_InReplyTo)

- [Keywords](#MailMessage_f_Keywords)

- [Mailer](#MailMessage_f_Mailer)

- [PlainText](#MailMessage_f_PlainText)

- [Priority](#MailMessage_f_Priority)

- [ReadReceipt](#MailMessage_f_ReadReceipt)

- [References](#MailMessage_f_References)

- [ReplyTo](#MailMessage_f_ReplyTo)

- [ReturnPath](#MailMessage_f_ReturnPath)

- [Sender](#MailMessage_f_Sender)

- [SendTo](#MailMessage_f_SendTo)

- [Subject](#MailMessage_f_Subject)

## Fields

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

Returns the number of attachments in this message.

 **Bcc** *char**
*Default Value: ""*

The contents of the BCC header field.

The BCC header field contains the addresses of secondary recipients of the message whose addresses are not to be revealed to other recipients of the message. Mail servers remove the BCC header when processing the message and use its value for dispatching the message only.

 **Cc** *char**
*Default Value: ""*

The value of the CC header field.

The CC field contains the addresses of secondary recipients of the message.

 **Comments** *char**
*Default Value: ""*

Contains additional information about the message body.

 **Date** *char**
*Default Value: ""*

The date and time when the message entered the mail delivery system.

This field contains the date and time at which the creator of the message posted the message to the mail delivery system.

The date is returned and accepted in UTC time zone.

 **DeliveryReceipt** *int*
*Default Value: FALSE*

Enables delivery notification.

 **From** *char**
*Default Value: ""*

Contains the value of the From header field.

This field contains the address(es) of the message author(s). If the actual sender is not the author of the message, use [Sender](#MailMessage_f_Sender) to specify the sender separately.

 **Handle** *int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **HtmlText** *char**
*Default Value: ""*

The HTML version of the message.

 **ID** *char**
*Default Value: ""*

The contents of the Message-ID header field.

This field contains a unique identifier that refers to a particular version of this message.

 **InReplyTo** *char**
*Default Value: ""*

The value of the In-Reply-To header field.

A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply.

 **Keywords** *char**
*Default Value: ""*

The value of the Keywords header field.

This field can be used to add some important words and phrases that might be useful for the recipient.

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

The name of the software that was used to send the message.

 **PlainText** *char**
*Default Value: ""*

The plain text version of the message.

 **Priority** *int*
*Default Value: 2*

Specifies the message priority.

Available options:

|  |  |
| --- | --- |
| mpLowest | 0 |
| mpLow | 1 |
| mpNormal | 2 |
| mpHigh | 3 |
| mpHighest | 4 |

 **ReadReceipt** *int*
*Default Value: FALSE*

Enables a read notification.

 **References** *char**
*Default Value: ""*

The value of the References header field.

A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message.

 **ReplyTo** *char**
*Default Value: ""*

The value of the Reply-To header field.

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the [From](#MailMessage_f_From) field.

 **ReturnPath** *char**
*Default Value: ""*

The value of the Return-Path header field.

This field contains the address to which this message shall be returned in case of unsuccessful delivery.

 **Sender** *char**
*Default Value: ""*

The value of the Sender header field.

This field specifies the mailbox of the agent responsible for the actual transmission of this message. If the originator of the message can be indicated by a single mailbox and both the author and the transmitter are identical, the "Sender:" field is deemed excessive and should not be used.

 **SendTo** *char**
*Default Value: ""*

The value of the To header field.

This field specifies the address(es) of the primary recipient(s) of the message.

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

Contains the subject field of this message.

## Constructors

```text
MailMessage()
```

 Creates a new empty mail message object.

# OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

## Syntax

 *SecureBlackboxOCSPResponse* (declared in *secureblackbox.h*)

## Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

An OCSP response is a snapshot of the certificate status at a given time.

The following fields are available:

- [Bytes](#OCSPResponse_f_Bytes)

- [EntryCount](#OCSPResponse_f_EntryCount)

- [Handle](#OCSPResponse_f_Handle)

- [Issuer](#OCSPResponse_f_Issuer)

- [IssuerRDN](#OCSPResponse_f_IssuerRDN)

- [Location](#OCSPResponse_f_Location)

- [ProducedAt](#OCSPResponse_f_ProducedAt)

- [SigAlgorithm](#OCSPResponse_f_SigAlgorithm)

- [Source](#OCSPResponse_f_Source)

## Fields

 **Bytes** *char* (read-only)*
*Default Value: *

A buffer containing the raw OCSP response data.

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

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

 **Handle** *int64*
*Default Value: 0*

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

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

Indicates the issuer of this response (a CA or its authorized representative).

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

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

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

The location of the OCSP responder.

 **ProducedAt** *char**
*Default Value: ""*

Specifies the time when the response was produced, in UTC.

 **SigAlgorithm** *char**
*Default Value: "0"*

The public key algorithm that was used by the CA to sign this OCSP response.

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

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

## Constructors

```text
OCSPResponse()
```

 Creates an empty OCSP response object.

# ProxySettings Type

A container for proxy server settings.

## Syntax

 *SecureBlackboxProxySettings* (declared in *secureblackbox.h*)

## Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

The following fields are available:

- [Address](#ProxySettings_f_Address)

- [Authentication](#ProxySettings_f_Authentication)

- [Password](#ProxySettings_f_Password)

- [Port](#ProxySettings_f_Port)

- [ProxyType](#ProxySettings_f_ProxyType)

- [RequestHeaders](#ProxySettings_f_RequestHeaders)

- [ResponseBody](#ProxySettings_f_ResponseBody)

- [ResponseHeaders](#ProxySettings_f_ResponseHeaders)

- [UseIPv6](#ProxySettings_f_UseIPv6)

- [Username](#ProxySettings_f_Username)

## Fields

 **Address** *char**
*Default Value: ""*

The IP address of the proxy server.

 **Authentication** *int*
*Default Value: 0*

The authentication type used by the proxy server.

|  |  |
| --- | --- |
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |

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

The password to authenticate to the proxy server.

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

The port on the proxy server to connect to.

 **ProxyType** *int*
*Default Value: 0*

The type of the proxy server.

|  |  |
| --- | --- |
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |

 **RequestHeaders** *char**
*Default Value: ""*

Contains HTTP request headers for WebTunnel and HTTP proxy.

 **ResponseBody** *char**
*Default Value: ""*

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

 **ResponseHeaders** *char**
*Default Value: ""*

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

 **UseIPv6** *int*
*Default Value: FALSE*

Specifies whether IPv6 should be used when connecting through the proxy.

 **Username** *char**
*Default Value: ""*

Specifies the username credential for proxy authentication.

## Constructors

```text
ProxySettings()
```

 Creates a new ProxySettings object.

# SocketSettings Type

A container for the socket settings.

## Syntax

 *SecureBlackboxSocketSettings* (declared in *secureblackbox.h*)

## Remarks

This type is a container for socket-layer parameters.

The following fields are available:

- [DNSMode](#SocketSettings_f_DNSMode)

- [DNSPort](#SocketSettings_f_DNSPort)

- [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout)

- [DNSServers](#SocketSettings_f_DNSServers)

- [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout)

- [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit)

- [LocalAddress](#SocketSettings_f_LocalAddress)

- [LocalPort](#SocketSettings_f_LocalPort)

- [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit)

- [Timeout](#SocketSettings_f_Timeout)

- [UseIPv6](#SocketSettings_f_UseIPv6)

## Fields

 **DNSMode** *int*
*Default Value: 0*

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

|  |  |
| --- | --- |
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |

 **DNSPort** *int*
*Default Value: 0*

Specifies the port number to be used for sending queries to the DNS server.

 **DNSQueryTimeout** *int*
*Default Value: 0*

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

 **DNSServers** *char**
*Default Value: ""*

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

 **DNSTotalTimeout** *int*
*Default Value: 0*

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

 **IncomingSpeedLimit** *int*
*Default Value: 0*

The maximum number of bytes to read from the socket, per second.

 **LocalAddress** *char**
*Default Value: ""*

The local network interface to bind the socket to.

 **LocalPort** *int*
*Default Value: 0*

The local port number to bind the socket to.

 **OutgoingSpeedLimit** *int*
*Default Value: 0*

The maximum number of bytes to write to the socket, per second.

 **Timeout** *int*
*Default Value: 60000*

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

 **UseIPv6** *int*
*Default Value: FALSE*

Enables or disables IP protocol version 6.

## Constructors

```text
SocketSettings()
```

 Creates a new SocketSettings object.

# TLSConnectionInfo Type

Contains information about a network connection.

## Syntax

 *SecureBlackboxTLSConnectionInfo* (declared in *secureblackbox.h*)

## Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

The following fields are available:

- [AEADCipher](#TLSConnectionInfo_f_AEADCipher)

- [ChainValidationDetails](#TLSConnectionInfo_f_ChainValidationDetails)

- [ChainValidationResult](#TLSConnectionInfo_f_ChainValidationResult)

- [Ciphersuite](#TLSConnectionInfo_f_Ciphersuite)

- [ClientAuthenticated](#TLSConnectionInfo_f_ClientAuthenticated)

- [ClientAuthRequested](#TLSConnectionInfo_f_ClientAuthRequested)

- [ConnectionEstablished](#TLSConnectionInfo_f_ConnectionEstablished)

- [ConnectionID](#TLSConnectionInfo_f_ConnectionID)

- [DigestAlgorithm](#TLSConnectionInfo_f_DigestAlgorithm)

- [EncryptionAlgorithm](#TLSConnectionInfo_f_EncryptionAlgorithm)

- [Exportable](#TLSConnectionInfo_f_Exportable)

- [Group](#TLSConnectionInfo_f_Group)

- [ID](#TLSConnectionInfo_f_ID)

- [KeyExchangeAlgorithm](#TLSConnectionInfo_f_KeyExchangeAlgorithm)

- [KeyExchangeKeyBits](#TLSConnectionInfo_f_KeyExchangeKeyBits)

- [PFSCipher](#TLSConnectionInfo_f_PFSCipher)

- [PreSharedIdentity](#TLSConnectionInfo_f_PreSharedIdentity)

- [PreSharedIdentityHint](#TLSConnectionInfo_f_PreSharedIdentityHint)

- [PublicKeyBits](#TLSConnectionInfo_f_PublicKeyBits)

- [RemoteAddress](#TLSConnectionInfo_f_RemoteAddress)

- [RemotePort](#TLSConnectionInfo_f_RemotePort)

- [ResumedSession](#TLSConnectionInfo_f_ResumedSession)

- [SecureConnection](#TLSConnectionInfo_f_SecureConnection)

- [ServerAuthenticated](#TLSConnectionInfo_f_ServerAuthenticated)

- [SignatureAlgorithm](#TLSConnectionInfo_f_SignatureAlgorithm)

- [SymmetricBlockSize](#TLSConnectionInfo_f_SymmetricBlockSize)

- [SymmetricKeyBits](#TLSConnectionInfo_f_SymmetricKeyBits)

- [TotalBytesReceived](#TLSConnectionInfo_f_TotalBytesReceived)

- [TotalBytesSent](#TLSConnectionInfo_f_TotalBytesSent)

- [ValidationLog](#TLSConnectionInfo_f_ValidationLog)

- [Version](#TLSConnectionInfo_f_Version)

## Fields

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

Indicates whether the encryption algorithm used is an AEAD cipher.

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

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

|  |  |  |
| --- | --- | --- |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |

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

The outcome of a certificate chain validation routine.

Available options:

|  |  |  |
| --- | --- | --- |
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |

Use the ValidationLog property to access the detailed validation log.

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

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

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

Specifies whether client authentication was performed during this connection.

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

Specifies whether client authentication was requested during this connection.

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

Indicates whether the connection has been established fully.

 **ConnectionID** *char* (read-only)*
*Default Value: *

The unique identifier assigned to this connection.

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

The digest algorithm used in a TLS-enabled connection.

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

The symmetric encryption algorithm used in a TLS-enabled connection.

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

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

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

The elliptic curve used in this connection.

This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions.

 **ID** *int64 (read-only)*
*Default Value: -1*

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

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

The key exchange algorithm used in a TLS-enabled connection.

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

The length of the key exchange key of a TLS-enabled connection.

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

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

 **PreSharedIdentity** *char**
*Default Value: ""*

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

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

A hint professed by the server to help the client select the PSK identity to use.

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

The length of the public key.

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

The client's IP address.

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

The remote port of the client connection.

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

Indicates whether a TLS-enabled connection was spawned from another TLS connection

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

Indicates whether TLS or SSL is enabled for this connection.

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

Indicates whether server authentication was performed during a TLS-enabled connection.

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

The signature algorithm used in a TLS handshake.

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

The block size of the symmetric algorithm used.

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

The key length of the symmetric algorithm used.

 **TotalBytesReceived** *int64 (read-only)*
*Default Value: 0*

The total number of bytes received over this connection.

 **TotalBytesSent** *int64 (read-only)*
*Default Value: 0*

The total number of bytes sent over this connection.

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

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

Indicates the version of SSL/TLS protocol negotiated during this connection.

## Constructors

```text
TLSConnectionInfo()
```

 Creates a new TLSConnectionInfo object.

# TLSSettings Type

A container for TLS connection settings.

## Syntax

 *SecureBlackboxTLSSettings* (declared in *secureblackbox.h*)

## Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

The following fields are available:

- [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates)

- [BaseConfiguration](#TLSSettings_f_BaseConfiguration)

- [Ciphersuites](#TLSSettings_f_Ciphersuites)

- [ClientAuth](#TLSSettings_f_ClientAuth)

- [Extensions](#TLSSettings_f_Extensions)

- [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges)

- [Groups](#TLSSettings_f_Groups)

- [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity)

- [PreSharedKey](#TLSSettings_f_PreSharedKey)

- [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite)

- [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode)

- [RevocationCheck](#TLSSettings_f_RevocationCheck)

- [SSLOptions](#TLSSettings_f_SSLOptions)

- [TLSMode](#TLSSettings_f_TLSMode)

- [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret)

- [UseSessionResumption](#TLSSettings_f_UseSessionResumption)

- [Versions](#TLSSettings_f_Versions)

## Fields

 **AutoValidateCertificates** *int*
*Default Value: TRUE*

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

 **BaseConfiguration** *int*
*Default Value: 0*

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

|  |  |  |
| --- | --- | --- |
| stpcDefault | 0 |  |
| stpcCompatible | 1 |  |
| stpcComprehensiveInsecure | 2 |  |
| stpcHighlySecure | 3 |  |

 **Ciphersuites** *char**
*Default Value: ""*

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [BaseConfiguration](#TLSSettings_f_BaseConfiguration). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256

 **ClientAuth** *int*
*Default Value: 0*

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

|  |  |  |
| --- | --- | --- |
| ccatNoAuth | 0 |  |
| ccatRequestCert | 1 |  |
| ccatRequireCert | 2 |  |

 **Extensions** *char**
*Default Value: ""*

Provides access to TLS extensions.

 **ForceResumeIfDestinationChanges** *int*
*Default Value: FALSE*

Whether to force TLS session resumption when the destination address changes.

 **Groups** *char**
*Default Value: ""*

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder:

```text
  // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
  client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";

  // Only enable the hybrid X25519/ML-KEM768 group
  client.TLSSettings.Groups = "-all;+x25519mlkem768";
```

The list of groups supported by the component is provided below. All the names are case-insensitive:

**Elliptic curve-based groups:**

- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448

**Finite field-based groups:**

- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192

**Post-Quantum and Hybrid groups:**

- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024

Note: this property was called *ECCurves* in SecureBlackbox 2024 and older.

 **PreSharedIdentity** *char**
*Default Value: ""*

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

 **PreSharedKey** *char**
*Default Value: ""*

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

 **PreSharedKeyCiphersuite** *char**
*Default Value: ""*

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

 **RenegotiationAttackPreventionMode** *int*
*Default Value: 2*

Selects the renegotiation attack prevention mechanism.

The following options are available:

|  |  |  |
| --- | --- | --- |
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |

 **RevocationCheck** *int*
*Default Value: 1*

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

 **SSLOptions** *int*
*Default Value: 16*

Various SSL (TLS) protocol options, set of

|  |  |  |
| --- | --- | --- |
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |

 **TLSMode** *int*
*Default Value: 0*

Specifies the TLS mode to use.

|  |  |  |
| --- | --- | --- |
| smDefault | 0 |  |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |

 **UseExtendedMasterSecret** *int*
*Default Value: TRUE*

Enables the Extended Master Secret Extension, as defined in RFC 7627.

 **UseSessionResumption** *int*
*Default Value: FALSE*

Enables or disables the TLS session resumption capability.

 **Versions** *int*
*Default Value: 48*

The SSL/TLS versions to enable by default.

|  |  |  |
| --- | --- | --- |
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |

## Constructors

```text
TLSSettings()
```

 Creates a new TLSSettings object.

# SecureBlackboxList Type

## Syntax

 *SecureBlackboxList<T>* (declared in *secureblackbox.h*)

## Remarks

 *SecureBlackboxList* 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 IMAPClient 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. |

# SecureBlackboxStream Type

## Syntax

 *SecureBlackboxStream* (declared in *secureblackbox.h*)

## Remarks

 The IMAPClient 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 SecureBlackboxStream interface and pass the IMAPClient class an instance of that concrete class.

 When implementing the SecureBlackboxStream 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 a SecureBlackboxStream 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 ([IMAPClient](#imapclient-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-imapclient-class) method.

### IMAPClient Config Settings

**Authentications**: Specifies enabled authentication methods and their priorities.Use this setting to enable or disable authentication methods and specify their priorities. The setting contains a comma-separated list of authentication methods. The first method in the list has the highest priority, and so on. The class will use the first method from the list which is supported by the server.

Supported methods: LOGIN, PLAIN, AUTH-LOGIN, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2, SCRAM-SHA-1, SCRAM-SHA-256

Default value: SCRAM-SHA-256,SCRAM-SHA-1,DIGEST-MD5,CRAM-MD5,AUTH-LOGIN,PLAIN,LOGIN

*Note:*

- LOGIN - is the LOGIN command
- AUTH-LOGIN = is a SASL mechanism used with the AUTHENTICATE command

**CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 0, which disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 0, which disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

**CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

**DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during TLS certificate revocation checks.

The default value is **dcrlpPreferDelta** (0).

Supported values:

- **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
- **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

**EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.Enable this property to delegate the chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

**IdleAuto**: Specifies whether idle mode should be requested automatically.Set this property to true to force this client to automatically send IDLE request to the server. Default value is false.

**IdleTimeout**: Specifies idle timeout in seconds.If IDLE command is running on a server, and a client has been inactive for some time, the server may log the client off. Set this property to a maximum period of time after which this client should resend the IDLE command. The default value is 1740 seconds (29 minutes).

**IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the [TrustedCertificates](#trustedcertificates-property-imapclient-class) property) are considered trusted.

**ListCriteria**: Specifies an advanced criteria for listing messages on the server.Use this setting to list messages based on additional criteria like message date, size, etc. For more details, see [SEARCH command in RFC 3501](https://tools.ietf.org/html/rfc3501#section-6.4.4)

**MaxLineLength**: Specifies maximum expected line length.Use this setting to specify how long the expected mail line can be. Setting the very long value leads to memory increase. Default value is 10000.

**MessageHeaderZZZ[i]**: A value of ZZZ header field for message i.Returns the value of the header field named ZZZ for the message with index i. If the message doesn't contain such header field, the returned value is an empty line.

For example, to get a value of the Content-Type header field, use MessageHeaderContentType[i] config name.

**OtherHeaders**: Specifies header fields to request when lists messages on the server.Use this setting to request additional header fields for each message on the server. The setting contains a comma-separated list of header field names that should be requested when the class lists messages. To request all the fields, use "OtherHeaders=*". To not request additional header fields, use "OtherHeaders=".

**RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled.

Supported values are case-insensitive:

|  |  |
| --- | --- |
| Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. |
| Default | Applies the component default freshness settings. For this component, Default is equivalent to Disabled. |
| Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. |
| Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. |
| N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. |
| crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap> | Sets the CRL and OCSP response freshness values explicitly. |

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

**SendingBufferSize**: Specifies the size of the buffer used to post messages to the server.Use this setting to specify how much memory to use for the temporary buffer when a message is uploaded to the server. Default value is 64KB.

**SessionLogDetails**: Specifies whether login credentials should be written to the session log.Use this setting to configure the details written to *SessionLog*. Possible values are:

|  |  |  |
| --- | --- | --- |
| default |  | Login credentials are not logged. |
| full |  | Login credentials appear in the SessionLog. |
| none |  | No SessionLog is created. |

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply.

**TLSCiphersuites**: Returns the list of ciphersuites activated in the component for the current session.Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler.

**TLSExtensions**: TBD.TBD

**TLSGroups**: Returns the list of TLS key exchange groups enabled in the component.Check this property to enumerate the list of TLS key exchange groups enabled in the component.

**TLSPeerExtensions**: TBD.TBD

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**TLSVersions**: Returns the list of TLS versions enabled in the component.Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask.

**TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated

**UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

**UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

**UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

**CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

**DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

**EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

**GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global".

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

**HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

**IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

**ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | None (by default) |
| fatal |  | Severe errors that cause premature termination. |
| error |  | Other runtime errors or unexpected conditions. |
| warning |  | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". |
| info |  | Interesting runtime events (startup/shutdown). |
| debug |  | Detailed information on flow of through the system. |
| trace |  | More detailed information. |

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No rotation |
| deleteolder |  | Delete older entries from the cache upon reaching LogMaxEventCount |
| keepolder |  | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |

**MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

**MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

**OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

**PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

**PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example:

```text
PKICachePath=C:\Temp\cache
```

 In this example, the cached PKI data is stored in the C:\Temp\cache directory.

**ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

**StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

**StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

**TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

**UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

**UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

**UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

**UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

**XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

**XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

**XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

# Trappable Errors ([IMAPClient](#imapclient-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.

### IMAPClient Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |