POP3Client Class

Properties Methods Events Config Settings Errors

The POP3Client class provides client-side functionality of the POP3 protocol for collecting E-mail messages from the server.

Syntax

POP3Client

Remarks

Use this class to retrieve e-mail messages from a POP3 server.

Property List

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


BlockedCertCount	The number of records in the BlockedCert arrays.
BlockedCertBytes	Returns the raw certificate data in DER format.
BlockedCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ClientCertCount	The number of records in the ClientCert arrays.
ClientCertBytes	Returns the raw certificate data in DER format.
ClientCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ConnInfoAEADCipher	Indicates whether the encryption algorithm used is an AEAD cipher.
ConnInfoChainValidationDetails	The details of a certificate chain validation outcome.
ConnInfoChainValidationResult	The outcome of a certificate chain validation routine.
ConnInfoCiphersuite	The cipher suite employed by this connection.
ConnInfoClientAuthenticated	Specifies whether client authentication was performed during this connection.
ConnInfoClientAuthRequested	Specifies whether client authentication was requested during this connection.
ConnInfoConnectionEstablished	Indicates whether the connection has been established fully.
ConnInfoConnectionID	The unique identifier assigned to this connection.
ConnInfoDigestAlgorithm	The digest algorithm used in a TLS-enabled connection.
ConnInfoEncryptionAlgorithm	The symmetric encryption algorithm used in a TLS-enabled connection.
ConnInfoExportable	Indicates whether a TLS connection uses a reduced-strength exportable cipher.
ConnInfoKeyExchangeAlgorithm	The key exchange algorithm used in a TLS-enabled connection.
ConnInfoKeyExchangeKeyBits	The length of the key exchange key of a TLS-enabled connection.
ConnInfoNamedECCurve	The elliptic curve used in this connection.
ConnInfoPFSCipher	Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
ConnInfoPreSharedIdentityHint	A hint professed by the server to help the client select the PSK identity to use.
ConnInfoPublicKeyBits	The length of the public key.
ConnInfoResumedSession	Indicates whether a TLS-enabled connection was spawned from another TLS connection.
ConnInfoSecureConnection	Indicates whether TLS or SSL is enabled for this connection.
ConnInfoServerAuthenticated	Indicates whether server authentication was performed during a TLS-enabled connection.
ConnInfoSignatureAlgorithm	The signature algorithm used in a TLS handshake.
ConnInfoSymmetricBlockSize	The block size of the symmetric algorithm used.
ConnInfoSymmetricKeyBits	The key length of the symmetric algorithm used.
ConnInfoTotalBytesReceived	The total number of bytes received over this connection.
ConnInfoTotalBytesSent	The total number of bytes sent over this connection.
ConnInfoValidationLog	Contains the server certificate's chain validation log.
ConnInfoVersion	Indicates the version of SSL/TLS protocol negotiated during this connection.
ExternalCryptoAsyncDocumentID	Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
ExternalCryptoCustomParams	Custom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoData	Additional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculation	Specifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithm	Specifies the request's signature hash algorithm.
ExternalCryptoKeyID	The ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecret	The pre-shared key used for DC request authentication.
ExternalCryptoMethod	Specifies the asynchronous signing method.
ExternalCryptoMode	Specifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithm	Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
FIPSMode	Reserved.
KnownCertCount	The number of records in the KnownCert arrays.
KnownCertBytes	Returns the raw certificate data in DER format.
KnownCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCount	The number of records in the KnownCRL arrays.
KnownCRLBytes	Returns the raw CRL data in DER format.
KnownCRLHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCount	The number of records in the KnownOCSP arrays.
KnownOCSPBytes	A buffer containing the raw OCSP response data.
KnownOCSPHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
MsgAttachmentCount	Returns the number of attachments in this message.
MsgBcc	The contents of the BCC header property.
MsgCc	The value of the CC header property.
MsgComments	Contains additional information about the message body.
MsgDate	The date and time when the message entered the mail delivery system.
MsgDeliveryReceipt	Enables delivery notification.
MsgFrom	Contains the value of the From header property.
MsgHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
MsgHtmlText	The HTML version of the message.
MsgID	The contents of the Message-ID header property.
MsgInReplyTo	The value of the In-Reply-To header property.
MsgKeywords	The value of the Keywords header property.
MsgMailer	The name of the software that was used to send the message.
MsgPlainText	The plain text version of the message.
MsgPriority	Specifies the message priority.
MsgReadReceipt	Enables a read notification.
MsgReferences	The value of the References header property.
MsgReplyTo	The value of the Reply-To header property.
MsgReturnPath	The value of the Return-Path header property.
MsgSender	The value of the Sender header property.
MsgSendTo	The value of the To header property.
MsgSubject	Contains the subject property of this message.
MsgInfoCount	The number of records in the MsgInfo arrays.
MsgInfoSize	Returns the size of the message in bytes.
MsgInfoUID	Returns the unique ID of the mail message.
Password	A password to authenticate to the POP3 server.
ProxyAddress	The IP address of the proxy server.
ProxyAuthentication	The authentication type used by the proxy server.
ProxyPassword	The password to authenticate to the proxy server.
ProxyPort	The port on the proxy server to connect to.
ProxyProxyType	The type of the proxy server.
ProxyRequestHeaders	Contains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBody	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeaders	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6	Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUseProxy	Enables or disables proxy-driven connection.
ProxyUsername	Specifies the username credential for proxy authentication.
ServerCertCount	The number of records in the ServerCert arrays.
ServerCertBytes	Returns the raw certificate data in DER format.
ServerCertCAKeyID	A unique identifier (fingerprint) of the CA certificate's private key.
ServerCertFingerprint	Contains the fingerprint (a hash imprint) of this certificate.
ServerCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ServerCertIssuer	The common name of the certificate issuer (CA), typically a company name.
ServerCertIssuerRDN	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
ServerCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
ServerCertKeyBits	Returns the length of the public key.
ServerCertKeyFingerprint	Returns a fingerprint of the public key contained in the certificate.
ServerCertKeyUsage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
ServerCertPublicKeyBytes	Contains the certificate's public key in DER format.
ServerCertSelfSigned	Indicates whether the certificate is self-signed (root) or signed by an external CA.
ServerCertSerialNumber	Returns the certificate's serial number.
ServerCertSigAlgorithm	Indicates the algorithm that was used by the CA to sign this certificate.
ServerCertSubject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
ServerCertSubjectKeyID	Contains a unique identifier (fingerprint) of the certificate's private key.
ServerCertSubjectRDN	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
ServerCertValidFrom	The time point at which the certificate becomes valid, in UTC.
ServerCertValidTo	The time point at which the certificate expires, in UTC.
ServerInfoApopSupported	Indicates whether the POP3 server supports the APOP command.
ServerInfoAvailable	Indicates whether the details of the server capabilities are available.
ServerInfoExpirationPeriod	Contains the parameter of EXPIRE capability.
ServerInfoExpireSupported	Indicates whether the POP3 server supports the EXPIRE extension.
ServerInfoImplementationSupported	Indicates whether the POP3 server supports the IMPLEMENTATION extension.
ServerInfoLoginDelay	Returns the parameter of LOGIN-DELAY capability.
ServerInfoLoginDelaySupported	Indicates whether the POP3 server supports the LOGIN-DELAY extension.
ServerInfoRespCodesSupported	Indicates whether the POP3 server supports the RESP-CODES extension.
ServerInfoSaslSupported	Indicates whether the POP3 server supports SASL authentication.
ServerInfoServerDetails	Contains the parameter of the IMPLEMENTATION capability.
ServerInfoTopSupported	Indicates whether the POP3 server supports the TOP command.
ServerInfoUidlSupported	Indicates whether the POP3 server supports the UIDL command.
ServerInfoUserSupported	Indicates whether the POP3 server supports the USER command.
SocketDNSMode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPort	Specifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeout	The timeout (in milliseconds) for each DNS query.
SocketDNSServers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeout	The timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimit	The maximum number of bytes to read from the socket, per second.
SocketLocalAddress	The local network interface to bind the socket to.
SocketLocalPort	The local port number to bind the socket to.
SocketOutgoingSpeedLimit	The maximum number of bytes to write to the socket, per second.
SocketTimeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6	Enables or disables IP protocol version 6.
TLSAutoValidateCertificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfiguration	Selects the base configuration for the TLS settings.
TLSCiphersuites	A list of ciphersuites separated with commas or semicolons.
TLSECCurves	Defines the elliptic curves to enable.
TLSExtensions	Provides access to TLS extensions.
TLSForceResumeIfDestinationChanges	Whether to force TLS session resumption when the destination address changes.
TLSPreSharedIdentity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKey	Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionMode	Selects the renegotiation attack prevention mechanism.
TLSRevocationCheck	Specifies the kind(s) of revocation check to perform.
TLSSSLOptions	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.
TLSTLSMode	Specifies the TLS mode to use.
TLSUseExtendedMasterSecret	Enables the Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumption	Enables or disables the TLS session resumption capability.
TLSVersions	The SSL/TLS versions to enable by default.
TrustedCertCount	The number of records in the TrustedCert arrays.
TrustedCertBytes	Returns the raw certificate data in DER format.
TrustedCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
Username	A username to authenticate to the POP3 server.

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	Sets or retrieves a configuration setting.
Connect	Establishes connection to the POP3 server.
DeleteMessage	Deletes a message from the server-side mailbox.
Disconnect	Closes connection to the POP3 server.
DoAction	Performs an additional action.
ListMessages	Queries a list of messages available on the server.
Ping	Sends a NOOP command to the POP3 server.
ReceiveBytes	Downloads a message to a byte array.
ReceiveFile	Downloads a message to a file.
ReceiveMessage	Downloads a message.
ReceiveStream	Downloads a message to a stream.
Undelete	Undeletes messages marked for deletion.

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.
CommandReply	Reports the receipt of a reply to a command.
CommandReplyData	Returns the data that accompanies a reply to a command.
Error	Provides information about errors during POP3 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.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
MaxLineLength	Specifies maximum expected line length.
RequestUIDs	Specifies whether to request message UIDs when listing messages.
TempPath	Path for storing temporary files.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
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.

BlockedCertCount Property (POP3Client Class)

The number of records in the BlockedCert arrays.

Syntax

ANSI (Cross Platform)
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);

Unicode (Windows)
INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);

int secureblackbox_pop3client_getblockedcertcount(void* lpObj);
int secureblackbox_pop3client_setblockedcertcount(void* lpObj, int iBlockedCertCount);

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

Default Value

Remarks

