SMTPClient Class
Properties Methods Events Config Settings Errors
The SMTPClient class provides client-side functionality for SMTP (Simple Mail Transfer Protocol).
Syntax
SMTPClient
Remarks
Use this component to send e-mails from your application.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BlockedCertificates | The certificates that must be rejected as trust anchors. |
ConnectionInfo | Returns the details of the underlying network connection. |
Domain | The sender host's domain name for HELO/EHLO. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
Message | Contains an e-mail message. |
Password | The authentication password. |
Proxy | The proxy server settings. |
ServerInfo | Encapsulates information about the server. |
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.
Config | This method sets or retrieves a configuration setting. |
Connect | Establishes a connection to the SMTP server. |
Disconnect | Closes connection to the SMTP server. |
DoAction | Performs an additional action. |
Reset | Resets the class settings. |
SendBytes | Sends an e-mail message stored in a byte array. |
SendFile | Sends an e-mail message stored in a file. |
SendMessage | Sends a message to the SMTP server. |
SendStream | Sends an e-mail message stored in a stream. |
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.
BeforeAuth | Fires before the authentication starts. |
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. |
Error | Provides information about errors during SMTP operations. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
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. |
BinaryChunkSize | Specifies the size of chunks to use for dividing outgoing messages in binary mode. |
BinaryMode | Specifies whether binary mode is allowed for sending. |
DSNOptions | Specifies the mode for Delivery Status Notifications (DSN). |
DSNReturnInfo | Specifies notification return info for DSN. |
ForceLogin | Forces the class to login to the server. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
RemoveBCC | Specifies if BCC header fields should be removed from messages. |
SendBufferSize | Size of send buffer in bytes. |
TempPath | Path for storing temporary files. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
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. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
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. |
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. |
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. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
BlockedCertificates Property (SMTPClient Class)
The certificates that must be rejected as trust anchors.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates(); int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_smtpclient_getblockedcertcount(void* lpObj);
int secureblackbox_smtpclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_smtpclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_smtpclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_smtpclient_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
ConnectionInfo Property (SMTPClient Class)
Returns the details of the underlying network connection.
Syntax
SecureBlackboxTLSConnectionInfo* GetConnectionInfo();
int secureblackbox_smtpclient_getconninfoaeadcipher(void* lpObj);
int secureblackbox_smtpclient_getconninfochainvalidationdetails(void* lpObj);
int secureblackbox_smtpclient_getconninfochainvalidationresult(void* lpObj);
char* secureblackbox_smtpclient_getconninfociphersuite(void* lpObj);
int secureblackbox_smtpclient_getconninfoclientauthenticated(void* lpObj);
int secureblackbox_smtpclient_getconninfoclientauthrequested(void* lpObj);
int secureblackbox_smtpclient_getconninfoconnectionestablished(void* lpObj);
int secureblackbox_smtpclient_getconninfoconnectionid(void* lpObj, char** lpConnInfoConnectionID, int* lenConnInfoConnectionID);
char* secureblackbox_smtpclient_getconninfodigestalgorithm(void* lpObj);
char* secureblackbox_smtpclient_getconninfoencryptionalgorithm(void* lpObj);
int secureblackbox_smtpclient_getconninfoexportable(void* lpObj);
int64 secureblackbox_smtpclient_getconninfoid(void* lpObj);
char* secureblackbox_smtpclient_getconninfokeyexchangealgorithm(void* lpObj);
int secureblackbox_smtpclient_getconninfokeyexchangekeybits(void* lpObj);
char* secureblackbox_smtpclient_getconninfonamedeccurve(void* lpObj);
int secureblackbox_smtpclient_getconninfopfscipher(void* lpObj);
char* secureblackbox_smtpclient_getconninfopresharedidentity(void* lpObj);
char* secureblackbox_smtpclient_getconninfopresharedidentityhint(void* lpObj);
int secureblackbox_smtpclient_getconninfopublickeybits(void* lpObj);
char* secureblackbox_smtpclient_getconninforemoteaddress(void* lpObj);
int secureblackbox_smtpclient_getconninforemoteport(void* lpObj);
int secureblackbox_smtpclient_getconninforesumedsession(void* lpObj);
int secureblackbox_smtpclient_getconninfosecureconnection(void* lpObj);
int secureblackbox_smtpclient_getconninfoserverauthenticated(void* lpObj);
char* secureblackbox_smtpclient_getconninfosignaturealgorithm(void* lpObj);
int secureblackbox_smtpclient_getconninfosymmetricblocksize(void* lpObj);
int secureblackbox_smtpclient_getconninfosymmetrickeybits(void* lpObj);
int64 secureblackbox_smtpclient_getconninfototalbytesreceived(void* lpObj);
int64 secureblackbox_smtpclient_getconninfototalbytessent(void* lpObj);
char* secureblackbox_smtpclient_getconninfovalidationlog(void* lpObj);
char* secureblackbox_smtpclient_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
Domain Property (SMTPClient Class)
The sender host's domain name for HELO/EHLO.
Syntax
ANSI (Cross Platform) char* GetDomain();
int SetDomain(const char* lpszDomain); Unicode (Windows) LPWSTR GetDomain();
INT SetDomain(LPCWSTR lpszDomain);
char* secureblackbox_smtpclient_getdomain(void* lpObj);
int secureblackbox_smtpclient_setdomain(void* lpObj, const char* lpszDomain);
QString GetDomain();
int SetDomain(QString qsDomain);
Default Value
""
Remarks
Use this property before calling the Connect method to provie the domain name of the sender's host.
Data Type
String
ExternalCrypto Property (SMTPClient Class)
Provides access to external signing and DC parameters.
Syntax
SecureBlackboxExternalCrypto* GetExternalCrypto();
char* secureblackbox_smtpclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_smtpclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_smtpclient_getexternalcryptodata(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_smtpclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_smtpclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_smtpclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_smtpclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_smtpclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_smtpclient_getexternalcryptomode(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_smtpclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_smtpclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).
This property is read-only.
Data Type
FIPSMode Property (SMTPClient Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_smtpclient_getfipsmode(void* lpObj);
int secureblackbox_smtpclient_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 (SMTPClient Class)
Additional certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_smtpclient_getknowncertcount(void* lpObj);
int secureblackbox_smtpclient_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_smtpclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_smtpclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_smtpclient_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 component manually.
The purpose of certificates to be added to this collection is roughly equivalent to that of 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
KnownCRLs Property (SMTPClient Class)
Additional CRLs for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs(); int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_smtpclient_getknowncrlcount(void* lpObj);
int secureblackbox_smtpclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_smtpclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_smtpclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_smtpclient_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
KnownOCSPs Property (SMTPClient Class)
Additional OCSP responses for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs(); int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);
int secureblackbox_smtpclient_getknownocspcount(void* lpObj);
int secureblackbox_smtpclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_smtpclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_smtpclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_smtpclient_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
Message Property (SMTPClient Class)
Contains an e-mail message.
Syntax
SecureBlackboxMailMessage* GetMessage(); int SetMessage(SecureBlackboxMailMessage* val);
int secureblackbox_smtpclient_getmsgattachmentcount(void* lpObj);
char* secureblackbox_smtpclient_getmsgbcc(void* lpObj);
int secureblackbox_smtpclient_setmsgbcc(void* lpObj, const char* lpszMsgBcc);
char* secureblackbox_smtpclient_getmsgcc(void* lpObj);
int secureblackbox_smtpclient_setmsgcc(void* lpObj, const char* lpszMsgCc);
char* secureblackbox_smtpclient_getmsgcomments(void* lpObj);
int secureblackbox_smtpclient_setmsgcomments(void* lpObj, const char* lpszMsgComments);
char* secureblackbox_smtpclient_getmsgdate(void* lpObj);
int secureblackbox_smtpclient_setmsgdate(void* lpObj, const char* lpszMsgDate);
int secureblackbox_smtpclient_getmsgdeliveryreceipt(void* lpObj);
int secureblackbox_smtpclient_setmsgdeliveryreceipt(void* lpObj, int bMsgDeliveryReceipt);
char* secureblackbox_smtpclient_getmsgfrom(void* lpObj);
int secureblackbox_smtpclient_setmsgfrom(void* lpObj, const char* lpszMsgFrom);
int64 secureblackbox_smtpclient_getmsghandle(void* lpObj);
int secureblackbox_smtpclient_setmsghandle(void* lpObj, int64 lMsgHandle);
char* secureblackbox_smtpclient_getmsghtmltext(void* lpObj);
int secureblackbox_smtpclient_setmsghtmltext(void* lpObj, const char* lpszMsgHtmlText);
char* secureblackbox_smtpclient_getmsgid(void* lpObj);
int secureblackbox_smtpclient_setmsgid(void* lpObj, const char* lpszMsgID);
char* secureblackbox_smtpclient_getmsginreplyto(void* lpObj);
int secureblackbox_smtpclient_setmsginreplyto(void* lpObj, const char* lpszMsgInReplyTo);
char* secureblackbox_smtpclient_getmsgkeywords(void* lpObj);
int secureblackbox_smtpclient_setmsgkeywords(void* lpObj, const char* lpszMsgKeywords);
char* secureblackbox_smtpclient_getmsgmailer(void* lpObj);
char* secureblackbox_smtpclient_getmsgplaintext(void* lpObj);
int secureblackbox_smtpclient_setmsgplaintext(void* lpObj, const char* lpszMsgPlainText);
int secureblackbox_smtpclient_getmsgpriority(void* lpObj);
int secureblackbox_smtpclient_setmsgpriority(void* lpObj, int iMsgPriority);
int secureblackbox_smtpclient_getmsgreadreceipt(void* lpObj);
int secureblackbox_smtpclient_setmsgreadreceipt(void* lpObj, int bMsgReadReceipt);
char* secureblackbox_smtpclient_getmsgreferences(void* lpObj);
int secureblackbox_smtpclient_setmsgreferences(void* lpObj, const char* lpszMsgReferences);
char* secureblackbox_smtpclient_getmsgreplyto(void* lpObj);
int secureblackbox_smtpclient_setmsgreplyto(void* lpObj, const char* lpszMsgReplyTo);
char* secureblackbox_smtpclient_getmsgreturnpath(void* lpObj);
int secureblackbox_smtpclient_setmsgreturnpath(void* lpObj, const char* lpszMsgReturnPath);
char* secureblackbox_smtpclient_getmsgsender(void* lpObj);
int secureblackbox_smtpclient_setmsgsender(void* lpObj, const char* lpszMsgSender);
char* secureblackbox_smtpclient_getmsgsendto(void* lpObj);
int secureblackbox_smtpclient_setmsgsendto(void* lpObj, const char* lpszMsgSendTo);
char* secureblackbox_smtpclient_getmsgsubject(void* lpObj);
int secureblackbox_smtpclient_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 provide the e-mail message to send.
This property is not available at design time.
Data Type
Password Property (SMTPClient 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_smtpclient_getpassword(void* lpObj);
int secureblackbox_smtpclient_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 SMTP server. In order to use OAuth 2.0 authentication to access the SMTP server, assign the access token to this property prepending it with "oauth:".
Data Type
String
Proxy Property (SMTPClient Class)
The proxy server settings.
Syntax
SecureBlackboxProxySettings* GetProxy();
char* secureblackbox_smtpclient_getproxyaddress(void* lpObj);
int secureblackbox_smtpclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_smtpclient_getproxyauthentication(void* lpObj);
int secureblackbox_smtpclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_smtpclient_getproxypassword(void* lpObj);
int secureblackbox_smtpclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_smtpclient_getproxyport(void* lpObj);
int secureblackbox_smtpclient_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_smtpclient_getproxyproxytype(void* lpObj);
int secureblackbox_smtpclient_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_smtpclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_smtpclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_smtpclient_getproxyresponsebody(void* lpObj);
int secureblackbox_smtpclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_smtpclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_smtpclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_smtpclient_getproxyuseipv6(void* lpObj);
int secureblackbox_smtpclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_smtpclient_getproxyusername(void* lpObj);
int secureblackbox_smtpclient_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
ServerInfo Property (SMTPClient Class)
Encapsulates information about the server.
Syntax
SecureBlackboxSMTPServerInfo* GetServerInfo();
int secureblackbox_smtpclient_getserverinfoauthloginsupported(void* lpObj);
int secureblackbox_smtpclient_getserverinfoauthplainsupported(void* lpObj);
int secureblackbox_smtpclient_getserverinfoavailable(void* lpObj);
int secureblackbox_smtpclient_getserverinfobinarysupported(void* lpObj);
int secureblackbox_smtpclient_getserverinfochunkingsupported(void* lpObj);
int secureblackbox_smtpclient_getserverinfodsnsupported(void* lpObj);
int secureblackbox_smtpclient_getserverinfomaxmessagesize(void* lpObj);
int secureblackbox_smtpclient_getserverinfosaslsupported(void* lpObj);
int secureblackbox_smtpclient_getserverinfosizesupported(void* lpObj);
int secureblackbox_smtpclient_getserverinfostatuscodessupported(void* lpObj);
bool GetServerInfoAuthLoginSupported(); bool GetServerInfoAuthPlainSupported(); bool GetServerInfoAvailable(); bool GetServerInfoBinarySupported(); bool GetServerInfoChunkingSupported(); bool GetServerInfoDsnSupported(); int GetServerInfoMaxMessageSize(); bool GetServerInfoSaslSupported(); bool GetServerInfoSizeSupported(); bool GetServerInfoStatusCodesSupported();
Remarks
Use this property after establishing a connection to the server to learn about the SMTP server's capabilities.
This property is read-only and not available at design time.
Data Type
SocketSettings Property (SMTPClient Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_smtpclient_getsocketdnsmode(void* lpObj);
int secureblackbox_smtpclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_smtpclient_getsocketdnsport(void* lpObj);
int secureblackbox_smtpclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_smtpclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_smtpclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_smtpclient_getsocketdnsservers(void* lpObj);
int secureblackbox_smtpclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_smtpclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_smtpclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_smtpclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_smtpclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_smtpclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_smtpclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_smtpclient_getsocketlocalport(void* lpObj);
int secureblackbox_smtpclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_smtpclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_smtpclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_smtpclient_getsockettimeout(void* lpObj);
int secureblackbox_smtpclient_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_smtpclient_getsocketuseipv6(void* lpObj);
int secureblackbox_smtpclient_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
TLSClientChain Property (SMTPClient Class)
The TLS client certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain(); int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_smtpclient_gettlsclientcertcount(void* lpObj);
int secureblackbox_smtpclient_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_smtpclient_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_smtpclient_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_smtpclient_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 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
TLSServerChain Property (SMTPClient Class)
The TLS server's certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int secureblackbox_smtpclient_gettlsservercertcount(void* lpObj);
int secureblackbox_smtpclient_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
int secureblackbox_smtpclient_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex, char** lpTLSServerCertFingerprint, int* lenTLSServerCertFingerprint);
int64 secureblackbox_smtpclient_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_smtpclient_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_smtpclient_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_smtpclient_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_smtpclient_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_smtpclient_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_smtpclient_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_smtpclient_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_smtpclient_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_smtpclient_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_smtpclient_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_smtpclient_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_smtpclient_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);
int GetTLSServerCertCount(); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); QByteArray 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 OnCertificateValidate event is fired by the client component.
This property is read-only and not available at design time.
Data Type
TLSSettings Property (SMTPClient Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_smtpclient_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_smtpclient_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_smtpclient_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_smtpclient_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_smtpclient_gettlsciphersuites(void* lpObj);
int secureblackbox_smtpclient_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_smtpclient_gettlsclientauth(void* lpObj);
int secureblackbox_smtpclient_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_smtpclient_gettlseccurves(void* lpObj);
int secureblackbox_smtpclient_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_smtpclient_gettlsextensions(void* lpObj);
int secureblackbox_smtpclient_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_smtpclient_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_smtpclient_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_smtpclient_gettlspresharedidentity(void* lpObj);
int secureblackbox_smtpclient_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_smtpclient_gettlspresharedkey(void* lpObj);
int secureblackbox_smtpclient_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_smtpclient_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_smtpclient_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_smtpclient_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_smtpclient_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_smtpclient_gettlsrevocationcheck(void* lpObj);
int secureblackbox_smtpclient_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_smtpclient_gettlsssloptions(void* lpObj);
int secureblackbox_smtpclient_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_smtpclient_gettlstlsmode(void* lpObj);
int secureblackbox_smtpclient_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_smtpclient_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_smtpclient_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_smtpclient_gettlsusesessionresumption(void* lpObj);
int secureblackbox_smtpclient_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_smtpclient_gettlsversions(void* lpObj);
int secureblackbox_smtpclient_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
TrustedCertificates Property (SMTPClient Class)
A list of trusted certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates(); int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_smtpclient_gettrustedcertcount(void* lpObj);
int secureblackbox_smtpclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_smtpclient_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_smtpclient_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_smtpclient_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 than that of 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
Username Property (SMTPClient 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_smtpclient_getusername(void* lpObj);
int secureblackbox_smtpclient_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 SMTP server.
Data Type
String
Config Method (SMTPClient Class)
This method sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_smtpclient_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 (SMTPClient Class)
Establishes a connection to the SMTP server.
Syntax
ANSI (Cross Platform) int Connect(const char* lpszAddress, int iPort); Unicode (Windows) INT Connect(LPCWSTR lpszAddress, INT iPort);
int secureblackbox_smtpclient_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 SMTP server at Address and Port.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Disconnect Method (SMTPClient Class)
Closes connection to the SMTP server.
Syntax
ANSI (Cross Platform) int Disconnect(); Unicode (Windows) INT Disconnect();
int secureblackbox_smtpclient_disconnect(void* lpObj);
int Disconnect();
Remarks
Call this method when all messages have been sent.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoAction Method (SMTPClient 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_smtpclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insencitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
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.
Reset Method (SMTPClient Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_smtpclient_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendBytes Method (SMTPClient Class)
Sends an e-mail message stored in a byte array.
Syntax
ANSI (Cross Platform) int SendBytes(const char* lpBytes, int lenBytes); Unicode (Windows) INT SendBytes(LPCSTR lpBytes, INT lenBytes);
int secureblackbox_smtpclient_sendbytes(void* lpObj, const char* lpBytes, int lenBytes);
int SendBytes(QByteArray qbaBytes);
Remarks
Use this method to send a message stored in a byte array specified by Bytes.
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.)
SendFile Method (SMTPClient Class)
Sends an e-mail message stored in a file.
Syntax
ANSI (Cross Platform) int SendFile(const char* lpszFileName); Unicode (Windows) INT SendFile(LPCWSTR lpszFileName);
int secureblackbox_smtpclient_sendfile(void* lpObj, const char* lpszFileName);
int SendFile(const QString& qsFileName);
Remarks
Use this method to send a message stored in the file specified by FileName.
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.)
SendMessage Method (SMTPClient Class)
Sends a message to the SMTP server.
Syntax
ANSI (Cross Platform) int SendMessage(); Unicode (Windows) INT SendMessage();
int secureblackbox_smtpclient_sendmessage(void* lpObj);
int SendMessage();
Remarks
Use this method to send a Message to the SMTP server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendStream Method (SMTPClient Class)
Sends an e-mail message stored in a stream.
Syntax
ANSI (Cross Platform) int SendStream(SecureBlackboxStream* sStream); Unicode (Windows) INT SendStream(SecureBlackboxStream* sStream);
int secureblackbox_smtpclient_sendstream(void* lpObj, SecureBlackboxStream* sStream);
int SendStream(SecureBlackboxStream* sStream);
Remarks
Use this method to send a message stored in the Stream to the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
BeforeAuth Event (SMTPClient Class)
Fires before the authentication starts.
Syntax
ANSI (Cross Platform) virtual int FireBeforeAuth(SMTPClientBeforeAuthEventParams *e);
typedef struct { int reserved; } SMTPClientBeforeAuthEventParams;
Unicode (Windows) virtual INT FireBeforeAuth(SMTPClientBeforeAuthEventParams *e);
typedef struct { INT reserved; } SMTPClientBeforeAuthEventParams;
#define EID_SMTPCLIENT_BEFOREAUTH 1 virtual INT SECUREBLACKBOX_CALL FireBeforeAuth();
class SMTPClientBeforeAuthEventParams { public: int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeAuth(SMTPClientBeforeAuthEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireBeforeAuth(SMTPClientBeforeAuthEventParams *e) {...}
Remarks
The class fires this event when it has established the TCP connection and is ready to proceed to the user authentication step.
Command Event (SMTPClient Class)
Reports a command sent to the server.
Syntax
ANSI (Cross Platform) virtual int FireCommand(SMTPClientCommandEventParams *e);
typedef struct {
const char *Cmd; int reserved; } SMTPClientCommandEventParams;
Unicode (Windows) virtual INT FireCommand(SMTPClientCommandEventParams *e);
typedef struct {
LPCWSTR Cmd; INT reserved; } SMTPClientCommandEventParams;
#define EID_SMTPCLIENT_COMMAND 2 virtual INT SECUREBLACKBOX_CALL FireCommand(LPSTR &lpszCmd);
class SMTPClientCommandEventParams { public: const QString &Cmd(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Command(SMTPClientCommandEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireCommand(SMTPClientCommandEventParams *e) {...}
Remarks
The class fires this event whenever it sends an SMTP command to the server. Use CommandReply to track the server's responses.
CommandData Event (SMTPClient Class)
Returns the data that accompanies the command.
Syntax
ANSI (Cross Platform) virtual int FireCommandData(SMTPClientCommandDataEventParams *e);
typedef struct {
const char *Cmd;
const char *Data; int reserved; } SMTPClientCommandDataEventParams;
Unicode (Windows) virtual INT FireCommandData(SMTPClientCommandDataEventParams *e);
typedef struct {
LPCWSTR Cmd;
LPCWSTR Data; INT reserved; } SMTPClientCommandDataEventParams;
#define EID_SMTPCLIENT_COMMANDDATA 3 virtual INT SECUREBLACKBOX_CALL FireCommandData(LPSTR &lpszCmd, LPSTR &lpszData);
class SMTPClientCommandDataEventParams { 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(SMTPClientCommandDataEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireCommandData(SMTPClientCommandDataEventParams *e) {...}
Remarks
Subscribe to this event to access data accompanying the outgoing commands.
CommandReply Event (SMTPClient Class)
Reports the receipt of a reply to a command.
Syntax
ANSI (Cross Platform) virtual int FireCommandReply(SMTPClientCommandReplyEventParams *e);
typedef struct {
const char *Cmd;
const char *Reply; int reserved; } SMTPClientCommandReplyEventParams;
Unicode (Windows) virtual INT FireCommandReply(SMTPClientCommandReplyEventParams *e);
typedef struct {
LPCWSTR Cmd;
LPCWSTR Reply; INT reserved; } SMTPClientCommandReplyEventParams;
#define EID_SMTPCLIENT_COMMANDREPLY 4 virtual INT SECUREBLACKBOX_CALL FireCommandReply(LPSTR &lpszCmd, LPSTR &lpszReply);
class SMTPClientCommandReplyEventParams { 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(SMTPClientCommandReplyEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireCommandReply(SMTPClientCommandReplyEventParams *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.
Error Event (SMTPClient Class)
Provides information about errors during SMTP operations.
Syntax
ANSI (Cross Platform) virtual int FireError(SMTPClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SMTPClientErrorEventParams;
Unicode (Windows) virtual INT FireError(SMTPClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SMTPClientErrorEventParams;
#define EID_SMTPCLIENT_ERROR 5 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SMTPClientErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SMTPClientErrorEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireError(SMTPClientErrorEventParams *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.
ExternalSign Event (SMTPClient Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
ANSI (Cross Platform) virtual int FireExternalSign(SMTPClientExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } SMTPClientExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(SMTPClientExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } SMTPClientExternalSignEventParams;
#define EID_SMTPCLIENT_EXTERNALSIGN 6 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class SMTPClientExternalSignEventParams { public: const QString &OperationId(); const QString &HashAlgorithm(); const QString &Pars(); const QString &Data(); const QString &SignedData(); void SetSignedData(const QString &qsSignedData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalSign(SMTPClientExternalSignEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireExternalSign(SMTPClientExternalSignEventParams *e) {...}
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
Notification Event (SMTPClient Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(SMTPClientNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } SMTPClientNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(SMTPClientNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } SMTPClientNotificationEventParams;
#define EID_SMTPCLIENT_NOTIFICATION 7 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class SMTPClientNotificationEventParams { 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(SMTPClientNotificationEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireNotification(SMTPClientNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
Progress Event (SMTPClient Class)
Reports the progress of the data transfer operation.
Syntax
ANSI (Cross Platform) virtual int FireProgress(SMTPClientProgressEventParams *e);
typedef struct {
int64 Total;
int64 Current;
int Cancel; int reserved; } SMTPClientProgressEventParams;
Unicode (Windows) virtual INT FireProgress(SMTPClientProgressEventParams *e);
typedef struct {
LONG64 Total;
LONG64 Current;
BOOL Cancel; INT reserved; } SMTPClientProgressEventParams;
#define EID_SMTPCLIENT_PROGRESS 8 virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);
class SMTPClientProgressEventParams { 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(SMTPClientProgressEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireProgress(SMTPClientProgressEventParams *e) {...}
Remarks
The class fires this event repeatedly to report the progress of the data transfer operation.
TLSCertNeeded Event (SMTPClient Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(SMTPClientTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } SMTPClientTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(SMTPClientTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } SMTPClientTLSCertNeededEventParams;
#define EID_SMTPCLIENT_TLSCERTNEEDED 9 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class SMTPClientTLSCertNeededEventParams { 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(SMTPClientTLSCertNeededEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireTLSCertNeeded(SMTPClientTLSCertNeededEventParams *e) {...}
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (SMTPClient 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(SMTPClientTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } SMTPClientTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(SMTPClientTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } SMTPClientTLSCertValidateEventParams;
#define EID_SMTPCLIENT_TLSCERTVALIDATE 10 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class SMTPClientTLSCertValidateEventParams { 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(SMTPClientTLSCertValidateEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireTLSCertValidate(SMTPClientTLSCertValidateEventParams *e) {...}
Remarks
This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
TLSEstablished Event (SMTPClient Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(SMTPClientTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } SMTPClientTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(SMTPClientTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } SMTPClientTLSEstablishedEventParams;
#define EID_SMTPCLIENT_TLSESTABLISHED 11 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class SMTPClientTLSEstablishedEventParams { 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(SMTPClientTLSEstablishedEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireTLSEstablished(SMTPClientTLSEstablishedEventParams *e) {...}
Remarks
The class uses this event to notify the application about successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (SMTPClient Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(SMTPClientTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } SMTPClientTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(SMTPClientTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } SMTPClientTLSHandshakeEventParams;
#define EID_SMTPCLIENT_TLSHANDSHAKE 12 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class SMTPClientTLSHandshakeEventParams { 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(SMTPClientTLSHandshakeEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireTLSHandshake(SMTPClientTLSHandshakeEventParams *e) {...}
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.
TLSPSK Event (SMTPClient Class)
Notifies the application about the PSK key exchange.
Syntax
ANSI (Cross Platform) virtual int FireTLSPSK(SMTPClientTLSPSKEventParams *e);
typedef struct {
const char *Host;
const char *Hint; int reserved; } SMTPClientTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(SMTPClientTLSPSKEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Hint; INT reserved; } SMTPClientTLSPSKEventParams;
#define EID_SMTPCLIENT_TLSPSK 13 virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LPSTR &lpszHost, LPSTR &lpszHint);
class SMTPClientTLSPSKEventParams { 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(SMTPClientTLSPSKEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireTLSPSK(SMTPClientTLSPSKEventParams *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 (SMTPClient Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(SMTPClientTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } SMTPClientTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(SMTPClientTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } SMTPClientTLSShutdownEventParams;
#define EID_SMTPCLIENT_TLSSHUTDOWN 14 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class SMTPClientTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(SMTPClientTLSShutdownEventParams *e);
// Or, subclass SMTPClient and override this emitter function. virtual int FireTLSShutdown(SMTPClientTLSShutdownEventParams *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
Provides details of an individual X.509 certificate.
Syntax
SecureBlackboxCertificate (declared in secureblackbox.h)
Remarks
This type provides access to X.509 certificate details.
Fields
Bytes
char* (read-only)
Default Value:
Returns raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the object.
CRLDistributionPoints
char*
Default Value: ""
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Curve
char*
Default Value: ""
Specifies the elliptic curve of the EC public key.
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.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate.
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: ""
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
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.
IssuerRDN
char*
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
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 |
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key.
KeyFingerprint
char* (read-only)
Default Value:
Returns a fingerprint of the public key contained in the certificate.
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 |
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 (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificates ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the origin of this certificate.
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.
PrivateKeyBytes
char* (read-only)
Default Value:
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has an associated private key.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
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 TSL to be qualified.
QualifiedStatements
int
Default Value: 0
Returns the qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifiers 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.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
Source
int (read-only)
Default Value: 0
Returns the source of the entity contained in the object.
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.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
SubjectKeyID
char*
Default Value:
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
SubjectRDN
char*
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature on the request is valid and matches the public key contained in the 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(const char* lpBytes, int lenBytes, int iStartIndex, int iCount, const char* lpszPassword)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
>Certificate(const char* lpCertBytes, int lenCertBytes, int iCertStartIndex, int iCertCount, const char* lpKeyBytes, int lenKeyBytes, int iKeyStartIndex, int iKeyCount, const char* lpszPassword)
Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
>Certificate(const char* lpBytes, int lenBytes, int iStartIndex, int iCount)
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.
>Certificate(const char* lpszPath, const char* lpszPassword)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.
>Certificate(const char* lpszCertPath, const char* lpszKeyPath, const char* lpszPassword)
Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.
>Certificate(const char* lpszPath)
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
>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.
Fields
Bytes
char* (read-only)
Default Value:
Returns raw CRL data in DER format.
CAKeyID
char*
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount
int (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
IssuerRDN
char* (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location
char* (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
NextUpdate
char* (read-only)
Default Value: ""
The planned time and date of the next version of this CRL to be published.
SigAlgorithm
char* (read-only)
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 of the entity contained in the object.
TBS
char* (read-only)
Default Value:
The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate
char* (read-only)
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
>
CRL(const char* lpBytes, int lenBytes, int iStartIndex, int iCount)
Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.
>CRL(const char* lpszLocation)
Creates a CRL object by downloading it from a remote location.
>CRL()
Creates an empty CRL object.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Syntax
SecureBlackboxExternalCrypto (declared in secureblackbox.h)
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
AsyncDocumentID
char*
Default Value: ""
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
CustomParams
char*
Default Value: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
char*
Default Value: ""
Additional data to be included in the async state and mirrored back by the requestor
ExternalHashCalculation
int
Default Value: FALSE
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.
HashAlgorithm
char*
Default Value: "SHA256"
Specifies the request's signature hash algorithm.
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 |
KeyID
char*
Default Value: ""
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
KeySecret
char*
Default Value: ""
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Method
int
Default Value: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Mode
int
Default Value: 0
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
PublicKeyAlgorithm
char*
Default Value: ""
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
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 |
Constructors
>
ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
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).
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 to specify the sender separately.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HtmlText
char*
Default Value: ""
The HTML version of the message.
ID
char*
Default Value: ""
The contents of the Message-ID header field.
This field contains a unique identifier that refers to a particular version of this message.
InReplyTo
char*
Default Value: ""
The value of the In-Reply-To header field.
A reply message should have the "In-Reply-To:" header field which may be used to identify the message (or messages) to which the new message is a reply.
Keywords
char*
Default Value: ""
The value of the Keywords header field.
This field can be used to add some important words and phrases that might be useful for the recipient.
Mailer
char* (read-only)
Default Value: ""
The name of the software that was used to send the message.
PlainText
char*
Default Value: ""
The plain text version of the message.
Priority
int
Default Value: 2
Specifies the message priority.
Available options:
mpLowest | 0 |
mpLow | 1 |
mpNormal | 2 |
mpHigh | 3 |
mpHighest | 4 |
ReadReceipt
int
Default Value: FALSE
Enables a read notification.
References
char*
Default Value: ""
The value of the References header field.
A reply message should include a "References:" header field which may be used to identify the "conversation thread". If the initial message is a reply itself, the References of the reply contain combined content of its "References:", "InReplyTo:" and "MessageID:" fields, subject to their presence in the original message.
ReplyTo
char*
Default Value: ""
The value of the Reply-To header field.
This field contains the addresses to which the replies to this message should be sent. This field is optional. If not specified, the replies must be sent to the addresses specified in the 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 (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
Bytes
char* (read-only)
Default Value:
Buffer containing raw OCSP response data.
EntryCount
int (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN
char* (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location
char* (read-only)
Default Value: ""
Location of the OCSP responder.
ProducedAt
char* (read-only)
Default Value: ""
Specifies the time when the response was produced, in UTC.
Source
int (read-only)
Default Value: 0
Returns the source of the entity contained in the object.
Constructors
>
OCSPResponse(const char* lpBytes, int lenBytes, int iStartIndex, int iCount)
Initializes the response from a memory buffer. Bytes is a buffer containing raw OCSP response data, StartIndex and Count specify the starting position and the number of bytes to be read from this buffer.
>OCSPResponse(const char* lpszLocation)
Downloads an OCSP response from a remote location.
>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.
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.
The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
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.
SMTPServerInfo Type
Describes the SMTP server's capabilities.
Syntax
SecureBlackboxSMTPServerInfo (declared in secureblackbox.h)
Remarks
Check this object to learn about the SMTP server's technical capabilities.
Fields
AuthLoginSupported
int (read-only)
Default Value: FALSE
Whether the SMTP server supports LOGIN authentication method.
AuthPlainSupported
int (read-only)
Default Value: FALSE
Whether the SMTP server supports PLAIN authentication method.
Available
int (read-only)
Default Value: FALSE
Specifies whether server extensions are available.
BinarySupported
int (read-only)
Default Value: FALSE
Whether binary sending mode is supported by the SMTP server.
ChunkingSupported
int (read-only)
Default Value: FALSE
Whether message chunking is supported by the SMTP server.
DsnSupported
int (read-only)
Default Value: FALSE
Whether the SMTP server supports Delivery Status Notifications.
MaxMessageSize
int (read-only)
Default Value: 0
Returns the maximum size of a message in bytes which the server can accept.
SaslSupported
int (read-only)
Default Value: FALSE
Whether the SMTP server supports SASL authentication.
SizeSupported
int (read-only)
Default Value: FALSE
Whether the SMTP server supports SIZE service extension.
StatusCodesSupported
int (read-only)
Default Value: FALSE
Whether the SMTP server supports status codes.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
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 the 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 the 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.
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 what 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
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
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 on offer, 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 that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
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 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 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 | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP | 3 | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP | 4 | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL | 5 | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP | 6 | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP | 7 | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) 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 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, allow plain data. |
UseExtendedMasterSecret
int
Default Value: FALSE
Enables Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables 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 SMTPClient 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() {}
|
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 SMTPClient 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 SMTPClient 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:
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 (SMTPClient 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.SMTPClient Config Settings
Supported methods: PLAIN, LOGIN, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2, SCRAM-SHA-1, SCRAM-SHA-256
Default value: LOGIN,PLAIN,DIGEST-MD5,CRAM-MD5,NTLM
Supported values: SUCCESS, FAILURE, DELAY
Default value: disabled (empty string)
Supported values: HEADERS, FULL
Default value: HEADERS
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- AuthorityKeyID extension in CRL and certificate issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
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) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (SMTPClient 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.
SMTPClient Errors
1048577 | Invalid parameter value (SB_ERROR_INVALID_PARAMETER) |
1048578 | Class is configured incorrectly (SB_ERROR_INVALID_SETUP) |
1048579 | Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) |
1048580 | Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) |
1048581 | Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) |
1048581 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |