IMAPClient Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

IMAPClient

Remarks

Use this class to manage E-mail and retrieve E-mail messages from the remote IMAP servers.

Property List


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

BlockedCertCountThe number of records in the BlockedCert arrays.
BlockedCertBytesReturns raw certificate data in DER format.
BlockedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ClientCertCountThe number of records in the ClientCert arrays.
ClientCertBytesReturns raw certificate data in DER format.
ClientCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ConnInfoAEADCipherIndicates whether the encryption algorithm used is an AEAD cipher.
ConnInfoChainValidationDetailsThe details of a certificate chain validation outcome.
ConnInfoChainValidationResultThe outcome of a certificate chain validation routine.
ConnInfoCiphersuiteThe cipher suite employed by this connection.
ConnInfoClientAuthenticatedSpecifies whether client authentication was performed during this connection.
ConnInfoClientAuthRequestedSpecifies whether client authentication was requested during this connection.
ConnInfoConnectionEstablishedIndicates whether the connection has been established fully.
ConnInfoConnectionIDThe unique identifier assigned to this connection.
ConnInfoDigestAlgorithmThe digest algorithm used in a TLS-enabled connection.
ConnInfoEncryptionAlgorithmThe symmetric encryption algorithm used in a TLS-enabled connection.
ConnInfoExportableIndicates whether a TLS connection uses a reduced-strength exportable cipher.
ConnInfoKeyExchangeAlgorithmThe key exchange algorithm used in a TLS-enabled connection.
ConnInfoKeyExchangeKeyBitsThe length of the key exchange key of a TLS-enabled connection.
ConnInfoNamedECCurveThe elliptic curve used in this connection.
ConnInfoPFSCipherIndicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
ConnInfoPreSharedIdentityHintA hint professed by the server to help the client select the PSK identity to use.
ConnInfoPublicKeyBitsThe length of the public key.
ConnInfoResumedSessionIndicates whether a TLS-enabled connection was spawned from another TLS connection.
ConnInfoSecureConnectionIndicates whether TLS or SSL is enabled for this connection.
ConnInfoServerAuthenticatedIndicates whether server authentication was performed during a TLS-enabled connection.
ConnInfoSignatureAlgorithmThe signature algorithm used in a TLS handshake.
ConnInfoSymmetricBlockSizeThe block size of the symmetric algorithm used.
ConnInfoSymmetricKeyBitsThe key length of the symmetric algorithm used.
ConnInfoTotalBytesReceivedThe total number of bytes received over this connection.
ConnInfoTotalBytesSentThe total number of bytes sent over this connection.
ConnInfoValidationLogContains the server certificate's chain validation log.
ConnInfoVersionIndicates the version of SSL/TLS protocol negotiated during this connection.
CurrMailboxMessageFlagsContains message flags defined in the mailbox.
CurrMailboxNameSpecifies mailbox name.
CurrMailboxNextUIDReturns the next unique identifier value.
CurrMailboxPermanentFlagsContains a list of message flags that can be changed permanently.
CurrMailboxReadOnlySpecifies whether the mailbox is write-protected.
CurrMailboxRecentMessagesThe number of recent messages in the mailbox.
CurrMailboxTotalMessagesTotal number of messages in the mailbox.
CurrMailboxUIDValiditySpecifies UID validity value.
CurrMailboxUnseenMessagesThe number of unseen messages in the mailbox.
FIPSModeReserved.
KnownCertCountThe number of records in the KnownCert arrays.
KnownCertBytesReturns raw certificate data in DER format.
KnownCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCountThe number of records in the KnownCRL arrays.
KnownCRLBytesReturns raw CRL data in DER format.
KnownCRLHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCountThe number of records in the KnownOCSP arrays.
KnownOCSPBytesBuffer containing raw OCSP response data.
KnownOCSPHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
MailboxInfoCountThe number of records in the MailboxInfo arrays.
MailboxInfoDelimiterMailbox hierarchy delimiter.
MailboxInfoHasChildrenSpecifies whether the mailbox has \\HasChildren attribute specified.
MailboxInfoHasNoChildrenSpecifies whether the mailbox has \\HasNoChildren attribute specified.
MailboxInfoMarkedSpecifies whether the mailbox has \\Marked attribute specified.
MailboxInfoNameSpecifies mailbox name.
MailboxInfoNoInferiorsSpecifies whether the mailbox has \\NoInferiors attribute specified.
MailboxInfoNoSelectSpecifies whether the mailbox has \\NoSelect attribute specified.
MailboxInfoUnmarkedSpecifies whether the mailbox has \\Unmarked attribute specified.
MsgAttachmentCountReturns the number of attachments in this message.
MsgBccThe contents of the BCC header property.
MsgCcThe value of the CC header property.
MsgCommentsContains additional information about the message body.
MsgDateThe date and time when the message entered the mail delivery system.
MsgDeliveryReceiptEnables delivery notification.
MsgFromContains the value of the From header property.
MsgHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
MsgHtmlTextThe HTML version of the message.
MsgIDThe contents of the Message-ID header property.
MsgInReplyToThe value of the In-Reply-To header property.
MsgKeywordsThe value of the Keywords header property.
MsgMailerThe name of the software that was used to send the message.
MsgPlainTextThe plain text version of the message.
MsgPrioritySpecifies the message priority.
MsgReadReceiptEnables a read notification.
MsgReferencesThe value of the References header property.
MsgReplyToThe value of the Reply-To header property.
MsgReturnPathThe value of the Return-Path header property.
MsgSenderThe value of the Sender header property.
MsgSendToThe value of the To header property.
MsgSubjectContains the subject property of this message.
MsgInfoCountThe number of records in the MsgInfo arrays.
MsgInfoDateContains the value of the Date header property.
MsgInfoFlagsReturns the flags currently set to the mail message.
MsgInfoFromContains the value of the From header property.
MsgInfoInternalDateReturns the internal date of the mail message.
MsgInfoPrioritySpecifies the message priority.
MsgInfoSentToContains the value of the To header property.
MsgInfoSizeReturns the size of the message in bytes.
MsgInfoSubjectContains the value of the Subject header property.
MsgInfoUIDReturns the unique ID of the mail message.
PasswordThe authentication password.
ProxyAddressThe IP address of the proxy server.
ProxyAuthenticationThe authentication type used by the proxy server.
ProxyPasswordThe password to authenticate to the proxy server.
ProxyPortThe port on the proxy server to connect to.
ProxyProxyTypeThe type of the proxy server.
ProxyRequestHeadersContains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeadersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUseProxyEnables or disables proxy-driven connection.
ProxyUsernameSpecifies the username credential for proxy authentication.
ServerCertCountThe number of records in the ServerCert arrays.
ServerCertBytesReturns raw certificate data in DER format.
ServerCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
ServerCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
ServerCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ServerCertIssuerThe common name of the certificate issuer (CA), typically a company name.
ServerCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
ServerCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
ServerCertKeyBitsReturns the length of the public key.
ServerCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
ServerCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
ServerCertPublicKeyBytesContains the certificate's public key in DER format.
ServerCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
ServerCertSerialNumberReturns the certificate's serial number.
ServerCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
ServerCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
ServerCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
ServerCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
ServerCertValidFromThe time point at which the certificate becomes valid, in UTC.
ServerCertValidToThe time point at which the certificate expires, in UTC.
ServerInfoCapabilitiesReturns the list of server capabilities.
ServerInfoIdleSupportedIndicates whether the IMAP server supports the IDLE command.
ServerInfoLoginDisabledSpecifies whether the server forbids login.
SocketDNSModeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPortSpecifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeoutThe timeout (in milliseconds) for each DNS query.
SocketDNSServersThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeoutThe timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimitThe maximum number of bytes to read from the socket, per second.
SocketLocalAddressThe local network interface to bind the socket to.
SocketLocalPortThe local port number to bind the socket to.
SocketOutgoingSpeedLimitThe maximum number of bytes to write to the socket, per second.
SocketTimeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6Enables or disables IP protocol version 6.
TLSAutoValidateCertificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfigurationSelects the base configuration for the TLS settings.
TLSCiphersuitesA list of ciphersuites separated with commas or semicolons.
TLSECCurvesDefines the elliptic curves to enable.
TLSExtensionsProvides access to TLS extensions.
TLSForceResumeIfDestinationChangesWhether to force TLS session resumption when the destination address changes.
TLSPreSharedIdentityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKeyContains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionModeSelects renegotiation attack prevention mechanism.
TLSRevocationCheckSpecifies the kind(s) of revocation check to perform.
TLSSSLOptionsVarious 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.
TLSTLSModeSpecifies the TLS mode to use.
TLSUseExtendedMasterSecretEnables Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumptionEnables or disables TLS session resumption capability.
TLSVersionsThe SSL/TLS versions to enable by default.
TrustedCertCountThe number of records in the TrustedCert arrays.
TrustedCertBytesReturns raw certificate data in DER format.
TrustedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UsernameThe 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.

CloseMailboxCloses the current mailbox.
ConfigSets or retrieves a configuration setting.
ConnectEstablishes a connection to the IMAP server.
CopyMessageCopies a message to another mailbox.
CreateMailboxCreates a new mailbox.
DeleteMailboxDeletes an existing mailbox.
DisconnectCloses connection to the IMAP server.
DoActionPerforms an additional action.
ExamineMailboxSelects the mailbox in read-only mode.
GetMailboxStatusRequests a mailbox status.
ListAllMessagesQueries a list of messages available in CurrentMailbox on the server.
ListDeletedMessagesQueries a list of deleted messages in the current mailbox on the server.
ListMailboxesQueries a list of mailboxes available on the server.
ListNewMessagesQueries a list of new messages available in the current mailbox on the mail server.
ListRecentMessagesQueries a list of recent messages available in the current mailbox on the server.
ListUnseenMessagesQueries a list of unseen messages available in the current mailbox on the server.
MarkMessageDeletedSets a Deleted flag to the message.
MarkMessageSeenSets a Seen flag to the message.
PingSends a NOOP command to the IMAP server.
PostBytesUploads an e-mail message stored in a byte array.
PostFileUploads a message stored in a file to the current mailbox on the IMAP server.
PostMessageUploads a pre-built message to the current mailbox on the IMAP server.
PostStreamUploads a message stored in a stream to the current mailbox on the IMAP server.
PurgeMessagesPermanently removes all deleted messages from the current mailbox.
ReceiveBytesDownloads a message to a byte array.
ReceiveFileDownloads a message to a file.
ReceiveMessageDownloads a message.
ReceiveStreamDownloads a message to a stream.
RefreshMailboxRefreshes the state info of the current mailbox.
RenameMailboxRenames an existing mailbox.
SelectMailboxSelects the specified mailbox.
UpdateMessageAlters flags assotiated 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.

BeforeAuthFires before the authentication starts.
CommandReports a command sent to the server.
CommandDataReturns the data that accompanies the command.
CommandReplyReports the receipt of a reply to a command.
CommandReplyDataReturns the data that accompanies a reply to a command.
ErrorProvides information about errors during SMTP operations.
MailboxStatusReports the mailbox status returned from the server.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the progress of the data transfer operation.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSPSKNotifies the application about the PSK key exchange.
TLSShutdownReports 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.

AuthenticationsSpecifies enabled authentication methods and their priorities.
IdleAutoSpecifies whether idle mode should be requested automatically.
IdleTimeoutSpecifies idle timeout in seconds.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
ListCriteriaSpecifies an advanced criteria for listing messages on the server.
MaxLineLengthSpecifies maximum expected line length.
MessageHeaderZZZ[i]A value of ZZZ header field for message i.
OtherHeadersSpecifies header fields to request when lists messages on the server.
SendingBufferSizeSpecifies the size of the buffer used to post messages to the server.
TempPathPath for storing temporary files.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

BlockedCertCount Property (IMAPClient Class)

The number of records in the BlockedCert arrays.

Syntax

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); Unicode (Windows) INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);
int secureblackbox_imapclient_getblockedcertcount(void* lpObj);
int secureblackbox_imapclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (IMAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes);

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);
int secureblackbox_imapclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

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

Data Type

Byte Array

BlockedCertHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle); Unicode (Windows) LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);
int64 secureblackbox_imapclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_imapclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is not available at design time.

Data Type

Long64

ClientCertCount Property (IMAPClient Class)

The number of records in the ClientCert arrays.

Syntax

ANSI (Cross Platform)
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount); Unicode (Windows) INT GetClientCertCount();
INT SetClientCertCount(INT iClientCertCount);
int secureblackbox_imapclient_getclientcertcount(void* lpObj);
int secureblackbox_imapclient_setclientcertcount(void* lpObj, int iClientCertCount);
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (IMAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetClientCertBytes(int iClientCertIndex, char* &lpClientCertBytes, int &lenClientCertBytes);

Unicode (Windows)
INT GetClientCertBytes(INT iClientCertIndex, LPSTR &lpClientCertBytes, INT &lenClientCertBytes);
int secureblackbox_imapclient_getclientcertbytes(void* lpObj, int clientcertindex, char** lpClientCertBytes, int* lenClientCertBytes);
QByteArray GetClientCertBytes(int iClientCertIndex);

Remarks

Returns raw certificate data in DER format.

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

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

Data Type

Byte Array

ClientCertHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, int64 lClientCertHandle); Unicode (Windows) LONG64 GetClientCertHandle(INT iClientCertIndex);
INT SetClientCertHandle(INT iClientCertIndex, LONG64 lClientCertHandle);
int64 secureblackbox_imapclient_getclientcerthandle(void* lpObj, int clientcertindex);
int secureblackbox_imapclient_setclientcerthandle(void* lpObj, int clientcertindex, int64 lClientCertHandle);
qint64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, qint64 lClientCertHandle);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCertCount property.

This property is not available at design time.

Data Type

Long64

ConnInfoAEADCipher Property (IMAPClient Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

ANSI (Cross Platform)
int GetConnInfoAEADCipher();

Unicode (Windows)
BOOL GetConnInfoAEADCipher();
int secureblackbox_imapclient_getconninfoaeadcipher(void* lpObj);
bool GetConnInfoAEADCipher();

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

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

Data Type

Boolean

ConnInfoChainValidationDetails Property (IMAPClient Class)

The details of a certificate chain validation outcome.

Syntax

ANSI (Cross Platform)
int GetConnInfoChainValidationDetails();

Unicode (Windows)
INT GetConnInfoChainValidationDetails();
int secureblackbox_imapclient_getconninfochainvalidationdetails(void* lpObj);
int GetConnInfoChainValidationDetails();

Default Value

0

Remarks

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

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

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

Data Type

Integer

ConnInfoChainValidationResult Property (IMAPClient Class)

The outcome of a certificate chain validation routine.

Syntax

ANSI (Cross Platform)
int GetConnInfoChainValidationResult();

Unicode (Windows)
INT GetConnInfoChainValidationResult();

Possible Values

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_imapclient_getconninfochainvalidationresult(void* lpObj);
int GetConnInfoChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

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

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

Data Type

Integer

ConnInfoCiphersuite Property (IMAPClient Class)

The cipher suite employed by this connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoCiphersuite();

Unicode (Windows)
LPWSTR GetConnInfoCiphersuite();
char* secureblackbox_imapclient_getconninfociphersuite(void* lpObj);
QString GetConnInfoCiphersuite();

Default Value

""

Remarks

The cipher suite employed by this connection.

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

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

Data Type

String

ConnInfoClientAuthenticated Property (IMAPClient Class)

Specifies whether client authentication was performed during this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoClientAuthenticated();

Unicode (Windows)
BOOL GetConnInfoClientAuthenticated();
int secureblackbox_imapclient_getconninfoclientauthenticated(void* lpObj);
bool GetConnInfoClientAuthenticated();

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

ConnInfoClientAuthRequested Property (IMAPClient Class)

Specifies whether client authentication was requested during this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoClientAuthRequested();

Unicode (Windows)
BOOL GetConnInfoClientAuthRequested();
int secureblackbox_imapclient_getconninfoclientauthrequested(void* lpObj);
bool GetConnInfoClientAuthRequested();

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

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

Data Type

Boolean

ConnInfoConnectionEstablished Property (IMAPClient Class)

Indicates whether the connection has been established fully.

Syntax

ANSI (Cross Platform)
int GetConnInfoConnectionEstablished();

Unicode (Windows)
BOOL GetConnInfoConnectionEstablished();
int secureblackbox_imapclient_getconninfoconnectionestablished(void* lpObj);
bool GetConnInfoConnectionEstablished();

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

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

Data Type

Boolean

ConnInfoConnectionID Property (IMAPClient Class)

The unique identifier assigned to this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoConnectionID(char* &lpConnInfoConnectionID, int &lenConnInfoConnectionID);

Unicode (Windows)
INT GetConnInfoConnectionID(LPSTR &lpConnInfoConnectionID, INT &lenConnInfoConnectionID);
int secureblackbox_imapclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);
QByteArray GetConnInfoConnectionID();

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

ConnInfoDigestAlgorithm Property (IMAPClient Class)

The digest algorithm used in a TLS-enabled connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoDigestAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoDigestAlgorithm();
char* secureblackbox_imapclient_getconninfodigestalgorithm(void* lpObj);
QString GetConnInfoDigestAlgorithm();

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

ConnInfoEncryptionAlgorithm Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithm();
char* secureblackbox_imapclient_getconninfoencryptionalgorithm(void* lpObj);
QString GetConnInfoEncryptionAlgorithm();

Default Value

""

Remarks

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

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

Data Type

String

ConnInfoExportable Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoExportable();

Unicode (Windows)
BOOL GetConnInfoExportable();
int secureblackbox_imapclient_getconninfoexportable(void* lpObj);
bool GetConnInfoExportable();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoKeyExchangeAlgorithm Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKeyExchangeAlgorithm();
char* secureblackbox_imapclient_getconninfokeyexchangealgorithm(void* lpObj);
QString GetConnInfoKeyExchangeAlgorithm();

Default Value

""

Remarks

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

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

Data Type

String

ConnInfoKeyExchangeKeyBits Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoKeyExchangeKeyBits();

Unicode (Windows)
INT GetConnInfoKeyExchangeKeyBits();
int secureblackbox_imapclient_getconninfokeyexchangekeybits(void* lpObj);
int GetConnInfoKeyExchangeKeyBits();

Default Value

0

Remarks

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

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

Data Type

Integer

ConnInfoNamedECCurve Property (IMAPClient Class)

The elliptic curve used in this connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoNamedECCurve();

Unicode (Windows)
LPWSTR GetConnInfoNamedECCurve();
char* secureblackbox_imapclient_getconninfonamedeccurve(void* lpObj);
QString GetConnInfoNamedECCurve();

Default Value

""

Remarks

The elliptic curve used in this connection.

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

Data Type

String

ConnInfoPFSCipher Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoPFSCipher();

Unicode (Windows)
BOOL GetConnInfoPFSCipher();
int secureblackbox_imapclient_getconninfopfscipher(void* lpObj);
bool GetConnInfoPFSCipher();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoPreSharedIdentityHint Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoPreSharedIdentityHint();

Unicode (Windows)
LPWSTR GetConnInfoPreSharedIdentityHint();
char* secureblackbox_imapclient_getconninfopresharedidentityhint(void* lpObj);
QString GetConnInfoPreSharedIdentityHint();

Default Value

""

Remarks

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

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

Data Type

String

ConnInfoPublicKeyBits Property (IMAPClient Class)

The length of the public key.

Syntax

ANSI (Cross Platform)
int GetConnInfoPublicKeyBits();

Unicode (Windows)
INT GetConnInfoPublicKeyBits();
int secureblackbox_imapclient_getconninfopublickeybits(void* lpObj);
int GetConnInfoPublicKeyBits();

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

ConnInfoResumedSession Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoResumedSession();

Unicode (Windows)
BOOL GetConnInfoResumedSession();
int secureblackbox_imapclient_getconninforesumedsession(void* lpObj);
bool GetConnInfoResumedSession();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoSecureConnection Property (IMAPClient Class)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoSecureConnection();

Unicode (Windows)
BOOL GetConnInfoSecureConnection();
int secureblackbox_imapclient_getconninfosecureconnection(void* lpObj);
bool GetConnInfoSecureConnection();

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

ConnInfoServerAuthenticated Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoServerAuthenticated();

Unicode (Windows)
BOOL GetConnInfoServerAuthenticated();
int secureblackbox_imapclient_getconninfoserverauthenticated(void* lpObj);
bool GetConnInfoServerAuthenticated();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoSignatureAlgorithm Property (IMAPClient Class)

The signature algorithm used in a TLS handshake.

Syntax

ANSI (Cross Platform)
char* GetConnInfoSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoSignatureAlgorithm();
char* secureblackbox_imapclient_getconninfosignaturealgorithm(void* lpObj);
QString GetConnInfoSignatureAlgorithm();

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

ConnInfoSymmetricBlockSize Property (IMAPClient Class)

The block size of the symmetric algorithm used.

Syntax

ANSI (Cross Platform)
int GetConnInfoSymmetricBlockSize();

Unicode (Windows)
INT GetConnInfoSymmetricBlockSize();
int secureblackbox_imapclient_getconninfosymmetricblocksize(void* lpObj);
int GetConnInfoSymmetricBlockSize();

Default Value

0

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoSymmetricKeyBits Property (IMAPClient Class)

The key length of the symmetric algorithm used.

Syntax

ANSI (Cross Platform)
int GetConnInfoSymmetricKeyBits();

Unicode (Windows)
INT GetConnInfoSymmetricKeyBits();
int secureblackbox_imapclient_getconninfosymmetrickeybits(void* lpObj);
int GetConnInfoSymmetricKeyBits();

Default Value

0

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoTotalBytesReceived Property (IMAPClient Class)

The total number of bytes received over this connection.

Syntax

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();
int64 secureblackbox_imapclient_getconninfototalbytesreceived(void* lpObj);
qint64 GetConnInfoTotalBytesReceived();

Default Value

0

Remarks

The total number of bytes received over this connection.

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

Data Type

Long64

ConnInfoTotalBytesSent Property (IMAPClient Class)

The total number of bytes sent over this connection.

Syntax

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();
int64 secureblackbox_imapclient_getconninfototalbytessent(void* lpObj);
qint64 GetConnInfoTotalBytesSent();

Default Value

0

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

ConnInfoValidationLog Property (IMAPClient Class)

Contains the server certificate's chain validation log.

Syntax

ANSI (Cross Platform)
char* GetConnInfoValidationLog();

Unicode (Windows)
LPWSTR GetConnInfoValidationLog();
char* secureblackbox_imapclient_getconninfovalidationlog(void* lpObj);
QString GetConnInfoValidationLog();

Default Value

""

Remarks

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

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

Data Type

String

ConnInfoVersion Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoVersion();

Unicode (Windows)
LPWSTR GetConnInfoVersion();
char* secureblackbox_imapclient_getconninfoversion(void* lpObj);
QString GetConnInfoVersion();

Default Value

""

Remarks

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

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

Data Type

String

CurrMailboxMessageFlags Property (IMAPClient Class)

Contains message flags defined in the mailbox.

Syntax

ANSI (Cross Platform)
int GetCurrMailboxMessageFlags();

Unicode (Windows)
INT GetCurrMailboxMessageFlags();
int secureblackbox_imapclient_getcurrmailboxmessageflags(void* lpObj);
int GetCurrMailboxMessageFlags();

Default Value

0

Remarks

Contains message flags defined in the mailbox.

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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

Data Type

Integer

CurrMailboxName Property (IMAPClient Class)

Specifies mailbox name.

Syntax

ANSI (Cross Platform)
char* GetCurrMailboxName();

Unicode (Windows)
LPWSTR GetCurrMailboxName();
char* secureblackbox_imapclient_getcurrmailboxname(void* lpObj);
QString GetCurrMailboxName();

Default Value

""

Remarks

Specifies mailbox name.

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

Data Type

String

CurrMailboxNextUID Property (IMAPClient Class)

Returns the next unique identifier value.

Syntax

ANSI (Cross Platform)
int GetCurrMailboxNextUID();