This property controls the size of the following arrays:

BlockedCertBytes
BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (POP3Client Class)

Returns the raw certificate data in DER format.

Syntax

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

Unicode (Windows)
INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);

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

QByteArray GetBlockedCertBytes(int iBlockedCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

BlockedCertHandle Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle);

Unicode (Windows)
LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);

int64 secureblackbox_pop3client_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_pop3client_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

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

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

ClientCertCount Property (POP3Client Class)

The number of records in the ClientCert arrays.

Syntax

ANSI (Cross Platform)
int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Unicode (Windows)
INT GetClientCertCount();
INT SetClientCertCount(INT iClientCertCount);

int secureblackbox_pop3client_getclientcertcount(void* lpObj);
int secureblackbox_pop3client_setclientcertcount(void* lpObj, int iClientCertCount);

int GetClientCertCount();
int SetClientCertCount(int iClientCertCount);

Default Value

Remarks

This property controls the size of the following arrays:

ClientCertBytes
ClientCertHandle

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

This property is not available at design time.

Data Type

Integer

ClientCertBytes Property (POP3Client Class)

Returns the raw certificate data in DER format.

Syntax

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

Unicode (Windows)
INT GetClientCertBytes(INT iClientCertIndex, LPSTR &lpClientCertBytes, INT &lenClientCertBytes);

int secureblackbox_pop3client_getclientcertbytes(void* lpObj, int clientcertindex, char** lpClientCertBytes, int* lenClientCertBytes);

QByteArray GetClientCertBytes(int iClientCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ClientCertHandle Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, int64 lClientCertHandle);

Unicode (Windows)
LONG64 GetClientCertHandle(INT iClientCertIndex);
INT SetClientCertHandle(INT iClientCertIndex, LONG64 lClientCertHandle);

int64 secureblackbox_pop3client_getclientcerthandle(void* lpObj, int clientcertindex);
int secureblackbox_pop3client_setclientcerthandle(void* lpObj, int clientcertindex, int64 lClientCertHandle);

qint64 GetClientCertHandle(int iClientCertIndex);
int SetClientCertHandle(int iClientCertIndex, qint64 lClientCertHandle);

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

ConnInfoAEADCipher Property (POP3Client Class)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

ANSI (Cross Platform)
int GetConnInfoAEADCipher();

Unicode (Windows)
BOOL GetConnInfoAEADCipher();

int secureblackbox_pop3client_getconninfoaeadcipher(void* lpObj);

bool GetConnInfoAEADCipher();

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

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

Data Type

Boolean

ConnInfoChainValidationDetails Property (POP3Client Class)

The details of a certificate chain validation outcome.

Syntax

ANSI (Cross Platform)
int GetConnInfoChainValidationDetails();

Unicode (Windows)
INT GetConnInfoChainValidationDetails();

int secureblackbox_pop3client_getconninfochainvalidationdetails(void* lpObj);

int GetConnInfoChainValidationDetails();

Default Value

Remarks

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

Returns a bit mask of the following options:


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

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

Data Type

Integer

ConnInfoChainValidationResult Property (POP3Client Class)

The outcome of a certificate chain validation routine.

Syntax

ANSI (Cross Platform)
int GetConnInfoChainValidationResult();

Unicode (Windows)
INT GetConnInfoChainValidationResult();

Possible Values

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1), 
CVT_INVALID(2), 
CVT_CANT_BE_ESTABLISHED(3)

int secureblackbox_pop3client_getconninfochainvalidationresult(void* lpObj);

int GetConnInfoChainValidationResult();

Default Value

Remarks

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.

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

Data Type

Integer

ConnInfoCiphersuite Property (POP3Client Class)

The cipher suite employed by this connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoCiphersuite();

Unicode (Windows)
LPWSTR GetConnInfoCiphersuite();

char* secureblackbox_pop3client_getconninfociphersuite(void* lpObj);

QString GetConnInfoCiphersuite();

Default Value

Remarks

The cipher suite employed by this connection.

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

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

Data Type

String

ConnInfoClientAuthenticated Property (POP3Client Class)

Specifies whether client authentication was performed during this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoClientAuthenticated();

Unicode (Windows)
BOOL GetConnInfoClientAuthenticated();

int secureblackbox_pop3client_getconninfoclientauthenticated(void* lpObj);

bool GetConnInfoClientAuthenticated();

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

ConnInfoClientAuthRequested Property (POP3Client Class)

Specifies whether client authentication was requested during this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoClientAuthRequested();

Unicode (Windows)
BOOL GetConnInfoClientAuthRequested();

int secureblackbox_pop3client_getconninfoclientauthrequested(void* lpObj);

bool GetConnInfoClientAuthRequested();

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

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

Data Type

Boolean

ConnInfoConnectionEstablished Property (POP3Client Class)

Indicates whether the connection has been established fully.

Syntax

ANSI (Cross Platform)
int GetConnInfoConnectionEstablished();

Unicode (Windows)
BOOL GetConnInfoConnectionEstablished();

int secureblackbox_pop3client_getconninfoconnectionestablished(void* lpObj);

bool GetConnInfoConnectionEstablished();

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

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

Data Type

Boolean

ConnInfoConnectionID Property (POP3Client Class)

The unique identifier assigned to this connection.

Syntax

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

Unicode (Windows)
INT GetConnInfoConnectionID(LPSTR &lpConnInfoConnectionID, INT &lenConnInfoConnectionID);

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

QByteArray GetConnInfoConnectionID();

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

ConnInfoDigestAlgorithm Property (POP3Client Class)

The digest algorithm used in a TLS-enabled connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoDigestAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoDigestAlgorithm();

char* secureblackbox_pop3client_getconninfodigestalgorithm(void* lpObj);

QString GetConnInfoDigestAlgorithm();

Default Value

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

ConnInfoEncryptionAlgorithm Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoEncryptionAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoEncryptionAlgorithm();

char* secureblackbox_pop3client_getconninfoencryptionalgorithm(void* lpObj);

QString GetConnInfoEncryptionAlgorithm();

Default Value

Remarks

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

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

Data Type

String

ConnInfoExportable Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoExportable();

Unicode (Windows)
BOOL GetConnInfoExportable();

int secureblackbox_pop3client_getconninfoexportable(void* lpObj);

bool GetConnInfoExportable();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoKeyExchangeAlgorithm Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoKeyExchangeAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoKeyExchangeAlgorithm();

char* secureblackbox_pop3client_getconninfokeyexchangealgorithm(void* lpObj);

QString GetConnInfoKeyExchangeAlgorithm();

Default Value

Remarks

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

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

Data Type

String

ConnInfoKeyExchangeKeyBits Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoKeyExchangeKeyBits();

Unicode (Windows)
INT GetConnInfoKeyExchangeKeyBits();

int secureblackbox_pop3client_getconninfokeyexchangekeybits(void* lpObj);

int GetConnInfoKeyExchangeKeyBits();

Default Value

Remarks

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

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

Data Type

Integer

ConnInfoNamedECCurve Property (POP3Client Class)

The elliptic curve used in this connection.

Syntax

ANSI (Cross Platform)
char* GetConnInfoNamedECCurve();

Unicode (Windows)
LPWSTR GetConnInfoNamedECCurve();

char* secureblackbox_pop3client_getconninfonamedeccurve(void* lpObj);

QString GetConnInfoNamedECCurve();

Default Value

Remarks

The elliptic curve used in this connection.

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

Data Type

String

ConnInfoPFSCipher Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoPFSCipher();

Unicode (Windows)
BOOL GetConnInfoPFSCipher();

int secureblackbox_pop3client_getconninfopfscipher(void* lpObj);

bool GetConnInfoPFSCipher();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoPreSharedIdentityHint Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoPreSharedIdentityHint();

Unicode (Windows)
LPWSTR GetConnInfoPreSharedIdentityHint();

char* secureblackbox_pop3client_getconninfopresharedidentityhint(void* lpObj);

QString GetConnInfoPreSharedIdentityHint();

Default Value

Remarks

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

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

Data Type

String

ConnInfoPublicKeyBits Property (POP3Client Class)

The length of the public key.

Syntax

ANSI (Cross Platform)
int GetConnInfoPublicKeyBits();

Unicode (Windows)
INT GetConnInfoPublicKeyBits();

int secureblackbox_pop3client_getconninfopublickeybits(void* lpObj);

int GetConnInfoPublicKeyBits();

Default Value

Remarks

The length of the public key.

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

Data Type

Integer

ConnInfoResumedSession Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoResumedSession();

Unicode (Windows)
BOOL GetConnInfoResumedSession();

int secureblackbox_pop3client_getconninforesumedsession(void* lpObj);

bool GetConnInfoResumedSession();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoSecureConnection Property (POP3Client Class)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

ANSI (Cross Platform)
int GetConnInfoSecureConnection();

Unicode (Windows)
BOOL GetConnInfoSecureConnection();

int secureblackbox_pop3client_getconninfosecureconnection(void* lpObj);

bool GetConnInfoSecureConnection();

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

ConnInfoServerAuthenticated Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetConnInfoServerAuthenticated();

Unicode (Windows)
BOOL GetConnInfoServerAuthenticated();

int secureblackbox_pop3client_getconninfoserverauthenticated(void* lpObj);

bool GetConnInfoServerAuthenticated();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

ConnInfoSignatureAlgorithm Property (POP3Client Class)

The signature algorithm used in a TLS handshake.

Syntax

ANSI (Cross Platform)
char* GetConnInfoSignatureAlgorithm();

Unicode (Windows)
LPWSTR GetConnInfoSignatureAlgorithm();

char* secureblackbox_pop3client_getconninfosignaturealgorithm(void* lpObj);

QString GetConnInfoSignatureAlgorithm();

Default Value

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

ConnInfoSymmetricBlockSize Property (POP3Client Class)

The block size of the symmetric algorithm used.

Syntax

ANSI (Cross Platform)
int GetConnInfoSymmetricBlockSize();

Unicode (Windows)
INT GetConnInfoSymmetricBlockSize();

int secureblackbox_pop3client_getconninfosymmetricblocksize(void* lpObj);

int GetConnInfoSymmetricBlockSize();

Default Value

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoSymmetricKeyBits Property (POP3Client Class)

The key length of the symmetric algorithm used.

Syntax

ANSI (Cross Platform)
int GetConnInfoSymmetricKeyBits();

Unicode (Windows)
INT GetConnInfoSymmetricKeyBits();

int secureblackbox_pop3client_getconninfosymmetrickeybits(void* lpObj);

int GetConnInfoSymmetricKeyBits();

Default Value

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

