MailReader Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TsbxMailReader

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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

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

AttachCount Property (MailReader Component)

The number of records in the Attach arrays.

Syntax

__property int AttachCount = { read=FAttachCount };

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

Contains the content subtype of the attachment.

Syntax

__property String AttachContentSubtype[int AttachIndex] = { read=FAttachContentSubtype };

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

Contains the content type of the attachment.

Syntax

__property String AttachContentType[int AttachIndex] = { read=FAttachContentType };

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

The creation date.

Syntax

__property String AttachCreationDate[int AttachIndex] = { read=FAttachCreationDate };

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

The content of the attachment.

Syntax

__property DynamicArray AttachData[int AttachIndex] = { read=FAttachData };

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

Textual description of the attachment.

Syntax

__property String AttachDescription[int AttachIndex] = { read=FAttachDescription };

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

Specifies the name of the attachment file.

Syntax

__property String AttachFileName[int AttachIndex] = { read=FAttachFileName };

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

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

Syntax

__property __int64 AttachHandle[int AttachIndex] = { read=FAttachHandle };

Default Value

0

Remarks

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

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

The 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 Component)

Contains the attachment's unique identifier.

Syntax

__property String AttachID[int AttachIndex] = { read=FAttachID };

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

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

Syntax

__property String AttachModificationDate[int AttachIndex] = { read=FAttachModificationDate };

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

Specifies the file's last read date.

Syntax

__property String AttachReadDate[int AttachIndex] = { read=FAttachReadDate };

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

The attachment's size in bytes.

Syntax

__property __int64 AttachSize[int AttachIndex] = { read=FAttachSize };

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

The number of records in the BccAddr arrays.

Syntax

__property int BccAddrCount = { read=FBccAddrCount };

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

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

Syntax

__property String BccAddrAddress[int BccAddrIndex] = { read=FBccAddrAddress };

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

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

Syntax

__property String BccAddrDisplayName[int BccAddrIndex] = { read=FBccAddrDisplayName };

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

The name of the group this address belongs to.

Syntax

__property String BccAddrGroupName[int BccAddrIndex] = { read=FBccAddrGroupName };

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

The number of records in the BlockedCert arrays.

Syntax

__property int BlockedCertCount = { read=FBlockedCertCount, write=FSetBlockedCertCount };

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

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray BlockedCertBytes[int BlockedCertIndex] = { read=FBlockedCertBytes };

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

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

Syntax

__property __int64 BlockedCertHandle[int BlockedCertIndex] = { read=FBlockedCertHandle, write=FSetBlockedCertHandle };

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

CcAddrCount Property (MailReader Component)

The number of records in the CcAddr arrays.

Syntax

__property int CcAddrCount = { read=FCcAddrCount };

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

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

Syntax

__property String CcAddrAddress[int CcAddrIndex] = { read=FCcAddrAddress };

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

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

Syntax

__property String CcAddrDisplayName[int CcAddrIndex] = { read=FCcAddrDisplayName };

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

The name of the group this address belongs to.

Syntax

__property String CcAddrGroupName[int CcAddrIndex] = { read=FCcAddrGroupName };

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

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray DecryptionCertBytes = { read=FDecryptionCertBytes };

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

Indicates whether the certificate has a CA capability.

Syntax

__property bool DecryptionCertCA = { read=FDecryptionCertCA, write=FSetDecryptionCertCA };

Default Value

false

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

DecryptionCertCAKeyID Property (MailReader Component)

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

Syntax

__property DynamicArray DecryptionCertCAKeyID = { read=FDecryptionCertCAKeyID };

Remarks

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

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

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

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

Data Type

Byte Array

DecryptionCertCertType Property (MailReader Component)

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

Syntax

__property TsbxMailReaderDecryptionCertCertTypes DecryptionCertCertType = { read=FDecryptionCertCertType };

enum TsbxMailReaderDecryptionCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

Remarks

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

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

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

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

Data Type

Integer