Unicode (Windows)
INT GetCurrMailboxNextUID();
int secureblackbox_imapclient_getcurrmailboxnextuid(void* lpObj);
int GetCurrMailboxNextUID();

Default Value

0

Remarks

Returns the next unique identifier value.

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

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

Data Type

Integer

CurrMailboxPermanentFlags Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetCurrMailboxPermanentFlags();

Unicode (Windows)
INT GetCurrMailboxPermanentFlags();
int secureblackbox_imapclient_getcurrmailboxpermanentflags(void* lpObj);
int GetCurrMailboxPermanentFlags();

Default Value

0

Remarks

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

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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

Data Type

Integer

CurrMailboxReadOnly Property (IMAPClient Class)

Specifies whether the mailbox is write-protected.

Syntax

ANSI (Cross Platform)
int GetCurrMailboxReadOnly();

Unicode (Windows)
BOOL GetCurrMailboxReadOnly();
int secureblackbox_imapclient_getcurrmailboxreadonly(void* lpObj);
bool GetCurrMailboxReadOnly();

Default Value

FALSE

Remarks

Specifies whether the mailbox is write-protected.

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

Data Type

Boolean

CurrMailboxRecentMessages Property (IMAPClient Class)

The number of recent messages in the mailbox.

Syntax

ANSI (Cross Platform)
int GetCurrMailboxRecentMessages();

Unicode (Windows)
INT GetCurrMailboxRecentMessages();
int secureblackbox_imapclient_getcurrmailboxrecentmessages(void* lpObj);
int GetCurrMailboxRecentMessages();

Default Value

0

Remarks

The number of recent messages in the mailbox.

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

Data Type

Integer

CurrMailboxTotalMessages Property (IMAPClient Class)

Total number of messages in the mailbox.

Syntax

ANSI (Cross Platform)
int GetCurrMailboxTotalMessages();

Unicode (Windows)
INT GetCurrMailboxTotalMessages();
int secureblackbox_imapclient_getcurrmailboxtotalmessages(void* lpObj);
int GetCurrMailboxTotalMessages();

Default Value

0

Remarks

Total number of messages in the mailbox.

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

Data Type

Integer

CurrMailboxUIDValidity Property (IMAPClient Class)

Specifies UID validity value.

Syntax

ANSI (Cross Platform)
int GetCurrMailboxUIDValidity();

Unicode (Windows)
INT GetCurrMailboxUIDValidity();
int secureblackbox_imapclient_getcurrmailboxuidvalidity(void* lpObj);
int GetCurrMailboxUIDValidity();

Default Value

0

Remarks

Specifies UID validity value.

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

Data Type

Integer

CurrMailboxUnseenMessages Property (IMAPClient Class)

The number of unseen messages in the mailbox.

Syntax

ANSI (Cross Platform)
int GetCurrMailboxUnseenMessages();

Unicode (Windows)
INT GetCurrMailboxUnseenMessages();
int secureblackbox_imapclient_getcurrmailboxunseenmessages(void* lpObj);
int GetCurrMailboxUnseenMessages();

Default Value

0

Remarks

The number of unseen messages in the mailbox.

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

Data Type

Integer

FIPSMode Property (IMAPClient Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_imapclient_getfipsmode(void* lpObj);
int secureblackbox_imapclient_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

KnownCertCount Property (IMAPClient Class)

The number of records in the KnownCert arrays.

Syntax

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); Unicode (Windows) INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);
int secureblackbox_imapclient_getknowncertcount(void* lpObj);
int secureblackbox_imapclient_setknowncertcount(void* lpObj, int iKnownCertCount);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (IMAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);
int secureblackbox_imapclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

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

Data Type

Byte Array

KnownCertHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle); Unicode (Windows) LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);
int64 secureblackbox_imapclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_imapclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (IMAPClient Class)

The number of records in the KnownCRL arrays.

Syntax

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); Unicode (Windows) INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);
int secureblackbox_imapclient_getknowncrlcount(void* lpObj);
int secureblackbox_imapclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (IMAPClient Class)

Returns raw CRL data in DER format.

Syntax

ANSI (Cross Platform)
int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes);

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);
int secureblackbox_imapclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

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

Data Type

Byte Array

KnownCRLHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle); Unicode (Windows) LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);
int64 secureblackbox_imapclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_imapclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (IMAPClient Class)

The number of records in the KnownOCSP arrays.

Syntax

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); Unicode (Windows) INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);
int secureblackbox_imapclient_getknownocspcount(void* lpObj);
int secureblackbox_imapclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (IMAPClient Class)

Buffer containing raw OCSP response data.

Syntax

ANSI (Cross Platform)
int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes);

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);
int secureblackbox_imapclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

Buffer containing raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

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

Data Type

Byte Array

KnownOCSPHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle); Unicode (Windows) LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);
int64 secureblackbox_imapclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_imapclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is not available at design time.

Data Type

Long64

MailboxInfoCount Property (IMAPClient Class)

The number of records in the MailboxInfo arrays.

Syntax

ANSI (Cross Platform)
int GetMailboxInfoCount();

Unicode (Windows)
INT GetMailboxInfoCount();
int secureblackbox_imapclient_getmailboxinfocount(void* lpObj);
int GetMailboxInfoCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

MailboxInfoDelimiter Property (IMAPClient Class)

Mailbox hierarchy delimiter.

Syntax

ANSI (Cross Platform)
char* GetMailboxInfoDelimiter(int iMailboxInfoIndex);

Unicode (Windows)
LPWSTR GetMailboxInfoDelimiter(INT iMailboxInfoIndex);
char* secureblackbox_imapclient_getmailboxinfodelimiter(void* lpObj, int mailboxinfoindex);
QString GetMailboxInfoDelimiter(int iMailboxInfoIndex);

Default Value

""

Remarks

Mailbox hierarchy delimiter.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

String

MailboxInfoHasChildren Property (IMAPClient Class)

Specifies whether the mailbox has \\HasChildren attribute specified.

Syntax

ANSI (Cross Platform)
int GetMailboxInfoHasChildren(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoHasChildren(INT iMailboxInfoIndex);
int secureblackbox_imapclient_getmailboxinfohaschildren(void* lpObj, int mailboxinfoindex);
bool GetMailboxInfoHasChildren(int iMailboxInfoIndex);

Default Value

FALSE

Remarks

Specifies whether the mailbox has \HasChildren attribute specified.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

Boolean

MailboxInfoHasNoChildren Property (IMAPClient Class)

Specifies whether the mailbox has \\HasNoChildren attribute specified.

Syntax

ANSI (Cross Platform)
int GetMailboxInfoHasNoChildren(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoHasNoChildren(INT iMailboxInfoIndex);
int secureblackbox_imapclient_getmailboxinfohasnochildren(void* lpObj, int mailboxinfoindex);
bool GetMailboxInfoHasNoChildren(int iMailboxInfoIndex);

Default Value

FALSE

Remarks

Specifies whether the mailbox has \HasNoChildren attribute specified.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

Boolean

MailboxInfoMarked Property (IMAPClient Class)

Specifies whether the mailbox has \\Marked attribute specified.

Syntax

ANSI (Cross Platform)
int GetMailboxInfoMarked(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoMarked(INT iMailboxInfoIndex);
int secureblackbox_imapclient_getmailboxinfomarked(void* lpObj, int mailboxinfoindex);
bool GetMailboxInfoMarked(int iMailboxInfoIndex);

Default Value

FALSE

Remarks

Specifies whether the mailbox has \Marked attribute specified.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

Boolean

MailboxInfoName Property (IMAPClient Class)

Specifies mailbox name.

Syntax

ANSI (Cross Platform)
char* GetMailboxInfoName(int iMailboxInfoIndex);

Unicode (Windows)
LPWSTR GetMailboxInfoName(INT iMailboxInfoIndex);
char* secureblackbox_imapclient_getmailboxinfoname(void* lpObj, int mailboxinfoindex);
QString GetMailboxInfoName(int iMailboxInfoIndex);

Default Value

""

Remarks

Specifies mailbox name.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

String

MailboxInfoNoInferiors Property (IMAPClient Class)

Specifies whether the mailbox has \\NoInferiors attribute specified.

Syntax

ANSI (Cross Platform)
int GetMailboxInfoNoInferiors(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoNoInferiors(INT iMailboxInfoIndex);
int secureblackbox_imapclient_getmailboxinfonoinferiors(void* lpObj, int mailboxinfoindex);
bool GetMailboxInfoNoInferiors(int iMailboxInfoIndex);

Default Value

FALSE

Remarks

Specifies whether the mailbox has \NoInferiors attribute specified.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

Boolean

MailboxInfoNoSelect Property (IMAPClient Class)

Specifies whether the mailbox has \\NoSelect attribute specified.

Syntax

ANSI (Cross Platform)
int GetMailboxInfoNoSelect(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoNoSelect(INT iMailboxInfoIndex);
int secureblackbox_imapclient_getmailboxinfonoselect(void* lpObj, int mailboxinfoindex);
bool GetMailboxInfoNoSelect(int iMailboxInfoIndex);

Default Value

FALSE

Remarks

Specifies whether the mailbox has \NoSelect attribute specified.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

Boolean

MailboxInfoUnmarked Property (IMAPClient Class)

Specifies whether the mailbox has \\Unmarked attribute specified.

Syntax

ANSI (Cross Platform)
int GetMailboxInfoUnmarked(int iMailboxInfoIndex);

Unicode (Windows)
BOOL GetMailboxInfoUnmarked(INT iMailboxInfoIndex);
int secureblackbox_imapclient_getmailboxinfounmarked(void* lpObj, int mailboxinfoindex);
bool GetMailboxInfoUnmarked(int iMailboxInfoIndex);

Default Value

FALSE

Remarks

Specifies whether the mailbox has \Unmarked attribute specified.

The MailboxInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MailboxInfoCount property.

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

Data Type

Boolean

MsgAttachmentCount Property (IMAPClient Class)

Returns the number of attachments in this message.

Syntax

ANSI (Cross Platform)
int GetMsgAttachmentCount();

Unicode (Windows)
INT GetMsgAttachmentCount();
int secureblackbox_imapclient_getmsgattachmentcount(void* lpObj);
int GetMsgAttachmentCount();

Default Value

0

Remarks

Returns the number of attachments in this message.

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

Data Type

Integer

MsgBcc Property (IMAPClient Class)

The contents of the BCC header property.

Syntax

ANSI (Cross Platform)
char* GetMsgBcc();
int SetMsgBcc(const char* lpszMsgBcc); Unicode (Windows) LPWSTR GetMsgBcc();
INT SetMsgBcc(LPCWSTR lpszMsgBcc);
char* secureblackbox_imapclient_getmsgbcc(void* lpObj);
int secureblackbox_imapclient_setmsgbcc(void* lpObj, const char* lpszMsgBcc);
QString GetMsgBcc();
int SetMsgBcc(QString qsMsgBcc);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

MsgCc Property (IMAPClient Class)

The value of the CC header property.

Syntax

ANSI (Cross Platform)
char* GetMsgCc();
int SetMsgCc(const char* lpszMsgCc); Unicode (Windows) LPWSTR GetMsgCc();
INT SetMsgCc(LPCWSTR lpszMsgCc);
char* secureblackbox_imapclient_getmsgcc(void* lpObj);
int secureblackbox_imapclient_setmsgcc(void* lpObj, const char* lpszMsgCc);
QString GetMsgCc();
int SetMsgCc(QString qsMsgCc);

Default Value

""

Remarks

The value of the CC header field.

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

This property is not available at design time.

Data Type

String

MsgComments Property (IMAPClient Class)

Contains additional information about the message body.

Syntax

ANSI (Cross Platform)
char* GetMsgComments();
int SetMsgComments(const char* lpszMsgComments); Unicode (Windows) LPWSTR GetMsgComments();
INT SetMsgComments(LPCWSTR lpszMsgComments);
char* secureblackbox_imapclient_getmsgcomments(void* lpObj);
int secureblackbox_imapclient_setmsgcomments(void* lpObj, const char* lpszMsgComments);
QString GetMsgComments();
int SetMsgComments(QString qsMsgComments);

Default Value

""

Remarks

Contains additional information about the message body.

This property is not available at design time.

Data Type

String

MsgDate Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetMsgDate();
int SetMsgDate(const char* lpszMsgDate); Unicode (Windows) LPWSTR GetMsgDate();
INT SetMsgDate(LPCWSTR lpszMsgDate);
char* secureblackbox_imapclient_getmsgdate(void* lpObj);
int secureblackbox_imapclient_setmsgdate(void* lpObj, const char* lpszMsgDate);
QString GetMsgDate();
int SetMsgDate(QString qsMsgDate);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

MsgDeliveryReceipt Property (IMAPClient Class)

Enables delivery notification.

Syntax

ANSI (Cross Platform)
int GetMsgDeliveryReceipt();
int SetMsgDeliveryReceipt(int bMsgDeliveryReceipt); Unicode (Windows) BOOL GetMsgDeliveryReceipt();
INT SetMsgDeliveryReceipt(BOOL bMsgDeliveryReceipt);
int secureblackbox_imapclient_getmsgdeliveryreceipt(void* lpObj);
int secureblackbox_imapclient_setmsgdeliveryreceipt(void* lpObj, int bMsgDeliveryReceipt);
bool GetMsgDeliveryReceipt();
int SetMsgDeliveryReceipt(bool bMsgDeliveryReceipt);

Default Value

FALSE

Remarks

Enables delivery notification.

This property is not available at design time.

Data Type

Boolean

MsgFrom Property (IMAPClient Class)

Contains the value of the From header property.

Syntax

ANSI (Cross Platform)
char* GetMsgFrom();
int SetMsgFrom(const char* lpszMsgFrom); Unicode (Windows) LPWSTR GetMsgFrom();
INT SetMsgFrom(LPCWSTR lpszMsgFrom);
char* secureblackbox_imapclient_getmsgfrom(void* lpObj);
int secureblackbox_imapclient_setmsgfrom(void* lpObj, const char* lpszMsgFrom);
QString GetMsgFrom();
int SetMsgFrom(QString qsMsgFrom);

Default Value

""

Remarks

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 MsgSender to specify the sender separately.

This property is not available at design time.

Data Type

String

MsgHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetMsgHandle();
int SetMsgHandle(int64 lMsgHandle); Unicode (Windows) LONG64 GetMsgHandle();
INT SetMsgHandle(LONG64 lMsgHandle);
int64 secureblackbox_imapclient_getmsghandle(void* lpObj);
int secureblackbox_imapclient_setmsghandle(void* lpObj, int64 lMsgHandle);
qint64 GetMsgHandle();
int SetMsgHandle(qint64 lMsgHandle);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

MsgHtmlText Property (IMAPClient Class)

The HTML version of the message.

Syntax

ANSI (Cross Platform)
char* GetMsgHtmlText();
int SetMsgHtmlText(const char* lpszMsgHtmlText); Unicode (Windows) LPWSTR GetMsgHtmlText();
INT SetMsgHtmlText(LPCWSTR lpszMsgHtmlText);
char* secureblackbox_imapclient_getmsghtmltext(void* lpObj);
int secureblackbox_imapclient_setmsghtmltext(void* lpObj, const char* lpszMsgHtmlText);
QString GetMsgHtmlText();
int SetMsgHtmlText(QString qsMsgHtmlText);

Default Value

""

Remarks

The HTML version of the message.

This property is not available at design time.

Data Type

String

MsgID Property (IMAPClient Class)

The contents of the Message-ID header property.

Syntax

ANSI (Cross Platform)
char* GetMsgID();
int SetMsgID(const char* lpszMsgID); Unicode (Windows) LPWSTR GetMsgID();
INT SetMsgID(LPCWSTR lpszMsgID);
char* secureblackbox_imapclient_getmsgid(void* lpObj);
int secureblackbox_imapclient_setmsgid(void* lpObj, const char* lpszMsgID);
QString GetMsgID();
int SetMsgID(QString qsMsgID);

Default Value

""

Remarks

The contents of the Message-ID header field.

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

This property is not available at design time.

Data Type

String

MsgInReplyTo Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetMsgInReplyTo();
int SetMsgInReplyTo(const char* lpszMsgInReplyTo); Unicode (Windows) LPWSTR GetMsgInReplyTo();
INT SetMsgInReplyTo(LPCWSTR lpszMsgInReplyTo);
char* secureblackbox_imapclient_getmsginreplyto(void* lpObj);
int secureblackbox_imapclient_setmsginreplyto(void* lpObj, const char* lpszMsgInReplyTo);
QString GetMsgInReplyTo();
int SetMsgInReplyTo(QString qsMsgInReplyTo);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

MsgKeywords Property (IMAPClient Class)

The value of the Keywords header property.

Syntax

ANSI (Cross Platform)
char* GetMsgKeywords();
int SetMsgKeywords(const char* lpszMsgKeywords); Unicode (Windows) LPWSTR GetMsgKeywords();
INT SetMsgKeywords(LPCWSTR lpszMsgKeywords);
char* secureblackbox_imapclient_getmsgkeywords(void* lpObj);
int secureblackbox_imapclient_setmsgkeywords(void* lpObj, const char* lpszMsgKeywords);
QString GetMsgKeywords();
int SetMsgKeywords(QString qsMsgKeywords);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

MsgMailer Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetMsgMailer();

Unicode (Windows)
LPWSTR GetMsgMailer();
char* secureblackbox_imapclient_getmsgmailer(void* lpObj);
QString GetMsgMailer();

Default Value

""

Remarks

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

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

Data Type

String

MsgPlainText Property (IMAPClient Class)

The plain text version of the message.

Syntax

ANSI (Cross Platform)
char* GetMsgPlainText();
int SetMsgPlainText(const char* lpszMsgPlainText); Unicode (Windows) LPWSTR GetMsgPlainText();
INT SetMsgPlainText(LPCWSTR lpszMsgPlainText);
char* secureblackbox_imapclient_getmsgplaintext(void* lpObj);
int secureblackbox_imapclient_setmsgplaintext(void* lpObj, const char* lpszMsgPlainText);
QString GetMsgPlainText();
int SetMsgPlainText(QString qsMsgPlainText);

Default Value

""

Remarks

The plain text version of the message.

This property is not available at design time.

Data Type

String

MsgPriority Property (IMAPClient Class)

Specifies the message priority.

Syntax

ANSI (Cross Platform)
int GetMsgPriority();
int SetMsgPriority(int iMsgPriority); Unicode (Windows) INT GetMsgPriority();
INT SetMsgPriority(INT iMsgPriority);

Possible Values

MP_LOWEST(0), 
MP_LOW(1),
MP_NORMAL(2),
MP_HIGH(3),
MP_HIGHEST(4)
int secureblackbox_imapclient_getmsgpriority(void* lpObj);
int secureblackbox_imapclient_setmsgpriority(void* lpObj, int iMsgPriority);
int GetMsgPriority();
int SetMsgPriority(int iMsgPriority);

Default Value

2

Remarks

Specifies the message priority.

Available options:

mpLowest0
mpLow1
mpNormal2
mpHigh3
mpHighest4

This property is not available at design time.

Data Type

Integer

MsgReadReceipt Property (IMAPClient Class)

Enables a read notification.

Syntax

ANSI (Cross Platform)
int GetMsgReadReceipt();
int SetMsgReadReceipt(int bMsgReadReceipt); Unicode (Windows) BOOL GetMsgReadReceipt();
INT SetMsgReadReceipt(BOOL bMsgReadReceipt);
int secureblackbox_imapclient_getmsgreadreceipt(void* lpObj);
int secureblackbox_imapclient_setmsgreadreceipt(void* lpObj, int bMsgReadReceipt);
bool GetMsgReadReceipt();
int SetMsgReadReceipt(bool bMsgReadReceipt);

Default Value

FALSE

Remarks

Enables a read notification.

This property is not available at design time.

Data Type

Boolean

MsgReferences Property (IMAPClient Class)

The value of the References header property.

Syntax

ANSI (Cross Platform)
char* GetMsgReferences();
int SetMsgReferences(const char* lpszMsgReferences); Unicode (Windows) LPWSTR GetMsgReferences();
INT SetMsgReferences(LPCWSTR lpszMsgReferences);
char* secureblackbox_imapclient_getmsgreferences(void* lpObj);
int secureblackbox_imapclient_setmsgreferences(void* lpObj, const char* lpszMsgReferences);
QString GetMsgReferences();
int SetMsgReferences(QString qsMsgReferences);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

MsgReplyTo Property (IMAPClient Class)

The value of the Reply-To header property.

Syntax

ANSI (Cross Platform)
char* GetMsgReplyTo();
int SetMsgReplyTo(const char* lpszMsgReplyTo); Unicode (Windows) LPWSTR GetMsgReplyTo();
INT SetMsgReplyTo(LPCWSTR lpszMsgReplyTo);
char* secureblackbox_imapclient_getmsgreplyto(void* lpObj);
int secureblackbox_imapclient_setmsgreplyto(void* lpObj, const char* lpszMsgReplyTo);
QString GetMsgReplyTo();
int SetMsgReplyTo(QString qsMsgReplyTo);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

MsgReturnPath Property (IMAPClient Class)

The value of the Return-Path header property.

Syntax

ANSI (Cross Platform)
char* GetMsgReturnPath();
int SetMsgReturnPath(const char* lpszMsgReturnPath); Unicode (Windows) LPWSTR GetMsgReturnPath();
INT SetMsgReturnPath(LPCWSTR lpszMsgReturnPath);
char* secureblackbox_imapclient_getmsgreturnpath(void* lpObj);
int secureblackbox_imapclient_setmsgreturnpath(void* lpObj, const char* lpszMsgReturnPath);
QString GetMsgReturnPath();
int SetMsgReturnPath(QString qsMsgReturnPath);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

MsgSender Property (IMAPClient Class)

The value of the Sender header property.

Syntax

ANSI (Cross Platform)
char* GetMsgSender();
int SetMsgSender(const char* lpszMsgSender); Unicode (Windows) LPWSTR GetMsgSender();
INT SetMsgSender(LPCWSTR lpszMsgSender);
char* secureblackbox_imapclient_getmsgsender(void* lpObj);
int secureblackbox_imapclient_setmsgsender(void* lpObj, const char* lpszMsgSender);
QString GetMsgSender();
int SetMsgSender(QString qsMsgSender);

Default Value

""

Remarks

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.

This property is not available at design time.

Data Type

String

MsgSendTo Property (IMAPClient Class)

The value of the To header property.

Syntax

ANSI (Cross Platform)
char* GetMsgSendTo();
int SetMsgSendTo(const char* lpszMsgSendTo); Unicode (Windows) LPWSTR GetMsgSendTo();
INT SetMsgSendTo(LPCWSTR lpszMsgSendTo);
char* secureblackbox_imapclient_getmsgsendto(void* lpObj);
int secureblackbox_imapclient_setmsgsendto(void* lpObj, const char* lpszMsgSendTo);
QString GetMsgSendTo();
int SetMsgSendTo(QString qsMsgSendTo);

Default Value

""

Remarks

The value of the To header field.

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

This property is not available at design time.

Data Type

String

MsgSubject Property (IMAPClient Class)

Contains the subject property of this message.

Syntax

ANSI (Cross Platform)
char* GetMsgSubject();
int SetMsgSubject(const char* lpszMsgSubject); Unicode (Windows) LPWSTR GetMsgSubject();
INT SetMsgSubject(LPCWSTR lpszMsgSubject);
char* secureblackbox_imapclient_getmsgsubject(void* lpObj);
int secureblackbox_imapclient_setmsgsubject(void* lpObj, const char* lpszMsgSubject);
QString GetMsgSubject();
int SetMsgSubject(QString qsMsgSubject);

Default Value

""

Remarks

Contains the subject field of this message.

This property is not available at design time.

Data Type

String

MsgInfoCount Property (IMAPClient Class)

The number of records in the MsgInfo arrays.

Syntax

ANSI (Cross Platform)
int GetMsgInfoCount();

Unicode (Windows)
INT GetMsgInfoCount();
int secureblackbox_imapclient_getmsginfocount(void* lpObj);
int GetMsgInfoCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

MsgInfoDate Property (IMAPClient Class)

Contains the value of the Date header property.

Syntax

ANSI (Cross Platform)
char* GetMsgInfoDate(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoDate(INT iMsgInfoIndex);
char* secureblackbox_imapclient_getmsginfodate(void* lpObj, int msginfoindex);
QString GetMsgInfoDate(int iMsgInfoIndex);

Default Value

""

Remarks

Contains the value of the Date header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

String

MsgInfoFlags Property (IMAPClient Class)

Returns the flags currently set to the mail message.

Syntax

ANSI (Cross Platform)
int GetMsgInfoFlags(int iMsgInfoIndex);

Unicode (Windows)
INT GetMsgInfoFlags(INT iMsgInfoIndex);
int secureblackbox_imapclient_getmsginfoflags(void* lpObj, int msginfoindex);
int GetMsgInfoFlags(int iMsgInfoIndex);

Default Value

0

Remarks

Returns the flags currently set to the mail message.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

Integer

MsgInfoFrom Property (IMAPClient Class)

Contains the value of the From header property.

Syntax

ANSI (Cross Platform)
char* GetMsgInfoFrom(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoFrom(INT iMsgInfoIndex);
char* secureblackbox_imapclient_getmsginfofrom(void* lpObj, int msginfoindex);
QString GetMsgInfoFrom(int iMsgInfoIndex);

Default Value

""

Remarks

Contains the value of the From header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

String

MsgInfoInternalDate Property (IMAPClient Class)

Returns the internal date of the mail message.

Syntax

ANSI (Cross Platform)
char* GetMsgInfoInternalDate(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoInternalDate(INT iMsgInfoIndex);
char* secureblackbox_imapclient_getmsginfointernaldate(void* lpObj, int msginfoindex);
QString GetMsgInfoInternalDate(int iMsgInfoIndex);

Default Value

""

Remarks

Returns the internal date of the mail message.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

String

MsgInfoPriority Property (IMAPClient Class)

Specifies the message priority.

Syntax

ANSI (Cross Platform)
int GetMsgInfoPriority(int iMsgInfoIndex);

Unicode (Windows)
INT GetMsgInfoPriority(INT iMsgInfoIndex);

Possible Values

MP_LOWEST(0), 
MP_LOW(1),
MP_NORMAL(2),
MP_HIGH(3),
MP_HIGHEST(4)
int secureblackbox_imapclient_getmsginfopriority(void* lpObj, int msginfoindex);
int GetMsgInfoPriority(int iMsgInfoIndex);

Default Value

2

Remarks

Specifies the message priority.

Available options:

mpLowest0
mpLow1
mpNormal2
mpHigh3
mpHighest4

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

Integer

MsgInfoSentTo Property (IMAPClient Class)

Contains the value of the To header property.

Syntax

ANSI (Cross Platform)
char* GetMsgInfoSentTo(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoSentTo(INT iMsgInfoIndex);
char* secureblackbox_imapclient_getmsginfosentto(void* lpObj, int msginfoindex);
QString GetMsgInfoSentTo(int iMsgInfoIndex);

Default Value

""

Remarks

Contains the value of the To header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

String

MsgInfoSize Property (IMAPClient Class)

Returns the size of the message in bytes.

Syntax

ANSI (Cross Platform)
int64 GetMsgInfoSize(int iMsgInfoIndex);

Unicode (Windows)
LONG64 GetMsgInfoSize(INT iMsgInfoIndex);
int64 secureblackbox_imapclient_getmsginfosize(void* lpObj, int msginfoindex);
qint64 GetMsgInfoSize(int iMsgInfoIndex);

Default Value

0

Remarks

Returns the size of the message in bytes.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

Long64

MsgInfoSubject Property (IMAPClient Class)

Contains the value of the Subject header property.

Syntax

ANSI (Cross Platform)
char* GetMsgInfoSubject(int iMsgInfoIndex);

Unicode (Windows)
LPWSTR GetMsgInfoSubject(INT iMsgInfoIndex);
char* secureblackbox_imapclient_getmsginfosubject(void* lpObj, int msginfoindex);
QString GetMsgInfoSubject(int iMsgInfoIndex);

Default Value

""

Remarks

Contains the value of the Subject header field.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

String

MsgInfoUID Property (IMAPClient Class)

Returns the unique ID of the mail message.

Syntax

ANSI (Cross Platform)
int GetMsgInfoUID(int iMsgInfoIndex);

Unicode (Windows)
INT GetMsgInfoUID(INT iMsgInfoIndex);
int secureblackbox_imapclient_getmsginfouid(void* lpObj, int msginfoindex);
int GetMsgInfoUID(int iMsgInfoIndex);

Default Value

0

Remarks

Returns the unique ID of the mail message.

The MsgInfoIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MsgInfoCount property.

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

Data Type

Integer

Password Property (IMAPClient Class)

The authentication password.

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* secureblackbox_imapclient_getpassword(void* lpObj);
int secureblackbox_imapclient_setpassword(void* lpObj, const char* lpszPassword);
QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

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

Data Type

String

ProxyAddress Property (IMAPClient Class)

The IP address of the proxy server.

Syntax

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress); Unicode (Windows) LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);
char* secureblackbox_imapclient_getproxyaddress(void* lpObj);
int secureblackbox_imapclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (IMAPClient Class)

The authentication type used by the proxy server.

Syntax

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); Unicode (Windows) INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

Possible Values

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_NTLM(3)
int secureblackbox_imapclient_getproxyauthentication(void* lpObj);
int secureblackbox_imapclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Default Value

0

Remarks

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

Data Type

Integer

ProxyPassword Property (IMAPClient Class)

The password to authenticate to the proxy server.

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* secureblackbox_imapclient_getproxypassword(void* lpObj);
int secureblackbox_imapclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (IMAPClient Class)

The port on the proxy server to connect to.

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int secureblackbox_imapclient_getproxyport(void* lpObj);
int secureblackbox_imapclient_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (IMAPClient Class)

The type of the proxy server.

Syntax

ANSI (Cross Platform)
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); Unicode (Windows) INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);

Possible Values

CPT_NONE(0), 
CPT_SOCKS_4(1),
CPT_SOCKS_5(2),
CPT_WEB_TUNNEL(3),
CPT_HTTP(4)
int secureblackbox_imapclient_getproxyproxytype(void* lpObj);
int secureblackbox_imapclient_setproxyproxytype(void* lpObj, int iProxyProxyType);
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Default Value

0

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

Data Type

Integer

ProxyRequestHeaders Property (IMAPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders); Unicode (Windows) LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);
char* secureblackbox_imapclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_imapclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody); Unicode (Windows) LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);
char* secureblackbox_imapclient_getproxyresponsebody(void* lpObj);
int secureblackbox_imapclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

Default Value

""

Remarks

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

Data Type

String

ProxyResponseHeaders Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders); Unicode (Windows) LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);
char* secureblackbox_imapclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_imapclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