ConnInfoTotalBytesReceived Property (POP3Client Class)

The total number of bytes received over this connection.

Syntax

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesReceived();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesReceived();

int64 secureblackbox_pop3client_getconninfototalbytesreceived(void* lpObj);

qint64 GetConnInfoTotalBytesReceived();

Default Value

Remarks

The total number of bytes received over this connection.

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

Data Type

Long64

ConnInfoTotalBytesSent Property (POP3Client Class)

The total number of bytes sent over this connection.

Syntax

ANSI (Cross Platform)
int64 GetConnInfoTotalBytesSent();

Unicode (Windows)
LONG64 GetConnInfoTotalBytesSent();

int64 secureblackbox_pop3client_getconninfototalbytessent(void* lpObj);

qint64 GetConnInfoTotalBytesSent();

Default Value

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

ConnInfoValidationLog Property (POP3Client Class)

Contains the server certificate's chain validation log.

Syntax

ANSI (Cross Platform)
char* GetConnInfoValidationLog();

Unicode (Windows)
LPWSTR GetConnInfoValidationLog();

char* secureblackbox_pop3client_getconninfovalidationlog(void* lpObj);

QString GetConnInfoValidationLog();

Default Value

Remarks

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

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

Data Type

String

ConnInfoVersion Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetConnInfoVersion();

Unicode (Windows)
LPWSTR GetConnInfoVersion();

char* secureblackbox_pop3client_getconninfoversion(void* lpObj);

QString GetConnInfoVersion();

Default Value

Remarks

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

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

Data Type

String

ExternalCryptoAsyncDocumentID Property (POP3Client Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID);

Unicode (Windows)
LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);

char* secureblackbox_pop3client_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_pop3client_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

Remarks

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 the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (POP3Client Class)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams);

Unicode (Windows)
LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);

char* secureblackbox_pop3client_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_pop3client_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

Default Value

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (POP3Client Class)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData);

Unicode (Windows)
LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);

char* secureblackbox_pop3client_getexternalcryptodata(void* lpObj);
int secureblackbox_pop3client_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

Default Value

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (POP3Client Class)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

ANSI (Cross Platform)
int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation);

Unicode (Windows)
BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);

int secureblackbox_pop3client_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_pop3client_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (POP3Client Class)

Specifies the request's signature hash algorithm.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);

char* secureblackbox_pop3client_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_pop3client_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

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`

Data Type

String

ExternalCryptoKeyID Property (POP3Client Class)

The ID of the pre-shared key used for DC request authentication.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID);

Unicode (Windows)
LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);

char* secureblackbox_pop3client_getexternalcryptokeyid(void* lpObj);
int secureblackbox_pop3client_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

Default Value

Remarks

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 an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret 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:

  Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (POP3Client Class)

The pre-shared key used for DC request authentication.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret);

Unicode (Windows)
LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);

char* secureblackbox_pop3client_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_pop3client_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

Default Value

Remarks

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.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (POP3Client Class)

Specifies the asynchronous signing method.

Syntax

ANSI (Cross Platform)
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Unicode (Windows)
INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);

Possible Values

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_pop3client_getexternalcryptomethod(void* lpObj);
int secureblackbox_pop3client_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Default Value

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Data Type

Integer

ExternalCryptoMode Property (POP3Client Class)

Specifies the external cryptography mode.

Syntax

ANSI (Cross Platform)
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Unicode (Windows)
INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);

Possible Values

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

int secureblackbox_pop3client_getexternalcryptomode(void* lpObj);
int secureblackbox_pop3client_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Default Value

Remarks

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 the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (POP3Client Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

ANSI (Cross Platform)
char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm);

Unicode (Windows)
LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);

char* secureblackbox_pop3client_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_pop3client_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

Remarks

Provide the 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`

Data Type

String

FIPSMode Property (POP3Client Class)

Reserved.

Syntax

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

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

int secureblackbox_pop3client_getfipsmode(void* lpObj);
int secureblackbox_pop3client_setfipsmode(void* lpObj, int bFIPSMode);

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

KnownCertCount Property (POP3Client Class)

The number of records in the KnownCert arrays.

Syntax

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Unicode (Windows)
INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);

int secureblackbox_pop3client_getknowncertcount(void* lpObj);
int secureblackbox_pop3client_setknowncertcount(void* lpObj, int iKnownCertCount);

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

Default Value

Remarks

This property controls the size of the following arrays:

KnownCertBytes
KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (POP3Client Class)

Returns the raw certificate data in DER format.

Syntax

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

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);

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

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle);

Unicode (Windows)
LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);

int64 secureblackbox_pop3client_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_pop3client_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);

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

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (POP3Client Class)

The number of records in the KnownCRL arrays.

Syntax

ANSI (Cross Platform)
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);

Unicode (Windows)
INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);

int secureblackbox_pop3client_getknowncrlcount(void* lpObj);
int secureblackbox_pop3client_setknowncrlcount(void* lpObj, int iKnownCRLCount);

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

Default Value

Remarks

This property controls the size of the following arrays:

KnownCRLBytes
KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (POP3Client Class)

Returns the raw CRL data in DER format.

Syntax

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

Unicode (Windows)
INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);

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

QByteArray GetKnownCRLBytes(int iKnownCRLIndex);

Remarks

Returns the raw CRL data in DER format.

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

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

Data Type

Byte Array

KnownCRLHandle Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle);

Unicode (Windows)
LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);

int64 secureblackbox_pop3client_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_pop3client_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);

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

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (POP3Client Class)

The number of records in the KnownOCSP arrays.

Syntax

ANSI (Cross Platform)
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);

Unicode (Windows)
INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);

int secureblackbox_pop3client_getknownocspcount(void* lpObj);
int secureblackbox_pop3client_setknownocspcount(void* lpObj, int iKnownOCSPCount);

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

Default Value

Remarks

This property controls the size of the following arrays:

KnownOCSPBytes
KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (POP3Client Class)

A buffer containing the raw OCSP response data.

Syntax

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

Unicode (Windows)
INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);

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

QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);

Remarks

A buffer containing the raw OCSP response data.

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

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

Data Type

Byte Array

KnownOCSPHandle Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle);

Unicode (Windows)
LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);

int64 secureblackbox_pop3client_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_pop3client_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);

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

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

MsgAttachmentCount Property (POP3Client Class)

Returns the number of attachments in this message.

Syntax

ANSI (Cross Platform)
int GetMsgAttachmentCount();

Unicode (Windows)
INT GetMsgAttachmentCount();

int secureblackbox_pop3client_getmsgattachmentcount(void* lpObj);

int GetMsgAttachmentCount();

Default Value

Remarks

Returns the number of attachments in this message.

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

Data Type

Integer

MsgBcc Property (POP3Client Class)

The contents of the BCC header property.

Syntax

ANSI (Cross Platform)
char* GetMsgBcc();

Unicode (Windows)
LPWSTR GetMsgBcc();

char* secureblackbox_pop3client_getmsgbcc(void* lpObj);

QString GetMsgBcc();

Default Value

Remarks

The contents of the BCC header field.

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

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

Data Type

String

MsgCc Property (POP3Client Class)

The value of the CC header property.

Syntax

ANSI (Cross Platform)
char* GetMsgCc();

Unicode (Windows)
LPWSTR GetMsgCc();

char* secureblackbox_pop3client_getmsgcc(void* lpObj);

QString GetMsgCc();

Default Value

Remarks

The value of the CC header field.

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

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

Data Type

String

MsgComments Property (POP3Client Class)

Contains additional information about the message body.

Syntax

ANSI (Cross Platform)
char* GetMsgComments();

Unicode (Windows)
LPWSTR GetMsgComments();

char* secureblackbox_pop3client_getmsgcomments(void* lpObj);

QString GetMsgComments();

Default Value

Remarks

Contains additional information about the message body.

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

Data Type

String

MsgDate Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetMsgDate();

Unicode (Windows)
LPWSTR GetMsgDate();

char* secureblackbox_pop3client_getmsgdate(void* lpObj);

QString GetMsgDate();

Default Value

Remarks

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

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

The date is returned and accepted in UTC time zone.

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

Data Type

String

MsgDeliveryReceipt Property (POP3Client Class)

Enables delivery notification.

Syntax

ANSI (Cross Platform)
int GetMsgDeliveryReceipt();

Unicode (Windows)
BOOL GetMsgDeliveryReceipt();

int secureblackbox_pop3client_getmsgdeliveryreceipt(void* lpObj);

bool GetMsgDeliveryReceipt();

Default Value

FALSE

Remarks

Enables delivery notification.

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

Data Type

Boolean

MsgFrom Property (POP3Client Class)

Contains the value of the From header property.

Syntax

ANSI (Cross Platform)
char* GetMsgFrom();

Unicode (Windows)
LPWSTR GetMsgFrom();

char* secureblackbox_pop3client_getmsgfrom(void* lpObj);

QString GetMsgFrom();

Default Value

Remarks

Contains the value of the From header field.

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

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

Data Type

String

MsgHandle Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int64 GetMsgHandle();

Unicode (Windows)
LONG64 GetMsgHandle();

int64 secureblackbox_pop3client_getmsghandle(void* lpObj);

qint64 GetMsgHandle();

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

Long64

MsgHtmlText Property (POP3Client Class)

The HTML version of the message.

Syntax

ANSI (Cross Platform)
char* GetMsgHtmlText();

Unicode (Windows)
LPWSTR GetMsgHtmlText();

char* secureblackbox_pop3client_getmsghtmltext(void* lpObj);

QString GetMsgHtmlText();

Default Value

Remarks

The HTML version of the message.

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

Data Type

String

MsgID Property (POP3Client Class)

The contents of the Message-ID header property.

Syntax

ANSI (Cross Platform)
char* GetMsgID();

Unicode (Windows)
LPWSTR GetMsgID();

char* secureblackbox_pop3client_getmsgid(void* lpObj);

QString GetMsgID();

Default Value

Remarks

The contents of the Message-ID header field.

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

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

Data Type

String

MsgInReplyTo Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetMsgInReplyTo();

Unicode (Windows)
LPWSTR GetMsgInReplyTo();

char* secureblackbox_pop3client_getmsginreplyto(void* lpObj);

QString GetMsgInReplyTo();

Default Value

Remarks

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

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

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

Data Type

String

MsgKeywords Property (POP3Client Class)

The value of the Keywords header property.

Syntax

ANSI (Cross Platform)
char* GetMsgKeywords();

Unicode (Windows)
LPWSTR GetMsgKeywords();

