MailReader Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

SecureBlackbox_MailReader

Procedural Interface

 secureblackbox_mailreader_open();
 secureblackbox_mailreader_close($res);
 secureblackbox_mailreader_register_callback($res, $id, $function);
 secureblackbox_mailreader_get_last_error($res);
 secureblackbox_mailreader_get_last_error_code($res);
 secureblackbox_mailreader_set($res, $id, $index, $value);
 secureblackbox_mailreader_get($res, $id, $index);
 secureblackbox_mailreader_do_config($res, $configurationstring);
 secureblackbox_mailreader_do_doaction($res, $actionid, $actionparams);
 secureblackbox_mailreader_do_findattachment($res, $id);
 secureblackbox_mailreader_do_loadfrombytes($res, $messagebytes);
 secureblackbox_mailreader_do_loadfromfile($res, $filename);
 secureblackbox_mailreader_do_reset($res);

Remarks

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

Loading a e-mail message and accessing its properties: MailReader reader = new MailReader(); reader.LoadFromFile("path\\message.eml"); Console.WriteLine($"From: {reader.Message.From}"); Console.WriteLine($"To : {reader.Message.SendTo}"); Console.WriteLine($"Subject: {reader.Message.Subject}"); Console.WriteLine($"Attachments: {reader.Message.AttachmentCount}"); Console.WriteLine("Plain text:"); Console.WriteLine(reader.Message.PlainText);

Checking a signed message and validating its signature: MailReader reader = new MailReader(); reader.LoadFromFile("path\\message.eml"); if (reader.SecurityInfo.Signed) { if (reader.SecurityInfo.SignatureValidationResult == SignatureValidities.svtValid) Console.WriteLine($"Signed by {reader.SigningCertificate.Subject} and the signature is valid"); else Console.WriteLine("Signature is NOT valid"); }

