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.

Downloading only the recent messages to local files IMAPClient client = new IMAPClient(); client.Username= "user"; client.Password= "password"; client.Connect("mail.domain.com", 993); client.OpenMailbox("INBOX", true); client.ListMessages(Constants.imapMessageRecent, 0); foreach (IMAPMessageInfo info in client.Messages) client.ReceiveFile(info.UID, $"path\\{info.UID}.eml"); client.Disconnect();

Use Command and CommandReply events to get a session log. IMAPClient client = new IMAPClient(); client.OnCommand += (s, e) => { Console.WriteLine($"C: {e.Cmd}"); }; client.OnCommandReply += (s, e) => { Console.WriteLine($"S: {e.Reply}"); };

Property List

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


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

Method List

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


CloseMailbox	Closes the current mailbox.
Config	Sets or retrieves a configuration setting.
Connect	Establishes a connection to the IMAP server.
CopyMessage	Copies a message to another mailbox.
CreateMailbox	Creates a new mailbox.
DeleteMailbox	Deletes an existing mailbox.
Disconnect	Closes connection to the IMAP server.
DoAction	Performs an additional action.
GetMailboxInfo	Requests mailbox status.
ListMailboxes	Queries a list of mailboxes available on the server.
ListMessages	Queries a list of messages available in the currently selected on the server.
OpenMailbox	Opens the specified mailbox.
Ping	Sends a NOOP command to the IMAP server.
PostBytes	Uploads an e-mail message stored in a byte array.
PostFile	Uploads a message stored in a file to the current mailbox on the IMAP server.
PostMessage	Uploads a pre-built message to the current mailbox on the IMAP server.
PostStream	Uploads a message stored in a stream to the current mailbox on the IMAP server.
PurgeMessages	Permanently removes all deleted messages from the current mailbox.
ReceiveBytes	Downloads a message to a byte array.
ReceiveFile	Downloads a message to a file.
ReceiveMessage	Downloads a message.
ReceiveStream	Downloads a message to a stream.
RefreshMailbox	Refreshes info about the currently selected mailbox.
RenameMailbox	Renames an existing mailbox.
Reset	Resets the class settings.
UpdateMessage	Alters 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.


AuthFailed	Fires when an authentication attempt has failed.
AuthStart	Fires when the authentication is about to be started.
AuthSucceeded	Fires when the authentication has succeeded.
Command	Reports a command sent to the server.
CommandData	Returns the data that accompanies the command.
CommandReply	Reports the receipt of a reply to a command.
CommandReplyData	Returns the data that accompanies a reply to a command.
Error	Provides information about errors during SMTP operations.
MailboxFound	Provides mailbox details.
MailboxInfo	Reports mailbox information returned from the server.
Notification	This event notifies the application about an underlying control flow event.
Progress	Reports the progress of the data transfer operation.
TLSCertNeeded	Fires when a remote TLS party requests a client certificate.
TLSCertValidate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablished	Fires when a TLS handshake with Host successfully completes.
TLSHandshake	Fires when a new TLS handshake is initiated, before the handshake commences.
TLSPSK	Notifies the application about the PSK key exchange.
TLSShutdown	Reports the graceful closure of a TLS connection.

Config Settings

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


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

AccessToken Property (IMAPClient Class)

An OAuth 2.0 access token to authenticate to the server.

Syntax

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

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

char* secureblackbox_imapclient_getaccesstoken(void* lpObj);
int secureblackbox_imapclient_setaccesstoken(void* lpObj, const char* lpszAccessToken);

QString GetAccessToken();
int SetAccessToken(QString qsAccessToken);

Default Value

Remarks

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

Data Type

String

BlockedCertificates Property (IMAPClient Class)

The certificates that must be rejected as trust anchors.

Syntax

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

int secureblackbox_imapclient_getblockedcertcount(void* lpObj);
int secureblackbox_imapclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);

int secureblackbox_imapclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);

int64 secureblackbox_imapclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_imapclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);

Remarks

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

This property is not available at design time.

Data Type

SecureBlackboxCertificate

ConnectionInfo Property (IMAPClient Class)

Returns the details of the underlying network connection.

Syntax

SecureBlackboxTLSConnectionInfo* GetConnectionInfo();

int secureblackbox_imapclient_getconninfoaeadcipher(void* lpObj);

int secureblackbox_imapclient_getconninfochainvalidationdetails(void* lpObj);

int secureblackbox_imapclient_getconninfochainvalidationresult(void* lpObj);

char* secureblackbox_imapclient_getconninfociphersuite(void* lpObj);

int secureblackbox_imapclient_getconninfoclientauthenticated(void* lpObj);

int secureblackbox_imapclient_getconninfoclientauthrequested(void* lpObj);

int secureblackbox_imapclient_getconninfoconnectionestablished(void* lpObj);

int secureblackbox_imapclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);

char* secureblackbox_imapclient_getconninfodigestalgorithm(void* lpObj);

char* secureblackbox_imapclient_getconninfoencryptionalgorithm(void* lpObj);

int secureblackbox_imapclient_getconninfoexportable(void* lpObj);

int64 secureblackbox_imapclient_getconninfoid(void* lpObj);

char* secureblackbox_imapclient_getconninfokeyexchangealgorithm(void* lpObj);

int secureblackbox_imapclient_getconninfokeyexchangekeybits(void* lpObj);

char* secureblackbox_imapclient_getconninfonamedeccurve(void* lpObj);

int secureblackbox_imapclient_getconninfopfscipher(void* lpObj);

char* secureblackbox_imapclient_getconninfopresharedidentity(void* lpObj);

char* secureblackbox_imapclient_getconninfopresharedidentityhint(void* lpObj);

int secureblackbox_imapclient_getconninfopublickeybits(void* lpObj);

char* secureblackbox_imapclient_getconninforemoteaddress(void* lpObj);

int secureblackbox_imapclient_getconninforemoteport(void* lpObj);

int secureblackbox_imapclient_getconninforesumedsession(void* lpObj);

int secureblackbox_imapclient_getconninfosecureconnection(void* lpObj);

int secureblackbox_imapclient_getconninfoserverauthenticated(void* lpObj);

char* secureblackbox_imapclient_getconninfosignaturealgorithm(void* lpObj);

int secureblackbox_imapclient_getconninfosymmetricblocksize(void* lpObj);

int secureblackbox_imapclient_getconninfosymmetrickeybits(void* lpObj);

int64 secureblackbox_imapclient_getconninfototalbytesreceived(void* lpObj);

int64 secureblackbox_imapclient_getconninfototalbytessent(void* lpObj);

char* secureblackbox_imapclient_getconninfovalidationlog(void* lpObj);

char* secureblackbox_imapclient_getconninfoversion(void* lpObj);