Default Value

""

Remarks

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

Data Type

String

ProxyUseIPv6 Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6); Unicode (Windows) BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);
int secureblackbox_imapclient_getproxyuseipv6(void* lpObj);
int secureblackbox_imapclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (IMAPClient Class)

Enables or disables proxy-driven connection.

Syntax

ANSI (Cross Platform)
int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy); Unicode (Windows) BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);
int secureblackbox_imapclient_getproxyuseproxy(void* lpObj);
int secureblackbox_imapclient_setproxyuseproxy(void* lpObj, int bProxyUseProxy);
bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (IMAPClient Class)

Specifies the username credential for proxy authentication.

Syntax

ANSI (Cross Platform)
char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername); Unicode (Windows) LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);
char* secureblackbox_imapclient_getproxyusername(void* lpObj);
int secureblackbox_imapclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerCertCount Property (IMAPClient Class)

The number of records in the ServerCert arrays.

Syntax

ANSI (Cross Platform)
int GetServerCertCount();

Unicode (Windows)
INT GetServerCertCount();
int secureblackbox_imapclient_getservercertcount(void* lpObj);
int GetServerCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

ServerCertBytes Property (IMAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetServerCertBytes(int iServerCertIndex, char* &lpServerCertBytes, int &lenServerCertBytes);

Unicode (Windows)
INT GetServerCertBytes(INT iServerCertIndex, LPSTR &lpServerCertBytes, INT &lenServerCertBytes);
int secureblackbox_imapclient_getservercertbytes(void* lpObj, int servercertindex, char** lpServerCertBytes, int* lenServerCertBytes);
QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns raw certificate data in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertCAKeyID Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetServerCertCAKeyID(int iServerCertIndex, char* &lpServerCertCAKeyID, int &lenServerCertCAKeyID);

Unicode (Windows)
INT GetServerCertCAKeyID(INT iServerCertIndex, LPSTR &lpServerCertCAKeyID, INT &lenServerCertCAKeyID);
int secureblackbox_imapclient_getservercertcakeyid(void* lpObj, int servercertindex, char** lpServerCertCAKeyID, int* lenServerCertCAKeyID);
QByteArray GetServerCertCAKeyID(int iServerCertIndex);

Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertFingerprint Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetServerCertFingerprint(int iServerCertIndex, char* &lpServerCertFingerprint, int &lenServerCertFingerprint);

Unicode (Windows)
INT GetServerCertFingerprint(INT iServerCertIndex, LPSTR &lpServerCertFingerprint, INT &lenServerCertFingerprint);
int secureblackbox_imapclient_getservercertfingerprint(void* lpObj, int servercertindex, char** lpServerCertFingerprint, int* lenServerCertFingerprint);
QByteArray GetServerCertFingerprint(int iServerCertIndex);

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetServerCertHandle(int iServerCertIndex);

Unicode (Windows)
LONG64 GetServerCertHandle(INT iServerCertIndex);
int64 secureblackbox_imapclient_getservercerthandle(void* lpObj, int servercertindex);
qint64 GetServerCertHandle(int iServerCertIndex);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Long64

ServerCertIssuer Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetServerCertIssuer(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertIssuer(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertissuer(void* lpObj, int servercertindex);
QString GetServerCertIssuer(int iServerCertIndex);

Default Value

""

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertIssuerRDN Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetServerCertIssuerRDN(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertIssuerRDN(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertissuerrdn(void* lpObj, int servercertindex);
QString GetServerCertIssuerRDN(int iServerCertIndex);

Default Value

""

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertKeyAlgorithm Property (IMAPClient Class)

Specifies the public key algorithm of this certificate.

Syntax

ANSI (Cross Platform)
char* GetServerCertKeyAlgorithm(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertKeyAlgorithm(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertkeyalgorithm(void* lpObj, int servercertindex);
QString GetServerCertKeyAlgorithm(int iServerCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertKeyBits Property (IMAPClient Class)

Returns the length of the public key.

Syntax

ANSI (Cross Platform)
int GetServerCertKeyBits(int iServerCertIndex);

Unicode (Windows)
INT GetServerCertKeyBits(INT iServerCertIndex);
int secureblackbox_imapclient_getservercertkeybits(void* lpObj, int servercertindex);
int GetServerCertKeyBits(int iServerCertIndex);

Default Value

0

Remarks

Returns the length of the public key.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Integer

ServerCertKeyFingerprint Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetServerCertKeyFingerprint(int iServerCertIndex, char* &lpServerCertKeyFingerprint, int &lenServerCertKeyFingerprint);

Unicode (Windows)
INT GetServerCertKeyFingerprint(INT iServerCertIndex, LPSTR &lpServerCertKeyFingerprint, INT &lenServerCertKeyFingerprint);
int secureblackbox_imapclient_getservercertkeyfingerprint(void* lpObj, int servercertindex, char** lpServerCertKeyFingerprint, int* lenServerCertKeyFingerprint);
QByteArray GetServerCertKeyFingerprint(int iServerCertIndex);

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertKeyUsage Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetServerCertKeyUsage(int iServerCertIndex);

Unicode (Windows)
INT GetServerCertKeyUsage(INT iServerCertIndex);
int secureblackbox_imapclient_getservercertkeyusage(void* lpObj, int servercertindex);
int GetServerCertKeyUsage(int iServerCertIndex);

Default Value

0

Remarks

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Integer

ServerCertPublicKeyBytes Property (IMAPClient Class)

Contains the certificate's public key in DER format.

Syntax

ANSI (Cross Platform)
int GetServerCertPublicKeyBytes(int iServerCertIndex, char* &lpServerCertPublicKeyBytes, int &lenServerCertPublicKeyBytes);

Unicode (Windows)
INT GetServerCertPublicKeyBytes(INT iServerCertIndex, LPSTR &lpServerCertPublicKeyBytes, INT &lenServerCertPublicKeyBytes);
int secureblackbox_imapclient_getservercertpublickeybytes(void* lpObj, int servercertindex, char** lpServerCertPublicKeyBytes, int* lenServerCertPublicKeyBytes);
QByteArray GetServerCertPublicKeyBytes(int iServerCertIndex);

Remarks

Contains the certificate's public key in DER format.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertSelfSigned Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetServerCertSelfSigned(int iServerCertIndex);

Unicode (Windows)
BOOL GetServerCertSelfSigned(INT iServerCertIndex);
int secureblackbox_imapclient_getservercertselfsigned(void* lpObj, int servercertindex);
bool GetServerCertSelfSigned(int iServerCertIndex);

Default Value

FALSE

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Boolean

ServerCertSerialNumber Property (IMAPClient Class)

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
int GetServerCertSerialNumber(int iServerCertIndex, char* &lpServerCertSerialNumber, int &lenServerCertSerialNumber);

Unicode (Windows)
INT GetServerCertSerialNumber(INT iServerCertIndex, LPSTR &lpServerCertSerialNumber, INT &lenServerCertSerialNumber);
int secureblackbox_imapclient_getservercertserialnumber(void* lpObj, int servercertindex, char** lpServerCertSerialNumber, int* lenServerCertSerialNumber);
QByteArray GetServerCertSerialNumber(int iServerCertIndex);

Remarks

Returns the certificate's serial number.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertSigAlgorithm Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetServerCertSigAlgorithm(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSigAlgorithm(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertsigalgorithm(void* lpObj, int servercertindex);
QString GetServerCertSigAlgorithm(int iServerCertIndex);

Default Value

""

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertSubject Property (IMAPClient Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

ANSI (Cross Platform)
char* GetServerCertSubject(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSubject(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertsubject(void* lpObj, int servercertindex);
QString GetServerCertSubject(int iServerCertIndex);

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertSubjectKeyID Property (IMAPClient Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

ANSI (Cross Platform)
int GetServerCertSubjectKeyID(int iServerCertIndex, char* &lpServerCertSubjectKeyID, int &lenServerCertSubjectKeyID);

Unicode (Windows)
INT GetServerCertSubjectKeyID(INT iServerCertIndex, LPSTR &lpServerCertSubjectKeyID, INT &lenServerCertSubjectKeyID);
int secureblackbox_imapclient_getservercertsubjectkeyid(void* lpObj, int servercertindex, char** lpServerCertSubjectKeyID, int* lenServerCertSubjectKeyID);
QByteArray GetServerCertSubjectKeyID(int iServerCertIndex);

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

Byte Array

ServerCertSubjectRDN Property (IMAPClient Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

ANSI (Cross Platform)
char* GetServerCertSubjectRDN(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertSubjectRDN(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertsubjectrdn(void* lpObj, int servercertindex);
QString GetServerCertSubjectRDN(int iServerCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertValidFrom Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetServerCertValidFrom(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertValidFrom(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertvalidfrom(void* lpObj, int servercertindex);
QString GetServerCertValidFrom(int iServerCertIndex);

Default Value

""

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerCertValidTo Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetServerCertValidTo(int iServerCertIndex);

Unicode (Windows)
LPWSTR GetServerCertValidTo(INT iServerCertIndex);
char* secureblackbox_imapclient_getservercertvalidto(void* lpObj, int servercertindex);
QString GetServerCertValidTo(int iServerCertIndex);

Default Value

""

Remarks

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

The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.

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

Data Type

String

ServerInfoCapabilities Property (IMAPClient Class)

Returns the list of server capabilities.

Syntax

ANSI (Cross Platform)
char* GetServerInfoCapabilities();

Unicode (Windows)
LPWSTR GetServerInfoCapabilities();
char* secureblackbox_imapclient_getserverinfocapabilities(void* lpObj);
QString GetServerInfoCapabilities();

Default Value

""

Remarks

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.

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

Data Type

String

ServerInfoIdleSupported Property (IMAPClient Class)

Indicates whether the IMAP server supports the IDLE command.

Syntax

ANSI (Cross Platform)
int GetServerInfoIdleSupported();

Unicode (Windows)
BOOL GetServerInfoIdleSupported();
int secureblackbox_imapclient_getserverinfoidlesupported(void* lpObj);
bool GetServerInfoIdleSupported();

Default Value

FALSE

Remarks

Indicates whether the IMAP server supports the IDLE command.

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

Data Type

Boolean

ServerInfoLoginDisabled Property (IMAPClient Class)

Specifies whether the server forbids login.

Syntax

ANSI (Cross Platform)
int GetServerInfoLoginDisabled();

Unicode (Windows)
BOOL GetServerInfoLoginDisabled();
int secureblackbox_imapclient_getserverinfologindisabled(void* lpObj);
bool GetServerInfoLoginDisabled();

Default Value

FALSE

Remarks

Specifies whether the server forbids login.

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

Data Type

Boolean

SocketDNSMode Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); Unicode (Windows) INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);

Possible Values

DM_AUTO(0), 
DM_PLATFORM(1),
DM_OWN(2),
DM_OWN_SECURE(3)
int secureblackbox_imapclient_getsocketdnsmode(void* lpObj);
int secureblackbox_imapclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Default Value

0

Remarks

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

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

Data Type

Integer

SocketDNSPort Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); Unicode (Windows) INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);
int secureblackbox_imapclient_getsocketdnsport(void* lpObj);
int secureblackbox_imapclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (IMAPClient Class)

The timeout (in milliseconds) for each DNS query.

Syntax

ANSI (Cross Platform)
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); Unicode (Windows) INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);
int secureblackbox_imapclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_imapclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers); Unicode (Windows) LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);
char* secureblackbox_imapclient_getsocketdnsservers(void* lpObj);
int secureblackbox_imapclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

Default Value

""

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (IMAPClient Class)

The timeout (in milliseconds) for the whole resolution process.

Syntax

ANSI (Cross Platform)
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); Unicode (Windows) INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);
int secureblackbox_imapclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_imapclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); Unicode (Windows) INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);
int secureblackbox_imapclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_imapclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (IMAPClient Class)

The local network interface to bind the socket to.

Syntax

ANSI (Cross Platform)
char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress); Unicode (Windows) LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);
char* secureblackbox_imapclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_imapclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (IMAPClient Class)

The local port number to bind the socket to.

Syntax

ANSI (Cross Platform)
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); Unicode (Windows) INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);
int secureblackbox_imapclient_getsocketlocalport(void* lpObj);
int secureblackbox_imapclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); Unicode (Windows) INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);
int secureblackbox_imapclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_imapclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); Unicode (Windows) INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);
int secureblackbox_imapclient_getsockettimeout(void* lpObj);
int secureblackbox_imapclient_setsockettimeout(void* lpObj, int iSocketTimeout);
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Default Value