char* secureblackbox_pop3client_getmsgkeywords(void* lpObj);

QString GetMsgKeywords();

Default Value

Remarks

The value of the Keywords header field.

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

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

Data Type

String

MsgMailer Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetMsgMailer();

Unicode (Windows)
LPWSTR GetMsgMailer();

char* secureblackbox_pop3client_getmsgmailer(void* lpObj);

QString GetMsgMailer();

Default Value

Remarks

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

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

Data Type

String

MsgPlainText Property (POP3Client Class)

The plain text version of the message.

Syntax

ANSI (Cross Platform)
char* GetMsgPlainText();

Unicode (Windows)
LPWSTR GetMsgPlainText();

char* secureblackbox_pop3client_getmsgplaintext(void* lpObj);

QString GetMsgPlainText();

Default Value

Remarks

The plain text version of the message.

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

Data Type

String

MsgPriority Property (POP3Client Class)

Specifies the message priority.

Syntax

ANSI (Cross Platform)
int GetMsgPriority();

Unicode (Windows)
INT GetMsgPriority();

Possible Values

MP_LOWEST(0), 
MP_LOW(1), 
MP_NORMAL(2), 
MP_HIGH(3), 
MP_HIGHEST(4)

int secureblackbox_pop3client_getmsgpriority(void* lpObj);

int GetMsgPriority();

Default Value

Remarks

Specifies the message priority.

Available options:


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

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

Data Type

Integer

MsgReadReceipt Property (POP3Client Class)

Enables a read notification.

Syntax

ANSI (Cross Platform)
int GetMsgReadReceipt();

Unicode (Windows)
BOOL GetMsgReadReceipt();

int secureblackbox_pop3client_getmsgreadreceipt(void* lpObj);

bool GetMsgReadReceipt();

Default Value

FALSE

Remarks

Enables a read notification.

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

Data Type

Boolean

MsgReferences Property (POP3Client Class)

The value of the References header property.

Syntax

ANSI (Cross Platform)
char* GetMsgReferences();

Unicode (Windows)
LPWSTR GetMsgReferences();

char* secureblackbox_pop3client_getmsgreferences(void* lpObj);

QString GetMsgReferences();

Default Value

Remarks

The value of the References header field.

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

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

Data Type

String

MsgReplyTo Property (POP3Client Class)

The value of the Reply-To header property.

Syntax

ANSI (Cross Platform)
char* GetMsgReplyTo();

Unicode (Windows)
LPWSTR GetMsgReplyTo();

char* secureblackbox_pop3client_getmsgreplyto(void* lpObj);

QString GetMsgReplyTo();

Default Value

Remarks

The value of the Reply-To header field.

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

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

Data Type

String

MsgReturnPath Property (POP3Client Class)

The value of the Return-Path header property.

Syntax

ANSI (Cross Platform)
char* GetMsgReturnPath();

Unicode (Windows)
LPWSTR GetMsgReturnPath();

char* secureblackbox_pop3client_getmsgreturnpath(void* lpObj);

QString GetMsgReturnPath();

Default Value

Remarks

The value of the Return-Path header field.

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

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

Data Type

String

MsgSender Property (POP3Client Class)

The value of the Sender header property.

Syntax

ANSI (Cross Platform)
char* GetMsgSender();

Unicode (Windows)
LPWSTR GetMsgSender();

char* secureblackbox_pop3client_getmsgsender(void* lpObj);

QString GetMsgSender();

Default Value

Remarks

The value of the Sender header field.

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

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

Data Type

String

MsgSendTo Property (POP3Client Class)

The value of the To header property.

Syntax

ANSI (Cross Platform)
char* GetMsgSendTo();

Unicode (Windows)
LPWSTR GetMsgSendTo();

char* secureblackbox_pop3client_getmsgsendto(void* lpObj);

QString GetMsgSendTo();

Default Value

Remarks

The value of the To header field.

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

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

Data Type

String

MsgSubject Property (POP3Client Class)

Contains the subject property of this message.

Syntax

ANSI (Cross Platform)
char* GetMsgSubject();

Unicode (Windows)
LPWSTR GetMsgSubject();

char* secureblackbox_pop3client_getmsgsubject(void* lpObj);

QString GetMsgSubject();

Default Value

Remarks

Contains the subject field of this message.

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

Data Type

String

MsgInfoCount Property (POP3Client Class)

The number of records in the MsgInfo arrays.

Syntax

ANSI (Cross Platform)
int GetMsgInfoCount();

Unicode (Windows)
INT GetMsgInfoCount();

int secureblackbox_pop3client_getmsginfocount(void* lpObj);

int GetMsgInfoCount();

Default Value

Remarks

This property controls the size of the following arrays:

MsgInfoSize
MsgInfoUID

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

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

Data Type

Integer

MsgInfoSize Property (POP3Client Class)

Returns the size of the message in bytes.

Syntax

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

Unicode (Windows)
LONG64 GetMsgInfoSize(INT iMsgInfoIndex);

int64 secureblackbox_pop3client_getmsginfosize(void* lpObj, int msginfoindex);

qint64 GetMsgInfoSize(int iMsgInfoIndex);

Default Value

Remarks

Returns the size of the message in bytes.

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

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

Data Type

Long64

MsgInfoUID Property (POP3Client Class)

Returns the unique ID of the mail message.

Syntax

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

Unicode (Windows)
LPWSTR GetMsgInfoUID(INT iMsgInfoIndex);

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

QString GetMsgInfoUID(int iMsgInfoIndex);

Default Value

Remarks

Returns the unique ID of the mail message.

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

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

Data Type

String

Password Property (POP3Client Class)

A password to authenticate to the POP3 server.

Syntax

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

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

char* secureblackbox_pop3client_getpassword(void* lpObj);
int secureblackbox_pop3client_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

Remarks

Use this property together with Username to provide an authentication password. In order to use OAuth 2.0 authentication to access the POP3 server, assign the access token to this property prepending it with "oauth:".

Data Type

String

ProxyAddress Property (POP3Client Class)

The IP address of the proxy server.

Syntax

ANSI (Cross Platform)
char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress);

Unicode (Windows)
LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);

char* secureblackbox_pop3client_getproxyaddress(void* lpObj);
int secureblackbox_pop3client_setproxyaddress(void* lpObj, const char* lpszProxyAddress);

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

Default Value

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (POP3Client Class)

The authentication type used by the proxy server.

Syntax

ANSI (Cross Platform)
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Unicode (Windows)
INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);

Possible Values

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

int secureblackbox_pop3client_getproxyauthentication(void* lpObj);
int secureblackbox_pop3client_setproxyauthentication(void* lpObj, int iProxyAuthentication);

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

Default Value

Remarks

The authentication type used by the proxy server.


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

Data Type

Integer

ProxyPassword Property (POP3Client Class)

The password to authenticate to the proxy server.

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* secureblackbox_pop3client_getproxypassword(void* lpObj);
int secureblackbox_pop3client_setproxypassword(void* lpObj, const char* lpszProxyPassword);

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

Default Value

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (POP3Client Class)

The port on the proxy server to connect to.

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int secureblackbox_pop3client_getproxyport(void* lpObj);
int secureblackbox_pop3client_setproxyport(void* lpObj, int iProxyPort);

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

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (POP3Client Class)

The type of the proxy server.

Syntax

ANSI (Cross Platform)
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Unicode (Windows)
INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);

Possible Values

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

int secureblackbox_pop3client_getproxyproxytype(void* lpObj);
int secureblackbox_pop3client_setproxyproxytype(void* lpObj, int iProxyProxyType);

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

Default Value

Remarks

The type of the proxy server.

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


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

Data Type

Integer

ProxyRequestHeaders Property (POP3Client Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders);

Unicode (Windows)
LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);

char* secureblackbox_pop3client_getproxyrequestheaders(void* lpObj);
int secureblackbox_pop3client_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);

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

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody);

Unicode (Windows)
LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);

char* secureblackbox_pop3client_getproxyresponsebody(void* lpObj);
int secureblackbox_pop3client_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);

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

Default Value

Remarks

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

Data Type

String

ProxyResponseHeaders Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders);

Unicode (Windows)
LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);

char* secureblackbox_pop3client_getproxyresponseheaders(void* lpObj);
int secureblackbox_pop3client_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);

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

Default Value

Remarks

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

Data Type

String

ProxyUseIPv6 Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6);

Unicode (Windows)
BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);

int secureblackbox_pop3client_getproxyuseipv6(void* lpObj);
int secureblackbox_pop3client_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (POP3Client Class)

Enables or disables proxy-driven connection.

Syntax

ANSI (Cross Platform)
int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy);

Unicode (Windows)
BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);

int secureblackbox_pop3client_getproxyuseproxy(void* lpObj);
int secureblackbox_pop3client_setproxyuseproxy(void* lpObj, int bProxyUseProxy);

bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

FALSE

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (POP3Client Class)

Specifies the username credential for proxy authentication.

Syntax

ANSI (Cross Platform)
char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername);

Unicode (Windows)
LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);

char* secureblackbox_pop3client_getproxyusername(void* lpObj);
int secureblackbox_pop3client_setproxyusername(void* lpObj, const char* lpszProxyUsername);

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

Default Value

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerCertCount Property (POP3Client Class)

The number of records in the ServerCert arrays.

Syntax

ANSI (Cross Platform)
int GetServerCertCount();

Unicode (Windows)
INT GetServerCertCount();

int secureblackbox_pop3client_getservercertcount(void* lpObj);

int GetServerCertCount();

Default Value

Remarks

This property controls the size of the following arrays:

ServerCertBytes
ServerCertCAKeyID
ServerCertFingerprint
ServerCertHandle
ServerCertIssuer
ServerCertIssuerRDN
ServerCertKeyAlgorithm
ServerCertKeyBits
ServerCertKeyFingerprint
ServerCertKeyUsage
ServerCertPublicKeyBytes
ServerCertSelfSigned
ServerCertSerialNumber
ServerCertSigAlgorithm
ServerCertSubject
ServerCertSubjectKeyID
ServerCertSubjectRDN
ServerCertValidFrom
ServerCertValidTo

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

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

Data Type

Integer

ServerCertBytes Property (POP3Client Class)

Returns the raw certificate data in DER format.

Syntax

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

Unicode (Windows)
INT GetServerCertBytes(INT iServerCertIndex, LPSTR &lpServerCertBytes, INT &lenServerCertBytes);

int secureblackbox_pop3client_getservercertbytes(void* lpObj, int servercertindex, char** lpServerCertBytes, int* lenServerCertBytes);