bool GetConnInfoAEADCipher();

int GetConnInfoChainValidationDetails();

int GetConnInfoChainValidationResult();

QString GetConnInfoCiphersuite();

bool GetConnInfoClientAuthenticated();

bool GetConnInfoClientAuthRequested();

bool GetConnInfoConnectionEstablished();

QByteArray GetConnInfoConnectionID();

QString GetConnInfoDigestAlgorithm();

QString GetConnInfoEncryptionAlgorithm();

bool GetConnInfoExportable();

qint64 GetConnInfoID();

QString GetConnInfoKeyExchangeAlgorithm();

int GetConnInfoKeyExchangeKeyBits();

QString GetConnInfoNamedECCurve();

bool GetConnInfoPFSCipher();

QString GetConnInfoPreSharedIdentity();

QString GetConnInfoPreSharedIdentityHint();

int GetConnInfoPublicKeyBits();

QString GetConnInfoRemoteAddress();

int GetConnInfoRemotePort();

bool GetConnInfoResumedSession();

bool GetConnInfoSecureConnection();

bool GetConnInfoServerAuthenticated();

QString GetConnInfoSignatureAlgorithm();

int GetConnInfoSymmetricBlockSize();

int GetConnInfoSymmetricKeyBits();

qint64 GetConnInfoTotalBytesReceived();

qint64 GetConnInfoTotalBytesSent();

QString GetConnInfoValidationLog();

QString GetConnInfoVersion();

Remarks

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

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

Data Type

SecureBlackboxTLSConnectionInfo

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

KnownCertificates Property (IMAPClient Class)

Additional certificates for chain validation.

Syntax

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

int secureblackbox_imapclient_getknowncertcount(void* lpObj);
int secureblackbox_imapclient_setknowncertcount(void* lpObj, int iKnownCertCount);

int secureblackbox_imapclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);

int64 secureblackbox_imapclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_imapclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

QByteArray GetKnownCertBytes(int iKnownCertIndex);

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Remarks

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

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

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

KnownCRLs Property (IMAPClient Class)

Additional CRLs for chain validation.

Syntax

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

int secureblackbox_imapclient_getknowncrlcount(void* lpObj);
int secureblackbox_imapclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);

int secureblackbox_imapclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);

int64 secureblackbox_imapclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_imapclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);

int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);

Remarks

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

This property is not available at design time.

Data Type

SecureBlackboxCRL

KnownOCSPs Property (IMAPClient Class)

Additional OCSP responses for chain validation.

Syntax

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

int secureblackbox_imapclient_getknownocspcount(void* lpObj);
int secureblackbox_imapclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);

int secureblackbox_imapclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);

int64 secureblackbox_imapclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_imapclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);

int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);

Remarks

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

This property is not available at design time.

Data Type

SecureBlackboxOCSPResponse

Mailbox Property (IMAPClient Class)

Returns the selected (active) mailbox info.

Syntax

SecureBlackboxIMAPMailboxInfo* GetMailbox();

int secureblackbox_imapclient_getmailboxmessageflags(void* lpObj);

char* secureblackbox_imapclient_getmailboxname(void* lpObj);

int secureblackbox_imapclient_getmailboxnextuid(void* lpObj);

int secureblackbox_imapclient_getmailboxpermanentflags(void* lpObj);

int secureblackbox_imapclient_getmailboxreadonly(void* lpObj);

int secureblackbox_imapclient_getmailboxrecentmessages(void* lpObj);

int secureblackbox_imapclient_getmailboxtotalmessages(void* lpObj);

int secureblackbox_imapclient_getmailboxuidvalidity(void* lpObj);

int secureblackbox_imapclient_getmailboxunseenmessages(void* lpObj);

int GetMailboxMessageFlags();

QString GetMailboxName();

int GetMailboxNextUID();

int GetMailboxPermanentFlags();

bool GetMailboxReadOnly();

int GetMailboxRecentMessages();

int GetMailboxTotalMessages();

int GetMailboxUIDValidity();

int GetMailboxUnseenMessages();

Remarks

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

To update information in this property call RefreshMailbox.

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

Data Type

SecureBlackboxIMAPMailboxInfo

Message Property (IMAPClient Class)

Contains a pinned e-mail message.

Syntax

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

int secureblackbox_imapclient_getmsgattachmentcount(void* lpObj);

char* secureblackbox_imapclient_getmsgbcc(void* lpObj);
int secureblackbox_imapclient_setmsgbcc(void* lpObj, const char* lpszMsgBcc);

char* secureblackbox_imapclient_getmsgcc(void* lpObj);
int secureblackbox_imapclient_setmsgcc(void* lpObj, const char* lpszMsgCc);

char* secureblackbox_imapclient_getmsgcomments(void* lpObj);
int secureblackbox_imapclient_setmsgcomments(void* lpObj, const char* lpszMsgComments);

char* secureblackbox_imapclient_getmsgdate(void* lpObj);
int secureblackbox_imapclient_setmsgdate(void* lpObj, const char* lpszMsgDate);

int secureblackbox_imapclient_getmsgdeliveryreceipt(void* lpObj);
int secureblackbox_imapclient_setmsgdeliveryreceipt(void* lpObj, int bMsgDeliveryReceipt);

char* secureblackbox_imapclient_getmsgfrom(void* lpObj);
int secureblackbox_imapclient_setmsgfrom(void* lpObj, const char* lpszMsgFrom);

int64 secureblackbox_imapclient_getmsghandle(void* lpObj);
int secureblackbox_imapclient_setmsghandle(void* lpObj, int64 lMsgHandle);

char* secureblackbox_imapclient_getmsghtmltext(void* lpObj);
int secureblackbox_imapclient_setmsghtmltext(void* lpObj, const char* lpszMsgHtmlText);

char* secureblackbox_imapclient_getmsgid(void* lpObj);
int secureblackbox_imapclient_setmsgid(void* lpObj, const char* lpszMsgID);

char* secureblackbox_imapclient_getmsginreplyto(void* lpObj);
int secureblackbox_imapclient_setmsginreplyto(void* lpObj, const char* lpszMsgInReplyTo);

char* secureblackbox_imapclient_getmsgkeywords(void* lpObj);
int secureblackbox_imapclient_setmsgkeywords(void* lpObj, const char* lpszMsgKeywords);

char* secureblackbox_imapclient_getmsgmailer(void* lpObj);

char* secureblackbox_imapclient_getmsgplaintext(void* lpObj);
int secureblackbox_imapclient_setmsgplaintext(void* lpObj, const char* lpszMsgPlainText);

int secureblackbox_imapclient_getmsgpriority(void* lpObj);
int secureblackbox_imapclient_setmsgpriority(void* lpObj, int iMsgPriority);