60000

Remarks

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

Data Type

Integer

SocketUseIPv6 Property (IMAPClient Class)

Enables or disables IP protocol version 6.

Syntax

ANSI (Cross Platform)
int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6); Unicode (Windows) BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);
int secureblackbox_imapclient_getsocketuseipv6(void* lpObj);
int secureblackbox_imapclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates); Unicode (Windows) BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);
int secureblackbox_imapclient_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_imapclient_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);

Default Value

TRUE

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (IMAPClient Class)

Selects the base configuration for the TLS settings.

Syntax

ANSI (Cross Platform)
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); Unicode (Windows) INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);

Possible Values

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
int secureblackbox_imapclient_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_imapclient_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Default Value

0

Remarks

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

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Data Type

Integer

TLSCiphersuites Property (IMAPClient Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

ANSI (Cross Platform)
char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites); Unicode (Windows) LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);
char* secureblackbox_imapclient_gettlsciphersuites(void* lpObj);
int secureblackbox_imapclient_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);

Default Value

""

Remarks

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 that allow to blanketly enable or disable all ciphersuites at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by 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

Data Type

String

TLSECCurves Property (IMAPClient Class)

Defines the elliptic curves to enable.

Syntax

ANSI (Cross Platform)
char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves); Unicode (Windows) LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);
char* secureblackbox_imapclient_gettlseccurves(void* lpObj);
int secureblackbox_imapclient_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (IMAPClient Class)

Provides access to TLS extensions.

Syntax

ANSI (Cross Platform)
char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions); Unicode (Windows) LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);
char* secureblackbox_imapclient_gettlsextensions(void* lpObj);
int secureblackbox_imapclient_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges); Unicode (Windows) BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);
int secureblackbox_imapclient_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_imapclient_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(const char* lpszTLSPreSharedIdentity); Unicode (Windows) LPWSTR GetTLSPreSharedIdentity();
INT SetTLSPreSharedIdentity(LPCWSTR lpszTLSPreSharedIdentity);
char* secureblackbox_imapclient_gettlspresharedidentity(void* lpObj);
int secureblackbox_imapclient_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedKey();
int SetTLSPreSharedKey(const char* lpszTLSPreSharedKey); Unicode (Windows) LPWSTR GetTLSPreSharedKey();
INT SetTLSPreSharedKey(LPCWSTR lpszTLSPreSharedKey);
char* secureblackbox_imapclient_gettlspresharedkey(void* lpObj);
int secureblackbox_imapclient_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(const char* lpszTLSPreSharedKeyCiphersuite); Unicode (Windows) LPWSTR GetTLSPreSharedKeyCiphersuite();
INT SetTLSPreSharedKeyCiphersuite(LPCWSTR lpszTLSPreSharedKeyCiphersuite);
char* secureblackbox_imapclient_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_imapclient_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);

Default Value

""

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (IMAPClient Class)

Selects renegotiation attack prevention mechanism.

Syntax

ANSI (Cross Platform)
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); Unicode (Windows) INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);

Possible Values

CRAPM_COMPATIBLE(0), 
CRAPM_STRICT(1),
CRAPM_AUTO(2)
int secureblackbox_imapclient_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_imapclient_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Default Value

0

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

Data Type

Integer

TLSRevocationCheck Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); Unicode (Windows) INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);

Possible Values

CRC_NONE(0), 
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
int secureblackbox_imapclient_gettlsrevocationcheck(void* lpObj);
int secureblackbox_imapclient_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Default Value

1

Remarks

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.

crcNone0No revocation checking
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2Check all provided CRL endpoints for all chain certificates.
crcAllOCSP3Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP4Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL5At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP6At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP7At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. 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 faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (IMAPClient Class)

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.

Syntax

ANSI (Cross Platform)
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); Unicode (Windows) INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);
int secureblackbox_imapclient_gettlsssloptions(void* lpObj);
int secureblackbox_imapclient_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send handshake message as large batches rather than individually

Data Type

Integer

TLSTLSMode Property (IMAPClient Class)

Specifies the TLS mode to use.

Syntax

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); Unicode (Windows) INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

Possible Values

SM_DEFAULT(0), 
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
int secureblackbox_imapclient_gettlstlsmode(void* lpObj);
int secureblackbox_imapclient_settlstlsmode(void* lpObj, int iTLSTLSMode);
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Default Value

0

Remarks

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, allow plain data.

Data Type

Integer

TLSUseExtendedMasterSecret Property (IMAPClient Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret); Unicode (Windows) BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);
int secureblackbox_imapclient_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_imapclient_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (IMAPClient Class)