QByteArray GetServerCertBytes(int iServerCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

ServerCertCAKeyID Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
INT GetServerCertCAKeyID(INT iServerCertIndex, LPSTR &lpServerCertCAKeyID, INT &lenServerCertCAKeyID);

int secureblackbox_pop3client_getservercertcakeyid(void* lpObj, int servercertindex, char** lpServerCertCAKeyID, int* lenServerCertCAKeyID);

QByteArray GetServerCertCAKeyID(int iServerCertIndex);

Remarks

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

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

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

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

Data Type

Byte Array

ServerCertFingerprint Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
INT GetServerCertFingerprint(INT iServerCertIndex, LPSTR &lpServerCertFingerprint, INT &lenServerCertFingerprint);

int secureblackbox_pop3client_getservercertfingerprint(void* lpObj, int servercertindex, char** lpServerCertFingerprint, int* lenServerCertFingerprint);

QByteArray GetServerCertFingerprint(int iServerCertIndex);

Remarks

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

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

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

Data Type

Byte Array

ServerCertHandle Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LONG64 GetServerCertHandle(INT iServerCertIndex);

int64 secureblackbox_pop3client_getservercerthandle(void* lpObj, int servercertindex);

qint64 GetServerCertHandle(int iServerCertIndex);

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

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

Data Type

Long64

ServerCertIssuer Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertIssuer(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertissuer(void* lpObj, int servercertindex);

QString GetServerCertIssuer(int iServerCertIndex);

Default Value

Remarks

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

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

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

Data Type

String

ServerCertIssuerRDN Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertIssuerRDN(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertissuerrdn(void* lpObj, int servercertindex);

QString GetServerCertIssuerRDN(int iServerCertIndex);

Default Value

Remarks

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

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

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

Data Type

String

ServerCertKeyAlgorithm Property (POP3Client Class)

Specifies the public key algorithm of this certificate.

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertKeyAlgorithm(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertkeyalgorithm(void* lpObj, int servercertindex);

QString GetServerCertKeyAlgorithm(int iServerCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_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`

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

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

Data Type

String

ServerCertKeyBits Property (POP3Client Class)

Returns the length of the public key.

Syntax

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

Unicode (Windows)
INT GetServerCertKeyBits(INT iServerCertIndex);

int secureblackbox_pop3client_getservercertkeybits(void* lpObj, int servercertindex);

int GetServerCertKeyBits(int iServerCertIndex);

Default Value

Remarks

Returns the length of the public key.

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

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

Data Type

Integer

ServerCertKeyFingerprint Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
INT GetServerCertKeyFingerprint(INT iServerCertIndex, LPSTR &lpServerCertKeyFingerprint, INT &lenServerCertKeyFingerprint);

int secureblackbox_pop3client_getservercertkeyfingerprint(void* lpObj, int servercertindex, char** lpServerCertKeyFingerprint, int* lenServerCertKeyFingerprint);

QByteArray GetServerCertKeyFingerprint(int iServerCertIndex);

Remarks

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

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

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

Data Type

Byte Array

ServerCertKeyUsage Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
INT GetServerCertKeyUsage(INT iServerCertIndex);

int secureblackbox_pop3client_getservercertkeyusage(void* lpObj, int servercertindex);

int GetServerCertKeyUsage(int iServerCertIndex);

Default Value

Remarks

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

This value is a bit mask of the following values:


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

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

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

Data Type

Integer

ServerCertPublicKeyBytes Property (POP3Client Class)

Contains the certificate's public key in DER format.

Syntax

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

Unicode (Windows)
INT GetServerCertPublicKeyBytes(INT iServerCertIndex, LPSTR &lpServerCertPublicKeyBytes, INT &lenServerCertPublicKeyBytes);

int secureblackbox_pop3client_getservercertpublickeybytes(void* lpObj, int servercertindex, char** lpServerCertPublicKeyBytes, int* lenServerCertPublicKeyBytes);

QByteArray GetServerCertPublicKeyBytes(int iServerCertIndex);

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

ServerCertSelfSigned Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
BOOL GetServerCertSelfSigned(INT iServerCertIndex);

int secureblackbox_pop3client_getservercertselfsigned(void* lpObj, int servercertindex);

bool GetServerCertSelfSigned(int iServerCertIndex);

Default Value

FALSE

Remarks

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

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

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

Data Type

Boolean

ServerCertSerialNumber Property (POP3Client Class)

Returns the certificate's serial number.

Syntax

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

Unicode (Windows)
INT GetServerCertSerialNumber(INT iServerCertIndex, LPSTR &lpServerCertSerialNumber, INT &lenServerCertSerialNumber);

int secureblackbox_pop3client_getservercertserialnumber(void* lpObj, int servercertindex, char** lpServerCertSerialNumber, int* lenServerCertSerialNumber);

QByteArray GetServerCertSerialNumber(int iServerCertIndex);

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

ServerCertSigAlgorithm Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertSigAlgorithm(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertsigalgorithm(void* lpObj, int servercertindex);

QString GetServerCertSigAlgorithm(int iServerCertIndex);

Default Value

Remarks

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

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

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

Data Type

String

ServerCertSubject Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertSubject(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertsubject(void* lpObj, int servercertindex);

QString GetServerCertSubject(int iServerCertIndex);

Default Value

Remarks

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

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

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

Data Type

String

ServerCertSubjectKeyID Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
INT GetServerCertSubjectKeyID(INT iServerCertIndex, LPSTR &lpServerCertSubjectKeyID, INT &lenServerCertSubjectKeyID);

int secureblackbox_pop3client_getservercertsubjectkeyid(void* lpObj, int servercertindex, char** lpServerCertSubjectKeyID, int* lenServerCertSubjectKeyID);

QByteArray GetServerCertSubjectKeyID(int iServerCertIndex);

Remarks

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

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

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

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

Data Type

Byte Array

ServerCertSubjectRDN Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertSubjectRDN(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertsubjectrdn(void* lpObj, int servercertindex);

QString GetServerCertSubjectRDN(int iServerCertIndex);

Default Value

Remarks

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

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

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

Data Type

String

ServerCertValidFrom Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertValidFrom(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertvalidfrom(void* lpObj, int servercertindex);

QString GetServerCertValidFrom(int iServerCertIndex);

Default Value

Remarks

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

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

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

Data Type

String

ServerCertValidTo Property (POP3Client Class)

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

Syntax

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

Unicode (Windows)
LPWSTR GetServerCertValidTo(INT iServerCertIndex);

char* secureblackbox_pop3client_getservercertvalidto(void* lpObj, int servercertindex);

QString GetServerCertValidTo(int iServerCertIndex);

Default Value

Remarks

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

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

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

Data Type

String

ServerInfoApopSupported Property (POP3Client Class)

Indicates whether the POP3 server supports the APOP command.

Syntax

ANSI (Cross Platform)
int GetServerInfoApopSupported();

Unicode (Windows)
BOOL GetServerInfoApopSupported();

int secureblackbox_pop3client_getserverinfoapopsupported(void* lpObj);

bool GetServerInfoApopSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the APOP command.

This property is read-only.

Data Type

Boolean

ServerInfoAvailable Property (POP3Client Class)

Indicates whether the details of the server capabilities are available.

Syntax

ANSI (Cross Platform)
int GetServerInfoAvailable();

Unicode (Windows)
BOOL GetServerInfoAvailable();

int secureblackbox_pop3client_getserverinfoavailable(void* lpObj);

bool GetServerInfoAvailable();

Default Value

FALSE

Remarks

Indicates whether the details of the server capabilities are available.

This property is read-only.

Data Type

Boolean

ServerInfoExpirationPeriod Property (POP3Client Class)

Contains the parameter of EXPIRE capability.

Syntax

ANSI (Cross Platform)
int GetServerInfoExpirationPeriod();

Unicode (Windows)
INT GetServerInfoExpirationPeriod();

int secureblackbox_pop3client_getserverinfoexpirationperiod(void* lpObj);

int GetServerInfoExpirationPeriod();

Default Value

-1

Remarks

Contains the parameter of EXPIRE capability.

This property is read-only.

Data Type

Integer

ServerInfoExpireSupported Property (POP3Client Class)

Indicates whether the POP3 server supports the EXPIRE extension.

Syntax

ANSI (Cross Platform)
int GetServerInfoExpireSupported();

Unicode (Windows)
BOOL GetServerInfoExpireSupported();

int secureblackbox_pop3client_getserverinfoexpiresupported(void* lpObj);

bool GetServerInfoExpireSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the EXPIRE extension. See ServerInfoExpirationPeriod field.

This property is read-only.

Data Type

Boolean

ServerInfoImplementationSupported Property (POP3Client Class)

Indicates whether the POP3 server supports the IMPLEMENTATION extension.

Syntax

ANSI (Cross Platform)
int GetServerInfoImplementationSupported();

Unicode (Windows)
BOOL GetServerInfoImplementationSupported();

int secureblackbox_pop3client_getserverinfoimplementationsupported(void* lpObj);

bool GetServerInfoImplementationSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the IMPLEMENTATION extension. See ServerInfoServerDetails field.

This property is read-only.

Data Type

Boolean

ServerInfoLoginDelay Property (POP3Client Class)

Returns the parameter of LOGIN-DELAY capability.

Syntax

ANSI (Cross Platform)
int GetServerInfoLoginDelay();

Unicode (Windows)
INT GetServerInfoLoginDelay();

int secureblackbox_pop3client_getserverinfologindelay(void* lpObj);

int GetServerInfoLoginDelay();

Default Value

Remarks

Returns the parameter of LOGIN-DELAY capability.

The LOGIN-DELAY parameter indicates the minimum number of seconds between unsuccessful login attempts. See RFC 2449, Section 6.5 for more information.

This property is read-only.

Data Type

Integer

ServerInfoLoginDelaySupported Property (POP3Client Class)

Indicates whether the POP3 server supports the LOGIN-DELAY extension.

Syntax

ANSI (Cross Platform)
int GetServerInfoLoginDelaySupported();

Unicode (Windows)
BOOL GetServerInfoLoginDelaySupported();

int secureblackbox_pop3client_getserverinfologindelaysupported(void* lpObj);

bool GetServerInfoLoginDelaySupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the LOGIN-DELAY extension.

See ServerInfoLoginDelay property for the details.

This property is read-only.

Data Type

Boolean

ServerInfoRespCodesSupported Property (POP3Client Class)

Indicates whether the POP3 server supports the RESP-CODES extension.

Syntax

ANSI (Cross Platform)
int GetServerInfoRespCodesSupported();

Unicode (Windows)
BOOL GetServerInfoRespCodesSupported();

int secureblackbox_pop3client_getserverinforespcodessupported(void* lpObj);

bool GetServerInfoRespCodesSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the RESP-CODES extension.

The RESP-CODES capability indicates that any response text issued by this server which begins with an open square bracket ("[") is an extended response code (see section 8 of RFC 2449). For more information see For more information see RFC 2449, Section 6.4.

This property is read-only.

Data Type

Boolean

ServerInfoSaslSupported Property (POP3Client Class)

Indicates whether the POP3 server supports SASL authentication.

Syntax

ANSI (Cross Platform)
int GetServerInfoSaslSupported();

Unicode (Windows)
BOOL GetServerInfoSaslSupported();

int secureblackbox_pop3client_getserverinfosaslsupported(void* lpObj);

bool GetServerInfoSaslSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports SASL authentication.

This property is read-only.

Data Type

Boolean

ServerInfoServerDetails Property (POP3Client Class)

Contains the parameter of the IMPLEMENTATION capability.

Syntax

ANSI (Cross Platform)
char* GetServerInfoServerDetails();

Unicode (Windows)
LPWSTR GetServerInfoServerDetails();

char* secureblackbox_pop3client_getserverinfoserverdetails(void* lpObj);

QString GetServerInfoServerDetails();

Default Value

Remarks

Contains the parameter of the IMPLEMENTATION capability.

The value of this property only makes sense if ServerInfoAvailable and ServerInfoImplementationSupported parameters are true.

The parameter to the IMPLEMENTATION capability consists of one or more tokens that identify the server. For more information see RFC 2449, Section 6.9.

This property is read-only.

Data Type

String

ServerInfoTopSupported Property (POP3Client Class)

Indicates whether the POP3 server supports the TOP command.

Syntax

ANSI (Cross Platform)
int GetServerInfoTopSupported();

Unicode (Windows)
BOOL GetServerInfoTopSupported();

int secureblackbox_pop3client_getserverinfotopsupported(void* lpObj);

bool GetServerInfoTopSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the TOP command.

This property is read-only.

Data Type

Boolean

ServerInfoUidlSupported Property (POP3Client Class)

Indicates whether the POP3 server supports the UIDL command.

Syntax

ANSI (Cross Platform)
int GetServerInfoUidlSupported();

Unicode (Windows)
BOOL GetServerInfoUidlSupported();

int secureblackbox_pop3client_getserverinfouidlsupported(void* lpObj);

bool GetServerInfoUidlSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the UIDL command.

This property is read-only.

Data Type

Boolean

ServerInfoUserSupported Property (POP3Client Class)

Indicates whether the POP3 server supports the USER command.

Syntax

ANSI (Cross Platform)
int GetServerInfoUserSupported();

Unicode (Windows)
BOOL GetServerInfoUserSupported();

int secureblackbox_pop3client_getserverinfousersupported(void* lpObj);

bool GetServerInfoUserSupported();

Default Value

FALSE

Remarks

Indicates whether the POP3 server supports the USER command.

This property is read-only.

Data Type

Boolean

SocketDNSMode Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Unicode (Windows)
INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);

Possible Values

DM_AUTO(0), 
DM_PLATFORM(1), 
DM_OWN(2), 
DM_OWN_SECURE(3)

int secureblackbox_pop3client_getsocketdnsmode(void* lpObj);
int secureblackbox_pop3client_setsocketdnsmode(void* lpObj, int iSocketDNSMode);

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

Default Value

Remarks

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`

Data Type

Integer

SocketDNSPort Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Unicode (Windows)
INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);

int secureblackbox_pop3client_getsocketdnsport(void* lpObj);
int secureblackbox_pop3client_setsocketdnsport(void* lpObj, int iSocketDNSPort);

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

Default Value

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (POP3Client Class)

The timeout (in milliseconds) for each DNS query.

Syntax

ANSI (Cross Platform)
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Unicode (Windows)
INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);

int secureblackbox_pop3client_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_pop3client_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);

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

Default Value

Remarks

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

Data Type

Integer

SocketDNSServers Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers);

Unicode (Windows)
LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);