DecryptionCertCRLDistributionPoints Property (MailReader Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

__property String DecryptionCertCRLDistributionPoints = { read=FDecryptionCertCRLDistributionPoints, write=FSetDecryptionCertCRLDistributionPoints };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

DecryptionCertCurve Property (MailReader Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

__property String DecryptionCertCurve = { read=FDecryptionCertCurve, write=FSetDecryptionCertCurve };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertFingerprint Property (MailReader Component)

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

Syntax

__property String DecryptionCertFingerprint = { read=FDecryptionCertFingerprint };

Default Value

""

Remarks

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

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

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

Data Type

String

DecryptionCertFriendlyName Property (MailReader Component)

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

Syntax

__property String DecryptionCertFriendlyName = { read=FDecryptionCertFriendlyName };

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertHandle Property (MailReader Component)

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

Syntax

__property __int64 DecryptionCertHandle = { read=FDecryptionCertHandle, write=FSetDecryptionCertHandle };

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

DecryptionCertHashAlgorithm Property (MailReader Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

__property String DecryptionCertHashAlgorithm = { read=FDecryptionCertHashAlgorithm, write=FSetDecryptionCertHashAlgorithm };

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

DecryptionCertIssuer Property (MailReader Component)

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

Syntax

__property String DecryptionCertIssuer = { read=FDecryptionCertIssuer };

Default Value

""

Remarks

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

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

Data Type

String

DecryptionCertIssuerRDN Property (MailReader Component)

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

Syntax

__property String DecryptionCertIssuerRDN = { read=FDecryptionCertIssuerRDN, write=FSetDecryptionCertIssuerRDN };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

DecryptionCertKeyAlgorithm Property (MailReader Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String DecryptionCertKeyAlgorithm = { read=FDecryptionCertKeyAlgorithm, write=FSetDecryptionCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the DecryptionCertKeyBits, DecryptionCertCurve, and DecryptionCertPublicKeyBytes properties to get more details about the key the certificate contains.

This property is not available at design time.

Data Type

String

DecryptionCertKeyBits Property (MailReader Component)

Returns the length of the public key in bits.

Syntax

__property int DecryptionCertKeyBits = { read=FDecryptionCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

Data Type

Integer

DecryptionCertKeyFingerprint Property (MailReader Component)

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

Syntax

__property String DecryptionCertKeyFingerprint = { read=FDecryptionCertKeyFingerprint };

Default Value

""

Remarks

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

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

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

Data Type

String

DecryptionCertKeyUsage Property (MailReader Component)

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

Syntax

__property int DecryptionCertKeyUsage = { read=FDecryptionCertKeyUsage, write=FSetDecryptionCertKeyUsage };

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:

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

This property is not available at design time.

Data Type

Integer

DecryptionCertKeyValid Property (MailReader Component)

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

Syntax

__property bool DecryptionCertKeyValid = { read=FDecryptionCertKeyValid };

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

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

Syntax

__property String DecryptionCertOCSPLocations = { read=FDecryptionCertOCSPLocations, write=FSetDecryptionCertOCSPLocations };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

DecryptionCertOCSPNoCheck Property (MailReader Component)

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

Syntax

__property bool DecryptionCertOCSPNoCheck = { read=FDecryptionCertOCSPNoCheck, write=FSetDecryptionCertOCSPNoCheck };

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

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

Syntax

__property int DecryptionCertOrigin = { read=FDecryptionCertOrigin };

Default Value

0

Remarks

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

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

Data Type

Integer

DecryptionCertPolicyIDs Property (MailReader Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String DecryptionCertPolicyIDs = { read=FDecryptionCertPolicyIDs, write=FSetDecryptionCertPolicyIDs };

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.

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

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

This property is not available at design time.

Data Type

String

DecryptionCertPrivateKeyBytes Property (MailReader Component)

Returns the certificate's private key in DER-encoded format.

Syntax

__property DynamicArray DecryptionCertPrivateKeyBytes = { read=FDecryptionCertPrivateKeyBytes };

Remarks

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

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

Data Type

Byte Array

DecryptionCertPrivateKeyExists Property (MailReader Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

__property bool DecryptionCertPrivateKeyExists = { read=FDecryptionCertPrivateKeyExists };

Default Value

false

Remarks

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

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

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

Data Type

Boolean

DecryptionCertPrivateKeyExtractable Property (MailReader Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool DecryptionCertPrivateKeyExtractable = { read=FDecryptionCertPrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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

Data Type

Boolean

DecryptionCertPublicKeyBytes Property (MailReader Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray DecryptionCertPublicKeyBytes = { read=FDecryptionCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

DecryptionCertQualified Property (MailReader Component)

Indicates whether the certificate is qualified.

Syntax

__property bool DecryptionCertQualified = { read=FDecryptionCertQualified };

Default Value

false

Remarks

Indicates whether the certificate is qualified.

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

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

Data Type

Boolean

DecryptionCertQualifiedStatements Property (MailReader Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxMailReaderDecryptionCertQualifiedStatements DecryptionCertQualifiedStatements = { read=FDecryptionCertQualifiedStatements, write=FSetDecryptionCertQualifiedStatements };

enum TsbxMailReaderDecryptionCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

Remarks

Returns a simplified qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

DecryptionCertQualifiers Property (MailReader Component)

A list of qualifiers.

Syntax

__property String DecryptionCertQualifiers = { read=FDecryptionCertQualifiers };

Default Value

""

Remarks

A list of qualifiers.

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

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

Data Type

String

DecryptionCertSelfSigned Property (MailReader Component)

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

Syntax

__property bool DecryptionCertSelfSigned = { read=FDecryptionCertSelfSigned };

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

Returns the certificate's serial number.

Syntax

__property DynamicArray DecryptionCertSerialNumber = { read=FDecryptionCertSerialNumber, write=FSetDecryptionCertSerialNumber };

Remarks

Returns the certificate's serial number.

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

This property is not available at design time.

Data Type

Byte Array

DecryptionCertSigAlgorithm Property (MailReader Component)

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

Syntax

__property String DecryptionCertSigAlgorithm = { read=FDecryptionCertSigAlgorithm };

Default Value

""

Remarks

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

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

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

Data Type

String

DecryptionCertSource Property (MailReader Component)

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

Syntax

__property TsbxMailReaderDecryptionCertSources DecryptionCertSource = { read=FDecryptionCertSource };

enum TsbxMailReaderDecryptionCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

Remarks

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

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

Data Type

Integer

DecryptionCertSubject Property (MailReader Component)

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

Syntax

__property String DecryptionCertSubject = { read=FDecryptionCertSubject };

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 is part of a larger set of credentials available via DecryptionCertSubjectRDN.

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

Data Type

String

DecryptionCertSubjectAlternativeName Property (MailReader Component)

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

Syntax

__property String DecryptionCertSubjectAlternativeName = { read=FDecryptionCertSubjectAlternativeName, write=FSetDecryptionCertSubjectAlternativeName };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

DecryptionCertSubjectKeyID Property (MailReader Component)

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

Syntax

__property DynamicArray DecryptionCertSubjectKeyID = { read=FDecryptionCertSubjectKeyID, write=FSetDecryptionCertSubjectKeyID };

Remarks

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

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

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

This property is not available at design time.

Data Type

Byte Array

DecryptionCertSubjectRDN Property (MailReader Component)

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

Syntax

__property String DecryptionCertSubjectRDN = { read=FDecryptionCertSubjectRDN, write=FSetDecryptionCertSubjectRDN };

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

DecryptionCertValid Property (MailReader Component)

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

Syntax

__property bool DecryptionCertValid = { read=FDecryptionCertValid };

Default Value

false

Remarks

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

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

Data Type

Boolean

DecryptionCertValidFrom Property (MailReader Component)

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

Syntax

__property String DecryptionCertValidFrom = { read=FDecryptionCertValidFrom, write=FSetDecryptionCertValidFrom };

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

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

Syntax

__property String DecryptionCertValidTo = { read=FDecryptionCertValidTo, write=FSetDecryptionCertValidTo };

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

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

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

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

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

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

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

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

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

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

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

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

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

If set to true, the component 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 Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (MailReader Component)

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

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (MailReader Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

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

Specifies the asynchronous signing method.

Syntax

__property TsbxMailReaderExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxMailReaderExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

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

Specifies the external cryptography mode.

Syntax

__property TsbxMailReaderExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxMailReaderExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (MailReader Component)

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

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

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

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

FromAddrCount Property (MailReader Component)

The number of records in the FromAddr arrays.

Syntax

__property int FromAddrCount = { read=FFromAddrCount };

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

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

Syntax

__property String FromAddrAddress[int FromAddrIndex] = { read=FFromAddrAddress };

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

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

Syntax

__property String FromAddrDisplayName[int FromAddrIndex] = { read=FFromAddrDisplayName };

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

The name of the group this address belongs to.

Syntax

__property String FromAddrGroupName[int FromAddrIndex] = { read=FFromAddrGroupName };

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

Makes the component tolerant to chain validation errors.

Syntax

__property bool IgnoreChainValidationErrors = { read=FIgnoreChainValidationErrors, write=FSetIgnoreChainValidationErrors };

Default Value

false

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

Data Type

Boolean

KnownCertCount Property (MailReader Component)

The number of records in the KnownCert arrays.

Syntax

__property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount };

Default Value

0

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

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray KnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes };

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

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

Syntax

__property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle };

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (MailReader Component)

The number of records in the KnownCRL arrays.

Syntax

__property int KnownCRLCount = { read=FKnownCRLCount, write=FSetKnownCRLCount };

Default Value

0

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

Returns the raw CRL data in DER format.

Syntax

__property DynamicArray KnownCRLBytes[int KnownCRLIndex] = { read=FKnownCRLBytes };

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

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

Syntax

__property __int64 KnownCRLHandle[int KnownCRLIndex] = { read=FKnownCRLHandle, write=FSetKnownCRLHandle };

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (MailReader Component)

The number of records in the KnownOCSP arrays.

Syntax

__property int KnownOCSPCount = { read=FKnownOCSPCount, write=FSetKnownOCSPCount };

Default Value

0

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

A buffer containing the raw OCSP response data.

Syntax

__property DynamicArray KnownOCSPBytes[int KnownOCSPIndex] = { read=FKnownOCSPBytes };

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

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

Syntax

__property __int64 KnownOCSPHandle[int KnownOCSPIndex] = { read=FKnownOCSPHandle, write=FSetKnownOCSPHandle };

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

MsgAttachmentCount Property (MailReader Component)

Returns the number of attachments in this message.

Syntax

__property int MsgAttachmentCount = { read=FMsgAttachmentCount };

Default Value

0

Remarks

Returns the number of attachments in this message.

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

Data Type

Integer

MsgBcc Property (MailReader Component)

The contents of the BCC header property.

Syntax

__property String MsgBcc = { read=FMsgBcc, write=FSetMsgBcc };

Default Value

""

Remarks

The contents of the BCC header field.

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

This property is not available at design time.

Data Type

String

MsgCc Property (MailReader Component)

The value of the CC header property.

Syntax

__property String MsgCc = { read=FMsgCc, write=FSetMsgCc };

Default Value

""

Remarks

The value of the CC header field.

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

This property is not available at design time.

Data Type

String

MsgComments Property (MailReader Component)

Contains additional information about the message body.

Syntax

__property String MsgComments = { read=FMsgComments, write=FSetMsgComments };

Default Value

""

Remarks

Contains additional information about the message body.

This property is not available at design time.

Data Type

String

MsgDate Property (MailReader Component)

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

Syntax

__property String MsgDate = { read=FMsgDate, write=FSetMsgDate };

Default Value

""

Remarks

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

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

The date is returned and accepted in UTC time zone.

This property is not available at design time.

Data Type

String

MsgDeliveryReceipt Property (MailReader Component)

Enables delivery notification.

Syntax

__property bool MsgDeliveryReceipt = { read=FMsgDeliveryReceipt, write=FSetMsgDeliveryReceipt };

Default Value

false

Remarks

Enables delivery notification.

This property is not available at design time.

Data Type

Boolean

MsgFrom Property (MailReader Component)

Contains the value of the From header property.

Syntax

__property String MsgFrom = { read=FMsgFrom, write=FSetMsgFrom };

Default Value

""

Remarks

Contains the value of the From header field.

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

This property is not available at design time.

Data Type

String

MsgHandle Property (MailReader Component)

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

Syntax

__property __int64 MsgHandle = { read=FMsgHandle, write=FSetMsgHandle };

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

MsgHtmlText Property (MailReader Component)

The HTML version of the message.

Syntax

__property String MsgHtmlText = { read=FMsgHtmlText, write=FSetMsgHtmlText };

Default Value

""

Remarks

The HTML version of the message.

This property is not available at design time.

Data Type

String

MsgID Property (MailReader Component)

The contents of the Message-ID header property.

Syntax

__property String MsgID = { read=FMsgID, write=FSetMsgID };

Default Value

""

Remarks

The contents of the Message-ID header field.

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

This property is not available at design time.

Data Type

String

MsgInReplyTo Property (MailReader Component)

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

Syntax

__property String MsgInReplyTo = { read=FMsgInReplyTo, write=FSetMsgInReplyTo };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

MsgKeywords Property (MailReader Component)

The value of the Keywords header property.

Syntax

__property String MsgKeywords = { read=FMsgKeywords, write=FSetMsgKeywords };

Default Value

""

Remarks

The value of the Keywords header field.

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

This property is not available at design time.

Data Type

String

MsgMailer Property (MailReader Component)

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

Syntax

__property String MsgMailer = { read=FMsgMailer };

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

The plain text version of the message.

Syntax

__property String MsgPlainText = { read=FMsgPlainText, write=FSetMsgPlainText };

Default Value

""

Remarks

The plain text version of the message.

This property is not available at design time.

Data Type

String

MsgPriority Property (MailReader Component)

Specifies the message priority.

Syntax

__property TsbxMailReaderMsgPriorities MsgPriority = { read=FMsgPriority, write=FSetMsgPriority };

enum TsbxMailReaderMsgPriorities {
  mpLowest=0,
  mpLow=1,
  mpNormal=2,
  mpHigh=3,
  mpHighest=4
};

Default Value

mpNormal

Remarks

Specifies the message priority.

Available options:

This property is not available at design time.

Data Type

Integer

MsgReadReceipt Property (MailReader Component)

Enables a read notification.

Syntax

__property bool MsgReadReceipt = { read=FMsgReadReceipt, write=FSetMsgReadReceipt };

Default Value

false

Remarks

Enables a read notification.

This property is not available at design time.

Data Type

Boolean

MsgReferences Property (MailReader Component)

The value of the References header property.

Syntax

__property String MsgReferences = { read=FMsgReferences, write=FSetMsgReferences };

Default Value

""

Remarks

The value of the References header field.

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

This property is not available at design time.

Data Type

String

MsgReplyTo Property (MailReader Component)

The value of the Reply-To header property.

Syntax

__property String MsgReplyTo = { read=FMsgReplyTo, write=FSetMsgReplyTo };

Default Value

""

Remarks

The value of the Reply-To header field.

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

This property is not available at design time.

Data Type

String

MsgReturnPath Property (MailReader Component)

The value of the Return-Path header property.

Syntax

__property String MsgReturnPath = { read=FMsgReturnPath, write=FSetMsgReturnPath };

Default Value

""

Remarks

The value of the Return-Path header field.

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

This property is not available at design time.

Data Type

String

MsgSender Property (MailReader Component)

The value of the Sender header property.

Syntax

__property String MsgSender = { read=FMsgSender, write=FSetMsgSender };

Default Value

""

Remarks

The value of the Sender header field.

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

This property is not available at design time.

Data Type

String

MsgSendTo Property (MailReader Component)

The value of the To header property.

Syntax

__property String MsgSendTo = { read=FMsgSendTo, write=FSetMsgSendTo };

Default Value

""

Remarks

The value of the To header field.

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

This property is not available at design time.

Data Type

String

MsgSubject Property (MailReader Component)

Contains the subject property of this message.

Syntax

__property String MsgSubject = { read=FMsgSubject, write=FSetMsgSubject };

Default Value

""

Remarks

Contains the subject field of this message.

This property is not available at design time.

Data Type

String

OfflineMode Property (MailReader Component)

Switches the component to offline mode.

Syntax

__property bool OfflineMode = { read=FOfflineMode, write=FSetOfflineMode };

Default Value

false

Remarks

When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

HeaderFieldCount Property (MailReader Component)

The number of records in the HeaderField arrays.

Syntax

__property int HeaderFieldCount = { read=FHeaderFieldCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• HeaderFieldCategory
• HeaderFieldFormat
• HeaderFieldName
• HeaderFieldValue

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

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

Data Type

Integer

HeaderFieldCategory Property (MailReader Component)

Specifies the string category of the contained value.

Syntax

__property String HeaderFieldCategory[int HeaderFieldIndex] = { read=FHeaderFieldCategory };

Default Value

""

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The HeaderFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

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

Data Type

String

HeaderFieldFormat Property (MailReader Component)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

__property int HeaderFieldFormat[int HeaderFieldIndex] = { read=FHeaderFieldFormat };

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the HeaderFieldValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:

The HeaderFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

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

Data Type

Integer

HeaderFieldName Property (MailReader Component)

The name element in a (name, value) pair.

Syntax

__property String HeaderFieldName[int HeaderFieldIndex] = { read=FHeaderFieldName };

Default Value

""

Remarks

The name element in a (name, value) pair.

The HeaderFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

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

Data Type

String

HeaderFieldValue Property (MailReader Component)

The value element in a (name, value) pair.

Syntax

__property String HeaderFieldValue[int HeaderFieldIndex] = { read=FHeaderFieldValue };

Default Value

""

Remarks

The value element in a (name, value) pair.

The HeaderFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderFieldCount property.

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

Data Type

String

Profile Property (MailReader Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

__property String Profile = { read=FProfile, write=FSetProfile };

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Data Type

String

ProxyAddress Property (MailReader Component)

The IP address of the proxy server.

Syntax

__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (MailReader Component)

The authentication type used by the proxy server.

Syntax

__property TsbxMailReaderProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };

enum TsbxMailReaderProxyAuthentications {
  patNoAuthentication=0,
  patBasic=1,
  patDigest=2,
  patNTLM=3
};

Default Value

patNoAuthentication

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (MailReader Component)

The password to authenticate to the proxy server.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (MailReader Component)

The port on the proxy server to connect to.

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (MailReader Component)

The type of the proxy server.

Syntax

__property TsbxMailReaderProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };

enum TsbxMailReaderProxyProxyTypes {
  cptNone=0,
  cptSocks4=1,
  cptSocks5=2,
  cptWebTunnel=3,
  cptHTTP=4
};

Default Value

cptNone

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.

Data Type

Integer

ProxyRequestHeaders Property (MailReader Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (MailReader Component)

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

Syntax

__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };

Default Value

""

Remarks

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

Data Type

String

ProxyResponseHeaders Property (MailReader Component)

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

Syntax

__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };

Default Value

""

Remarks

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

Data Type

String

ProxyUseIPv6 Property (MailReader Component)

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

Syntax

__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (MailReader Component)

Specifies the username credential for proxy authentication.

Syntax

__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ReplyToAddrCount Property (MailReader Component)

The number of records in the ReplyToAddr arrays.

Syntax

__property int ReplyToAddrCount = { read=FReplyToAddrCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReplyToAddrAddress
• ReplyToAddrDisplayName
• ReplyToAddrGroupName

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

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

Data Type

Integer

ReplyToAddrAddress Property (MailReader Component)

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

Syntax

__property String ReplyToAddrAddress[int ReplyToAddrIndex] = { read=FReplyToAddrAddress };

Default Value

""

Remarks

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

The ReplyToAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReplyToAddrCount property.

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

Data Type

String

ReplyToAddrDisplayName Property (MailReader Component)

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

Syntax

__property String ReplyToAddrDisplayName[int ReplyToAddrIndex] = { read=FReplyToAddrDisplayName };

Default Value

""

Remarks

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

The ReplyToAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReplyToAddrCount property.

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

Data Type

String

ReplyToAddrGroupName Property (MailReader Component)

The name of the group this address belongs to.

Syntax

__property String ReplyToAddrGroupName[int ReplyToAddrIndex] = { read=FReplyToAddrGroupName };

Default Value

""

Remarks

The name of the group this address belongs to.

The ReplyToAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReplyToAddrCount property.

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

Data Type

String

RevocationCheck Property (MailReader Component)

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

Syntax

__property TsbxMailReaderRevocationChecks RevocationCheck = { read=FRevocationCheck, write=FSetRevocationCheck };

enum TsbxMailReaderRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

Remarks

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

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

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

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

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to 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.

Data Type

Integer

SecInfoChainValidationDetails Property (MailReader Component)

The details of a certificate chain validation outcome.

Syntax

__property int SecInfoChainValidationDetails = { read=FSecInfoChainValidationDetails };

Default Value

0

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:

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

Data Type

Integer

SecInfoChainValidationResult Property (MailReader Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxMailReaderSecInfoChainValidationResults SecInfoChainValidationResult = { read=FSecInfoChainValidationResult };

enum TsbxMailReaderSecInfoChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

SecInfoClaimedSigningTime Property (MailReader Component)

Returns the signature's claimed signing time.

Syntax

__property String SecInfoClaimedSigningTime = { read=FSecInfoClaimedSigningTime };

Default Value

""

Remarks

Returns the signature's claimed signing time.

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by a trusted timestamp and may be forfeited or wrong. The time is provided in UTC.

This property is read-only.

Data Type

String

SecInfoEncrypted Property (MailReader Component)

Indicates whether the message is encrypted.

Syntax

__property bool SecInfoEncrypted = { read=FSecInfoEncrypted };

Default Value

false

Remarks

Indicates whether the message is encrypted.

This property is read-only.

Data Type

Boolean

SecInfoEncryptionAlgorithm Property (MailReader Component)

Indicates the algorithm that was used to encrypt the message.

Syntax

__property String SecInfoEncryptionAlgorithm = { read=FSecInfoEncryptionAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used to encrypt the message.

This property is read-only.

Data Type

String

SecInfoHashAlgorithm Property (MailReader Component)

Specifies the hash algorithm that was used to calculate the signature.

Syntax

__property String SecInfoHashAlgorithm = { read=FSecInfoHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm that was used to calculate the signature.

This property is read-only.

Data Type

String

SecInfoSignatureValidationResult Property (MailReader Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxMailReaderSecInfoSignatureValidationResults SecInfoSignatureValidationResult = { read=FSecInfoSignatureValidationResult };

enum TsbxMailReaderSecInfoSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

Data Type

Integer

SecInfoSigned Property (MailReader Component)

Indicates whether the message is signed.

Syntax

__property bool SecInfoSigned = { read=FSecInfoSigned };

Default Value

false

Remarks

Indicates whether the message is signed.

This property is read-only.

Data Type

Boolean

SecInfoValidationLog Property (MailReader Component)

Contains the signing certificate's chain validation log.

Syntax

__property String SecInfoValidationLog = { read=FSecInfoValidationLog };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SenderAddrAddress Property (MailReader Component)

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

Syntax

__property String SenderAddrAddress = { read=FSenderAddrAddress };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SenderAddrDisplayName Property (MailReader Component)

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

Syntax

__property String SenderAddrDisplayName = { read=FSenderAddrDisplayName };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SenderAddrGroupName Property (MailReader Component)

The name of the group this address belongs to.

Syntax

__property String SenderAddrGroupName = { read=FSenderAddrGroupName };

Default Value

""

Remarks

The name of the group this address belongs to.

This property is read-only.

Data Type

String

SendToAddrCount Property (MailReader Component)

The number of records in the SendToAddr arrays.

Syntax

__property int SendToAddrCount = { read=FSendToAddrCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SendToAddrAddress
• SendToAddrDisplayName
• SendToAddrGroupName

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

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

Data Type

Integer

SendToAddrAddress Property (MailReader Component)

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

Syntax

__property String SendToAddrAddress[int SendToAddrIndex] = { read=FSendToAddrAddress };

Default Value

""

Remarks

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

The SendToAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendToAddrCount property.

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

Data Type

String

SendToAddrDisplayName Property (MailReader Component)

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

Syntax

__property String SendToAddrDisplayName[int SendToAddrIndex] = { read=FSendToAddrDisplayName };

Default Value

""

Remarks

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

The SendToAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendToAddrCount property.

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

Data Type

String

SendToAddrGroupName Property (MailReader Component)

The name of the group this address belongs to.

Syntax

__property String SendToAddrGroupName[int SendToAddrIndex] = { read=FSendToAddrGroupName };

Default Value

""

Remarks

The name of the group this address belongs to.

The SendToAddrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SendToAddrCount property.

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

Data Type

String

SigningCertBytes Property (MailReader Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertCA Property (MailReader Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool SigningCertCA = { read=FSigningCertCA };

Default Value

false

Remarks

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

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

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

Data Type

Boolean

SigningCertCAKeyID Property (MailReader Component)

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

Syntax

__property DynamicArray SigningCertCAKeyID = { read=FSigningCertCAKeyID };

Remarks

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

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

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

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

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (MailReader Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

__property String SigningCertCRLDistributionPoints = { read=FSigningCertCRLDistributionPoints };

Default Value

""

Remarks

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

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

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

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

Data Type

String

SigningCertCurve Property (MailReader Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

__property String SigningCertCurve = { read=FSigningCertCurve };

Default Value

""

Remarks

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

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

Data Type

String

SigningCertFingerprint Property (MailReader Component)

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

Syntax

__property String SigningCertFingerprint = { read=FSigningCertFingerprint };

Default Value

""

Remarks

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

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

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

Data Type

String

SigningCertFriendlyName Property (MailReader Component)

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

Syntax

__property String SigningCertFriendlyName = { read=FSigningCertFriendlyName };

Default Value

""

Remarks

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

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

Data Type

String

SigningCertHandle Property (MailReader Component)

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

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle };

Default Value

0

Remarks

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

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

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

Data Type

Long64

SigningCertHashAlgorithm Property (MailReader Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

__property String SigningCertHashAlgorithm = { read=FSigningCertHashAlgorithm };

Default Value

""

Remarks

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

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

Data Type

String

SigningCertIssuer Property (MailReader Component)

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

Syntax

__property String SigningCertIssuer = { read=FSigningCertIssuer };

Default Value

""

Remarks

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

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

Data Type

String

SigningCertIssuerRDN Property (MailReader Component)

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

Syntax

__property String SigningCertIssuerRDN = { read=FSigningCertIssuerRDN };

Default Value

""

Remarks

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

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

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

Data Type

String

SigningCertKeyAlgorithm Property (MailReader Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String SigningCertKeyAlgorithm = { read=FSigningCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the SigningCertKeyBits, SigningCertCurve, and SigningCertPublicKeyBytes properties to get more details about the key the certificate contains.

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

Data Type

String

SigningCertKeyBits Property (MailReader Component)

Returns the length of the public key in bits.

Syntax

__property int SigningCertKeyBits = { read=FSigningCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

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

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

Data Type

Integer

SigningCertKeyFingerprint Property (MailReader Component)

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

Syntax

__property String SigningCertKeyFingerprint = { read=FSigningCertKeyFingerprint };

Default Value

""

Remarks

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

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

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

Data Type

String

SigningCertKeyUsage Property (MailReader Component)

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

Syntax

__property int SigningCertKeyUsage = { read=FSigningCertKeyUsage };

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:

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

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

Data Type

Integer

SigningCertKeyValid Property (MailReader Component)

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

Syntax

__property bool SigningCertKeyValid = { read=FSigningCertKeyValid };

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

SigningCertOCSPLocations Property (MailReader Component)

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

Syntax

__property String SigningCertOCSPLocations = { read=FSigningCertOCSPLocations };

Default Value

""

Remarks

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

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

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

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

Data Type

String

SigningCertPolicyIDs Property (MailReader Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String SigningCertPolicyIDs = { read=FSigningCertPolicyIDs };

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.

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

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

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

Data Type

String

SigningCertPublicKeyBytes Property (MailReader Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray SigningCertPublicKeyBytes = { read=FSigningCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

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

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

Data Type

Byte Array

SigningCertSelfSigned Property (MailReader Component)

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

Syntax

__property bool SigningCertSelfSigned = { read=FSigningCertSelfSigned };

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

SigningCertSerialNumber Property (MailReader Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray SigningCertSerialNumber = { read=FSigningCertSerialNumber };

Remarks

Returns the certificate's serial number.

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

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

Data Type

Byte Array

SigningCertSigAlgorithm Property (MailReader Component)

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

Syntax

__property String SigningCertSigAlgorithm = { read=FSigningCertSigAlgorithm };

Default Value

""

Remarks

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

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

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

Data Type

String

SigningCertSubject Property (MailReader Component)

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

Syntax

__property String SigningCertSubject = { read=FSigningCertSubject };

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 is part of a larger set of credentials available via SigningCertSubjectRDN.

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

Data Type

String

SigningCertSubjectKeyID Property (MailReader Component)

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

Syntax

__property DynamicArray SigningCertSubjectKeyID = { read=FSigningCertSubjectKeyID };

Remarks

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

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

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

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

Data Type

Byte Array

SigningCertSubjectRDN Property (MailReader Component)

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

Syntax

__property String SigningCertSubjectRDN = { read=FSigningCertSubjectRDN };

Default Value

""

Remarks

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

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

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

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

Data Type

String

SigningCertValidFrom Property (MailReader Component)

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

Syntax

__property String SigningCertValidFrom = { read=FSigningCertValidFrom };

Default Value

""

Remarks

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

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

Data Type

String

SigningCertValidTo Property (MailReader Component)

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

Syntax

__property String SigningCertValidTo = { read=FSigningCertValidTo };

Default Value

""

Remarks

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

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

Data Type

String

SocketDNSMode Property (MailReader Component)

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

Syntax

__property TsbxMailReaderSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };

enum TsbxMailReaderSocketDNSModes {
  dmAuto=0,
  dmPlatform=1,
  dmOwn=2,
  dmOwnSecure=3
};

Default Value

dmAuto

Remarks

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

Data Type

Integer

SocketDNSPort Property (MailReader Component)

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

Syntax

__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (MailReader Component)

The timeout (in milliseconds) for each DNS query.

Syntax

__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSServers Property (MailReader Component)

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

Syntax

__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };

Default Value

""

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (MailReader Component)

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

Syntax

__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };

Default Value

0

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (MailReader Component)

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

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (MailReader Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (MailReader Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (MailReader Component)

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

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (MailReader Component)

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

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

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

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (MailReader Component)

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

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (MailReader Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxMailReaderTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxMailReaderTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

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.

Data Type

Integer

TLSCiphersuites Property (MailReader Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

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

TLSClientAuth Property (MailReader Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxMailReaderTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxMailReaderTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

Integer

TLSECCurves Property (MailReader Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (MailReader Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (MailReader Component)

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

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (MailReader Component)

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

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

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

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

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

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

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

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (MailReader Component)

Selects the renegotiation attack prevention mechanism.

Syntax

__property TsbxMailReaderTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxMailReaderTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmAuto

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (MailReader Component)

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

Syntax

__property TsbxMailReaderTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxMailReaderTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

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.

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

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

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to 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.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (MailReader Component)

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

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (MailReader Component)

Specifies the TLS mode to use.

Syntax

__property TsbxMailReaderTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxMailReaderTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (MailReader Component)

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

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (MailReader Component)

Enables or disables the TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (MailReader Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (MailReader Component)

The number of records in the TrustedCert arrays.

Syntax

__property int TrustedCertCount = { read=FTrustedCertCount, write=FSetTrustedCertCount };

Default Value

0

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

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TrustedCertBytes[int TrustedCertIndex] = { read=FTrustedCertBytes };

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

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

Syntax

__property __int64 TrustedCertHandle[int TrustedCertIndex] = { read=FTrustedCertHandle, write=FSetTrustedCertHandle };

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

UsedCertCount Property (MailReader Component)

The number of records in the UsedCert arrays.

Syntax

__property int UsedCertCount = { read=FUsedCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• UsedCertBytes
• UsedCertCA
• UsedCertCAKeyID
• UsedCertCertType
• UsedCertCRLDistributionPoints
• UsedCertCurve
• UsedCertFingerprint
• UsedCertFriendlyName
• UsedCertHandle
• UsedCertHashAlgorithm
• UsedCertIssuer
• UsedCertIssuerRDN
• UsedCertKeyAlgorithm
• UsedCertKeyBits
• UsedCertKeyFingerprint
• UsedCertKeyUsage
• UsedCertKeyValid
• UsedCertOCSPLocations
• UsedCertOCSPNoCheck
• UsedCertOrigin
• UsedCertPolicyIDs
• UsedCertPrivateKeyBytes
• UsedCertPrivateKeyExists
• UsedCertPrivateKeyExtractable
• UsedCertPublicKeyBytes
• UsedCertQualified
• UsedCertQualifiedStatements
• UsedCertQualifiers
• UsedCertSelfSigned
• UsedCertSerialNumber
• UsedCertSigAlgorithm
• UsedCertSource
• UsedCertSubject
• UsedCertSubjectAlternativeName
• UsedCertSubjectKeyID
• UsedCertSubjectRDN
• UsedCertValid
• UsedCertValidFrom
• UsedCertValidTo

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

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

Data Type

Integer

UsedCertBytes Property (MailReader Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray UsedCertBytes[int UsedCertIndex] = { read=FUsedCertBytes };

Remarks

Returns the raw certificate data in DER format.

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Byte Array

UsedCertCA Property (MailReader Component)

Indicates whether the certificate has a CA capability.

Syntax

__property bool UsedCertCA[int UsedCertIndex] = { read=FUsedCertCA };

Default Value

false

Remarks

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertCAKeyID Property (MailReader Component)

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

Syntax

__property DynamicArray UsedCertCAKeyID[int UsedCertIndex] = { read=FUsedCertCAKeyID };

Remarks

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

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Byte Array

UsedCertCertType Property (MailReader Component)

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

Syntax

__property TsbxMailReaderUsedCertCertTypes UsedCertCertType[int UsedCertIndex] = { read=FUsedCertCertType };

enum TsbxMailReaderUsedCertCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

Remarks

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

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Integer

UsedCertCRLDistributionPoints Property (MailReader Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

__property String UsedCertCRLDistributionPoints[int UsedCertIndex] = { read=FUsedCertCRLDistributionPoints };

Default Value

""

Remarks

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

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertCurve Property (MailReader Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

__property String UsedCertCurve[int UsedCertIndex] = { read=FUsedCertCurve };

Default Value

""

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertFingerprint Property (MailReader Component)

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

Syntax

__property String UsedCertFingerprint[int UsedCertIndex] = { read=FUsedCertFingerprint };

Default Value

""

Remarks

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertFriendlyName Property (MailReader Component)

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

Syntax

__property String UsedCertFriendlyName[int UsedCertIndex] = { read=FUsedCertFriendlyName };

Default Value

""

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertHandle Property (MailReader Component)

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

Syntax

__property __int64 UsedCertHandle[int UsedCertIndex] = { read=FUsedCertHandle };

Default Value

0

Remarks

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Long64

UsedCertHashAlgorithm Property (MailReader Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

__property String UsedCertHashAlgorithm[int UsedCertIndex] = { read=FUsedCertHashAlgorithm };

Default Value

""

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertIssuer Property (MailReader Component)

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

Syntax

__property String UsedCertIssuer[int UsedCertIndex] = { read=FUsedCertIssuer };

Default Value

""

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertIssuerRDN Property (MailReader Component)

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

Syntax

__property String UsedCertIssuerRDN[int UsedCertIndex] = { read=FUsedCertIssuerRDN };

Default Value

""

Remarks

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertKeyAlgorithm Property (MailReader Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String UsedCertKeyAlgorithm[int UsedCertIndex] = { read=FUsedCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the UsedCertKeyBits, UsedCertCurve, and UsedCertPublicKeyBytes properties to get more details about the key the certificate contains.

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertKeyBits Property (MailReader Component)

Returns the length of the public key in bits.

Syntax

__property int UsedCertKeyBits[int UsedCertIndex] = { read=FUsedCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Integer

UsedCertKeyFingerprint Property (MailReader Component)

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

Syntax

__property String UsedCertKeyFingerprint[int UsedCertIndex] = { read=FUsedCertKeyFingerprint };

Default Value

""

Remarks

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertKeyUsage Property (MailReader Component)

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

Syntax

__property int UsedCertKeyUsage[int UsedCertIndex] = { read=FUsedCertKeyUsage };

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:

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Integer

UsedCertKeyValid Property (MailReader Component)

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

Syntax

__property bool UsedCertKeyValid[int UsedCertIndex] = { read=FUsedCertKeyValid };

Default Value

false

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertOCSPLocations Property (MailReader Component)

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

Syntax

__property String UsedCertOCSPLocations[int UsedCertIndex] = { read=FUsedCertOCSPLocations };

Default Value

""

Remarks

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

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertOCSPNoCheck Property (MailReader Component)

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

Syntax

__property bool UsedCertOCSPNoCheck[int UsedCertIndex] = { read=FUsedCertOCSPNoCheck };

Default Value

false

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertOrigin Property (MailReader Component)

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

Syntax

__property int UsedCertOrigin[int UsedCertIndex] = { read=FUsedCertOrigin };

Default Value

0

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Integer

UsedCertPolicyIDs Property (MailReader Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String UsedCertPolicyIDs[int UsedCertIndex] = { read=FUsedCertPolicyIDs };

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.

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertPrivateKeyBytes Property (MailReader Component)

Returns the certificate's private key in DER-encoded format.

Syntax

__property DynamicArray UsedCertPrivateKeyBytes[int UsedCertIndex] = { read=FUsedCertPrivateKeyBytes };

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Byte Array

UsedCertPrivateKeyExists Property (MailReader Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

__property bool UsedCertPrivateKeyExists[int UsedCertIndex] = { read=FUsedCertPrivateKeyExists };

Default Value

false

Remarks

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertPrivateKeyExtractable Property (MailReader Component)

Indicates whether the private key is extractable (exportable).

Syntax

__property bool UsedCertPrivateKeyExtractable[int UsedCertIndex] = { read=FUsedCertPrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertPublicKeyBytes Property (MailReader Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray UsedCertPublicKeyBytes[int UsedCertIndex] = { read=FUsedCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Byte Array

UsedCertQualified Property (MailReader Component)

Indicates whether the certificate is qualified.

Syntax

__property bool UsedCertQualified[int UsedCertIndex] = { read=FUsedCertQualified };

Default Value

false

Remarks

Indicates whether the certificate is qualified.

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertQualifiedStatements Property (MailReader Component)

Returns a simplified qualified status of the certificate.

Syntax

__property TsbxMailReaderUsedCertQualifiedStatements UsedCertQualifiedStatements[int UsedCertIndex] = { read=FUsedCertQualifiedStatements };

enum TsbxMailReaderUsedCertQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

Remarks

Returns a simplified qualified status of the certificate.

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Integer

UsedCertQualifiers Property (MailReader Component)

A list of qualifiers.

Syntax

__property String UsedCertQualifiers[int UsedCertIndex] = { read=FUsedCertQualifiers };

Default Value

""

Remarks

A list of qualifiers.

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertSelfSigned Property (MailReader Component)

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

Syntax

__property bool UsedCertSelfSigned[int UsedCertIndex] = { read=FUsedCertSelfSigned };

Default Value

false

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertSerialNumber Property (MailReader Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray UsedCertSerialNumber[int UsedCertIndex] = { read=FUsedCertSerialNumber };

Remarks

Returns the certificate's serial number.

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Byte Array

UsedCertSigAlgorithm Property (MailReader Component)

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

Syntax

__property String UsedCertSigAlgorithm[int UsedCertIndex] = { read=FUsedCertSigAlgorithm };

Default Value

""

Remarks

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertSource Property (MailReader Component)

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

Syntax

__property TsbxMailReaderUsedCertSources UsedCertSource[int UsedCertIndex] = { read=FUsedCertSource };

enum TsbxMailReaderUsedCertSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Integer

UsedCertSubject Property (MailReader Component)

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

Syntax

__property String UsedCertSubject[int UsedCertIndex] = { read=FUsedCertSubject };

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 is part of a larger set of credentials available via UsedCertSubjectRDN.

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertSubjectAlternativeName Property (MailReader Component)

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

Syntax

__property String UsedCertSubjectAlternativeName[int UsedCertIndex] = { read=FUsedCertSubjectAlternativeName };

Default Value

""

Remarks

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

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertSubjectKeyID Property (MailReader Component)

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

Syntax

__property DynamicArray UsedCertSubjectKeyID[int UsedCertIndex] = { read=FUsedCertSubjectKeyID };

Remarks

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

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Byte Array

UsedCertSubjectRDN Property (MailReader Component)

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

Syntax

__property String UsedCertSubjectRDN[int UsedCertIndex] = { read=FUsedCertSubjectRDN };

Default Value

""

Remarks

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

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

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertValid Property (MailReader Component)

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

Syntax

__property bool UsedCertValid[int UsedCertIndex] = { read=FUsedCertValid };

Default Value

false

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

Boolean

UsedCertValidFrom Property (MailReader Component)

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

Syntax

__property String UsedCertValidFrom[int UsedCertIndex] = { read=FUsedCertValidFrom };

Default Value

""

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

UsedCertValidTo Property (MailReader Component)

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

Syntax

__property String UsedCertValidTo[int UsedCertIndex] = { read=FUsedCertValidTo };

Default Value

""

Remarks

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

The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.

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

Data Type

String

ValidationMoment Property (MailReader Component)

The time point at which signature validity is to be established.

Syntax

__property String ValidationMoment = { read=FValidationMoment, write=FSetValidationMoment };

Default Value

""

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

Data Type

String

Config Method (MailReader Component)

This method sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

DoAction Method (MailReader Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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;....

FindAttachment Method (MailReader Component)

Looks up a Message's attachment by its ID.

Syntax

int __fastcall FindAttachment(String ID);

Remarks

Use this method to find the attachment by its ID.

LoadFromBytes Method (MailReader Component)

Loads an e-mail message from a byte array.

Syntax

void __fastcall LoadFromBytes(DynamicArray<Byte> MessageBytes);

Remarks

Use this method to load a message from a byte array and process it. Once the message has been loaded, use Message to access its properties.

LoadFromFile Method (MailReader Component)

Loads an e-mail message from a file.

Syntax

void __fastcall LoadFromFile(String FileName);

Remarks

Use this method to load a message from a file and process it. Once the message has been loaded, use Message to access its properties.

Reset Method (MailReader Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

ChainValidated Event (MailReader Component)

Reports the completion of a certificate chain validation.

Syntax

typedef struct {
  String SubjectRDN;
  int ValidationResult;
  int ValidationDetails;
} TsbxMailReaderChainValidatedEventParams;
typedef void __fastcall (__closure *TsbxMailReaderChainValidatedEvent)(System::TObject* Sender, TsbxMailReaderChainValidatedEventParams *e);
__property TsbxMailReaderChainValidatedEvent OnChainValidated = { read=FOnChainValidated, write=FOnChainValidated };

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

Any other value reports a failure, and ValidationDetails provides more details on its reasons.

DecryptionInfoNeeded Event (MailReader Component)

Asks the application to provide a decryption certificate.

Syntax

typedef struct {
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
} TsbxMailReaderDecryptionInfoNeededEventParams;
typedef void __fastcall (__closure *TsbxMailReaderDecryptionInfoNeededEvent)(System::TObject* Sender, TsbxMailReaderDecryptionInfoNeededEventParams *e);
__property TsbxMailReaderDecryptionInfoNeededEvent OnDecryptionInfoNeeded = { read=FOnDecryptionInfoNeeded, write=FOnDecryptionInfoNeeded };

Remarks

This event is fired when the component needs a decryption certificate. Use the provided values to look up the certificate, and assign it to DecryptionCertificate property.

Note that the decryption certificate must have an associated private key.

Error Event (MailReader Component)

Reports information about errors during e-mail message loading, parsing or saving.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxMailReaderErrorEventParams;
typedef void __fastcall (__closure *TsbxMailReaderErrorEvent)(System::TObject* Sender, TsbxMailReaderErrorEventParams *e);
__property TsbxMailReaderErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The event is fired in case of exceptional conditions during message processing.

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

ExternalDecrypt Event (MailReader Component)

Handles remote or external decryption.

Syntax

typedef struct {
  String OperationId;
  String Algorithm;
  String Pars;
  String EncryptedData;
  String Data;
} TsbxMailReaderExternalDecryptEventParams;
typedef void __fastcall (__closure *TsbxMailReaderExternalDecryptEvent)(System::TObject* Sender, TsbxMailReaderExternalDecryptEventParams *e);
__property TsbxMailReaderExternalDecryptEvent OnExternalDecrypt = { read=FOnExternalDecrypt, write=FOnExternalDecrypt };

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

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

The component uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

Notification Event (MailReader Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxMailReaderNotificationEventParams;
typedef void __fastcall (__closure *TsbxMailReaderNotificationEvent)(System::TObject* Sender, TsbxMailReaderNotificationEventParams *e);
__property TsbxMailReaderNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

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

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

SignatureFound Event (MailReader Component)

Signifies the start of signature validation.

Syntax

typedef struct {
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  bool CertFound;
  bool ValidateSignature;
  bool ValidateChain;
} TsbxMailReaderSignatureFoundEventParams;
typedef void __fastcall (__closure *TsbxMailReaderSignatureFoundEvent)(System::TObject* Sender, TsbxMailReaderSignatureFoundEventParams *e);
__property TsbxMailReaderSignatureFoundEvent OnSignatureFound = { read=FOnSignatureFound, write=FOnSignatureFound };

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (MailReader Component)

Marks the completion of the signature validation routine.

Syntax

typedef struct {
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  int ValidationResult;
} TsbxMailReaderSignatureValidatedEventParams;
typedef void __fastcall (__closure *TsbxMailReaderSignatureValidatedEvent)(System::TObject* Sender, TsbxMailReaderSignatureValidatedEventParams *e);
__property TsbxMailReaderSignatureValidatedEvent OnSignatureValidated = { read=FOnSignatureValidated, write=FOnSignatureValidated };

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

Config Settings (MailReader Component)

The component 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 component, access to these internal properties is provided through the Config method.

MailReader Config Settings

Base Config Settings

Trappable Errors (MailReader Component)

MailReader Errors