Processing an encrypted e-mail message: MailReader reader = new MailReader(); reader.OnDecryptionInfoNeeded += (s, e) => { // here you should provide a certificate for decryption; // use the provided IssuerRDN and SerialNumber/SubjectKeyID // values to find an appropriate certificate, then // assign the certificate to DecryptionCertificate property; // the certificate should include its private key }; reader.LoadFromFile("path\\message.eml");

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AttachCount Property (SecureBlackbox_MailReader Class)

The number of records in the Attach arrays.

Object Oriented Interface

public function getAttachCount();

Procedural Interface

secureblackbox_mailreader_get($res, 1 );

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

Contains the content subtype of the attachment.

Object Oriented Interface

public function getAttachContentSubtype($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 2 , $attachindex);

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

Contains the content type of the attachment.

Object Oriented Interface

public function getAttachContentType($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 3 , $attachindex);

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

The creation date.

Object Oriented Interface

public function getAttachCreationDate($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 4 , $attachindex);

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

The content of the attachment.

Object Oriented Interface

public function getAttachData($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 5 , $attachindex);

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

Textual description of the attachment.

Object Oriented Interface

public function getAttachDescription($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 6 , $attachindex);

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

Specifies the name of the attachment file.

Object Oriented Interface

public function getAttachFileName($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 7 , $attachindex);

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

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

Object Oriented Interface

public function getAttachHandle($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 8 , $attachindex);

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

Contains the attachment's unique identifier.

Object Oriented Interface

public function getAttachID($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 9 , $attachindex);

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

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

Object Oriented Interface

public function getAttachModificationDate($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 10 , $attachindex);

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

Specifies the file's last read date.

Object Oriented Interface

public function getAttachReadDate($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 11 , $attachindex);

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

The attachment's size in bytes.

Object Oriented Interface

public function getAttachSize($attachindex);

Procedural Interface

secureblackbox_mailreader_get($res, 12 , $attachindex);

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

The number of records in the BccAddr arrays.

Object Oriented Interface

public function getBccAddrCount();

Procedural Interface

secureblackbox_mailreader_get($res, 13 );

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

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

Object Oriented Interface

public function getBccAddrAddress($bccaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 14 , $bccaddrindex);

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

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

Object Oriented Interface

public function getBccAddrDisplayName($bccaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 15 , $bccaddrindex);

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

The name of the group this address belongs to.

Object Oriented Interface

public function getBccAddrGroupName($bccaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 16 , $bccaddrindex);

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

The number of records in the BlockedCert arrays.

Object Oriented Interface

public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface

secureblackbox_mailreader_get($res, 17 );


secureblackbox_mailreader_set($res, 17, $value );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getBlockedCertBytes($blockedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 18 , $blockedcertindex);

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

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

Object Oriented Interface

public function getBlockedCertHandle($blockedcertindex);


public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface

secureblackbox_mailreader_get($res, 26 , $blockedcertindex);


secureblackbox_mailreader_set($res, 26, $value , $blockedcertindex);

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

The number of records in the CcAddr arrays.

Object Oriented Interface

public function getCcAddrCount();

Procedural Interface

secureblackbox_mailreader_get($res, 57 );

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

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

Object Oriented Interface

public function getCcAddrAddress($ccaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 58 , $ccaddrindex);

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

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

Object Oriented Interface

public function getCcAddrDisplayName($ccaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 59 , $ccaddrindex);

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

The name of the group this address belongs to.

Object Oriented Interface

public function getCcAddrGroupName($ccaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 60 , $ccaddrindex);

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getDecryptionCertBytes();

Procedural Interface

secureblackbox_mailreader_get($res, 61 );

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

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getDecryptionCertCA();


public function setDecryptionCertCA($value);

Procedural Interface

secureblackbox_mailreader_get($res, 62 );


secureblackbox_mailreader_set($res, 62, $value );

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

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

Object Oriented Interface

public function getDecryptionCertCAKeyID();

Procedural Interface

secureblackbox_mailreader_get($res, 63 );

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

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

Object Oriented Interface

public function getDecryptionCertCertType();

Procedural Interface

secureblackbox_mailreader_get($res, 64 );

Default Value

0

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 class 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 (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getDecryptionCertCRLDistributionPoints();


public function setDecryptionCertCRLDistributionPoints($value);

Procedural Interface

secureblackbox_mailreader_get($res, 65 );


secureblackbox_mailreader_set($res, 65, $value );

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

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

Object Oriented Interface

public function getDecryptionCertCurve();


public function setDecryptionCertCurve($value);

Procedural Interface

secureblackbox_mailreader_get($res, 66 );


secureblackbox_mailreader_set($res, 66, $value );

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

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

Object Oriented Interface

public function getDecryptionCertFingerprint();

Procedural Interface

secureblackbox_mailreader_get($res, 67 );

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

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

Object Oriented Interface

public function getDecryptionCertFriendlyName();

Procedural Interface

secureblackbox_mailreader_get($res, 68 );

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

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

Object Oriented Interface

public function getDecryptionCertHandle();


public function setDecryptionCertHandle($value);

Procedural Interface

secureblackbox_mailreader_get($res, 69 );


secureblackbox_mailreader_set($res, 69, $value );

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

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

Object Oriented Interface

public function getDecryptionCertHashAlgorithm();


public function setDecryptionCertHashAlgorithm($value);

Procedural Interface

secureblackbox_mailreader_get($res, 70 );


secureblackbox_mailreader_set($res, 70, $value );

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

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

Object Oriented Interface

public function getDecryptionCertIssuer();

Procedural Interface

secureblackbox_mailreader_get($res, 71 );

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

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

Object Oriented Interface

public function getDecryptionCertIssuerRDN();


public function setDecryptionCertIssuerRDN($value);

Procedural Interface

secureblackbox_mailreader_get($res, 72 );


secureblackbox_mailreader_set($res, 72, $value );

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getDecryptionCertKeyAlgorithm();


public function setDecryptionCertKeyAlgorithm($value);

Procedural Interface

secureblackbox_mailreader_get($res, 73 );


secureblackbox_mailreader_set($res, 73, $value );

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

Returns the length of the public key in bits.

Object Oriented Interface

public function getDecryptionCertKeyBits();

Procedural Interface

secureblackbox_mailreader_get($res, 74 );

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

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

Object Oriented Interface

public function getDecryptionCertKeyFingerprint();

Procedural Interface

secureblackbox_mailreader_get($res, 75 );

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

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

Object Oriented Interface

public function getDecryptionCertKeyUsage();


public function setDecryptionCertKeyUsage($value);

Procedural Interface

secureblackbox_mailreader_get($res, 76 );


secureblackbox_mailreader_set($res, 76, $value );

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

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

Object Oriented Interface

public function getDecryptionCertKeyValid();

Procedural Interface

secureblackbox_mailreader_get($res, 77 );

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

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

Object Oriented Interface

public function getDecryptionCertOCSPLocations();


public function setDecryptionCertOCSPLocations($value);

Procedural Interface

secureblackbox_mailreader_get($res, 78 );


secureblackbox_mailreader_set($res, 78, $value );

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

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

Object Oriented Interface

public function getDecryptionCertOCSPNoCheck();


public function setDecryptionCertOCSPNoCheck($value);

Procedural Interface

secureblackbox_mailreader_get($res, 79 );


secureblackbox_mailreader_set($res, 79, $value );

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

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

Object Oriented Interface

public function getDecryptionCertOrigin();

Procedural Interface

secureblackbox_mailreader_get($res, 80 );

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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getDecryptionCertPolicyIDs();


public function setDecryptionCertPolicyIDs($value);

Procedural Interface

secureblackbox_mailreader_get($res, 81 );


secureblackbox_mailreader_set($res, 81, $value );

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

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

Object Oriented Interface

public function getDecryptionCertPrivateKeyBytes();

Procedural Interface

secureblackbox_mailreader_get($res, 82 );

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

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

Object Oriented Interface

public function getDecryptionCertPrivateKeyExists();

Procedural Interface

secureblackbox_mailreader_get($res, 83 );

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

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getDecryptionCertPrivateKeyExtractable();

Procedural Interface

secureblackbox_mailreader_get($res, 84 );

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

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getDecryptionCertPublicKeyBytes();

Procedural Interface

secureblackbox_mailreader_get($res, 85 );

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

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getDecryptionCertQualified();

Procedural Interface

secureblackbox_mailreader_get($res, 86 );

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

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getDecryptionCertQualifiedStatements();


public function setDecryptionCertQualifiedStatements($value);

Procedural Interface

secureblackbox_mailreader_get($res, 87 );


secureblackbox_mailreader_set($res, 87, $value );

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

DecryptionCertQualifiers Property (SecureBlackbox_MailReader Class)

A list of qualifiers.

Object Oriented Interface

public function getDecryptionCertQualifiers();

Procedural Interface

secureblackbox_mailreader_get($res, 88 );

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

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

Object Oriented Interface

public function getDecryptionCertSelfSigned();

Procedural Interface

secureblackbox_mailreader_get($res, 89 );

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

Returns the certificate's serial number.

Object Oriented Interface

public function getDecryptionCertSerialNumber();


public function setDecryptionCertSerialNumber($value);

Procedural Interface

secureblackbox_mailreader_get($res, 90 );


secureblackbox_mailreader_set($res, 90, $value );

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

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

Object Oriented Interface

public function getDecryptionCertSigAlgorithm();

Procedural Interface

secureblackbox_mailreader_get($res, 91 );

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

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

Object Oriented Interface

public function getDecryptionCertSource();

Procedural Interface

secureblackbox_mailreader_get($res, 92 );

Default Value

0

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

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

Object Oriented Interface

public function getDecryptionCertSubject();

Procedural Interface

secureblackbox_mailreader_get($res, 93 );

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

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

Object Oriented Interface

public function getDecryptionCertSubjectAlternativeName();


public function setDecryptionCertSubjectAlternativeName($value);

Procedural Interface

secureblackbox_mailreader_get($res, 94 );


secureblackbox_mailreader_set($res, 94, $value );

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

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

Object Oriented Interface

public function getDecryptionCertSubjectKeyID();


public function setDecryptionCertSubjectKeyID($value);

Procedural Interface

secureblackbox_mailreader_get($res, 95 );


secureblackbox_mailreader_set($res, 95, $value );

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

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

Object Oriented Interface

public function getDecryptionCertSubjectRDN();


public function setDecryptionCertSubjectRDN($value);

Procedural Interface

secureblackbox_mailreader_get($res, 96 );


secureblackbox_mailreader_set($res, 96, $value );

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

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.

Object Oriented Interface

public function getDecryptionCertValid();

Procedural Interface

secureblackbox_mailreader_get($res, 97 );

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

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

Object Oriented Interface

public function getDecryptionCertValidFrom();


public function setDecryptionCertValidFrom($value);

Procedural Interface

secureblackbox_mailreader_get($res, 98 );


secureblackbox_mailreader_set($res, 98, $value );

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

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

Object Oriented Interface

public function getDecryptionCertValidTo();


public function setDecryptionCertValidTo($value);

Procedural Interface

secureblackbox_mailreader_get($res, 99 );


secureblackbox_mailreader_set($res, 99, $value );

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

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

Object Oriented Interface

public function getExternalCryptoAsyncDocumentID();


public function setExternalCryptoAsyncDocumentID($value);

Procedural Interface

secureblackbox_mailreader_get($res, 100 );


secureblackbox_mailreader_set($res, 100, $value );

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

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

Object Oriented Interface

public function getExternalCryptoCustomParams();


public function setExternalCryptoCustomParams($value);

Procedural Interface

secureblackbox_mailreader_get($res, 101 );


secureblackbox_mailreader_set($res, 101, $value );

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

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

Object Oriented Interface

public function getExternalCryptoData();


public function setExternalCryptoData($value);

Procedural Interface

secureblackbox_mailreader_get($res, 102 );


secureblackbox_mailreader_set($res, 102, $value );

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

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

Object Oriented Interface

public function getExternalCryptoExternalHashCalculation();


public function setExternalCryptoExternalHashCalculation($value);

Procedural Interface

secureblackbox_mailreader_get($res, 103 );


secureblackbox_mailreader_set($res, 103, $value );

Default Value

false

Remarks

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

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

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SecureBlackbox_MailReader Class)

Specifies the request's signature hash algorithm.

Object Oriented Interface

public function getExternalCryptoHashAlgorithm();


public function setExternalCryptoHashAlgorithm($value);

Procedural Interface

secureblackbox_mailreader_get($res, 104 );


secureblackbox_mailreader_set($res, 104, $value );

Default Value

'SHA256'

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getExternalCryptoKeyID();


public function setExternalCryptoKeyID($value);

Procedural Interface

secureblackbox_mailreader_get($res, 105 );


secureblackbox_mailreader_set($res, 105, $value );

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

The pre-shared key used for DC request authentication.

Object Oriented Interface

public function getExternalCryptoKeySecret();


public function setExternalCryptoKeySecret($value);

Procedural Interface

secureblackbox_mailreader_get($res, 106 );


secureblackbox_mailreader_set($res, 106, $value );

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

Specifies the asynchronous signing method.

Object Oriented Interface

public function getExternalCryptoMethod();


public function setExternalCryptoMethod($value);

Procedural Interface

secureblackbox_mailreader_get($res, 107 );


secureblackbox_mailreader_set($res, 107, $value );

Default Value

0

Remarks

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

Available options:

Data Type

Integer

ExternalCryptoMode Property (SecureBlackbox_MailReader Class)

Specifies the external cryptography mode.

Object Oriented Interface

public function getExternalCryptoMode();


public function setExternalCryptoMode($value);

Procedural Interface

secureblackbox_mailreader_get($res, 108 );


secureblackbox_mailreader_set($res, 108, $value );

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getExternalCryptoPublicKeyAlgorithm();


public function setExternalCryptoPublicKeyAlgorithm($value);

Procedural Interface

secureblackbox_mailreader_get($res, 109 );


secureblackbox_mailreader_set($res, 109, $value );

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

Reserved.

Object Oriented Interface

public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface

secureblackbox_mailreader_get($res, 110 );


secureblackbox_mailreader_set($res, 110, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

FromAddrCount Property (SecureBlackbox_MailReader Class)

The number of records in the FromAddr arrays.

Object Oriented Interface

public function getFromAddrCount();

Procedural Interface

secureblackbox_mailreader_get($res, 111 );

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

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

Object Oriented Interface

public function getFromAddrAddress($fromaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 112 , $fromaddrindex);

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

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

Object Oriented Interface

public function getFromAddrDisplayName($fromaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 113 , $fromaddrindex);

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

The name of the group this address belongs to.

Object Oriented Interface

public function getFromAddrGroupName($fromaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 114 , $fromaddrindex);

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

Makes the class tolerant to chain validation errors.

Object Oriented Interface

public function getIgnoreChainValidationErrors();


public function setIgnoreChainValidationErrors($value);

Procedural Interface

secureblackbox_mailreader_get($res, 115 );


secureblackbox_mailreader_set($res, 115, $value );

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

The number of records in the KnownCert arrays.

Object Oriented Interface

public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface

secureblackbox_mailreader_get($res, 116 );


secureblackbox_mailreader_set($res, 116, $value );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getKnownCertBytes($knowncertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 117 , $knowncertindex);

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

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

Object Oriented Interface

public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface

secureblackbox_mailreader_get($res, 125 , $knowncertindex);


secureblackbox_mailreader_set($res, 125, $value , $knowncertindex);

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

The number of records in the KnownCRL arrays.

Object Oriented Interface

public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface

secureblackbox_mailreader_get($res, 156 );


secureblackbox_mailreader_set($res, 156, $value );

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

Returns the raw CRL data in DER format.

Object Oriented Interface

public function getKnownCRLBytes($knowncrlindex);

Procedural Interface

secureblackbox_mailreader_get($res, 157 , $knowncrlindex);

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

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

Object Oriented Interface

public function getKnownCRLHandle($knowncrlindex);


public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface

secureblackbox_mailreader_get($res, 160 , $knowncrlindex);


secureblackbox_mailreader_set($res, 160, $value , $knowncrlindex);

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

The number of records in the KnownOCSP arrays.

Object Oriented Interface

public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface

secureblackbox_mailreader_get($res, 169 );


secureblackbox_mailreader_set($res, 169, $value );

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

A buffer containing the raw OCSP response data.

Object Oriented Interface

public function getKnownOCSPBytes($knownocspindex);

Procedural Interface

secureblackbox_mailreader_get($res, 170 , $knownocspindex);

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

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

Object Oriented Interface

public function getKnownOCSPHandle($knownocspindex);


public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface

secureblackbox_mailreader_get($res, 172 , $knownocspindex);


secureblackbox_mailreader_set($res, 172, $value , $knownocspindex);

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

Returns the number of attachments in this message.

Object Oriented Interface

public function getMsgAttachmentCount();

Procedural Interface

secureblackbox_mailreader_get($res, 179 );

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

The contents of the BCC header property.

Object Oriented Interface

public function getMsgBcc();


public function setMsgBcc($value);

Procedural Interface

secureblackbox_mailreader_get($res, 180 );


secureblackbox_mailreader_set($res, 180, $value );

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

The value of the CC header property.

Object Oriented Interface

public function getMsgCc();


public function setMsgCc($value);

Procedural Interface

secureblackbox_mailreader_get($res, 181 );


secureblackbox_mailreader_set($res, 181, $value );

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

Contains additional information about the message body.

Object Oriented Interface

public function getMsgComments();


public function setMsgComments($value);

Procedural Interface

secureblackbox_mailreader_get($res, 182 );


secureblackbox_mailreader_set($res, 182, $value );

Default Value

''

Remarks

Contains additional information about the message body.

This property is not available at design time.

Data Type

String

MsgDate Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getMsgDate();


public function setMsgDate($value);

Procedural Interface

secureblackbox_mailreader_get($res, 183 );


secureblackbox_mailreader_set($res, 183, $value );

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

Enables delivery notification.

Object Oriented Interface

public function getMsgDeliveryReceipt();


public function setMsgDeliveryReceipt($value);

Procedural Interface

secureblackbox_mailreader_get($res, 184 );


secureblackbox_mailreader_set($res, 184, $value );

Default Value

false

Remarks

Enables delivery notification.

This property is not available at design time.

Data Type

Boolean

MsgFrom Property (SecureBlackbox_MailReader Class)

Contains the value of the From header property.

Object Oriented Interface

public function getMsgFrom();


public function setMsgFrom($value);

Procedural Interface

secureblackbox_mailreader_get($res, 185 );


secureblackbox_mailreader_set($res, 185, $value );

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

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

Object Oriented Interface

public function getMsgHandle();


public function setMsgHandle($value);

Procedural Interface

secureblackbox_mailreader_get($res, 186 );


secureblackbox_mailreader_set($res, 186, $value );

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

The HTML version of the message.

Object Oriented Interface

public function getMsgHtmlText();


public function setMsgHtmlText($value);

Procedural Interface

secureblackbox_mailreader_get($res, 187 );


secureblackbox_mailreader_set($res, 187, $value );

Default Value

''

Remarks

The HTML version of the message.

This property is not available at design time.

Data Type

String

MsgID Property (SecureBlackbox_MailReader Class)

The contents of the Message-ID header property.

Object Oriented Interface

public function getMsgID();


public function setMsgID($value);

Procedural Interface

secureblackbox_mailreader_get($res, 188 );


secureblackbox_mailreader_set($res, 188, $value );

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

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

Object Oriented Interface

public function getMsgInReplyTo();


public function setMsgInReplyTo($value);

Procedural Interface

secureblackbox_mailreader_get($res, 189 );


secureblackbox_mailreader_set($res, 189, $value );

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

The value of the Keywords header property.

Object Oriented Interface

public function getMsgKeywords();


public function setMsgKeywords($value);

Procedural Interface

secureblackbox_mailreader_get($res, 190 );


secureblackbox_mailreader_set($res, 190, $value );

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

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

Object Oriented Interface

public function getMsgMailer();

Procedural Interface

secureblackbox_mailreader_get($res, 191 );

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

The plain text version of the message.

Object Oriented Interface

public function getMsgPlainText();


public function setMsgPlainText($value);

Procedural Interface

secureblackbox_mailreader_get($res, 192 );


secureblackbox_mailreader_set($res, 192, $value );

Default Value

''

Remarks

The plain text version of the message.

This property is not available at design time.

Data Type

String

MsgPriority Property (SecureBlackbox_MailReader Class)

Specifies the message priority.

Object Oriented Interface

public function getMsgPriority();


public function setMsgPriority($value);

Procedural Interface

secureblackbox_mailreader_get($res, 193 );


secureblackbox_mailreader_set($res, 193, $value );

Default Value

2

Remarks

Specifies the message priority.

Available options:

This property is not available at design time.

Data Type

Integer

MsgReadReceipt Property (SecureBlackbox_MailReader Class)

Enables a read notification.

Object Oriented Interface

public function getMsgReadReceipt();


public function setMsgReadReceipt($value);

Procedural Interface

secureblackbox_mailreader_get($res, 194 );


secureblackbox_mailreader_set($res, 194, $value );

Default Value

false

Remarks

Enables a read notification.

This property is not available at design time.

Data Type

Boolean

MsgReferences Property (SecureBlackbox_MailReader Class)

The value of the References header property.

Object Oriented Interface

public function getMsgReferences();


public function setMsgReferences($value);

Procedural Interface

secureblackbox_mailreader_get($res, 195 );


secureblackbox_mailreader_set($res, 195, $value );

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

The value of the Reply-To header property.

Object Oriented Interface

public function getMsgReplyTo();


public function setMsgReplyTo($value);

Procedural Interface

secureblackbox_mailreader_get($res, 196 );


secureblackbox_mailreader_set($res, 196, $value );

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

The value of the Return-Path header property.

Object Oriented Interface

public function getMsgReturnPath();


public function setMsgReturnPath($value);

Procedural Interface

secureblackbox_mailreader_get($res, 197 );


secureblackbox_mailreader_set($res, 197, $value );

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

The value of the Sender header property.

Object Oriented Interface

public function getMsgSender();


public function setMsgSender($value);

Procedural Interface

secureblackbox_mailreader_get($res, 198 );


secureblackbox_mailreader_set($res, 198, $value );

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

The value of the To header property.

Object Oriented Interface

public function getMsgSendTo();


public function setMsgSendTo($value);

Procedural Interface

secureblackbox_mailreader_get($res, 199 );


secureblackbox_mailreader_set($res, 199, $value );

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

Contains the subject property of this message.

Object Oriented Interface

public function getMsgSubject();


public function setMsgSubject($value);

Procedural Interface

secureblackbox_mailreader_get($res, 200 );


secureblackbox_mailreader_set($res, 200, $value );

Default Value

''

Remarks

Contains the subject field of this message.

This property is not available at design time.

Data Type

String

OfflineMode Property (SecureBlackbox_MailReader Class)

Switches the class to offline mode.

Object Oriented Interface

public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface

secureblackbox_mailreader_get($res, 201 );


secureblackbox_mailreader_set($res, 201, $value );

Default Value

false

Remarks

When working in offline mode, the class 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 (SecureBlackbox_MailReader Class)

The number of records in the HeaderField arrays.

Object Oriented Interface

public function getHeaderFieldCount();

Procedural Interface

secureblackbox_mailreader_get($res, 202 );

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

Specifies the string category of the contained value.

Object Oriented Interface

public function getHeaderFieldCategory($headerfieldindex);

Procedural Interface

secureblackbox_mailreader_get($res, 203 , $headerfieldindex);

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

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

Object Oriented Interface

public function getHeaderFieldFormat($headerfieldindex);

Procedural Interface

secureblackbox_mailreader_get($res, 204 , $headerfieldindex);

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

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

Object Oriented Interface

public function getHeaderFieldName($headerfieldindex);

Procedural Interface

secureblackbox_mailreader_get($res, 205 , $headerfieldindex);

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

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

Object Oriented Interface

public function getHeaderFieldValue($headerfieldindex);

Procedural Interface

secureblackbox_mailreader_get($res, 206 , $headerfieldindex);

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

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

Object Oriented Interface

public function getProfile();


public function setProfile($value);

Procedural Interface

secureblackbox_mailreader_get($res, 207 );


secureblackbox_mailreader_set($res, 207, $value );

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

The IP address of the proxy server.

Object Oriented Interface

public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface

secureblackbox_mailreader_get($res, 208 );


secureblackbox_mailreader_set($res, 208, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_MailReader Class)

The authentication type used by the proxy server.

Object Oriented Interface

public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface

secureblackbox_mailreader_get($res, 209 );


secureblackbox_mailreader_set($res, 209, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SecureBlackbox_MailReader Class)

The password to authenticate to the proxy server.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

secureblackbox_mailreader_get($res, 210 );


secureblackbox_mailreader_set($res, 210, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_MailReader Class)

The port on the proxy server to connect to.

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

secureblackbox_mailreader_get($res, 211 );


secureblackbox_mailreader_set($res, 211, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_MailReader Class)

The type of the proxy server.

Object Oriented Interface

public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface

secureblackbox_mailreader_get($res, 212 );


secureblackbox_mailreader_set($res, 212, $value );

Default Value

0

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_MailReader Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface

public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface

secureblackbox_mailreader_get($res, 213 );


secureblackbox_mailreader_set($res, 213, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface

secureblackbox_mailreader_get($res, 214 );


secureblackbox_mailreader_set($res, 214, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface

secureblackbox_mailreader_get($res, 215 );


secureblackbox_mailreader_set($res, 215, $value );

Default Value

''

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface

secureblackbox_mailreader_get($res, 216 );


secureblackbox_mailreader_set($res, 216, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_MailReader Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface

public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface

secureblackbox_mailreader_get($res, 217 );


secureblackbox_mailreader_set($res, 217, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ReplyToAddrCount Property (SecureBlackbox_MailReader Class)

The number of records in the ReplyToAddr arrays.

Object Oriented Interface

public function getReplyToAddrCount();

Procedural Interface

secureblackbox_mailreader_get($res, 218 );

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

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

Object Oriented Interface

public function getReplyToAddrAddress($replytoaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 219 , $replytoaddrindex);

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

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

Object Oriented Interface

public function getReplyToAddrDisplayName($replytoaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 220 , $replytoaddrindex);

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

The name of the group this address belongs to.

Object Oriented Interface

public function getReplyToAddrGroupName($replytoaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 221 , $replytoaddrindex);

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

Specifies the kind(s) of revocation check to perform for all chain certificates.

Object Oriented Interface

public function getRevocationCheck();


public function setRevocationCheck($value);

Procedural Interface

secureblackbox_mailreader_get($res, 222 );


secureblackbox_mailreader_set($res, 222, $value );

Default Value

1

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

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

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

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

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

Data Type

Integer

SecInfoChainValidationDetails Property (SecureBlackbox_MailReader Class)

The details of a certificate chain validation outcome.

Object Oriented Interface

public function getSecInfoChainValidationDetails();

Procedural Interface

secureblackbox_mailreader_get($res, 223 );

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

The outcome of a certificate chain validation routine.

Object Oriented Interface

public function getSecInfoChainValidationResult();

Procedural Interface

secureblackbox_mailreader_get($res, 224 );

Default Value

0

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

Returns the signature's claimed signing time.

Object Oriented Interface

public function getSecInfoClaimedSigningTime();

Procedural Interface

secureblackbox_mailreader_get($res, 225 );

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

Indicates whether the message is encrypted.

Object Oriented Interface

public function getSecInfoEncrypted();

Procedural Interface

secureblackbox_mailreader_get($res, 226 );

Default Value

false

Remarks

Indicates whether the message is encrypted.

This property is read-only.

Data Type

Boolean

SecInfoEncryptionAlgorithm Property (SecureBlackbox_MailReader Class)

Indicates the algorithm that was used to encrypt the message.

Object Oriented Interface

public function getSecInfoEncryptionAlgorithm();

Procedural Interface

secureblackbox_mailreader_get($res, 227 );

Default Value

''

Remarks

Indicates the algorithm that was used to encrypt the message.

This property is read-only.

Data Type

String

SecInfoHashAlgorithm Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getSecInfoHashAlgorithm();

Procedural Interface

secureblackbox_mailreader_get($res, 228 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SecInfoSignatureValidationResult Property (SecureBlackbox_MailReader Class)

The outcome of the cryptographic signature validation.

Object Oriented Interface

public function getSecInfoSignatureValidationResult();

Procedural Interface

secureblackbox_mailreader_get($res, 229 );

Default Value

0

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

Indicates whether the message is signed.

Object Oriented Interface

public function getSecInfoSigned();

Procedural Interface

secureblackbox_mailreader_get($res, 230 );

Default Value

false

Remarks

Indicates whether the message is signed.

This property is read-only.

Data Type

Boolean

SecInfoValidationLog Property (SecureBlackbox_MailReader Class)

Contains the signing certificate's chain validation log.

Object Oriented Interface

public function getSecInfoValidationLog();

Procedural Interface

secureblackbox_mailreader_get($res, 231 );

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

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

Object Oriented Interface

public function getSenderAddrAddress();

Procedural Interface

secureblackbox_mailreader_get($res, 232 );

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

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

Object Oriented Interface

public function getSenderAddrDisplayName();

Procedural Interface

secureblackbox_mailreader_get($res, 233 );

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

The name of the group this address belongs to.

Object Oriented Interface

public function getSenderAddrGroupName();

Procedural Interface

secureblackbox_mailreader_get($res, 234 );

Default Value

''

Remarks

The name of the group this address belongs to.

This property is read-only.

Data Type

String

SendToAddrCount Property (SecureBlackbox_MailReader Class)

The number of records in the SendToAddr arrays.

Object Oriented Interface

public function getSendToAddrCount();

Procedural Interface

secureblackbox_mailreader_get($res, 235 );

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

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

Object Oriented Interface

public function getSendToAddrAddress($sendtoaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 236 , $sendtoaddrindex);

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

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

Object Oriented Interface

public function getSendToAddrDisplayName($sendtoaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 237 , $sendtoaddrindex);

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

The name of the group this address belongs to.

Object Oriented Interface

public function getSendToAddrGroupName($sendtoaddrindex);

Procedural Interface

secureblackbox_mailreader_get($res, 238 , $sendtoaddrindex);

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_mailreader_get($res, 239 );

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

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getSigningCertCA();

Procedural Interface

secureblackbox_mailreader_get($res, 240 );

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

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

Object Oriented Interface

public function getSigningCertCAKeyID();

Procedural Interface

secureblackbox_mailreader_get($res, 241 );

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

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

Object Oriented Interface

public function getSigningCertCRLDistributionPoints();

Procedural Interface

secureblackbox_mailreader_get($res, 243 );

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

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

Object Oriented Interface

public function getSigningCertCurve();

Procedural Interface

secureblackbox_mailreader_get($res, 244 );

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

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

Object Oriented Interface

public function getSigningCertFingerprint();

Procedural Interface

secureblackbox_mailreader_get($res, 245 );

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

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

Object Oriented Interface

public function getSigningCertFriendlyName();

Procedural Interface

secureblackbox_mailreader_get($res, 246 );

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

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

Object Oriented Interface

public function getSigningCertHandle();

Procedural Interface

secureblackbox_mailreader_get($res, 247 );

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

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

Object Oriented Interface

public function getSigningCertHashAlgorithm();

Procedural Interface

secureblackbox_mailreader_get($res, 248 );

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

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

Object Oriented Interface

public function getSigningCertIssuer();

Procedural Interface

secureblackbox_mailreader_get($res, 249 );

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

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

Object Oriented Interface

public function getSigningCertIssuerRDN();

Procedural Interface

secureblackbox_mailreader_get($res, 250 );

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getSigningCertKeyAlgorithm();

Procedural Interface

secureblackbox_mailreader_get($res, 251 );

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

Returns the length of the public key in bits.

Object Oriented Interface

public function getSigningCertKeyBits();

Procedural Interface

secureblackbox_mailreader_get($res, 252 );

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

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

Object Oriented Interface

public function getSigningCertKeyFingerprint();

Procedural Interface

secureblackbox_mailreader_get($res, 253 );

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

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

Object Oriented Interface

public function getSigningCertKeyUsage();

Procedural Interface

secureblackbox_mailreader_get($res, 254 );

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

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

Object Oriented Interface

public function getSigningCertKeyValid();

Procedural Interface

secureblackbox_mailreader_get($res, 255 );

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

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

Object Oriented Interface

public function getSigningCertOCSPLocations();

Procedural Interface

secureblackbox_mailreader_get($res, 256 );

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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getSigningCertPolicyIDs();

Procedural Interface

secureblackbox_mailreader_get($res, 259 );

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

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getSigningCertPublicKeyBytes();

Procedural Interface

secureblackbox_mailreader_get($res, 263 );

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

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

Object Oriented Interface

public function getSigningCertSelfSigned();

Procedural Interface

secureblackbox_mailreader_get($res, 267 );

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

Returns the certificate's serial number.

Object Oriented Interface

public function getSigningCertSerialNumber();

Procedural Interface

secureblackbox_mailreader_get($res, 268 );

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

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

Object Oriented Interface

public function getSigningCertSigAlgorithm();

Procedural Interface

secureblackbox_mailreader_get($res, 269 );

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

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

Object Oriented Interface

public function getSigningCertSubject();

Procedural Interface

secureblackbox_mailreader_get($res, 271 );

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

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

Object Oriented Interface

public function getSigningCertSubjectKeyID();

Procedural Interface

secureblackbox_mailreader_get($res, 273 );

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

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

Object Oriented Interface

public function getSigningCertSubjectRDN();

Procedural Interface

secureblackbox_mailreader_get($res, 274 );

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

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

Object Oriented Interface

public function getSigningCertValidFrom();

Procedural Interface

secureblackbox_mailreader_get($res, 276 );

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

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

Object Oriented Interface

public function getSigningCertValidTo();

Procedural Interface

secureblackbox_mailreader_get($res, 277 );

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

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

Object Oriented Interface

public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface

secureblackbox_mailreader_get($res, 278 );


secureblackbox_mailreader_set($res, 278, $value );

Default Value

0

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

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

Object Oriented Interface

public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface

secureblackbox_mailreader_get($res, 279 );


secureblackbox_mailreader_set($res, 279, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_MailReader Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface

public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface

secureblackbox_mailreader_get($res, 280 );


secureblackbox_mailreader_set($res, 280, $value );

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

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

Object Oriented Interface

public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface

secureblackbox_mailreader_get($res, 281 );


secureblackbox_mailreader_set($res, 281, $value );

Default Value

''

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface

secureblackbox_mailreader_get($res, 282 );


secureblackbox_mailreader_set($res, 282, $value );

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

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

Object Oriented Interface

public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface

secureblackbox_mailreader_get($res, 283 );


secureblackbox_mailreader_set($res, 283, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_MailReader Class)

The local network interface to bind the socket to.

Object Oriented Interface

public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface

secureblackbox_mailreader_get($res, 284 );


secureblackbox_mailreader_set($res, 284, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_MailReader Class)

The local port number to bind the socket to.

Object Oriented Interface

public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface

secureblackbox_mailreader_get($res, 285 );


secureblackbox_mailreader_set($res, 285, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface

secureblackbox_mailreader_get($res, 286 );


secureblackbox_mailreader_set($res, 286, $value );

Default Value

0

Remarks

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

Data Type

Integer

SocketTimeout Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface

secureblackbox_mailreader_get($res, 287 );


secureblackbox_mailreader_set($res, 287, $value );

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

Enables or disables IP protocol version 6.

Object Oriented Interface

public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface

secureblackbox_mailreader_get($res, 288 );


secureblackbox_mailreader_set($res, 288, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSAutoValidateCertificates Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface

secureblackbox_mailreader_get($res, 289 );


secureblackbox_mailreader_set($res, 289, $value );

Default Value

true

Remarks

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

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_MailReader Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface

public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface

secureblackbox_mailreader_get($res, 290 );


secureblackbox_mailreader_set($res, 290, $value );

Default Value

0

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

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface

public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface

secureblackbox_mailreader_get($res, 291 );


secureblackbox_mailreader_set($res, 291, $value );

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

Enables or disables certificate-based client authentication.

Object Oriented Interface

public function getTLSClientAuth();


public function setTLSClientAuth($value);

Procedural Interface

secureblackbox_mailreader_get($res, 292 );


secureblackbox_mailreader_set($res, 292, $value );

Default Value

0

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

Defines the elliptic curves to enable.

Object Oriented Interface

public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface

secureblackbox_mailreader_get($res, 293 );


secureblackbox_mailreader_set($res, 293, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_MailReader Class)

Provides access to TLS extensions.

Object Oriented Interface

public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface

secureblackbox_mailreader_get($res, 294 );


secureblackbox_mailreader_set($res, 294, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface

secureblackbox_mailreader_get($res, 295 );


secureblackbox_mailreader_set($res, 295, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface

secureblackbox_mailreader_get($res, 296 );


secureblackbox_mailreader_set($res, 296, $value );

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

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

Object Oriented Interface

public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface

secureblackbox_mailreader_get($res, 297 );


secureblackbox_mailreader_set($res, 297, $value );

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

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

Object Oriented Interface

public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface

secureblackbox_mailreader_get($res, 298 );


secureblackbox_mailreader_set($res, 298, $value );

Default Value

''

Remarks

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

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_MailReader Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface

public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface

secureblackbox_mailreader_get($res, 299 );


secureblackbox_mailreader_set($res, 299, $value );

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface

secureblackbox_mailreader_get($res, 300 );


secureblackbox_mailreader_set($res, 300, $value );

Default Value

1

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

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

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

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

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

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface

secureblackbox_mailreader_get($res, 301 );


secureblackbox_mailreader_set($res, 301, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_MailReader Class)

Specifies the TLS mode to use.

Object Oriented Interface

public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface

secureblackbox_mailreader_get($res, 302 );


secureblackbox_mailreader_set($res, 302, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface

secureblackbox_mailreader_get($res, 303 );


secureblackbox_mailreader_set($res, 303, $value );

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_MailReader Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface

public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface

secureblackbox_mailreader_get($res, 304 );


secureblackbox_mailreader_set($res, 304, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_MailReader Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface

public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface

secureblackbox_mailreader_get($res, 305 );


secureblackbox_mailreader_set($res, 305, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_MailReader Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface

secureblackbox_mailreader_get($res, 306 );


secureblackbox_mailreader_set($res, 306, $value );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getTrustedCertBytes($trustedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 307 , $trustedcertindex);

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

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

Object Oriented Interface

public function getTrustedCertHandle($trustedcertindex);


public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface

secureblackbox_mailreader_get($res, 315 , $trustedcertindex);


secureblackbox_mailreader_set($res, 315, $value , $trustedcertindex);

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

The number of records in the UsedCert arrays.

Object Oriented Interface

public function getUsedCertCount();

Procedural Interface

secureblackbox_mailreader_get($res, 346 );

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

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getUsedCertBytes($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 347 , $usedcertindex);

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

Indicates whether the certificate has a CA capability.

Object Oriented Interface

public function getUsedCertCA($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 348 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertCAKeyID($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 349 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertCertType($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 350 , $usedcertindex);

Default Value

0

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 class 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 (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function getUsedCertCRLDistributionPoints($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 351 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertCurve($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 352 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertFingerprint($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 353 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertFriendlyName($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 354 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertHandle($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 355 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertHashAlgorithm($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 356 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertIssuer($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 357 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertIssuerRDN($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 358 , $usedcertindex);

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

Specifies the public key algorithm of this certificate.

Object Oriented Interface

public function getUsedCertKeyAlgorithm($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 359 , $usedcertindex);

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

Returns the length of the public key in bits.

Object Oriented Interface

public function getUsedCertKeyBits($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 360 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertKeyFingerprint($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 361 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertKeyUsage($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 362 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertKeyValid($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 363 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertOCSPLocations($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 364 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertOCSPNoCheck($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 365 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertOrigin($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 366 , $usedcertindex);

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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface

public function getUsedCertPolicyIDs($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 367 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertPrivateKeyBytes($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 368 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertPrivateKeyExists($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 369 , $usedcertindex);

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

Indicates whether the private key is extractable (exportable).

Object Oriented Interface

public function getUsedCertPrivateKeyExtractable($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 370 , $usedcertindex);

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

Contains the certificate's public key in DER format.

Object Oriented Interface

public function getUsedCertPublicKeyBytes($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 371 , $usedcertindex);

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

Indicates whether the certificate is qualified.

Object Oriented Interface

public function getUsedCertQualified($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 372 , $usedcertindex);

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

Returns a simplified qualified status of the certificate.

Object Oriented Interface

public function getUsedCertQualifiedStatements($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 373 , $usedcertindex);

Default Value

0

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

A list of qualifiers.

Object Oriented Interface

public function getUsedCertQualifiers($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 374 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertSelfSigned($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 375 , $usedcertindex);

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

Returns the certificate's serial number.

Object Oriented Interface

public function getUsedCertSerialNumber($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 376 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertSigAlgorithm($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 377 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertSource($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 378 , $usedcertindex);

Default Value

0

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

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

Object Oriented Interface

public function getUsedCertSubject($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 379 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertSubjectAlternativeName($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 380 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertSubjectKeyID($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 381 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertSubjectRDN($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 382 , $usedcertindex);

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

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.

Object Oriented Interface

public function getUsedCertValid($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 383 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertValidFrom($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 384 , $usedcertindex);

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

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

Object Oriented Interface

public function getUsedCertValidTo($usedcertindex);

Procedural Interface

secureblackbox_mailreader_get($res, 385 , $usedcertindex);

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

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

Object Oriented Interface

public function getValidationMoment();


public function setValidationMoment($value);

Procedural Interface

secureblackbox_mailreader_get($res, 386 );


secureblackbox_mailreader_set($res, 386, $value );

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_mailreader_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (SecureBlackbox_MailReader Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_mailreader_do_doaction($res, $actionid, $actionparams);

Remarks

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

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

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

FindAttachment Method (SecureBlackbox_MailReader Class)

Looks up a Message's attachment by its ID.

Object Oriented Interface

public function doFindAttachment($id);

Procedural Interface

secureblackbox_mailreader_do_findattachment($res, $id);

Remarks

Use this method to find the attachment by its ID.

LoadFromBytes Method (SecureBlackbox_MailReader Class)

Loads an e-mail message from a byte array.

Object Oriented Interface

public function doLoadFromBytes($messagebytes);

Procedural Interface

secureblackbox_mailreader_do_loadfrombytes($res, $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 (SecureBlackbox_MailReader Class)

Loads an e-mail message from a file.

Object Oriented Interface

public function doLoadFromFile($filename);

Procedural Interface

secureblackbox_mailreader_do_loadfromfile($res, $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 (SecureBlackbox_MailReader Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_mailreader_do_reset($res);

Remarks

Reset is a generic method available in every class.

ChainValidated Event (SecureBlackbox_MailReader Class)

Reports the completion of a certificate chain validation.

Object Oriented Interface

public function fireChainValidated($param);

Procedural Interface

secureblackbox_mailreader_register_callback($res, 1, array($this, 'fireChainValidated'));

Parameter List

 'subjectrdn'
 'validationresult'
 'validationdetails'

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

Asks the application to provide a decryption certificate.

Object Oriented Interface

public function fireDecryptionInfoNeeded($param);

Procedural Interface

secureblackbox_mailreader_register_callback($res, 2, array($this, 'fireDecryptionInfoNeeded'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'

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

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

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_mailreader_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Handles remote or external decryption.

Object Oriented Interface

public function fireExternalDecrypt($param);

Procedural Interface

secureblackbox_mailreader_register_callback($res, 4, array($this, 'fireExternalDecrypt'));

Parameter List

 'operationid'
 'algorithm'
 'pars'
 'encrypteddata'
 'data'

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 class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class 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 (SecureBlackbox_MailReader Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_mailreader_register_callback($res, 5, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

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

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

SignatureFound Event (SecureBlackbox_MailReader Class)

Signifies the start of signature validation.

Object Oriented Interface

public function fireSignatureFound($param);

Procedural Interface

secureblackbox_mailreader_register_callback($res, 6, array($this, 'fireSignatureFound'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'certfound'
 'validatesignature'
 'validatechain'

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 class 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 (SecureBlackbox_MailReader Class)

Marks the completion of the signature validation routine.

Object Oriented Interface

public function fireSignatureValidated($param);

Procedural Interface

secureblackbox_mailreader_register_callback($res, 7, array($this, 'fireSignatureValidated'));

Parameter List

 'issuerrdn'
 'serialnumber'
 'subjectkeyid'
 'validationresult'

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

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

MailReader Config Settings

Base Config Settings

Trappable Errors (MailReader Class)

MailReader Errors