char* secureblackbox_pop3client_getsocketdnsservers(void* lpObj);
int secureblackbox_pop3client_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);

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

Default Value

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Unicode (Windows)
INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);

int secureblackbox_pop3client_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_pop3client_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);

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

Default Value

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Unicode (Windows)
INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);

int secureblackbox_pop3client_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_pop3client_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);

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

Default Value

Remarks

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

Data Type

Integer

SocketLocalAddress Property (POP3Client Class)

The local network interface to bind the socket to.

Syntax

ANSI (Cross Platform)
char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress);

Unicode (Windows)
LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);

char* secureblackbox_pop3client_getsocketlocaladdress(void* lpObj);
int secureblackbox_pop3client_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);

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

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (POP3Client Class)

The local port number to bind the socket to.

Syntax

ANSI (Cross Platform)
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Unicode (Windows)
INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);

int secureblackbox_pop3client_getsocketlocalport(void* lpObj);
int secureblackbox_pop3client_setsocketlocalport(void* lpObj, int iSocketLocalPort);

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

Default Value

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Unicode (Windows)
INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);

int secureblackbox_pop3client_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_pop3client_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);

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

Default Value

Remarks

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

Data Type

Integer

SocketTimeout Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

Unicode (Windows)
INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);

int secureblackbox_pop3client_getsockettimeout(void* lpObj);
int secureblackbox_pop3client_setsockettimeout(void* lpObj, int iSocketTimeout);

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

Default Value

60000

Remarks

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

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

Data Type

Integer

SocketUseIPv6 Property (POP3Client Class)

Enables or disables IP protocol version 6.

Syntax

ANSI (Cross Platform)
int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6);

Unicode (Windows)
BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);

int secureblackbox_pop3client_getsocketuseipv6(void* lpObj);
int secureblackbox_pop3client_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);

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

Default Value

FALSE

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates);

Unicode (Windows)
BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);

int secureblackbox_pop3client_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_pop3client_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);

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

Default Value

TRUE

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (POP3Client Class)

Selects the base configuration for the TLS settings.

Syntax

ANSI (Cross Platform)
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);

Unicode (Windows)
INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);

Possible Values

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1), 
STPC_COMPREHENSIVE_INSECURE(2), 
STPC_HIGHLY_SECURE(3)

int secureblackbox_pop3client_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_pop3client_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);

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

Default Value

Remarks

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


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

Data Type

Integer

TLSCiphersuites Property (POP3Client Class)

A list of ciphersuites separated with commas or semicolons.

Syntax

ANSI (Cross Platform)
char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites);

Unicode (Windows)
LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);

char* secureblackbox_pop3client_gettlsciphersuites(void* lpObj);
int secureblackbox_pop3client_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);

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

Default Value

Remarks

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

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

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

Data Type

String

TLSECCurves Property (POP3Client Class)

Defines the elliptic curves to enable.

Syntax

ANSI (Cross Platform)
char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves);

Unicode (Windows)
LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);

char* secureblackbox_pop3client_gettlseccurves(void* lpObj);
int secureblackbox_pop3client_settlseccurves(void* lpObj, const char* lpszTLSECCurves);

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

Default Value

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (POP3Client Class)

Provides access to TLS extensions.

Syntax

ANSI (Cross Platform)
char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions);

Unicode (Windows)
LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);

char* secureblackbox_pop3client_gettlsextensions(void* lpObj);
int secureblackbox_pop3client_settlsextensions(void* lpObj, const char* lpszTLSExtensions);

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

Default Value

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges);

Unicode (Windows)
BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);

int secureblackbox_pop3client_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_pop3client_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(const char* lpszTLSPreSharedIdentity);

Unicode (Windows)
LPWSTR GetTLSPreSharedIdentity();
INT SetTLSPreSharedIdentity(LPCWSTR lpszTLSPreSharedIdentity);

char* secureblackbox_pop3client_gettlspresharedidentity(void* lpObj);
int secureblackbox_pop3client_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);

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

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedKey();
int SetTLSPreSharedKey(const char* lpszTLSPreSharedKey);

Unicode (Windows)
LPWSTR GetTLSPreSharedKey();
INT SetTLSPreSharedKey(LPCWSTR lpszTLSPreSharedKey);

char* secureblackbox_pop3client_gettlspresharedkey(void* lpObj);
int secureblackbox_pop3client_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);

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

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
char* GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(const char* lpszTLSPreSharedKeyCiphersuite);

Unicode (Windows)
LPWSTR GetTLSPreSharedKeyCiphersuite();
INT SetTLSPreSharedKeyCiphersuite(LPCWSTR lpszTLSPreSharedKeyCiphersuite);

char* secureblackbox_pop3client_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_pop3client_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);

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

Default Value

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (POP3Client Class)

Selects the renegotiation attack prevention mechanism.

Syntax

ANSI (Cross Platform)
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);

Unicode (Windows)
INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);

Possible Values

CRAPM_COMPATIBLE(0), 
CRAPM_STRICT(1), 
CRAPM_AUTO(2)

int secureblackbox_pop3client_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_pop3client_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);

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

Default Value

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:


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

Data Type

Integer

TLSRevocationCheck Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);

Unicode (Windows)
INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);

Possible Values

CRC_NONE(0), 
CRC_AUTO(1), 
CRC_ALL_CRL(2), 
CRC_ALL_OCSP(3), 
CRC_ALL_CRLAND_OCSP(4), 
CRC_ANY_CRL(5), 
CRC_ANY_OCSP(6), 
CRC_ANY_CRLOR_OCSP(7), 
CRC_ANY_OCSPOR_CRL(8)

int secureblackbox_pop3client_gettlsrevocationcheck(void* lpObj);
int secureblackbox_pop3client_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);

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

Default Value

Remarks

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

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


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

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (POP3Client Class)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

ANSI (Cross Platform)
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);

Unicode (Windows)
INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);

int secureblackbox_pop3client_gettlsssloptions(void* lpObj);
int secureblackbox_pop3client_settlsssloptions(void* lpObj, int iTLSSSLOptions);

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

Default Value

Remarks

Various SSL (TLS) protocol options, set of


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

Data Type

Integer

TLSTLSMode Property (POP3Client Class)

Specifies the TLS mode to use.

Syntax

ANSI (Cross Platform)
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);

Unicode (Windows)
INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);

Possible Values

SM_DEFAULT(0), 
SM_NO_TLS(1), 
SM_EXPLICIT_TLS(2), 
SM_IMPLICIT_TLS(3), 
SM_MIXED_TLS(4)