Enables or disables TLS session resumption capability.

Syntax

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption); Unicode (Windows) BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);
int secureblackbox_imapclient_gettlsusesessionresumption(void* lpObj);
int secureblackbox_imapclient_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);

Default Value

FALSE

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (IMAPClient Class)

The SSL/TLS versions to enable by default.

Syntax

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions); Unicode (Windows) INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);
int secureblackbox_imapclient_gettlsversions(void* lpObj);
int secureblackbox_imapclient_settlsversions(void* lpObj, int iTLSVersions);
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Data Type

Integer

TrustedCertCount Property (IMAPClient Class)

The number of records in the TrustedCert arrays.

Syntax

ANSI (Cross Platform)
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); Unicode (Windows) INT GetTrustedCertCount();
INT SetTrustedCertCount(INT iTrustedCertCount);
int secureblackbox_imapclient_gettrustedcertcount(void* lpObj);
int secureblackbox_imapclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (IMAPClient Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetTrustedCertBytes(int iTrustedCertIndex, char* &lpTrustedCertBytes, int &lenTrustedCertBytes);

Unicode (Windows)
INT GetTrustedCertBytes(INT iTrustedCertIndex, LPSTR &lpTrustedCertBytes, INT &lenTrustedCertBytes);
int secureblackbox_imapclient_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
QByteArray GetTrustedCertBytes(int iTrustedCertIndex);

Remarks

Returns raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

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

Data Type

Byte Array

TrustedCertHandle Property (IMAPClient Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

ANSI (Cross Platform)
int64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, int64 lTrustedCertHandle); Unicode (Windows) LONG64 GetTrustedCertHandle(INT iTrustedCertIndex);
INT SetTrustedCertHandle(INT iTrustedCertIndex, LONG64 lTrustedCertHandle);
int64 secureblackbox_imapclient_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_imapclient_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);

Default Value

0

Remarks

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Long64

Username Property (IMAPClient Class)

The authentication username.

Syntax

ANSI (Cross Platform)
char* GetUsername();
int SetUsername(const char* lpszUsername); Unicode (Windows) LPWSTR GetUsername();
INT SetUsername(LPCWSTR lpszUsername);
char* secureblackbox_imapclient_getusername(void* lpObj);
int secureblackbox_imapclient_setusername(void* lpObj, const char* lpszUsername);
QString GetUsername();
int SetUsername(QString qsUsername);

Default Value

""

Remarks

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

Data Type

String

CloseMailbox Method (IMAPClient Class)

Closes the current mailbox.

Syntax

ANSI (Cross Platform)
int CloseMailbox();

Unicode (Windows)
INT CloseMailbox();
int secureblackbox_imapclient_closemailbox(void* lpObj);
int CloseMailbox();

Remarks

Use this method to close the CurrentMailbox.

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 Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_imapclient_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, 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 Class)

Establishes a connection to the IMAP server.

Syntax

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

Unicode (Windows)
INT Connect(LPCWSTR lpszAddress, INT iPort);
int secureblackbox_imapclient_connect(void* lpObj, const char* lpszAddress, int iPort);
int Connect(const QString& qsAddress, 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 Class)

Copies a message to another mailbox.

Syntax

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

Unicode (Windows)
INT CopyMessage(INT iUID, LPCWSTR lpszMailboxName);
int secureblackbox_imapclient_copymessage(void* lpObj, int iUID, const char* lpszMailboxName);
int CopyMessage(int iUID, const QString& qsMailboxName);

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 Class)

Creates a new mailbox.

Syntax

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

Unicode (Windows)
INT CreateMailbox(LPCWSTR lpszName);
int secureblackbox_imapclient_createmailbox(void* lpObj, const char* lpszName);
int CreateMailbox(const QString& qsName);

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 Class)

Deletes an existing mailbox.

Syntax

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

Unicode (Windows)
INT DeleteMailbox(LPCWSTR lpszName);
int secureblackbox_imapclient_deletemailbox(void* lpObj, const char* lpszName);
int DeleteMailbox(const QString& qsName);

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 Class)

Closes connection to the IMAP server.

Syntax

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();
int secureblackbox_imapclient_disconnect(void* lpObj);
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 Class)

Performs an additional action.

Syntax

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

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_imapclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);

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 insencitive) 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;....

ActionParametersReturned value
SearchA criteria for the SEARCH command. If the value is empty, the criteria is considered 'ALL'. For more details, see SEARCH command in RFC 3501UIDs 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.

ExamineMailbox Method (IMAPClient Class)

Selects the mailbox in read-only mode.

Syntax

ANSI (Cross Platform)
int ExamineMailbox(const char* lpszName);

Unicode (Windows)
INT ExamineMailbox(LPCWSTR lpszName);
int secureblackbox_imapclient_examinemailbox(void* lpObj, const char* lpszName);
int ExamineMailbox(const QString& qsName);

Remarks

Use this method to select the specified mailbox on the server in read-only mode. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the CurrentMailbox 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.)

GetMailboxStatus Method (IMAPClient Class)

Requests a mailbox status.

Syntax

ANSI (Cross Platform)
int GetMailboxStatus(const char* lpszName);

Unicode (Windows)
INT GetMailboxStatus(LPCWSTR lpszName);
int secureblackbox_imapclient_getmailboxstatus(void* lpObj, const char* lpszName);
int GetMailboxStatus(const QString& qsName);

Remarks

Requests the status of the specified mailbox and returns it using MailboxStatus 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.)

ListAllMessages Method (IMAPClient Class)

Queries a list of messages available in CurrentMailbox on the server.

Syntax

ANSI (Cross Platform)
int ListAllMessages();

Unicode (Windows)
INT ListAllMessages();
int secureblackbox_imapclient_listallmessages(void* lpObj);
int ListAllMessages();

Remarks

Call this method to request a list of messages available in the current 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.)

ListDeletedMessages Method (IMAPClient Class)

Queries a list of deleted messages in the current mailbox on the server.

Syntax

ANSI (Cross Platform)
int ListDeletedMessages();

Unicode (Windows)
INT ListDeletedMessages();
int secureblackbox_imapclient_listdeletedmessages(void* lpObj);
int ListDeletedMessages();

Remarks

Call this method to enumerate deleted messages (i.e. those having Deleted flag set) in CurrentMailbox.

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 Class)

Queries a list of mailboxes available on the server.

Syntax

ANSI (Cross Platform)
int ListMailboxes();

Unicode (Windows)
INT ListMailboxes();
int secureblackbox_imapclient_listmailboxes(void* lpObj);
int ListMailboxes();

Remarks

Use this method to request a list of mailboxes currently available on the server. Use the Mailboxes property to access the mailbox details.

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

ListNewMessages Method (IMAPClient Class)

Queries a list of new messages available in the current mailbox on the mail server.

Syntax

ANSI (Cross Platform)
int ListNewMessages();

Unicode (Windows)
INT ListNewMessages();
int secureblackbox_imapclient_listnewmessages(void* lpObj);
int ListNewMessages();

Remarks

Retrieves a list of new messages (i.e. those having Recent flag set and not having Seen flag set) present in CurrentMailbox.

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

ListRecentMessages Method (IMAPClient Class)

Queries a list of recent messages available in the current mailbox on the server.

Syntax

ANSI (Cross Platform)
int ListRecentMessages();

Unicode (Windows)
INT ListRecentMessages();
int secureblackbox_imapclient_listrecentmessages(void* lpObj);
int ListRecentMessages();

Remarks

Retrieves a list of recent messages (i.e. those having Recent flag set) present in CurrentMailbox.

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

ListUnseenMessages Method (IMAPClient Class)

Queries a list of unseen messages available in the current mailbox on the server.

Syntax

ANSI (Cross Platform)
int ListUnseenMessages();

Unicode (Windows)
INT ListUnseenMessages();
int secureblackbox_imapclient_listunseenmessages(void* lpObj);
int ListUnseenMessages();

Remarks

Requests a list of unseen messages (i.e. not having Seen flag set) present in CurrentMailbox.

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

MarkMessageDeleted Method (IMAPClient Class)

Sets a Deleted flag to the message.

Syntax

ANSI (Cross Platform)
int MarkMessageDeleted(int iUID);

Unicode (Windows)
INT MarkMessageDeleted(INT iUID);
int secureblackbox_imapclient_markmessagedeleted(void* lpObj, int iUID);
int MarkMessageDeleted(int iUID);

Remarks

Use this method to mark a message as deleted, then call PurgeMessages to remove all the marked messages from the server.

Error Handling (C++)

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

MarkMessageSeen Method (IMAPClient Class)

Sets a Seen flag to the message.

Syntax

ANSI (Cross Platform)
int MarkMessageSeen(int iUID);

Unicode (Windows)
INT MarkMessageSeen(INT iUID);
int secureblackbox_imapclient_markmessageseen(void* lpObj, int iUID);
int MarkMessageSeen(int iUID);

Remarks

Use this method to mark a message as seen.

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 Class)

Sends a NOOP command to the IMAP server.

Syntax

ANSI (Cross Platform)
int Ping();

Unicode (Windows)
INT Ping();
int secureblackbox_imapclient_ping(void* lpObj);
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 Class)

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

Syntax

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);
int secureblackbox_imapclient_postbytes(void* lpObj, const char* lpBytes, int lenBytes, int iFlags, const char* lpszInternalDate);
int PostBytes(QByteArray qbaBytes, int iFlags, const QString& qsInternalDate);

Remarks

Use this method to send a message stored in a byte array specified by Bytes.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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 Class)

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

Syntax

ANSI (Cross Platform)
int PostFile(const char* lpszFilename, int iFlags, const char* lpszInternalDate);

Unicode (Windows)
INT PostFile(LPCWSTR lpszFilename, INT iFlags, LPCWSTR lpszInternalDate);
int secureblackbox_imapclient_postfile(void* lpObj, const char* lpszFilename, int iFlags, const char* lpszInternalDate);
int PostFile(const QString& qsFilename, int iFlags, const QString& qsInternalDate);

Remarks

Use this method to upload an e-mail message stored in a file to CurrentMailbox.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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 Class)

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

Syntax

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

Unicode (Windows)
INT PostMessage(INT iFlags, LPCWSTR lpszInternalDate);
int secureblackbox_imapclient_postmessage(void* lpObj, int iFlags, const char* lpszInternalDate);
int PostMessage(int iFlags, const QString& qsInternalDate);

Remarks

Use this message to upload Message to CurrentMailbox.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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 Class)

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

Syntax

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

Unicode (Windows)
INT PostStream(SecureBlackboxStream* sStream, INT iFlags, LPCWSTR lpszInternalDate);
int secureblackbox_imapclient_poststream(void* lpObj, SecureBlackboxStream* sStream, int iFlags, const char* lpszInternalDate);
int PostStream(SecureBlackboxStream* sStream, int iFlags, const QString& qsInternalDate);

Remarks

Use this message to upload a message provided in Stream to CurrentMailbox.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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 Class)

Permanently removes all deleted messages from the current mailbox.

Syntax

ANSI (Cross Platform)
int PurgeMessages();

Unicode (Windows)
INT PurgeMessages();
int secureblackbox_imapclient_purgemessages(void* lpObj);
int PurgeMessages();

Remarks

Use this method to permanently remove all messages in CurrentMailbox 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 Class)

Downloads a message to a byte array.

Syntax

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

Unicode (Windows)
LPSTR ReceiveBytes(INT iUID, LPINT lpSize = NULL);
char* secureblackbox_imapclient_receivebytes(void* lpObj, int iUID, int *lpSize);
QByteArray ReceiveBytes(int iUID);

Remarks

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

Error Handling (C++)

This method returns a Binary String 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 Class)

Downloads a message to a file.

Syntax

ANSI (Cross Platform)
int ReceiveFile(int iUID, const char* lpszFilename);

Unicode (Windows)
INT ReceiveFile(INT iUID, LPCWSTR lpszFilename);
int secureblackbox_imapclient_receivefile(void* lpObj, int iUID, const char* lpszFilename);
int ReceiveFile(int iUID, const QString& qsFilename);

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 Class)

Downloads a message.

Syntax

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