int secureblackbox_imapclient_getmsgreadreceipt(void* lpObj);
int secureblackbox_imapclient_setmsgreadreceipt(void* lpObj, int bMsgReadReceipt);

char* secureblackbox_imapclient_getmsgreferences(void* lpObj);
int secureblackbox_imapclient_setmsgreferences(void* lpObj, const char* lpszMsgReferences);

char* secureblackbox_imapclient_getmsgreplyto(void* lpObj);
int secureblackbox_imapclient_setmsgreplyto(void* lpObj, const char* lpszMsgReplyTo);

char* secureblackbox_imapclient_getmsgreturnpath(void* lpObj);
int secureblackbox_imapclient_setmsgreturnpath(void* lpObj, const char* lpszMsgReturnPath);

char* secureblackbox_imapclient_getmsgsender(void* lpObj);
int secureblackbox_imapclient_setmsgsender(void* lpObj, const char* lpszMsgSender);

char* secureblackbox_imapclient_getmsgsendto(void* lpObj);
int secureblackbox_imapclient_setmsgsendto(void* lpObj, const char* lpszMsgSendTo);

char* secureblackbox_imapclient_getmsgsubject(void* lpObj);
int secureblackbox_imapclient_setmsgsubject(void* lpObj, const char* lpszMsgSubject);

int GetMsgAttachmentCount();

QString GetMsgBcc();
int SetMsgBcc(QString qsMsgBcc);

QString GetMsgCc();
int SetMsgCc(QString qsMsgCc);

QString GetMsgComments();
int SetMsgComments(QString qsMsgComments);

QString GetMsgDate();
int SetMsgDate(QString qsMsgDate);

bool GetMsgDeliveryReceipt();
int SetMsgDeliveryReceipt(bool bMsgDeliveryReceipt);

QString GetMsgFrom();
int SetMsgFrom(QString qsMsgFrom);

qint64 GetMsgHandle();
int SetMsgHandle(qint64 lMsgHandle);

QString GetMsgHtmlText();
int SetMsgHtmlText(QString qsMsgHtmlText);

QString GetMsgID();
int SetMsgID(QString qsMsgID);

QString GetMsgInReplyTo();
int SetMsgInReplyTo(QString qsMsgInReplyTo);

QString GetMsgKeywords();
int SetMsgKeywords(QString qsMsgKeywords);

QString GetMsgMailer();

QString GetMsgPlainText();
int SetMsgPlainText(QString qsMsgPlainText);

int GetMsgPriority();
int SetMsgPriority(int iMsgPriority);

bool GetMsgReadReceipt();
int SetMsgReadReceipt(bool bMsgReadReceipt);

QString GetMsgReferences();
int SetMsgReferences(QString qsMsgReferences);

QString GetMsgReplyTo();
int SetMsgReplyTo(QString qsMsgReplyTo);

QString GetMsgReturnPath();
int SetMsgReturnPath(QString qsMsgReturnPath);

QString GetMsgSender();
int SetMsgSender(QString qsMsgSender);

QString GetMsgSendTo();
int SetMsgSendTo(QString qsMsgSendTo);

QString GetMsgSubject();
int SetMsgSubject(QString qsMsgSubject);

Remarks

Use this property to access an e-mail message that was just downloaded with a ReceiveMessage call, or assign it with a message to be uploaded with PostMessage call.

This property is not available at design time.

Data Type

SecureBlackboxMailMessage

Messages Property (IMAPClient Class)

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

Syntax

SecureBlackboxList<SecureBlackboxIMAPMessageInfo>* GetMessages();

int secureblackbox_imapclient_getmsginfocount(void* lpObj);

char* secureblackbox_imapclient_getmsginfodate(void* lpObj, int msginfoindex);

int secureblackbox_imapclient_getmsginfoflags(void* lpObj, int msginfoindex);

char* secureblackbox_imapclient_getmsginfofrom(void* lpObj, int msginfoindex);

char* secureblackbox_imapclient_getmsginfointernaldate(void* lpObj, int msginfoindex);

int secureblackbox_imapclient_getmsginfopriority(void* lpObj, int msginfoindex);

char* secureblackbox_imapclient_getmsginfosentto(void* lpObj, int msginfoindex);

int64 secureblackbox_imapclient_getmsginfosize(void* lpObj, int msginfoindex);

char* secureblackbox_imapclient_getmsginfosubject(void* lpObj, int msginfoindex);

int secureblackbox_imapclient_getmsginfouid(void* lpObj, int msginfoindex);

int GetMsgInfoCount();

QString GetMsgInfoDate(int iMsgInfoIndex);

int GetMsgInfoFlags(int iMsgInfoIndex);

QString GetMsgInfoFrom(int iMsgInfoIndex);

QString GetMsgInfoInternalDate(int iMsgInfoIndex);

int GetMsgInfoPriority(int iMsgInfoIndex);

QString GetMsgInfoSentTo(int iMsgInfoIndex);

qint64 GetMsgInfoSize(int iMsgInfoIndex);

QString GetMsgInfoSubject(int iMsgInfoIndex);

int GetMsgInfoUID(int iMsgInfoIndex);

Remarks

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

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

Data Type

SecureBlackboxIMAPMessageInfo

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.

In order to use OAuth 2.0 authentication to access the IMAP server, use the AccessToken property instead.

Data Type

String

Proxy Property (IMAPClient Class)

The proxy server settings.

Syntax

SecureBlackboxProxySettings* GetProxy();

char* secureblackbox_imapclient_getproxyaddress(void* lpObj);
int secureblackbox_imapclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

int secureblackbox_imapclient_getproxyauthentication(void* lpObj);
int secureblackbox_imapclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);

char* secureblackbox_imapclient_getproxypassword(void* lpObj);
int secureblackbox_imapclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int secureblackbox_imapclient_getproxyport(void* lpObj);
int secureblackbox_imapclient_setproxyport(void* lpObj, int iProxyPort);

int secureblackbox_imapclient_getproxyproxytype(void* lpObj);
int secureblackbox_imapclient_setproxyproxytype(void* lpObj, int iProxyProxyType);

char* secureblackbox_imapclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_imapclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

char* secureblackbox_imapclient_getproxyresponsebody(void* lpObj);
int secureblackbox_imapclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

char* secureblackbox_imapclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_imapclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

int secureblackbox_imapclient_getproxyuseipv6(void* lpObj);
int secureblackbox_imapclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

char* secureblackbox_imapclient_getproxyusername(void* lpObj);
int secureblackbox_imapclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);

QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

Data Type

SecureBlackboxProxySettings

ServerInfo Property (IMAPClient Class)

Encapsulates information about the server.

Syntax

SecureBlackboxIMAPServerInfo* GetServerInfo();

char* secureblackbox_imapclient_getserverinfocapabilities(void* lpObj);

int64 secureblackbox_imapclient_getserverinfofeatures(void* lpObj);

char* secureblackbox_imapclient_getserverinfosupportedauths(void* lpObj);

QString GetServerInfoCapabilities();

qint64 GetServerInfoFeatures();

QString GetServerInfoSupportedAuths();

Remarks

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

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

Data Type

SecureBlackboxIMAPServerInfo

SessionLog Property (IMAPClient Class)

Contains the complete log of the last session.

Syntax

ANSI (Cross Platform)
char* GetSessionLog();

Unicode (Windows)
LPWSTR GetSessionLog();

char* secureblackbox_imapclient_getsessionlog(void* lpObj);

QString GetSessionLog();

Default Value

Remarks

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

See the SessionLogDetails config property for the log details settings.

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

Data Type

String

SocketSettings Property (IMAPClient Class)

Manages network connection settings.

Syntax

SecureBlackboxSocketSettings* GetSocketSettings();

int secureblackbox_imapclient_getsocketdnsmode(void* lpObj);
int secureblackbox_imapclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

int secureblackbox_imapclient_getsocketdnsport(void* lpObj);
int secureblackbox_imapclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);

int secureblackbox_imapclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_imapclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

char* secureblackbox_imapclient_getsocketdnsservers(void* lpObj);
int secureblackbox_imapclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

int secureblackbox_imapclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_imapclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

int secureblackbox_imapclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_imapclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

char* secureblackbox_imapclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_imapclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

int secureblackbox_imapclient_getsocketlocalport(void* lpObj);
int secureblackbox_imapclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);

int secureblackbox_imapclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_imapclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

int secureblackbox_imapclient_getsockettimeout(void* lpObj);
int secureblackbox_imapclient_setsockettimeout(void* lpObj, int iSocketTimeout);

int secureblackbox_imapclient_getsocketuseipv6(void* lpObj);
int secureblackbox_imapclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Data Type

SecureBlackboxSocketSettings

TLSClientChain Property (IMAPClient Class)

The TLS client certificate chain.

Syntax

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

int secureblackbox_imapclient_gettlsclientcertcount(void* lpObj);
int secureblackbox_imapclient_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);

int secureblackbox_imapclient_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);

int64 secureblackbox_imapclient_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_imapclient_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);

int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);

QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);

qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);

Remarks

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

Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

Data Type

SecureBlackboxCertificate

TLSServerChain Property (IMAPClient Class)

The TLS server's certificate chain.

Syntax

SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();

int secureblackbox_imapclient_gettlsservercertcount(void* lpObj);

int secureblackbox_imapclient_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);

char* secureblackbox_imapclient_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);

int64 secureblackbox_imapclient_gettlsservercerthandle(void* lpObj, int tlsservercertindex);

char* secureblackbox_imapclient_gettlsservercertissuer(void* lpObj, int tlsservercertindex);

char* secureblackbox_imapclient_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);

char* secureblackbox_imapclient_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);

int secureblackbox_imapclient_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);

int secureblackbox_imapclient_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);

int secureblackbox_imapclient_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);

int secureblackbox_imapclient_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);

char* secureblackbox_imapclient_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);

char* secureblackbox_imapclient_gettlsservercertsubject(void* lpObj, int tlsservercertindex);

char* secureblackbox_imapclient_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);

char* secureblackbox_imapclient_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);

char* secureblackbox_imapclient_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);

int GetTLSServerCertCount();

QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);

QString GetTLSServerCertFingerprint(int iTLSServerCertIndex);

qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);

QString GetTLSServerCertIssuer(int iTLSServerCertIndex);

QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex);

QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex);

int GetTLSServerCertKeyBits(int iTLSServerCertIndex);

int GetTLSServerCertKeyUsage(int iTLSServerCertIndex);

bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex);

QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex);

QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex);

QString GetTLSServerCertSubject(int iTLSServerCertIndex);

QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex);

QString GetTLSServerCertValidFrom(int iTLSServerCertIndex);

QString GetTLSServerCertValidTo(int iTLSServerCertIndex);

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.

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

Data Type

SecureBlackboxCertificate

TLSSettings Property (IMAPClient Class)

Manages TLS layer settings.

Syntax

SecureBlackboxTLSSettings* GetTLSSettings();

int secureblackbox_imapclient_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_imapclient_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

int secureblackbox_imapclient_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_imapclient_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

char* secureblackbox_imapclient_gettlsciphersuites(void* lpObj);
int secureblackbox_imapclient_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

int secureblackbox_imapclient_gettlsclientauth(void* lpObj);
int secureblackbox_imapclient_settlsclientauth(void* lpObj, int iTLSClientAuth);

char* secureblackbox_imapclient_gettlseccurves(void* lpObj);
int secureblackbox_imapclient_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

char* secureblackbox_imapclient_gettlsextensions(void* lpObj);
int secureblackbox_imapclient_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

int secureblackbox_imapclient_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_imapclient_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

char* secureblackbox_imapclient_gettlspresharedidentity(void* lpObj);
int secureblackbox_imapclient_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

char* secureblackbox_imapclient_gettlspresharedkey(void* lpObj);
int secureblackbox_imapclient_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

char* secureblackbox_imapclient_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_imapclient_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

int secureblackbox_imapclient_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_imapclient_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

int secureblackbox_imapclient_gettlsrevocationcheck(void* lpObj);
int secureblackbox_imapclient_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

int secureblackbox_imapclient_gettlsssloptions(void* lpObj);
int secureblackbox_imapclient_settlsssloptions(void* lpObj, int iTLSSSLOptions);

int secureblackbox_imapclient_gettlstlsmode(void* lpObj);
int secureblackbox_imapclient_settlstlsmode(void* lpObj, int iTLSTLSMode);

int secureblackbox_imapclient_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_imapclient_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

int secureblackbox_imapclient_gettlsusesessionresumption(void* lpObj);
int secureblackbox_imapclient_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

int secureblackbox_imapclient_gettlsversions(void* lpObj);
int secureblackbox_imapclient_settlsversions(void* lpObj, int iTLSVersions);

bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);

int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);

int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth);

QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);

QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);

bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);

QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);

QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);

QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);

int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);

bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);

int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Data Type

SecureBlackboxTLSSettings

TrustedCertificates Property (IMAPClient Class)

A list of trusted certificates for chain validation.

Syntax

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

int secureblackbox_imapclient_gettrustedcertcount(void* lpObj);
int secureblackbox_imapclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);

int secureblackbox_imapclient_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);

int64 secureblackbox_imapclient_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_imapclient_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);

int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

QByteArray GetTrustedCertBytes(int iTrustedCertIndex);

qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);

