MailReader Class

Properties   Methods   Events   Config Settings   Errors  

The MailReader class implements parsing and decryption of e-mail messages.

Syntax

MailReader

Remarks

MailReader parses and decrypts e-mail messages, as well as verifies electronic signatures.

Property List

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

Method List

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

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.

Config Settings

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

AttachCount Property (MailReader Class)

The number of records in the Attach arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachCount();

Unicode (Windows)
INT GetAttachCount();

int secureblackbox_mailreader_getattachcount(void* lpObj);

int GetAttachCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachContentSubtype
• AttachContentType
• AttachCreationDate
• AttachData
• AttachDescription
• AttachFilename
• AttachHandle
• AttachID
• AttachModificationDate
• AttachReadDate
• AttachSize

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

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

Data Type

Integer

AttachContentSubtype Property (MailReader Class)

Contains the content subtype of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachContentSubtype(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachContentSubtype(INT iAttachIndex);

char* secureblackbox_mailreader_getattachcontentsubtype(void* lpObj, int attachindex);

QString GetAttachContentSubtype(int iAttachIndex);

Default Value

""

Remarks

Contains the content subtype of the attachment.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachContentType Property (MailReader Class)

Contains the content type of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachContentType(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachContentType(INT iAttachIndex);

char* secureblackbox_mailreader_getattachcontenttype(void* lpObj, int attachindex);

QString GetAttachContentType(int iAttachIndex);

Default Value

""

Remarks

Contains the content type of the attachment.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachCreationDate Property (MailReader Class)

The creation date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachCreationDate(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachCreationDate(INT iAttachIndex);

char* secureblackbox_mailreader_getattachcreationdate(void* lpObj, int attachindex);

QString GetAttachCreationDate(int iAttachIndex);

Default Value

""

Remarks

The creation date.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachData Property (MailReader Class)

The content of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttachData(int iAttachIndex, char* &lpAttachData, int &lenAttachData);

Unicode (Windows)
INT GetAttachData(INT iAttachIndex, LPSTR &lpAttachData, INT &lenAttachData);

int secureblackbox_mailreader_getattachdata(void* lpObj, int attachindex, char** lpAttachData, int* lenAttachData);

QByteArray GetAttachData(int iAttachIndex);

Remarks

The content of the attachment.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

Byte Array

AttachDescription Property (MailReader Class)

Textual description of the attachment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachDescription(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachDescription(INT iAttachIndex);

char* secureblackbox_mailreader_getattachdescription(void* lpObj, int attachindex);

QString GetAttachDescription(int iAttachIndex);

Default Value

""

Remarks

Textual description of the attachment.

This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachFilename Property (MailReader Class)

Specifies the name of the attachment file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachFilename(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachFilename(INT iAttachIndex);

char* secureblackbox_mailreader_getattachfilename(void* lpObj, int attachindex);

QString GetAttachFilename(int iAttachIndex);

Default Value

""

Remarks

Specifies the name of the attachment file.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachHandle Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetAttachHandle(int iAttachIndex);

Unicode (Windows)
LONG64 GetAttachHandle(INT iAttachIndex);

int64 secureblackbox_mailreader_getattachhandle(void* lpObj, int attachindex);

qint64 GetAttachHandle(int iAttachIndex);

Default Value

0

Remarks

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

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

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

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

Long64

AttachID Property (MailReader Class)

Contains the attachment's unique identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachID(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachID(INT iAttachIndex);

char* secureblackbox_mailreader_getattachid(void* lpObj, int attachindex);

QString GetAttachID(int iAttachIndex);

Default Value

""

Remarks

Contains the attachment's unique identifier.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachModificationDate Property (MailReader Class)

Specifies the date and time of the file's last modification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachModificationDate(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachModificationDate(INT iAttachIndex);

char* secureblackbox_mailreader_getattachmodificationdate(void* lpObj, int attachindex);

QString GetAttachModificationDate(int iAttachIndex);

Default Value

""

Remarks

Specifies the date and time of the file's last modification.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachReadDate Property (MailReader Class)

Specifies the file's last read date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttachReadDate(int iAttachIndex);

Unicode (Windows)
LPWSTR GetAttachReadDate(INT iAttachIndex);

char* secureblackbox_mailreader_getattachreaddate(void* lpObj, int attachindex);

QString GetAttachReadDate(int iAttachIndex);

Default Value

""

Remarks

Specifies the file's last read date.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

String

AttachSize Property (MailReader Class)

The attachment's size in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetAttachSize(int iAttachIndex);

Unicode (Windows)
LONG64 GetAttachSize(INT iAttachIndex);

int64 secureblackbox_mailreader_getattachsize(void* lpObj, int attachindex);

qint64 GetAttachSize(int iAttachIndex);

Default Value

0

Remarks

The attachment's size in bytes.

The AttachIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachCount property.

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

Data Type

Long64

BccAddrCount Property (MailReader Class)

The number of records in the BccAddr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBccAddrCount();

Unicode (Windows)
INT GetBccAddrCount();

int secureblackbox_mailreader_getbccaddrcount(void* lpObj);

int GetBccAddrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• BccAddrAddress
• BccAddrDisplayName
• BccAddrGroupName

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

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

Data Type

Integer

BccAddrAddress Property (MailReader Class)

Contains the e-mail address in the form of john@doe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBccAddrAddress(int iBccAddrIndex);

Unicode (Windows)
LPWSTR GetBccAddrAddress(INT iBccAddrIndex);

char* secureblackbox_mailreader_getbccaddraddress(void* lpObj, int bccaddrindex);

QString GetBccAddrAddress(int iBccAddrIndex);

Default Value

""

Remarks

Contains the e-mail address in the form of john@doe.com.

The BccAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BccAddrCount property.

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

Data Type

String

BccAddrDisplayName Property (MailReader Class)

Contains the friendly name of the user of this address, such as John Doe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBccAddrDisplayName(int iBccAddrIndex);

Unicode (Windows)
LPWSTR GetBccAddrDisplayName(INT iBccAddrIndex);

char* secureblackbox_mailreader_getbccaddrdisplayname(void* lpObj, int bccaddrindex);

QString GetBccAddrDisplayName(int iBccAddrIndex);

Default Value

""

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The BccAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BccAddrCount property.

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

Data Type

String

BccAddrGroupName Property (MailReader Class)

The name of the group this address belongs to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBccAddrGroupName(int iBccAddrIndex);

Unicode (Windows)
LPWSTR GetBccAddrGroupName(INT iBccAddrIndex);

char* secureblackbox_mailreader_getbccaddrgroupname(void* lpObj, int bccaddrindex);

QString GetBccAddrGroupName(int iBccAddrIndex);

Default Value

""

Remarks

The name of the group this address belongs to.

The BccAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BccAddrCount property.

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

Data Type

String

BlockedCertCount Property (MailReader Class)

The number of records in the BlockedCert arrays.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_mailreader_getblockedcertcount(void* lpObj);
int secureblackbox_mailreader_setblockedcertcount(void* lpObj, int iBlockedCertCount);

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

Default Value

0

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

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_mailreader_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 (MailReader Class)

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

Syntax

• C++
• C
• Qt

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_mailreader_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_mailreader_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);

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

Default Value

0

Remarks

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

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

 
 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

CcAddrCount Property (MailReader Class)

The number of records in the CcAddr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCcAddrCount();

Unicode (Windows)
INT GetCcAddrCount();

int secureblackbox_mailreader_getccaddrcount(void* lpObj);

int GetCcAddrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• CcAddrAddress
• CcAddrDisplayName
• CcAddrGroupName

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

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

Data Type

Integer

CcAddrAddress Property (MailReader Class)

Contains the e-mail address in the form of john@doe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCcAddrAddress(int iCcAddrIndex);

Unicode (Windows)
LPWSTR GetCcAddrAddress(INT iCcAddrIndex);

char* secureblackbox_mailreader_getccaddraddress(void* lpObj, int ccaddrindex);

QString GetCcAddrAddress(int iCcAddrIndex);

Default Value

""

Remarks

Contains the e-mail address in the form of john@doe.com.

The CcAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CcAddrCount property.

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

Data Type

String

CcAddrDisplayName Property (MailReader Class)

Contains the friendly name of the user of this address, such as John Doe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCcAddrDisplayName(int iCcAddrIndex);

Unicode (Windows)
LPWSTR GetCcAddrDisplayName(INT iCcAddrIndex);

char* secureblackbox_mailreader_getccaddrdisplayname(void* lpObj, int ccaddrindex);

QString GetCcAddrDisplayName(int iCcAddrIndex);

Default Value

""

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The CcAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CcAddrCount property.

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

Data Type

String

CcAddrGroupName Property (MailReader Class)

The name of the group this address belongs to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCcAddrGroupName(int iCcAddrIndex);

Unicode (Windows)
LPWSTR GetCcAddrGroupName(INT iCcAddrIndex);

char* secureblackbox_mailreader_getccaddrgroupname(void* lpObj, int ccaddrindex);

QString GetCcAddrGroupName(int iCcAddrIndex);

Default Value

""

Remarks

The name of the group this address belongs to.

The CcAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CcAddrCount property.

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

Data Type

String

DecryptionCertBytes Property (MailReader Class)

Returns the raw certificate data in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertBytes(char* &lpDecryptionCertBytes, int &lenDecryptionCertBytes);

Unicode (Windows)
INT GetDecryptionCertBytes(LPSTR &lpDecryptionCertBytes, INT &lenDecryptionCertBytes);

int secureblackbox_mailreader_getdecryptioncertbytes(void* lpObj, char** lpDecryptionCertBytes, int* lenDecryptionCertBytes);

QByteArray GetDecryptionCertBytes();

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

DecryptionCertCA Property (MailReader Class)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertCA();
int SetDecryptionCertCA(int bDecryptionCertCA);

Unicode (Windows)
BOOL GetDecryptionCertCA();
INT SetDecryptionCertCA(BOOL bDecryptionCertCA);

int secureblackbox_mailreader_getdecryptioncertca(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertca(void* lpObj, int bDecryptionCertCA);

bool GetDecryptionCertCA();
int SetDecryptionCertCA(bool bDecryptionCertCA);

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

This property is not available at design time.

Data Type

Boolean

DecryptionCertCAKeyID Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertCAKeyID(char* &lpDecryptionCertCAKeyID, int &lenDecryptionCertCAKeyID);

Unicode (Windows)
INT GetDecryptionCertCAKeyID(LPSTR &lpDecryptionCertCAKeyID, INT &lenDecryptionCertCAKeyID);

int secureblackbox_mailreader_getdecryptioncertcakeyid(void* lpObj, char** lpDecryptionCertCAKeyID, int* lenDecryptionCertCAKeyID);

QByteArray GetDecryptionCertCAKeyID();

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.

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

Data Type

Byte Array

DecryptionCertCRLDistributionPoints Property (MailReader Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertCRLDistributionPoints();
int SetDecryptionCertCRLDistributionPoints(const char* lpszDecryptionCertCRLDistributionPoints);

Unicode (Windows)
LPWSTR GetDecryptionCertCRLDistributionPoints();
INT SetDecryptionCertCRLDistributionPoints(LPCWSTR lpszDecryptionCertCRLDistributionPoints);

char* secureblackbox_mailreader_getdecryptioncertcrldistributionpoints(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertcrldistributionpoints(void* lpObj, const char* lpszDecryptionCertCRLDistributionPoints);

QString GetDecryptionCertCRLDistributionPoints();
int SetDecryptionCertCRLDistributionPoints(QString qsDecryptionCertCRLDistributionPoints);

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is not available at design time.

Data Type

String

DecryptionCertCurve Property (MailReader Class)

Specifies the elliptic curve of the EC public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertCurve();
int SetDecryptionCertCurve(const char* lpszDecryptionCertCurve);

Unicode (Windows)
LPWSTR GetDecryptionCertCurve();
INT SetDecryptionCertCurve(LPCWSTR lpszDecryptionCertCurve);

char* secureblackbox_mailreader_getdecryptioncertcurve(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertcurve(void* lpObj, const char* lpszDecryptionCertCurve);

QString GetDecryptionCertCurve();
int SetDecryptionCertCurve(QString qsDecryptionCertCurve);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

This property is not available at design time.

Data Type

String

DecryptionCertFingerprint Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertFingerprint(char* &lpDecryptionCertFingerprint, int &lenDecryptionCertFingerprint);

Unicode (Windows)
INT GetDecryptionCertFingerprint(LPSTR &lpDecryptionCertFingerprint, INT &lenDecryptionCertFingerprint);

int secureblackbox_mailreader_getdecryptioncertfingerprint(void* lpObj, char** lpDecryptionCertFingerprint, int* lenDecryptionCertFingerprint);

QByteArray GetDecryptionCertFingerprint();

Remarks

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

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

Data Type

Byte Array

DecryptionCertFriendlyName Property (MailReader Class)

Contains an associated alias (friendly name) of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertFriendlyName();

Unicode (Windows)
LPWSTR GetDecryptionCertFriendlyName();

char* secureblackbox_mailreader_getdecryptioncertfriendlyname(void* lpObj);

QString GetDecryptionCertFriendlyName();

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate.

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

Data Type

String

DecryptionCertHandle Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetDecryptionCertHandle();
int SetDecryptionCertHandle(int64 lDecryptionCertHandle);

Unicode (Windows)
LONG64 GetDecryptionCertHandle();
INT SetDecryptionCertHandle(LONG64 lDecryptionCertHandle);

int64 secureblackbox_mailreader_getdecryptioncerthandle(void* lpObj);
int secureblackbox_mailreader_setdecryptioncerthandle(void* lpObj, int64 lDecryptionCertHandle);

qint64 GetDecryptionCertHandle();
int SetDecryptionCertHandle(qint64 lDecryptionCertHandle);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

DecryptionCertHashAlgorithm Property (MailReader Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertHashAlgorithm();
int SetDecryptionCertHashAlgorithm(const char* lpszDecryptionCertHashAlgorithm);

Unicode (Windows)
LPWSTR GetDecryptionCertHashAlgorithm();
INT SetDecryptionCertHashAlgorithm(LPCWSTR lpszDecryptionCertHashAlgorithm);

char* secureblackbox_mailreader_getdecryptioncerthashalgorithm(void* lpObj);
int secureblackbox_mailreader_setdecryptioncerthashalgorithm(void* lpObj, const char* lpszDecryptionCertHashAlgorithm);

QString GetDecryptionCertHashAlgorithm();
int SetDecryptionCertHashAlgorithm(QString qsDecryptionCertHashAlgorithm);

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

This property is not available at design time.

Data Type

String

DecryptionCertIssuer Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertIssuer();

Unicode (Windows)
LPWSTR GetDecryptionCertIssuer();

char* secureblackbox_mailreader_getdecryptioncertissuer(void* lpObj);

QString GetDecryptionCertIssuer();

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertIssuerRDN Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertIssuerRDN();
int SetDecryptionCertIssuerRDN(const char* lpszDecryptionCertIssuerRDN);

Unicode (Windows)
LPWSTR GetDecryptionCertIssuerRDN();
INT SetDecryptionCertIssuerRDN(LPCWSTR lpszDecryptionCertIssuerRDN);

char* secureblackbox_mailreader_getdecryptioncertissuerrdn(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertissuerrdn(void* lpObj, const char* lpszDecryptionCertIssuerRDN);

QString GetDecryptionCertIssuerRDN();
int SetDecryptionCertIssuerRDN(QString qsDecryptionCertIssuerRDN);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertKeyAlgorithm Property (MailReader Class)

Specifies the public key algorithm of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertKeyAlgorithm();
int SetDecryptionCertKeyAlgorithm(const char* lpszDecryptionCertKeyAlgorithm);

Unicode (Windows)
LPWSTR GetDecryptionCertKeyAlgorithm();
INT SetDecryptionCertKeyAlgorithm(LPCWSTR lpszDecryptionCertKeyAlgorithm);

char* secureblackbox_mailreader_getdecryptioncertkeyalgorithm(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertkeyalgorithm(void* lpObj, const char* lpszDecryptionCertKeyAlgorithm);

QString GetDecryptionCertKeyAlgorithm();
int SetDecryptionCertKeyAlgorithm(QString qsDecryptionCertKeyAlgorithm);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

This property is not available at design time.

Data Type

String

DecryptionCertKeyBits Property (MailReader Class)

Returns the length of the public key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertKeyBits();

Unicode (Windows)
INT GetDecryptionCertKeyBits();

int secureblackbox_mailreader_getdecryptioncertkeybits(void* lpObj);

int GetDecryptionCertKeyBits();

Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

DecryptionCertKeyFingerprint Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertKeyFingerprint(char* &lpDecryptionCertKeyFingerprint, int &lenDecryptionCertKeyFingerprint);

Unicode (Windows)
INT GetDecryptionCertKeyFingerprint(LPSTR &lpDecryptionCertKeyFingerprint, INT &lenDecryptionCertKeyFingerprint);

int secureblackbox_mailreader_getdecryptioncertkeyfingerprint(void* lpObj, char** lpDecryptionCertKeyFingerprint, int* lenDecryptionCertKeyFingerprint);

QByteArray GetDecryptionCertKeyFingerprint();

Remarks

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

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

Data Type

Byte Array

DecryptionCertKeyUsage Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertKeyUsage();
int SetDecryptionCertKeyUsage(int iDecryptionCertKeyUsage);

Unicode (Windows)
INT GetDecryptionCertKeyUsage();
INT SetDecryptionCertKeyUsage(INT iDecryptionCertKeyUsage);

int secureblackbox_mailreader_getdecryptioncertkeyusage(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertkeyusage(void* lpObj, int iDecryptionCertKeyUsage);

int GetDecryptionCertKeyUsage();
int SetDecryptionCertKeyUsage(int iDecryptionCertKeyUsage);

Default Value

0

Remarks

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

This value is a bit mask of the following values:

This property is not available at design time.

Data Type

Integer

DecryptionCertKeyValid Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertKeyValid();

Unicode (Windows)
BOOL GetDecryptionCertKeyValid();

int secureblackbox_mailreader_getdecryptioncertkeyvalid(void* lpObj);

bool GetDecryptionCertKeyValid();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

DecryptionCertOCSPLocations Property (MailReader Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertOCSPLocations();
int SetDecryptionCertOCSPLocations(const char* lpszDecryptionCertOCSPLocations);

Unicode (Windows)
LPWSTR GetDecryptionCertOCSPLocations();
INT SetDecryptionCertOCSPLocations(LPCWSTR lpszDecryptionCertOCSPLocations);

char* secureblackbox_mailreader_getdecryptioncertocsplocations(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertocsplocations(void* lpObj, const char* lpszDecryptionCertOCSPLocations);

QString GetDecryptionCertOCSPLocations();
int SetDecryptionCertOCSPLocations(QString qsDecryptionCertOCSPLocations);

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is not available at design time.

Data Type

String

DecryptionCertOCSPNoCheck Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertOCSPNoCheck();
int SetDecryptionCertOCSPNoCheck(int bDecryptionCertOCSPNoCheck);

Unicode (Windows)
BOOL GetDecryptionCertOCSPNoCheck();
INT SetDecryptionCertOCSPNoCheck(BOOL bDecryptionCertOCSPNoCheck);

int secureblackbox_mailreader_getdecryptioncertocspnocheck(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertocspnocheck(void* lpObj, int bDecryptionCertOCSPNoCheck);

bool GetDecryptionCertOCSPNoCheck();
int SetDecryptionCertOCSPNoCheck(bool bDecryptionCertOCSPNoCheck);

Default Value

FALSE

Remarks

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

This property is not available at design time.

Data Type

Boolean

DecryptionCertOrigin Property (MailReader Class)

Returns the origin of this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertOrigin();

Unicode (Windows)
INT GetDecryptionCertOrigin();

int secureblackbox_mailreader_getdecryptioncertorigin(void* lpObj);

int GetDecryptionCertOrigin();

Default Value

0

Remarks

Returns the origin of this certificate.

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

Data Type

Integer

DecryptionCertPolicyIDs Property (MailReader Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertPolicyIDs();
int SetDecryptionCertPolicyIDs(const char* lpszDecryptionCertPolicyIDs);

Unicode (Windows)
LPWSTR GetDecryptionCertPolicyIDs();
INT SetDecryptionCertPolicyIDs(LPCWSTR lpszDecryptionCertPolicyIDs);

char* secureblackbox_mailreader_getdecryptioncertpolicyids(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertpolicyids(void* lpObj, const char* lpszDecryptionCertPolicyIDs);

QString GetDecryptionCertPolicyIDs();
int SetDecryptionCertPolicyIDs(QString qsDecryptionCertPolicyIDs);

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

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

This property is not available at design time.

Data Type

String

DecryptionCertPrivateKeyBytes Property (MailReader Class)

Contains the certificate's private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertPrivateKeyBytes(char* &lpDecryptionCertPrivateKeyBytes, int &lenDecryptionCertPrivateKeyBytes);

Unicode (Windows)
INT GetDecryptionCertPrivateKeyBytes(LPSTR &lpDecryptionCertPrivateKeyBytes, INT &lenDecryptionCertPrivateKeyBytes);

int secureblackbox_mailreader_getdecryptioncertprivatekeybytes(void* lpObj, char** lpDecryptionCertPrivateKeyBytes, int* lenDecryptionCertPrivateKeyBytes);

QByteArray GetDecryptionCertPrivateKeyBytes();

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

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

Data Type

Byte Array

DecryptionCertPrivateKeyExists Property (MailReader Class)

Indicates whether the certificate has an associated private key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertPrivateKeyExists();

Unicode (Windows)
BOOL GetDecryptionCertPrivateKeyExists();

int secureblackbox_mailreader_getdecryptioncertprivatekeyexists(void* lpObj);

bool GetDecryptionCertPrivateKeyExists();

Default Value

FALSE

Remarks

Indicates whether the certificate has an associated private key.

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

Data Type

Boolean

DecryptionCertPrivateKeyExtractable Property (MailReader Class)

Indicates whether the private key is extractable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertPrivateKeyExtractable();

Unicode (Windows)
BOOL GetDecryptionCertPrivateKeyExtractable();

int secureblackbox_mailreader_getdecryptioncertprivatekeyextractable(void* lpObj);

bool GetDecryptionCertPrivateKeyExtractable();

Default Value

FALSE

Remarks

Indicates whether the private key is extractable.

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

Data Type

Boolean

DecryptionCertPublicKeyBytes Property (MailReader Class)

Contains the certificate's public key in DER format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertPublicKeyBytes(char* &lpDecryptionCertPublicKeyBytes, int &lenDecryptionCertPublicKeyBytes);

Unicode (Windows)
INT GetDecryptionCertPublicKeyBytes(LPSTR &lpDecryptionCertPublicKeyBytes, INT &lenDecryptionCertPublicKeyBytes);

int secureblackbox_mailreader_getdecryptioncertpublickeybytes(void* lpObj, char** lpDecryptionCertPublicKeyBytes, int* lenDecryptionCertPublicKeyBytes);

QByteArray GetDecryptionCertPublicKeyBytes();

Remarks

Contains the certificate's public key in DER format.

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

Data Type

Byte Array

DecryptionCertQualifiedStatements Property (MailReader Class)

Returns the qualified status of the certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertQualifiedStatements();
int SetDecryptionCertQualifiedStatements(int iDecryptionCertQualifiedStatements);

Unicode (Windows)
INT GetDecryptionCertQualifiedStatements();
INT SetDecryptionCertQualifiedStatements(INT iDecryptionCertQualifiedStatements);

QST_NON_QUALIFIED(0), 
QST_QUALIFIED_HARDWARE(1), 
QST_QUALIFIED_SOFTWARE(2)

int secureblackbox_mailreader_getdecryptioncertqualifiedstatements(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertqualifiedstatements(void* lpObj, int iDecryptionCertQualifiedStatements);

int GetDecryptionCertQualifiedStatements();
int SetDecryptionCertQualifiedStatements(int iDecryptionCertQualifiedStatements);

Default Value

0

Remarks

Returns the qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

DecryptionCertSelfSigned Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertSelfSigned();

Unicode (Windows)
BOOL GetDecryptionCertSelfSigned();

int secureblackbox_mailreader_getdecryptioncertselfsigned(void* lpObj);

bool GetDecryptionCertSelfSigned();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

DecryptionCertSerialNumber Property (MailReader Class)

Returns the certificate's serial number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertSerialNumber(char* &lpDecryptionCertSerialNumber, int &lenDecryptionCertSerialNumber);
int SetDecryptionCertSerialNumber(const char* lpDecryptionCertSerialNumber, int lenDecryptionCertSerialNumber);

Unicode (Windows)
INT GetDecryptionCertSerialNumber(LPSTR &lpDecryptionCertSerialNumber, INT &lenDecryptionCertSerialNumber);
INT SetDecryptionCertSerialNumber(LPCSTR lpDecryptionCertSerialNumber, INT lenDecryptionCertSerialNumber);

int secureblackbox_mailreader_getdecryptioncertserialnumber(void* lpObj, char** lpDecryptionCertSerialNumber, int* lenDecryptionCertSerialNumber);
int secureblackbox_mailreader_setdecryptioncertserialnumber(void* lpObj, const char* lpDecryptionCertSerialNumber, int lenDecryptionCertSerialNumber);

QByteArray GetDecryptionCertSerialNumber();
int SetDecryptionCertSerialNumber(QByteArray qbaDecryptionCertSerialNumber);

Remarks

Returns the certificate's serial number.

This property is not available at design time.

Data Type

Byte Array

DecryptionCertSigAlgorithm Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertSigAlgorithm();

Unicode (Windows)
LPWSTR GetDecryptionCertSigAlgorithm();

char* secureblackbox_mailreader_getdecryptioncertsigalgorithm(void* lpObj);

QString GetDecryptionCertSigAlgorithm();

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertSubject Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertSubject();

Unicode (Windows)
LPWSTR GetDecryptionCertSubject();

char* secureblackbox_mailreader_getdecryptioncertsubject(void* lpObj);

QString GetDecryptionCertSubject();

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.

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

Data Type

String

DecryptionCertSubjectAlternativeName Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertSubjectAlternativeName();
int SetDecryptionCertSubjectAlternativeName(const char* lpszDecryptionCertSubjectAlternativeName);

Unicode (Windows)
LPWSTR GetDecryptionCertSubjectAlternativeName();
INT SetDecryptionCertSubjectAlternativeName(LPCWSTR lpszDecryptionCertSubjectAlternativeName);

char* secureblackbox_mailreader_getdecryptioncertsubjectalternativename(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertsubjectalternativename(void* lpObj, const char* lpszDecryptionCertSubjectAlternativeName);

QString GetDecryptionCertSubjectAlternativeName();
int SetDecryptionCertSubjectAlternativeName(QString qsDecryptionCertSubjectAlternativeName);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertSubjectKeyID Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDecryptionCertSubjectKeyID(char* &lpDecryptionCertSubjectKeyID, int &lenDecryptionCertSubjectKeyID);
int SetDecryptionCertSubjectKeyID(const char* lpDecryptionCertSubjectKeyID, int lenDecryptionCertSubjectKeyID);

Unicode (Windows)
INT GetDecryptionCertSubjectKeyID(LPSTR &lpDecryptionCertSubjectKeyID, INT &lenDecryptionCertSubjectKeyID);
INT SetDecryptionCertSubjectKeyID(LPCSTR lpDecryptionCertSubjectKeyID, INT lenDecryptionCertSubjectKeyID);

int secureblackbox_mailreader_getdecryptioncertsubjectkeyid(void* lpObj, char** lpDecryptionCertSubjectKeyID, int* lenDecryptionCertSubjectKeyID);
int secureblackbox_mailreader_setdecryptioncertsubjectkeyid(void* lpObj, const char* lpDecryptionCertSubjectKeyID, int lenDecryptionCertSubjectKeyID);

QByteArray GetDecryptionCertSubjectKeyID();
int SetDecryptionCertSubjectKeyID(QByteArray qbaDecryptionCertSubjectKeyID);

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.

This property is not available at design time.

Data Type

Byte Array

DecryptionCertSubjectRDN Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertSubjectRDN();
int SetDecryptionCertSubjectRDN(const char* lpszDecryptionCertSubjectRDN);

Unicode (Windows)
LPWSTR GetDecryptionCertSubjectRDN();
INT SetDecryptionCertSubjectRDN(LPCWSTR lpszDecryptionCertSubjectRDN);

char* secureblackbox_mailreader_getdecryptioncertsubjectrdn(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertsubjectrdn(void* lpObj, const char* lpszDecryptionCertSubjectRDN);

QString GetDecryptionCertSubjectRDN();
int SetDecryptionCertSubjectRDN(QString qsDecryptionCertSubjectRDN);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertValidFrom Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertValidFrom();
int SetDecryptionCertValidFrom(const char* lpszDecryptionCertValidFrom);

Unicode (Windows)
LPWSTR GetDecryptionCertValidFrom();
INT SetDecryptionCertValidFrom(LPCWSTR lpszDecryptionCertValidFrom);

char* secureblackbox_mailreader_getdecryptioncertvalidfrom(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertvalidfrom(void* lpObj, const char* lpszDecryptionCertValidFrom);

QString GetDecryptionCertValidFrom();
int SetDecryptionCertValidFrom(QString qsDecryptionCertValidFrom);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertValidTo Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDecryptionCertValidTo();
int SetDecryptionCertValidTo(const char* lpszDecryptionCertValidTo);

Unicode (Windows)
LPWSTR GetDecryptionCertValidTo();
INT SetDecryptionCertValidTo(LPCWSTR lpszDecryptionCertValidTo);

char* secureblackbox_mailreader_getdecryptioncertvalidto(void* lpObj);
int secureblackbox_mailreader_setdecryptioncertvalidto(void* lpObj, const char* lpszDecryptionCertValidTo);

QString GetDecryptionCertValidTo();
int SetDecryptionCertValidTo(QString qsDecryptionCertValidTo);

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ExternalCryptoAsyncDocumentID Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_mailreader_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_mailreader_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_mailreader_getexternalcryptodata(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

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

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_mailreader_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

Specifies the request's signature hash algorithm.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_mailreader_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_mailreader_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);

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

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_mailreader_getexternalcryptokeyid(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

The pre-shared key used for DC request authentication.

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_mailreader_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_mailreader_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 (MailReader Class)

Specifies the asynchronous signing method.

Syntax

• C++
• C
• Qt

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

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

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

int secureblackbox_mailreader_getexternalcryptomethod(void* lpObj);
int secureblackbox_mailreader_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);

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

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (MailReader Class)

Specifies the external cryptography mode.

Syntax

• C++
• C
• Qt

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

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

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

int secureblackbox_mailreader_getexternalcryptomode(void* lpObj);
int secureblackbox_mailreader_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);

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

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (MailReader Class)

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

Syntax

• C++
• C
• Qt

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

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

char* secureblackbox_mailreader_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_mailreader_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.

Data Type

String

FIPSMode Property (MailReader Class)

Reserved.

Syntax

• C++
• C
• Qt

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

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

int secureblackbox_mailreader_getfipsmode(void* lpObj);
int secureblackbox_mailreader_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

FromAddrCount Property (MailReader Class)

The number of records in the FromAddr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFromAddrCount();

Unicode (Windows)
INT GetFromAddrCount();

int secureblackbox_mailreader_getfromaddrcount(void* lpObj);

int GetFromAddrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• FromAddrAddress
• FromAddrDisplayName
• FromAddrGroupName

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

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

Data Type

Integer

FromAddrAddress Property (MailReader Class)

Contains the e-mail address in the form of john@doe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFromAddrAddress(int iFromAddrIndex);

Unicode (Windows)
LPWSTR GetFromAddrAddress(INT iFromAddrIndex);

char* secureblackbox_mailreader_getfromaddraddress(void* lpObj, int fromaddrindex);

QString GetFromAddrAddress(int iFromAddrIndex);

Default Value

""

Remarks

Contains the e-mail address in the form of john@doe.com.

The FromAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FromAddrCount property.

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

Data Type

String

FromAddrDisplayName Property (MailReader Class)

Contains the friendly name of the user of this address, such as John Doe.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFromAddrDisplayName(int iFromAddrIndex);

Unicode (Windows)
LPWSTR GetFromAddrDisplayName(INT iFromAddrIndex);

char* secureblackbox_mailreader_getfromaddrdisplayname(void* lpObj, int fromaddrindex);

QString GetFromAddrDisplayName(int iFromAddrIndex);

Default Value

""

Remarks

Contains the friendly name of the user of this address, such as John Doe.

The FromAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FromAddrCount property.

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

Data Type

String

FromAddrGroupName Property (MailReader Class)

The name of the group this address belongs to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFromAddrGroupName(int iFromAddrIndex);

Unicode (Windows)
LPWSTR GetFromAddrGroupName(INT iFromAddrIndex);

char* secureblackbox_mailreader_getfromaddrgroupname(void* lpObj, int fromaddrindex);

QString GetFromAddrGroupName(int iFromAddrIndex);

Default Value

""

Remarks

The name of the group this address belongs to.

The FromAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FromAddrCount property.

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

Data Type

String

IgnoreChainValidationErrors Property (MailReader Class)

Makes the class tolerant to chain validation errors.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(int bIgnoreChainValidationErrors);

Unicode (Windows)
BOOL GetIgnoreChainValidationErrors();
INT SetIgnoreChainValidationErrors(BOOL bIgnoreChainValidationErrors);

int secureblackbox_mailreader_getignorechainvalidationerrors(void* lpObj);
int secureblackbox_mailreader_setignorechainvalidationerrors(void* lpObj, int bIgnoreChainValidationErrors);

bool GetIgnoreChainValidationErrors();
int SetIgnoreChainValidationErrors(bool bIgnoreChainValidationErrors);

Default Value

FALSE

Remarks