int secureblackbox_pop3client_gettlstlsmode(void* lpObj);
int secureblackbox_pop3client_settlstlsmode(void* lpObj, int iTLSTLSMode);

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

Default Value

Remarks

Specifies the TLS mode to use.


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

Data Type

Integer

TLSUseExtendedMasterSecret Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret);

Unicode (Windows)
BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);

int secureblackbox_pop3client_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_pop3client_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (POP3Client Class)

Enables or disables the TLS session resumption capability.

Syntax

ANSI (Cross Platform)
int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption);

Unicode (Windows)
BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);

int secureblackbox_pop3client_gettlsusesessionresumption(void* lpObj);
int secureblackbox_pop3client_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);

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

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (POP3Client Class)

The SSL/TLS versions to enable by default.

Syntax

ANSI (Cross Platform)
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);

Unicode (Windows)
INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);

int secureblackbox_pop3client_gettlsversions(void* lpObj);
int secureblackbox_pop3client_settlsversions(void* lpObj, int iTLSVersions);

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

Default Value

Remarks

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

Data Type

Integer

TrustedCertCount Property (POP3Client Class)

The number of records in the TrustedCert arrays.

Syntax

ANSI (Cross Platform)
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);

Unicode (Windows)
INT GetTrustedCertCount();
INT SetTrustedCertCount(INT iTrustedCertCount);

int secureblackbox_pop3client_gettrustedcertcount(void* lpObj);
int secureblackbox_pop3client_settrustedcertcount(void* lpObj, int iTrustedCertCount);

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

Default Value

Remarks

This property controls the size of the following arrays:

TrustedCertBytes
TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (POP3Client Class)

Returns the raw certificate data in DER format.

Syntax

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

Unicode (Windows)
INT GetTrustedCertBytes(INT iTrustedCertIndex, LPSTR &lpTrustedCertBytes, INT &lenTrustedCertBytes);

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

QByteArray GetTrustedCertBytes(int iTrustedCertIndex);

Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

TrustedCertHandle Property (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
int64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, int64 lTrustedCertHandle);

Unicode (Windows)
LONG64 GetTrustedCertHandle(INT iTrustedCertIndex);
INT SetTrustedCertHandle(INT iTrustedCertIndex, LONG64 lTrustedCertHandle);

int64 secureblackbox_pop3client_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_pop3client_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);

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

Default Value

Remarks

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

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

  Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is not available at design time.

Data Type

Long64

Username Property (POP3Client Class)

A username to authenticate to the POP3 server.

Syntax

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

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

char* secureblackbox_pop3client_getusername(void* lpObj);
int secureblackbox_pop3client_setusername(void* lpObj, const char* lpszUsername);

QString GetUsername();
int SetUsername(QString qsUsername);

Default Value

Remarks

Use this property together with Password to provide authentication credentials to the component.

Data Type

String

Config Method (POP3Client Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* secureblackbox_pop3client_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 (POP3Client Class)

Establishes connection to the POP3 server.

Syntax

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

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

int secureblackbox_pop3client_connect(void* lpObj, const char* lpszAddress, int iPort);

int Connect(const QString& qsAddress, int iPort);

Remarks

Use this method to establish connection to a POP3 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.)

DeleteMessage Method (POP3Client Class)

Deletes a message from the server-side mailbox.

Syntax

ANSI (Cross Platform)
int DeleteMessage(int iIndex);

Unicode (Windows)
INT DeleteMessage(INT iIndex);

int secureblackbox_pop3client_deletemessage(void* lpObj, int iIndex);

int DeleteMessage(int iIndex);

Remarks

Call this method to delete a message from the mailbox.

Note that the message may not be deleted immediately. It is typical for POP3 servers to only mark messages for deletion upon receipt of this command, and only delete them after the connection has been gracefully closed.

If needed, messages can be "undeleted" during the same session by calling the Undelete method.

Error Handling (C++)

Disconnect Method (POP3Client Class)

Closes connection to the POP3 server.

Syntax

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int secureblackbox_pop3client_disconnect(void* lpObj);

int Disconnect();

Remarks

Call this method to gracefully terminate the connection.

Error Handling (C++)