Remarks

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

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

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

This property is not available at design time.

Data Type

SecureBlackboxCertificate

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 (i.e. deselect) the currently selected mailbox.

Error Handling (C++)

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

Config Method (IMAPClient 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++)

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

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

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

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

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 insensitive) of the action is provided in the ActionID parameter.

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

Common ActionIDs:


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


Action	Parameters	Returned value
Search	A criteria for the SEARCH command. If the value is empty, the criteria is considered 'ALL'. For more details, see SEARCH command in RFC 3501	UIDs of messages relevant to the criteria, separated by a space

Error Handling (C++)

GetMailboxInfo Method (IMAPClient Class)

Requests mailbox status.

Syntax

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

Unicode (Windows)
INT GetMailboxInfo(LPCWSTR lpszName);

int secureblackbox_imapclient_getmailboxinfo(void* lpObj, const char* lpszName);

int GetMailboxInfo(const QString& qsName);

Remarks

Requests status information of the specified mailbox and returns it using MailboxInfo event.

Error Handling (C++)

ListMailboxes Method (IMAPClient Class)

Queries a list of mailboxes available on the server.

Syntax

ANSI (Cross Platform)
char* ListMailboxes();

Unicode (Windows)
LPWSTR ListMailboxes();

char* secureblackbox_imapclient_listmailboxes(void* lpObj);

QString ListMailboxes();

Remarks

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

Another way to handle mailboxes is to subscribe to the MailboxFound event. Using the event, it's possible to get not only mailbox names but mailbox attributes as well.

Error Handling (C++)

ListMessages Method (IMAPClient Class)

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

Syntax

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

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

int secureblackbox_imapclient_listmessages(void* lpObj, int iFlagsSet, int iFlagsNotSet);

int ListMessages(int iFlagsSet, int iFlagsNotSet);

Remarks

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

FlagsSet and FlagsNotSet are bit masks of the following values:


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

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

For example:

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

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

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

Error Handling (C++)

OpenMailbox Method (IMAPClient Class)

Opens the specified mailbox.

Syntax

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

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

int secureblackbox_imapclient_openmailbox(void* lpObj, const char* lpszName, int bReadOnly);

int OpenMailbox(const QString& qsName, bool bReadOnly);

Remarks

Use this method to open (select) the specified mailbox on the server. Only one mailbox can be selected at a time. You can check the name of the currently selected mailbox using the Mailbox property.

Error Handling (C++)

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

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 upload a message stored in a byte array specified by Bytes to Mailbox.

Supported flags are:


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

Error Handling (C++)

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

Supported flags are:


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

Error Handling (C++)

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

Supported flags are:


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

Error Handling (C++)

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

Supported flags are:


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

Error Handling (C++)

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 Mailbox marked with the Deleted flag.

Error Handling (C++)

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 Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ReceiveFile Method (IMAPClient 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++)

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

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

RefreshMailbox Method (IMAPClient Class)

Refreshes info about the currently selected 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 Mailbox info.

To request information about other mailbox, call GetMailboxInfo.

Error Handling (C++)

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

Reset Method (IMAPClient Class)

Resets the class settings.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int secureblackbox_imapclient_reset(void* lpObj);

int Reset();

Remarks

Reset is a generic method available in every class.

Error Handling (C++)

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 the currently selected mailbox.

Supported flags are:


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message 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++)

AuthFailed Event (IMAPClient Class)

Fires when an authentication attempt has failed.

Syntax

ANSI (Cross Platform)
virtual int FireAuthFailed(IMAPClientAuthFailedEventParams *e);

typedef struct {
  const char *Auth;
  int ErrorCode;
  const char *ErrorMessage;
  const char *ServerReply;
  int TryAgain;
  int reserved;
} IMAPClientAuthFailedEventParams;


Unicode (Windows)
virtual INT FireAuthFailed(IMAPClientAuthFailedEventParams *e);

typedef struct {
  LPCWSTR Auth;
  INT ErrorCode;
  LPCWSTR ErrorMessage;
  LPCWSTR ServerReply;
  BOOL TryAgain;
  INT reserved;
} IMAPClientAuthFailedEventParams;

#define EID_IMAPCLIENT_AUTHFAILED 1

virtual INT SECUREBLACKBOX_CALL FireAuthFailed(LPSTR &lpszAuth, INT &iErrorCode, LPSTR &lpszErrorMessage, LPSTR &lpszServerReply, BOOL &bTryAgain);

class IMAPClientAuthFailedEventParams {
public:
  const QString &Auth();

  int ErrorCode();

  const QString &ErrorMessage();

  const QString &ServerReply();