Unicode (Windows)
INT ReceiveMessage(INT iUID);
int secureblackbox_imapclient_receivemessage(void* lpObj, int iUID);
int ReceiveMessage(int iUID);

Remarks

Use this method to download a server-side message to the Message 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 Class)

Downloads a message to a stream.

Syntax

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

Unicode (Windows)
INT ReceiveStream(INT iUID, SecureBlackboxStream* sStream);
int secureblackbox_imapclient_receivestream(void* lpObj, int iUID, SecureBlackboxStream* sStream);
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 Class)

Refreshes the state info of the current mailbox.

Syntax

ANSI (Cross Platform)
int RefreshMailbox();

Unicode (Windows)
INT RefreshMailbox();
int secureblackbox_imapclient_refreshmailbox(void* lpObj);
int RefreshMailbox();

Remarks

Use this method to refresh the CurrentMailbox info.

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 Class)

Renames an existing mailbox.

Syntax

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

Unicode (Windows)
INT RenameMailbox(LPCWSTR lpszName, LPCWSTR lpszNewName);
int secureblackbox_imapclient_renamemailbox(void* lpObj, const char* lpszName, const char* lpszNewName);
int RenameMailbox(const QString& qsName, const QString& qsNewName);

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

SelectMailbox Method (IMAPClient Class)

Selects the specified mailbox.

Syntax

ANSI (Cross Platform)
int SelectMailbox(const char* lpszName);

Unicode (Windows)
INT SelectMailbox(LPCWSTR lpszName);
int secureblackbox_imapclient_selectmailbox(void* lpObj, const char* lpszName);
int SelectMailbox(const QString& qsName);

Remarks

Use this method to 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 CurrentMailbox 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.)

UpdateMessage Method (IMAPClient Class)

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

Syntax

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

Unicode (Windows)
INT UpdateMessage(INT iUID, INT iSetFlags, INT iClearFlags);
int secureblackbox_imapclient_updatemessage(void* lpObj, int iUID, int iSetFlags, int iClearFlags);
int UpdateMessage(int iUID, int iSetFlags, int iClearFlags);

Remarks

Use this method to alter flags associated with a UID message in CurrentMailbox.

Supported flags are:

imapMessageAnswered0x01Message has been answered.

imapMessageDeleted0x02Message is 'deleted' for removal later.

imapMessageDraft0x04Message has not completed composition (marked as a draft).

imapMessageFlagged0x08Message is 'flagged' for urgent/special attention.

imapMessageRecent0x10Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.

imapMessageSeen0x20Message has been read.

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

BeforeAuth Event (IMAPClient Class)

Fires before the authentication starts.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeAuth(IMAPClientBeforeAuthEventParams *e);
typedef struct { int reserved; } IMAPClientBeforeAuthEventParams;
Unicode (Windows) virtual INT FireBeforeAuth(IMAPClientBeforeAuthEventParams *e);
typedef struct { INT reserved; } IMAPClientBeforeAuthEventParams;
#define EID_IMAPCLIENT_BEFOREAUTH 1

virtual INT SECUREBLACKBOX_CALL FireBeforeAuth();
class IMAPClientBeforeAuthEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void BeforeAuth(IMAPClientBeforeAuthEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireBeforeAuth(IMAPClientBeforeAuthEventParams *e) {...}

Remarks

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

Command Event (IMAPClient Class)

Reports a command sent to the server.

Syntax

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;
#define EID_IMAPCLIENT_COMMAND 2

virtual INT SECUREBLACKBOX_CALL FireCommand(LPSTR &lpszCmd);
class IMAPClientCommandEventParams {
public:
  const QString &Cmd();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Command(IMAPClientCommandEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommand(IMAPClientCommandEventParams *e) {...}

Remarks

The class fires this event whenever it sends an IMAP command to the server. Use CommandReply and CommandReplyData to track the server's responses.

CommandData Event (IMAPClient Class)

Returns the data that accompanies the command.

Syntax

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;
#define EID_IMAPCLIENT_COMMANDDATA 3

virtual INT SECUREBLACKBOX_CALL FireCommandData(LPSTR &lpszCmd, LPSTR &lpszData);
class IMAPClientCommandDataEventParams {
public:
  const QString &Cmd();

  const QString &Data();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CommandData(IMAPClientCommandDataEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommandData(IMAPClientCommandDataEventParams *e) {...}

Remarks

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

CommandReply Event (IMAPClient Class)

Reports the receipt of a reply to a command.

Syntax

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;
#define EID_IMAPCLIENT_COMMANDREPLY 4

virtual INT SECUREBLACKBOX_CALL FireCommandReply(LPSTR &lpszCmd, LPSTR &lpszReply);
class IMAPClientCommandReplyEventParams {
public:
  const QString &Cmd();

  const QString &Reply();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CommandReply(IMAPClientCommandReplyEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommandReply(IMAPClientCommandReplyEventParams *e) {...}

Remarks

Use this event to track command replies sent in by the server. Use Command to track the commands sent out by the client, and CommandReplyData to access the reply data for commands that assume it.

CommandReplyData Event (IMAPClient Class)

Returns the data that accompanies a reply to a command.

Syntax

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;
#define EID_IMAPCLIENT_COMMANDREPLYDATA 5

virtual INT SECUREBLACKBOX_CALL FireCommandReplyData(LPSTR &lpszCmd, LPSTR &lpszData);
class IMAPClientCommandReplyDataEventParams {
public:
  const QString &Cmd();

  const QString &Data();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void CommandReplyData(IMAPClientCommandReplyDataEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireCommandReplyData(IMAPClientCommandReplyDataEventParams *e) {...}

Remarks

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

Error Event (IMAPClient Class)

Provides information about errors during SMTP operations.

Syntax

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;
#define EID_IMAPCLIENT_ERROR 6

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class IMAPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(IMAPClientErrorEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireError(IMAPClientErrorEventParams *e) {...}

Remarks

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

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

MailboxStatus Event (IMAPClient Class)

Reports the mailbox status returned from the server.

Syntax

ANSI (Cross Platform)
virtual int FireMailboxStatus(IMAPClientMailboxStatusEventParams *e);
typedef struct {
const char *Name;
int TotalMessages;
int RecentMessages;
int UnseenMessages;
int NextUID;
int UIDValidity; int reserved; } IMAPClientMailboxStatusEventParams;
Unicode (Windows) virtual INT FireMailboxStatus(IMAPClientMailboxStatusEventParams *e);
typedef struct {
LPCWSTR Name;
INT TotalMessages;
INT RecentMessages;
INT UnseenMessages;
INT NextUID;
INT UIDValidity; INT reserved; } IMAPClientMailboxStatusEventParams;
#define EID_IMAPCLIENT_MAILBOXSTATUS 7

virtual INT SECUREBLACKBOX_CALL FireMailboxStatus(LPSTR &lpszName, INT &iTotalMessages, INT &iRecentMessages, INT &iUnseenMessages, INT &iNextUID, INT &iUIDValidity);
class IMAPClientMailboxStatusEventParams {
public:
  const QString &Name();

  int TotalMessages();

  int RecentMessages();

  int UnseenMessages();

  int NextUID();

  int UIDValidity();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void MailboxStatus(IMAPClientMailboxStatusEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireMailboxStatus(IMAPClientMailboxStatusEventParams *e) {...}

Remarks

Subscribe to this event to be notified of mailbox status as returned by the IMAP server.

Notification Event (IMAPClient Class)

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

Syntax

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;
#define EID_IMAPCLIENT_NOTIFICATION 8

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class IMAPClientNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Notification(IMAPClientNotificationEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireNotification(IMAPClientNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

EventIDEventParam
MessageAddedNumber of messages in the current mailbox.
MessageDeletedUID of the deleted message if the message is in the current message list.
MessageUpdatedUID of the updated message if the message is in the current message list.

Progress Event (IMAPClient Class)

Reports the progress of the data transfer operation.

Syntax

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;
#define EID_IMAPCLIENT_PROGRESS 9

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);
class IMAPClientProgressEventParams {
public:
  qint64 Total();

  qint64 Current();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Progress(IMAPClientProgressEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireProgress(IMAPClientProgressEventParams *e) {...}

Remarks

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

TLSCertNeeded Event (IMAPClient Class)

Fires when a remote TLS party requests a client certificate.

Syntax

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;
#define EID_IMAPCLIENT_TLSCERTNEEDED 10

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class IMAPClientTLSCertNeededEventParams {
public:
  const QString &Host();

  const QString &CANames();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSCertNeeded(IMAPClientTLSCertNeededEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSCertNeeded(IMAPClientTLSCertNeededEventParams *e) {...}

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 (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain 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 event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (IMAPClient Class)

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

Syntax

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;
#define EID_IMAPCLIENT_TLSCERTVALIDATE 11

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class IMAPClientTLSCertValidateEventParams {
public:
  const QString &ServerHost();

  const QString &ServerIP();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSCertValidate(IMAPClientTLSCertValidateEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSCertValidate(IMAPClientTLSCertValidateEventParams *e) {...}

Remarks

This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components 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 component, and can be adjusted if needed.

TLSEstablished Event (IMAPClient Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

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;
#define EID_IMAPCLIENT_TLSESTABLISHED 12

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class IMAPClientTLSEstablishedEventParams {
public:
  const QString &Host();

  const QString &Version();

  const QString &Ciphersuite();

  const QByteArray &ConnectionId();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSEstablished(IMAPClientTLSEstablishedEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSEstablished(IMAPClientTLSEstablishedEventParams *e) {...}

Remarks

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

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

TLSHandshake Event (IMAPClient Class)

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

Syntax

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;
#define EID_IMAPCLIENT_TLSHANDSHAKE 13

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class IMAPClientTLSHandshakeEventParams {
public:
  const QString &Host();

  bool Abort();
  void SetAbort(bool bAbort);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSHandshake(IMAPClientTLSHandshakeEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSHandshake(IMAPClientTLSHandshakeEventParams *e) {...}

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 with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.

TLSPSK Event (IMAPClient Class)

Notifies the application about the PSK key exchange.

Syntax

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;
#define EID_IMAPCLIENT_TLSPSK 14

virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LPSTR &lpszHost, LPSTR &lpszHint);
class IMAPClientTLSPSKEventParams {
public:
  const QString &Host();

  const QString &Hint();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSPSK(IMAPClientTLSPSKEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSPSK(IMAPClientTLSPSKEventParams *e) {...}

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 to provide the pre-shared key to the component.

TLSShutdown Event (IMAPClient Class)

Reports the graceful closure of a TLS connection.

Syntax

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;
#define EID_IMAPCLIENT_TLSSHUTDOWN 15

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class IMAPClientTLSShutdownEventParams {
public:
  const QString &Host();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TLSShutdown(IMAPClientTLSShutdownEventParams *e);
// Or, subclass IMAPClient and override this emitter function. virtual int FireTLSShutdown(IMAPClientTLSShutdownEventParams *e) {...}

Remarks

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

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.

Properties

CanRead Whether the stream supports reading.

bool CanRead() { return true; }
CanSeek Whether the stream supports seeking.

bool CanSeek() { return true; }
CanWrite Whether the stream supports writing.

bool CanWrite() { return true; }
Length Gets the length of the stream, in bytes.

int64 GetLength() = 0;

Methods

Close Closes the stream, releasing all resources currently allocated for it.

void Close() {}

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.

int Flush() { return 0; }

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.

int Read(void* buffer, int count) = 0;

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.

int64 Seek(int64 offset, int seekOrigin) = 0;

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.

int Write(const void* buffer, int count) = 0;

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 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 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: PLAIN, LOGIN, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2, SCRAM-SHA-1, SCRAM-SHA-256

Default value: PLAIN,DIGEST-MD5,CRAM-MD5,NTLM

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 component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.

If 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 TrustedCertificates 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

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

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.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

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
  • 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
UseMicrosoftCTL:   Enables or disables automatic use of 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 chain validation module 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

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:

offNo caching (default)
localLocal caching
globalGlobal 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.

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.

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

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.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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 devided 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 chached 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).

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.

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.

Trappable Errors (IMAPClient 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 value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)