DoAction Method (POP3Client 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_pop3client_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

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

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

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

Error Handling (C++)

ListMessages Method (POP3Client Class)

Queries a list of messages available on the server.

Syntax

ANSI (Cross Platform)
int ListMessages();

Unicode (Windows)
INT ListMessages();

int secureblackbox_pop3client_listmessages(void* lpObj);

int ListMessages();

Remarks

Use this method to request a list of messages currently available on the server. Use the Messages property to access the message details.

Error Handling (C++)

Ping Method (POP3Client Class)

Sends a NOOP command to the POP3 server.

Syntax

ANSI (Cross Platform)
int Ping();

Unicode (Windows)
INT Ping();

int secureblackbox_pop3client_ping(void* lpObj);

int Ping();

Remarks

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

Error Handling (C++)

ReceiveBytes Method (POP3Client Class)

Downloads a message to a byte array.

Syntax

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

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

char* secureblackbox_pop3client_receivebytes(void* lpObj, int iIndex, int *lpSize);

QByteArray ReceiveBytes(int iIndex);

Remarks

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

Error Handling (C++)

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

ReceiveFile Method (POP3Client Class)

Downloads a message to a file.

Syntax

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

Unicode (Windows)
INT ReceiveFile(INT iIndex, LPCWSTR lpszFilename);

int secureblackbox_pop3client_receivefile(void* lpObj, int iIndex, const char* lpszFilename);

int ReceiveFile(int iIndex, const QString& qsFilename);

Remarks

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

Error Handling (C++)

ReceiveMessage Method (POP3Client Class)

Downloads a message.

Syntax

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

Unicode (Windows)
INT ReceiveMessage(INT iIndex);

int secureblackbox_pop3client_receivemessage(void* lpObj, int iIndex);

int ReceiveMessage(int iIndex);

Remarks

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

Error Handling (C++)

ReceiveStream Method (POP3Client Class)

Downloads a message to a stream.

Syntax

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

Unicode (Windows)
INT ReceiveStream(INT iIndex, SecureBlackboxStream* sStream);

int secureblackbox_pop3client_receivestream(void* lpObj, int iIndex, SecureBlackboxStream* sStream);

int ReceiveStream(int iIndex, SecureBlackboxStream* sStream);

Remarks

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

Error Handling (C++)

Undelete Method (POP3Client Class)

Undeletes messages marked for deletion.

Syntax

ANSI (Cross Platform)
int Undelete();

Unicode (Windows)
INT Undelete();

int secureblackbox_pop3client_undelete(void* lpObj);

int Undelete();

Remarks

This method sends an RSET command, which tells the server to undelete all previously deleted messages by removing their 'delete' marks.

Note that this method only applies to messages deleted within the same session.

Error Handling (C++)

BeforeAuth Event (POP3Client Class)

Fires before the authentication starts.

Syntax

ANSI (Cross Platform)
virtual int FireBeforeAuth(POP3ClientBeforeAuthEventParams *e);

typedef struct {
  int reserved;
} POP3ClientBeforeAuthEventParams;


Unicode (Windows)
virtual INT FireBeforeAuth(POP3ClientBeforeAuthEventParams *e);

typedef struct {
  INT reserved;
} POP3ClientBeforeAuthEventParams;

#define EID_POP3CLIENT_BEFOREAUTH 1

virtual INT SECUREBLACKBOX_CALL FireBeforeAuth();

class POP3ClientBeforeAuthEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireBeforeAuth(POP3ClientBeforeAuthEventParams *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 (POP3Client Class)

Reports a command sent to the server.

Syntax

ANSI (Cross Platform)
virtual int FireCommand(POP3ClientCommandEventParams *e);

typedef struct {
  const char *Cmd;
  int reserved;
} POP3ClientCommandEventParams;


Unicode (Windows)
virtual INT FireCommand(POP3ClientCommandEventParams *e);

typedef struct {
  LPCWSTR Cmd;
  INT reserved;
} POP3ClientCommandEventParams;

#define EID_POP3CLIENT_COMMAND 2

virtual INT SECUREBLACKBOX_CALL FireCommand(LPSTR &lpszCmd);

class POP3ClientCommandEventParams {
public:
  const QString &Cmd();

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

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireCommand(POP3ClientCommandEventParams *e) {...}

Remarks

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

CommandReply Event (POP3Client Class)

Reports the receipt of a reply to a command.

Syntax

ANSI (Cross Platform)
virtual int FireCommandReply(POP3ClientCommandReplyEventParams *e);

typedef struct {
  const char *Cmd;
  const char *Reply;
  int reserved;
} POP3ClientCommandReplyEventParams;


Unicode (Windows)
virtual INT FireCommandReply(POP3ClientCommandReplyEventParams *e);

typedef struct {
  LPCWSTR Cmd;
  LPCWSTR Reply;
  INT reserved;
} POP3ClientCommandReplyEventParams;

#define EID_POP3CLIENT_COMMANDREPLY 3

virtual INT SECUREBLACKBOX_CALL FireCommandReply(LPSTR &lpszCmd, LPSTR &lpszReply);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireCommandReply(POP3ClientCommandReplyEventParams *e) {...}

Remarks

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

CommandReplyData Event (POP3Client Class)

Returns the data that accompanies a reply to a command.

Syntax

ANSI (Cross Platform)
virtual int FireCommandReplyData(POP3ClientCommandReplyDataEventParams *e);

typedef struct {
  const char *Cmd;
  const char *Data;
  int reserved;
} POP3ClientCommandReplyDataEventParams;


Unicode (Windows)
virtual INT FireCommandReplyData(POP3ClientCommandReplyDataEventParams *e);

typedef struct {
  LPCWSTR Cmd;
  LPCWSTR Data;
  INT reserved;
} POP3ClientCommandReplyDataEventParams;

#define EID_POP3CLIENT_COMMANDREPLYDATA 4

virtual INT SECUREBLACKBOX_CALL FireCommandReplyData(LPSTR &lpszCmd, LPSTR &lpszData);

class POP3ClientCommandReplyDataEventParams {
public:
  const QString &Cmd();

  const QString &Data();

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

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireCommandReplyData(POP3ClientCommandReplyDataEventParams *e) {...}

Remarks

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

Error Event (POP3Client Class)

Provides information about errors during POP3 operations.

Syntax

ANSI (Cross Platform)
virtual int FireError(POP3ClientErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} POP3ClientErrorEventParams;


Unicode (Windows)
virtual INT FireError(POP3ClientErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} POP3ClientErrorEventParams;

#define EID_POP3CLIENT_ERROR 5

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class POP3ClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireError(POP3ClientErrorEventParams *e) {...}

Remarks

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

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

ExternalSign Event (POP3Client Class)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

ANSI (Cross Platform)
virtual int FireExternalSign(POP3ClientExternalSignEventParams *e);

typedef struct {
  const char *OperationId;
  const char *HashAlgorithm;
  const char *Pars;
  const char *Data;
  char *SignedData;
  int reserved;
} POP3ClientExternalSignEventParams;


Unicode (Windows)
virtual INT FireExternalSign(POP3ClientExternalSignEventParams *e);

typedef struct {
  LPCWSTR OperationId;
  LPCWSTR HashAlgorithm;
  LPCWSTR Pars;
  LPCWSTR Data;
  LPWSTR SignedData;
  INT reserved;
} POP3ClientExternalSignEventParams;

#define EID_POP3CLIENT_EXTERNALSIGN 6

virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireExternalSign(POP3ClientExternalSignEventParams *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 class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the 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 the .NET RSACryptoServiceProvider class may look like the following:

  Copy
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 (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(POP3ClientNotificationEventParams *e);

typedef struct {
  const char *EventID;
  const char *EventParam;
  int reserved;
} POP3ClientNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(POP3ClientNotificationEventParams *e);

typedef struct {
  LPCWSTR EventID;
  LPCWSTR EventParam;
  INT reserved;
} POP3ClientNotificationEventParams;

#define EID_POP3CLIENT_NOTIFICATION 7

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireNotification(POP3ClientNotificationEventParams *e) {...}

Remarks

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

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

Progress Event (POP3Client Class)

Reports the progress of the data transfer operation.

Syntax

ANSI (Cross Platform)
virtual int FireProgress(POP3ClientProgressEventParams *e);

typedef struct {
  int64 Total;
  int64 Current;
  int Cancel;
  int reserved;
} POP3ClientProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(POP3ClientProgressEventParams *e);

typedef struct {
  LONG64 Total;
  LONG64 Current;
  BOOL Cancel;
  INT reserved;
} POP3ClientProgressEventParams;

#define EID_POP3CLIENT_PROGRESS 8

virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireProgress(POP3ClientProgressEventParams *e) {...}

Remarks

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

TLSCertNeeded Event (POP3Client Class)

Fires when a remote TLS party requests a client certificate.

Syntax

ANSI (Cross Platform)
virtual int FireTLSCertNeeded(POP3ClientTLSCertNeededEventParams *e);

typedef struct {
  const char *Host;
  const char *CANames;
  int reserved;
} POP3ClientTLSCertNeededEventParams;


Unicode (Windows)
virtual INT FireTLSCertNeeded(POP3ClientTLSCertNeededEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR CANames;
  INT reserved;
} POP3ClientTLSCertNeededEventParams;

#define EID_POP3CLIENT_TLSCERTNEEDED 9

virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireTLSCertNeeded(POP3ClientTLSCertNeededEventParams *e) {...}

Remarks

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

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (POP3Client 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(POP3ClientTLSCertValidateEventParams *e);

typedef struct {
  const char *ServerHost;
  const char *ServerIP;
  int Accept;
  int reserved;
} POP3ClientTLSCertValidateEventParams;


Unicode (Windows)
virtual INT FireTLSCertValidate(POP3ClientTLSCertValidateEventParams *e);

typedef struct {
  LPCWSTR ServerHost;
  LPCWSTR ServerIP;
  BOOL Accept;
  INT reserved;
} POP3ClientTLSCertValidateEventParams;

#define EID_POP3CLIENT_TLSCERTVALIDATE 10

virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireTLSCertValidate(POP3ClientTLSCertValidateEventParams *e) {...}

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

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

TLSEstablished Event (POP3Client Class)

Fires when a TLS handshake with Host successfully completes.

Syntax

ANSI (Cross Platform)
virtual int FireTLSEstablished(POP3ClientTLSEstablishedEventParams *e);

typedef struct {
  const char *Host;
  const char *Version;
  const char *Ciphersuite;
  const char *ConnectionId;
  int lenConnectionId;
  int Abort;
  int reserved;
} POP3ClientTLSEstablishedEventParams;


Unicode (Windows)
virtual INT FireTLSEstablished(POP3ClientTLSEstablishedEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR Version;
  LPCWSTR Ciphersuite;
  LPCSTR ConnectionId;
  INT lenConnectionId;
  BOOL Abort;
  INT reserved;
} POP3ClientTLSEstablishedEventParams;

#define EID_POP3CLIENT_TLSESTABLISHED 11

virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireTLSEstablished(POP3ClientTLSEstablishedEventParams *e) {...}

Remarks

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

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

TLSHandshake Event (POP3Client Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireTLSHandshake(POP3ClientTLSHandshakeEventParams *e);

typedef struct {
  const char *Host;
  int Abort;
  int reserved;
} POP3ClientTLSHandshakeEventParams;


Unicode (Windows)
virtual INT FireTLSHandshake(POP3ClientTLSHandshakeEventParams *e);

typedef struct {
  LPCWSTR Host;
  BOOL Abort;
  INT reserved;
} POP3ClientTLSHandshakeEventParams;

#define EID_POP3CLIENT_TLSHANDSHAKE 12

virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireTLSHandshake(POP3ClientTLSHandshakeEventParams *e) {...}

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (POP3Client Class)

Notifies the application about the PSK key exchange.

Syntax

ANSI (Cross Platform)
virtual int FireTLSPSK(POP3ClientTLSPSKEventParams *e);

typedef struct {
  const char *Host;
  const char *Hint;
  int reserved;
} POP3ClientTLSPSKEventParams;


Unicode (Windows)
virtual INT FireTLSPSK(POP3ClientTLSPSKEventParams *e);

typedef struct {
  LPCWSTR Host;
  LPCWSTR Hint;
  INT reserved;
} POP3ClientTLSPSKEventParams;

#define EID_POP3CLIENT_TLSPSK 13

virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LPSTR &lpszHost, LPSTR &lpszHint);

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireTLSPSK(POP3ClientTLSPSKEventParams *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 (POP3Client Class)

Reports the graceful closure of a TLS connection.

Syntax

ANSI (Cross Platform)
virtual int FireTLSShutdown(POP3ClientTLSShutdownEventParams *e);

typedef struct {
  const char *Host;
  int reserved;
} POP3ClientTLSShutdownEventParams;


Unicode (Windows)
virtual INT FireTLSShutdown(POP3ClientTLSShutdownEventParams *e);

typedef struct {
  LPCWSTR Host;
  INT reserved;
} POP3ClientTLSShutdownEventParams;

#define EID_POP3CLIENT_TLSSHUTDOWN 14

virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);

class POP3ClientTLSShutdownEventParams {
public:
  const QString &Host();

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

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

// Or, subclass POP3Client and override this emitter function.
virtual int FireTLSShutdown(POP3ClientTLSShutdownEventParams *e) {...}

Remarks

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

SecureBlackboxStream Type

Syntax

SecureBlackboxStream (declared in secureblackbox.h)

Remarks

The POP3Client 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 POP3Client class an instance of that concrete class.

When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

Properties

CanRead	Whether the stream supports reading. bool CanRead() { return true; }
CanSeek	Whether the stream supports seeking. bool CanSeek() { return true; }
CanWrite	Whether the stream supports writing. bool CanWrite() { return true; }
Length	Gets the length of the stream, in bytes. int64 GetLength() = 0;
Methods

Close	Closes the stream, releasing all resources currently allocated for it. void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted.
Flush	Forces all data held by the stream's buffers to be written out to storage. int Flush() { return 0; } Must return `0` if flushing is successful; or `-1` if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return `0`.
Read	Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. int Read(void* buffer, int count) = 0; `Buffer` specifies the buffer to populate with data from the stream. `Count` specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into `Buffer`; this may be less than `Count` if that many bytes are not currently available, or `0` if the end of the stream has been reached. Must return `-1` if an error occurs, if reading is not supported, or if the stream is closed.
Seek	Sets the current position within the stream based on a particular point of origin. int64 Seek(int64 offset, int seekOrigin) = 0; `Offset` specifies the offset in the stream to seek to, relative to `SeekOrigin`. Valid values for `SeekOrigin` are: `0`: Seek from beginning. `1`: Seek from current position. `2`: Seek from end. Must return the new position within the stream; or `-1` if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If `-1` is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an `Offset` of `0` and a `SeekOrigin` of `1` to obtain the current position within the stream, even if seeking is not otherwise supported.
Write	Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. int Write(const void* buffer, int count) = 0; `Buffer` specifies the buffer with data to write to the stream. `Count` specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than `Count` if that many bytes could not be written. Must return `-1` if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (POP3Client 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.

POP3Client Config Settings

Authentications: Specifies enabled authentication methods and their priorities.

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

Supported methods: USER, APOP, CRAM-MD5, DIGEST-MD5, NTLM, GSSAPI, XOAUTH2, SCRAM-SHA-1, SCRAM-SHA-256

Default value: APOP,USER,DIGEST-MD5,CRAM-MD5,NTLM

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

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

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

MaxLineLength: Specifies maximum expected line length.

Use this setting to specify how long the expected mail line can be. Setting the very long value leads to memory increase. Default value is 10000. RFC 5322 requires that lines of up to 1000 characters long are handled correctly.

RequestUIDs: Specifies whether to request message UIDs when listing messages.

Use this setting to enable or disable message UID requests.

TempPath: Path for storing temporary files.

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

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

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

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

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

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

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

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

Base Config Settings

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

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

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

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

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

Supported values are:


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

Cookies: Gets or sets local cookies for the class.

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

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

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

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

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

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

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

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

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

LogDestination: Specifies the debug log destination.

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

Supported values are:


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

LogDetails: Specifies the debug log details to dump.

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

Supported values are:


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

LogFile: Specifies the debug log filename.

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

LogFilters: Specifies the debug log filters.

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

Supported filter names are:


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

LogFlushMode: Specifies the log flush mode.

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


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

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


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

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

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

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

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


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

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

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

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

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

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

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

StaticDNS: Specifies whether static DNS rules should be used.

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

Supported values are:


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

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

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

StaticIPAddresses: Gets or sets all the static DNS rules.

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

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

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

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

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

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

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

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

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

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

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

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

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

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

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

Trappable Errors (POP3Client 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.

POP3Client 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`)