  bool TryAgain();
  void SetTryAgain(bool bTryAgain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthFailed(IMAPClientAuthFailedEventParams *e);

// Or, subclass IMAPClient and override this emitter function.
virtual int FireAuthFailed(IMAPClientAuthFailedEventParams *e) {...}

Remarks

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

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

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

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

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

AuthStart Event (IMAPClient Class)

Fires when the authentication is about to be started.

Syntax

ANSI (Cross Platform)
virtual int FireAuthStart(IMAPClientAuthStartEventParams *e);

typedef struct {
  const char *UsableAuths;
  int reserved;
} IMAPClientAuthStartEventParams;


Unicode (Windows)
virtual INT FireAuthStart(IMAPClientAuthStartEventParams *e);

typedef struct {
  LPCWSTR UsableAuths;
  INT reserved;
} IMAPClientAuthStartEventParams;

#define EID_IMAPCLIENT_AUTHSTART 2

virtual INT SECUREBLACKBOX_CALL FireAuthStart(LPSTR &lpszUsableAuths);

class IMAPClientAuthStartEventParams {
public:
  const QString &UsableAuths();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthStart(IMAPClientAuthStartEventParams *e);

// Or, subclass IMAPClient and override this emitter function.
virtual int FireAuthStart(IMAPClientAuthStartEventParams *e) {...}

Remarks

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

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

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

AuthSucceeded Event (IMAPClient Class)

Fires when the authentication has succeeded.

Syntax

ANSI (Cross Platform)
virtual int FireAuthSucceeded(IMAPClientAuthSucceededEventParams *e);

typedef struct {
  const char *Auth;
  int reserved;
} IMAPClientAuthSucceededEventParams;


Unicode (Windows)
virtual INT FireAuthSucceeded(IMAPClientAuthSucceededEventParams *e);

typedef struct {
  LPCWSTR Auth;
  INT reserved;
} IMAPClientAuthSucceededEventParams;

#define EID_IMAPCLIENT_AUTHSUCCEEDED 3

virtual INT SECUREBLACKBOX_CALL FireAuthSucceeded(LPSTR &lpszAuth);

class IMAPClientAuthSucceededEventParams {
public:
  const QString &Auth();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthSucceeded(IMAPClientAuthSucceededEventParams *e);

// Or, subclass IMAPClient and override this emitter function.
virtual int FireAuthSucceeded(IMAPClientAuthSucceededEventParams *e) {...}

Remarks

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

Command Event (IMAPClient 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 4

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 5

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 6

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 7

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 8

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.

MailboxFound Event (IMAPClient Class)

Provides mailbox details.

Syntax

ANSI (Cross Platform)
virtual int FireMailboxFound(IMAPClientMailboxFoundEventParams *e);

typedef struct {
  const char *Name;
  const char *Delimiter;
  int Attributes;
  int reserved;
} IMAPClientMailboxFoundEventParams;


Unicode (Windows)
virtual INT FireMailboxFound(IMAPClientMailboxFoundEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Delimiter;
  INT Attributes;
  INT reserved;
} IMAPClientMailboxFoundEventParams;

#define EID_IMAPCLIENT_MAILBOXFOUND 9

virtual INT SECUREBLACKBOX_CALL FireMailboxFound(LPSTR &lpszName, LPSTR &lpszDelimiter, INT &iAttributes);

class IMAPClientMailboxFoundEventParams {
public:
  const QString &Name();

  const QString &Delimiter();

  int Attributes();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MailboxFound(IMAPClientMailboxFoundEventParams *e);

// Or, subclass IMAPClient and override this emitter function.
virtual int FireMailboxFound(IMAPClientMailboxFoundEventParams *e) {...}

Remarks

Subscribe to this event to get mailbox details published by ListMailboxes.

Delimiter is a mailbox hierarchy delimiter.

Attributes value is bit mask of the following values:


imapMailboxHasChildren	`0x0001`	Indicates whether the mailbox has \HasChildren attribute specified.
imapMailboxHasNoChildren	`0x0002`	Indicates whether the mailbox has \HasNoChildren attribute specified.
imapMailboxMarked	`0x0004`	Indicates whether the mailbox has \Marked attribute specified.
imapMailboxNoInferiors	`0x0008`	Indicates whether the mailbox has \NoInferiors attribute specified.
imapMailboxNoSelect	`0x0010`	Indicates whether the mailbox has \NoSelect attribute specified.
imapMailboxUnmarked	`0x0020`	Indicates whether the mailbox has \Unmarked attribute specified.

MailboxInfo Event (IMAPClient Class)

Reports mailbox information returned from the server.

Syntax

ANSI (Cross Platform)
virtual int FireMailboxInfo(IMAPClientMailboxInfoEventParams *e);

typedef struct {
  const char *Name;
  int TotalMessages;
  int RecentMessages;
  int UnseenMessages;
  int NextUID;
  int UIDValidity;
  int reserved;
} IMAPClientMailboxInfoEventParams;


Unicode (Windows)
virtual INT FireMailboxInfo(IMAPClientMailboxInfoEventParams *e);

typedef struct {
  LPCWSTR Name;
  INT TotalMessages;
  INT RecentMessages;
  INT UnseenMessages;
  INT NextUID;
  INT UIDValidity;
  INT reserved;
} IMAPClientMailboxInfoEventParams;

#define EID_IMAPCLIENT_MAILBOXINFO 10

virtual INT SECUREBLACKBOX_CALL FireMailboxInfo(LPSTR &lpszName, INT &iTotalMessages, INT &iRecentMessages, INT &iUnseenMessages, INT &iNextUID, INT &iUIDValidity);

class IMAPClientMailboxInfoEventParams {
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 MailboxInfo(IMAPClientMailboxInfoEventParams *e);

// Or, subclass IMAPClient and override this emitter function.
virtual int FireMailboxInfo(IMAPClientMailboxInfoEventParams *e) {...}

Remarks

Subscribe to this event to be notified of mailbox info as returned by the IMAP server on GetMailboxInfo call.

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 11

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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

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


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

Progress Event (IMAPClient 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 12

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 13

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 parameter (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 14

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 the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

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

TLSEstablished Event (IMAPClient 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 15

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 a successful completion of a TLS handshake.

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

TLSHandshake Event (IMAPClient 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 16

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 by the TLSEstablished event. If the server chooses to request a client certificate, the 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 17

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 18

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.

Certificate Type

Encapsulates an individual X.509 certificate.

Syntax

SecureBlackboxCertificate (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

Returns the raw certificate data in DER format.

CA
int
Default Value: FALSE

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

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

CAKeyID
char* (read-only)
Default Value:

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

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

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

CertType
int (read-only)
Default Value: 0

Returns the type of the entity contained in the Certificate object.

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

Use the CertificateManager class to load or create new certificate and certificate requests objects.

CRLDistributionPoints
char*
Default Value: ""

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

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

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

Curve
char*
Default Value: ""

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


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

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

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

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

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

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

Handle
int64
Default Value: 0

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

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

HashAlgorithm
char*
Default Value: ""

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


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

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

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

IssuerRDN
char*
Default Value: ""

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

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

KeyAlgorithm
char*
Default Value: "0"

Specifies the public key algorithm of this certificate.


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

Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.

KeyBits
int (read-only)
Default Value: 0

Returns the length of the public key in bits.

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

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

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

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

KeyUsage
int
Default Value: 0

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

This value is a bit mask of the following values:


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

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

KeyValid
int (read-only)
Default Value: FALSE

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

OCSPLocations
char*
Default Value: ""

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

Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.

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

OCSPNoCheck
int
Default Value: FALSE

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

Origin
int (read-only)
Default Value: 0

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

PolicyIDs
char*
Default Value: ""

Contains identifiers (OIDs) of the applicable certificate policies.

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

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

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

PrivateKeyBytes
char* (read-only)
Default Value:

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

PrivateKeyExists
int (read-only)
Default Value: FALSE

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

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

PrivateKeyExtractable
int (read-only)
Default Value: FALSE

Indicates whether the private key is extractable (exportable).

PublicKeyBytes
char* (read-only)
Default Value:

Contains the certificate's public key in DER format.

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

Qualified
int (read-only)
Default Value: FALSE

Indicates whether the certificate is qualified.

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

QualifiedStatements
int
Default Value: 0

Returns a simplified qualified status of the certificate.

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

A list of qualifiers.

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

SelfSigned
int (read-only)
Default Value: FALSE

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

SerialNumber
char*
Default Value:

Returns the certificate's serial number.

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

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

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

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

Source
int (read-only)
Default Value: 0

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

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

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

SubjectAlternativeName
char*
Default Value: ""

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

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

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

SubjectKeyID
char*
Default Value:

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

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

The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

SubjectRDN
char*
Default Value: ""

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

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

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

Valid
int (read-only)
Default Value: FALSE

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

ValidFrom
char*
Default Value: ""

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

ValidTo
char*
Default Value: ""

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

Constructors

Certificate()

Creates a new object with default field values.

CRL Type

Represents a Certificate Revocation List.

Syntax

SecureBlackboxCRL (declared in secureblackbox.h)

Remarks

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

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

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

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

Returns the raw CRL data in DER format.

CAKeyID
char*
Default Value:

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

EntryCount
int (read-only)
Default Value: 0

Returns the number of certificate status entries in the CRL.

Handle
int64
Default Value: 0

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

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

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

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

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

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

The URL that the CRL was downloaded from.

NextUpdate
char*
Default Value: ""

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

SigAlgorithm
char*
Default Value: "0"

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

Source
int (read-only)
Default Value: 0

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

TBS
char* (read-only)
Default Value:

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

ThisUpdate
char*
Default Value: ""

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

Constructors

CRL()

Creates an empty CRL object.

IMAPMailboxInfo Type

Contains information about an IMAP mailbox.

Syntax

SecureBlackboxIMAPMailboxInfo (declared in secureblackbox.h)

Remarks

This compound object provides details of an IMAP mailbox.

The following fields are available:

Fields

MessageFlags
int (read-only)
Default Value: 0

Contains message flags defined in the mailbox.


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

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

Specifies mailbox name.

NextUID
int (read-only)
Default Value: 0

Returns the next unique identifier value.

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

PermanentFlags
int (read-only)
Default Value: 0

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


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

ReadOnly
int (read-only)
Default Value: FALSE

Specifies whether the mailbox is write-protected.

RecentMessages
int (read-only)
Default Value: 0

The number of recent messages in the mailbox.

TotalMessages
int (read-only)
Default Value: 0

Total number of messages in the mailbox.

UIDValidity
int (read-only)
Default Value: 0

Specifies UID validity value.

UnseenMessages
int (read-only)
Default Value: 0

The number of unseen messages in the mailbox.

IMAPMessageInfo Type

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

Syntax

SecureBlackboxIMAPMessageInfo (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Fields

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

Contains the value of the Date header field.

Flags
int (read-only)
Default Value: 0

Returns the flags currently set to the mail message.

Supported flags are:


imapMessageAnswered	`0x01`	Message has been answered.
imapMessageDeleted	`0x02`	Message is 'deleted' for removal later.
imapMessageDraft	`0x04`	Message has not completed composition (marked as a draft).
imapMessageFlagged	`0x08`	Message is 'flagged' for urgent/special attention.
imapMessageRecent	`0x10`	Message is 'recently' arrived in this mailbox. This session is the first session to have been notified about this message.
imapMessageSeen	`0x20`	Message has been read.

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

Contains the value of the From header field.

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

Returns the internal date of the mail message.

Priority
int (read-only)
Default Value: 2

Specifies the message priority.

Available options:


mpLowest	`0`
mpLow	`1`
mpNormal	`2`
mpHigh	`3`
mpHighest	`4`

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

Contains the value of the To header field.

Size
int64 (read-only)
Default Value: 0

Returns the size of the message in bytes.

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

Contains the value of the Subject header field.

UID
int (read-only)
Default Value: 0

Returns the unique ID of the mail message.

IMAPServerInfo Type

Describes the IMAP server's capabilities.

Syntax

SecureBlackboxIMAPServerInfo (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Capabilities

Features

SupportedAuths

Fields

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

Returns the list of server capabilities.

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

Features
int64 (read-only)
Default Value: 0

Returns the list of capabilities supported by the server.

This value is bit mask of the following values:


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

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

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

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

MailMessage Type

Represents an e-mail message.

Syntax

SecureBlackboxMailMessage (declared in secureblackbox.h)

Remarks

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

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

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

The following fields are available:

Fields

AttachmentCount
int (read-only)
Default Value: 0

Returns the number of attachments in this message.

Bcc
char*
Default Value: ""

The contents of the BCC header field.

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

Cc
char*
Default Value: ""

The value of the CC header field.

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

Comments
char*
Default Value: ""

Contains additional information about the message body.

Date
char*
Default Value: ""

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

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

The date is returned and accepted in UTC time zone.

DeliveryReceipt
int
Default Value: FALSE

Enables delivery notification.

From
char*
Default Value: ""

Contains the value of the From header field.

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

Handle
int64
Default Value: 0

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

HtmlText
char*
Default Value: ""

The HTML version of the message.

ID
char*
Default Value: ""

The contents of the Message-ID header field.

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

InReplyTo
char*
Default Value: ""

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

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

Keywords
char*
Default Value: ""

The value of the Keywords header field.

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

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

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

PlainText
char*
Default Value: ""

The plain text version of the message.

Priority
int
Default Value: 2

Specifies the message priority.

Available options:


mpLowest	`0`
mpLow	`1`
mpNormal	`2`
mpHigh	`3`
mpHighest	`4`

ReadReceipt
int
Default Value: FALSE

Enables a read notification.

References
char*
Default Value: ""

The value of the References header field.

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

ReplyTo
char*
Default Value: ""

The value of the Reply-To header field.

This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the From field.

ReturnPath
char*
Default Value: ""

The value of the Return-Path header field.

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

Sender
char*
Default Value: ""

The value of the Sender header field.

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

SendTo
char*
Default Value: ""

The value of the To header field.

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

Subject
char*
Default Value: ""

Contains the subject field of this message.

Constructors

MailMessage()

Creates a new empty mail message object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Syntax

SecureBlackboxOCSPResponse (declared in secureblackbox.h)

Remarks

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

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

The following fields are available:

Fields

Bytes
char* (read-only)
Default Value:

A buffer containing the raw OCSP response data.

EntryCount
int (read-only)
Default Value: 0

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

Handle
int64
Default Value: 0

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

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

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

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

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

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

The location of the OCSP responder.

ProducedAt
char*
Default Value: ""

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

SigAlgorithm
char*
Default Value: "0"

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

Source
int (read-only)
Default Value: 0

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

Constructors

OCSPResponse()

Creates an empty OCSP response object.

ProxySettings Type

A container for proxy server settings.

Syntax

SecureBlackboxProxySettings (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Fields

Address
char*
Default Value: ""

The IP address of the proxy server.

Authentication
int
Default Value: 0

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Password
char*
Default Value: ""

The password to authenticate to the proxy server.

Port
int
Default Value: 0

The port on the proxy server to connect to.

ProxyType
int
Default Value: 0

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

RequestHeaders
char*
Default Value: ""

Contains HTTP request headers for WebTunnel and HTTP proxy.

ResponseBody
char*
Default Value: ""

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

ResponseHeaders
char*
Default Value: ""

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

UseIPv6
int
Default Value: FALSE

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

Username
char*
Default Value: ""

Specifies the username credential for proxy authentication.

Constructors

ProxySettings()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Syntax

SecureBlackboxSocketSettings (declared in secureblackbox.h)

Remarks

This type is a container for socket-layer parameters.

The following fields are available:

Fields

DNSMode
int
Default Value: 0

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


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

DNSPort
int
Default Value: 0

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

DNSQueryTimeout
int
Default Value: 0

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

DNSServers
char*
Default Value: ""

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

DNSTotalTimeout
int
Default Value: 0

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

IncomingSpeedLimit
int
Default Value: 0

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

LocalAddress
char*
Default Value: ""

The local network interface to bind the socket to.

LocalPort
int
Default Value: 0

The local port number to bind the socket to.

OutgoingSpeedLimit
int
Default Value: 0

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

Timeout
int
Default Value: 60000

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

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

UseIPv6
int
Default Value: FALSE

Enables or disables IP protocol version 6.

Constructors

SocketSettings()

Creates a new SocketSettings object.

TLSConnectionInfo Type

Contains information about a network connection.

Syntax

SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)

Remarks

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

The following fields are available:

Fields

AEADCipher
int (read-only)
Default Value: FALSE

Indicates whether the encryption algorithm used is an AEAD cipher.

ChainValidationDetails
int (read-only)
Default Value: 0

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

Returns a bit mask of the following options:


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

ChainValidationResult
int (read-only)
Default Value: 0

The outcome of a certificate chain validation routine.

Available options:


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

Use the ValidationLog property to access the detailed validation log.

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

The cipher suite employed by this connection.

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

ClientAuthenticated
int (read-only)
Default Value: FALSE

Specifies whether client authentication was performed during this connection.

ClientAuthRequested
int (read-only)
Default Value: FALSE

Specifies whether client authentication was requested during this connection.

ConnectionEstablished
int (read-only)
Default Value: FALSE

Indicates whether the connection has been established fully.

ConnectionID
char* (read-only)
Default Value:

The unique identifier assigned to this connection.

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

The digest algorithm used in a TLS-enabled connection.

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

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

Exportable
int (read-only)
Default Value: FALSE

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

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

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

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

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

KeyExchangeKeyBits
int (read-only)
Default Value: 0

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

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

The elliptic curve used in this connection.

PFSCipher
int (read-only)
Default Value: FALSE

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

PreSharedIdentity
char*
Default Value: ""

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

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

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

PublicKeyBits
int (read-only)
Default Value: 0

The length of the public key.

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

The client's IP address.

RemotePort
int (read-only)
Default Value: 0

The remote port of the client connection.

ResumedSession
int (read-only)
Default Value: FALSE

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

SecureConnection
int (read-only)
Default Value: FALSE

Indicates whether TLS or SSL is enabled for this connection.

ServerAuthenticated
int (read-only)
Default Value: FALSE

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

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

The signature algorithm used in a TLS handshake.

SymmetricBlockSize
int (read-only)
Default Value: 0

The block size of the symmetric algorithm used.

SymmetricKeyBits
int (read-only)
Default Value: 0

The key length of the symmetric algorithm used.

TotalBytesReceived
int64 (read-only)
Default Value: 0

The total number of bytes received over this connection.

TotalBytesSent
int64 (read-only)
Default Value: 0

The total number of bytes sent over this connection.

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

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

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

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

Constructors

TLSConnectionInfo()

Creates a new TLSConnectionInfo object.

TLSSettings Type

A container for TLS connection settings.

Syntax

SecureBlackboxTLSSettings (declared in secureblackbox.h)

Remarks

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

The following fields are available:

AutoValidateCertificates

ForceResumeIfDestinationChanges

PreSharedIdentity

PreSharedKey

PreSharedKeyCiphersuite

RenegotiationAttackPreventionMode

RevocationCheck

SSLOptions

TLSMode

UseExtendedMasterSecret

UseSessionResumption

Versions

Fields

AutoValidateCertificates
int
Default Value: TRUE

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

BaseConfiguration
int
Default Value: 0

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


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

Ciphersuites
char*
Default Value: ""

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

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

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

ClientAuth
int
Default Value: 0

Enables or disables certificate-based client authentication.

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


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

ECCurves
char*
Default Value: ""

Defines the elliptic curves to enable.

Extensions
char*
Default Value: ""

Provides access to TLS extensions.

ForceResumeIfDestinationChanges
int
Default Value: FALSE

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

PreSharedIdentity
char*
Default Value: ""

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

PreSharedKey
char*
Default Value: ""

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

PreSharedKeyCiphersuite
char*
Default Value: ""

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

RenegotiationAttackPreventionMode
int
Default Value: 2

Selects the renegotiation attack prevention mechanism.

The following options are available:


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

RevocationCheck
int
Default Value: 1

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

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


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

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

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

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

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

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

SSLOptions
int
Default Value: 16

Various SSL (TLS) protocol options, set of


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

TLSMode
int
Default Value: 0

Specifies the TLS mode to use.


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

UseExtendedMasterSecret
int
Default Value: FALSE

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

UseSessionResumption
int
Default Value: FALSE

Enables or disables the TLS session resumption capability.

Versions
int
Default Value: 16

The SSL/TLS versions to enable by default.


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

Constructors

TLSSettings()

Creates a new TLSSettings object.

SecureBlackboxList Type

Syntax

SecureBlackboxList<T> (declared in secureblackbox.h)

Remarks

SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the IMAPClient class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

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

IdleAuto: Specifies whether idle mode should be requested automatically.

Set this property to true to force this client to automatically send IDLE request to the server. Default value is false.

IdleTimeout: Specifies idle timeout in seconds.

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

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates 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.

SessionLogDetails: Specifies whether login credentials should be written to the session log.

Use this setting to configure the details written to SessionLog. Possible values are:


default		Login credentials are not logged.
full		Login credentials appeare in the SessionLog.
none		No SessionLog is created.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


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

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are 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.

TempPath: Path for storing temporary files.

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

TLSExtensions: TBD.

TBD

TLSPeerExtensions: TBD.

TBD

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of 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).

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

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

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

UseMicrosoftCTL: Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSystemCertificates: Enables or disables the use of the system certificates.

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

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

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

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

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


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

Cookies: Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

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

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

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

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

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

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

ListDelimiter: The delimiter character for multi-element lists.

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

LogDestination: Specifies the debug log destination.

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

Supported values are:


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

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


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

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


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

LogFlushMode: Specifies the log flush mode.

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


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

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


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

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

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


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

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

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

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

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

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

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

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

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

Supported Values:


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

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath: Specifies the file system path where cached PKI data is stored.

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

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

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:


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

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

StaticIPAddresses: Gets or sets all the static DNS rules.

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.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseCRLObjectCaching: Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching: Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

XMLRDNDescriptorName[OID]: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]: Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder: Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator: Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (IMAPClient Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

IMAPClient Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)