Struct secureblackbox::MailReader

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

secureblackbox::MailReader

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");

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the MailReader struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of MailReader when you have finished using the instance.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

attach_count property (MailReader Struct)

The number of records in the Attach arrays.

Syntax

fn attach_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attach_content_subtype
• attach_content_type
• attach_creation_date
• attach_data
• attach_description
• attach_file_name
• attach_handle
• attach_id
• attach_modification_date
• attach_read_date
• attach_size

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

This property is read-only.

Data Type

i32

attach_content_subtype property (MailReader Struct)

Contains the content subtype of the attachment.

Syntax

fn attach_content_subtype(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_content_type property (MailReader Struct)

Contains the content type of the attachment.

Syntax

fn attach_content_type(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_creation_date property (MailReader Struct)

The creation date.

Syntax

fn attach_creation_date(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_data property (MailReader Struct)

The content of the attachment.

Syntax

fn attach_data(&self , AttachIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

attach_description property (MailReader Struct)

Textual description of the attachment.

Syntax

fn attach_description(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_file_name property (MailReader Struct)

Specifies the name of the attachment file.

Syntax

fn attach_file_name(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_handle property (MailReader Struct)

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

Syntax

fn attach_handle(&self , AttachIndex : i32) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

attach_id property (MailReader Struct)

Contains the attachment's unique identifier.

Syntax

fn attach_id(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_modification_date property (MailReader Struct)

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

Syntax

fn attach_modification_date(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_read_date property (MailReader Struct)

Specifies the file's last read date.

Syntax

fn attach_read_date(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

attach_size property (MailReader Struct)

The attachment's size in bytes.

Syntax

fn attach_size(&self , AttachIndex : i32) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

bcc_addr_count property (MailReader Struct)

The number of records in the BccAddr arrays.

Syntax

fn bcc_addr_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• bcc_addr_address
• bcc_addr_display_name
• bcc_addr_group_name

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

This property is read-only.

Data Type

i32

bcc_addr_address property (MailReader Struct)

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

Syntax

fn bcc_addr_address(&self , BccAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

bcc_addr_display_name property (MailReader Struct)

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

Syntax

fn bcc_addr_display_name(&self , BccAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

bcc_addr_group_name property (MailReader Struct)

The name of the group this address belongs to.

Syntax

fn bcc_addr_group_name(&self , BccAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

blocked_cert_count property (MailReader Struct)

The number of records in the BlockedCert arrays.

Syntax

fn blocked_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_blocked_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• blocked_cert_bytes
• blocked_cert_handle

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

Data Type

i32

blocked_cert_bytes property (MailReader Struct)

Returns the raw certificate data in DER format.

Syntax

fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

blocked_cert_handle property (MailReader Struct)

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

Syntax

fn blocked_cert_handle(&self , BlockedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_blocked_cert_handle(&self, BlockedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

cc_addr_count property (MailReader Struct)

The number of records in the CcAddr arrays.

Syntax

fn cc_addr_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• cc_addr_address
• cc_addr_display_name
• cc_addr_group_name

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

This property is read-only.

Data Type

i32

cc_addr_address property (MailReader Struct)

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

Syntax

fn cc_addr_address(&self , CcAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

cc_addr_display_name property (MailReader Struct)

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

Syntax

fn cc_addr_display_name(&self , CcAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

cc_addr_group_name property (MailReader Struct)

The name of the group this address belongs to.

Syntax

fn cc_addr_group_name(&self , CcAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

decryption_cert_bytes property (MailReader Struct)

Returns the raw certificate data in DER format.

Syntax

fn decryption_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

decryption_cert_ca property (MailReader Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn decryption_cert_ca(&self ) -> Result<bool, SecureBlackboxError> 
fn set_decryption_cert_ca(&self, value : bool) ->  Option<SecureBlackboxError> 

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.

Data Type

bool

decryption_cert_ca_key_id property (MailReader Struct)

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

Syntax

fn decryption_cert_ca_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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 decryption_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

Vec

decryption_cert_cert_type property (MailReader Struct)

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

Syntax

fn decryption_cert_cert_type(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

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 struct to load or create new certificate and certificate requests objects.

This property is read-only.

Data Type

i32

decryption_cert_crl_distribution_points property (MailReader Struct)

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

Syntax

fn decryption_cert_crl_distribution_points(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_crl_distribution_points(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_crl_distribution_points_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

decryption_cert_curve property (MailReader Struct)

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

Syntax

fn decryption_cert_curve(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_curve(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_curve_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

decryption_cert_fingerprint property (MailReader Struct)

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

Syntax

fn decryption_cert_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

decryption_cert_friendly_name property (MailReader Struct)

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

Syntax

fn decryption_cert_friendly_name(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

decryption_cert_handle property (MailReader Struct)

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

Syntax

fn decryption_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_decryption_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

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());

Data Type

i64

decryption_cert_hash_algorithm property (MailReader Struct)

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

Syntax

fn decryption_cert_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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 decryption_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

Data Type

String

decryption_cert_issuer property (MailReader Struct)

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

Syntax

fn decryption_cert_issuer(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

decryption_cert_issuer_rdn property (MailReader Struct)

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

Syntax

fn decryption_cert_issuer_rdn(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_issuer_rdn(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_issuer_rdn_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

Data Type

String

decryption_cert_key_algorithm property (MailReader Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn decryption_cert_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the decryption_cert_key_bits, decryption_cert_curve, and decryption_cert_public_key_bytes properties to get more details about the key the certificate contains.

Data Type

String

decryption_cert_key_bits property (MailReader Struct)

Returns the length of the public key in bits.

Syntax

fn decryption_cert_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

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 decryption_cert_public_key_bytes or decryption_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

i32

decryption_cert_key_fingerprint property (MailReader Struct)

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

Syntax

fn decryption_cert_key_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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 decryption_cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

String

decryption_cert_key_usage property (MailReader Struct)

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

Syntax

fn decryption_cert_key_usage(&self ) -> Result<i32, SecureBlackboxError> 
fn set_decryption_cert_key_usage(&self, value : i32) ->  Option<SecureBlackboxError> 

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.

Data Type

i32

decryption_cert_key_valid property (MailReader Struct)

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

Syntax

fn decryption_cert_key_valid(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

decryption_cert_ocsp_locations property (MailReader Struct)

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

Syntax

fn decryption_cert_ocsp_locations(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_ocsp_locations(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_ocsp_locations_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

decryption_cert_ocsp_no_check property (MailReader Struct)

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

Syntax

fn decryption_cert_ocsp_no_check(&self ) -> Result<bool, SecureBlackboxError> 
fn set_decryption_cert_ocsp_no_check(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

decryption_cert_origin property (MailReader Struct)

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

Syntax

fn decryption_cert_origin(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

decryption_cert_policy_i_ds property (MailReader Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn decryption_cert_policy_i_ds(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_policy_i_ds(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_policy_i_ds_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

decryption_cert_private_key_bytes property (MailReader Struct)

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

Syntax

fn decryption_cert_private_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

decryption_cert_private_key_exists property (MailReader Struct)

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

Syntax

fn decryption_cert_private_key_exists(&self ) -> Result<bool, SecureBlackboxError> 

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 decryption_cert_private_key_bytes, 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.

Data Type

bool

decryption_cert_private_key_extractable property (MailReader Struct)

Indicates whether the private key is extractable (exportable).

Syntax

fn decryption_cert_private_key_extractable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

Data Type

bool

decryption_cert_public_key_bytes property (MailReader Struct)

Contains the certificate's public key in DER format.

Syntax

fn decryption_cert_public_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

decryption_cert_qualified property (MailReader Struct)

Indicates whether the certificate is qualified.

Syntax

fn decryption_cert_qualified(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

decryption_cert_qualified_statements property (MailReader Struct)

Returns a simplified qualified status of the certificate.

Syntax

fn decryption_cert_qualified_statements(&self ) -> Result<i32, SecureBlackboxError> 
fn set_decryption_cert_qualified_statements(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

Data Type

i32

decryption_cert_qualifiers property (MailReader Struct)

A list of qualifiers.

Syntax

fn decryption_cert_qualifiers(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

decryption_cert_self_signed property (MailReader Struct)

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

Syntax

fn decryption_cert_self_signed(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

decryption_cert_serial_number property (MailReader Struct)

Returns the certificate's serial number.

Syntax

fn decryption_cert_serial_number(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_decryption_cert_serial_number(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_serial_number_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

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.

Data Type

Vec

decryption_cert_sig_algorithm property (MailReader Struct)

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

Syntax

fn decryption_cert_sig_algorithm(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

decryption_cert_source property (MailReader Struct)

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

Syntax

fn decryption_cert_source(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

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.

Data Type

i32

decryption_cert_subject property (MailReader Struct)

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

Syntax

fn decryption_cert_subject(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

decryption_cert_subject_alternative_name property (MailReader Struct)

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

Syntax

fn decryption_cert_subject_alternative_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_subject_alternative_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_subject_alternative_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

Data Type

String

decryption_cert_subject_key_id property (MailReader Struct)

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

Syntax

fn decryption_cert_subject_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_decryption_cert_subject_key_id(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_subject_key_id_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

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 decryption_cert_subject_key_id and decryption_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

Data Type

Vec

decryption_cert_subject_rdn property (MailReader Struct)

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

Syntax

fn decryption_cert_subject_rdn(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_subject_rdn(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_subject_rdn_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

decryption_cert_valid property (MailReader Struct)

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

Syntax

fn decryption_cert_valid(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

decryption_cert_valid_from property (MailReader Struct)

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

Syntax

fn decryption_cert_valid_from(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_valid_from(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_valid_from_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

decryption_cert_valid_to property (MailReader Struct)

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

Syntax

fn decryption_cert_valid_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_cert_valid_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_cert_valid_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_async_document_id property (MailReader Struct)

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

Syntax

fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_async_document_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_async_document_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

external_crypto_custom_params property (MailReader Struct)

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

Syntax

fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_custom_params(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_custom_params_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_data property (MailReader Struct)

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

Syntax

fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_data(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_data_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_external_hash_calculation property (MailReader Struct)

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

Syntax

fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError> 
fn set_external_crypto_external_hash_calculation(&self, value : bool) ->  Option<SecureBlackboxError> 

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

If set to true, the struct 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

bool

external_crypto_hash_algorithm property (MailReader Struct)

Specifies the request's signature hash algorithm.

Syntax

fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

external_crypto_key_id property (MailReader Struct)

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

Syntax

fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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 external_crypto_key_secret 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

external_crypto_key_secret property (MailReader Struct)

The pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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 external_crypto_key_id topic.

Data Type

String

external_crypto_method property (MailReader Struct)

Specifies the asynchronous signing method.

Syntax

fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

0

Remarks

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

Available options:

Data Type

i32

external_crypto_mode property (MailReader Struct)

Specifies the external cryptography mode.

Syntax

fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

Data Type

i32

external_crypto_public_key_algorithm property (MailReader Struct)

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

Syntax

fn external_crypto_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

fips_mode property (MailReader Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

from_addr_count property (MailReader Struct)

The number of records in the FromAddr arrays.

Syntax

fn from_addr_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• from_addr_address
• from_addr_display_name
• from_addr_group_name

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

This property is read-only.

Data Type

i32

from_addr_address property (MailReader Struct)

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

Syntax

fn from_addr_address(&self , FromAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

from_addr_display_name property (MailReader Struct)

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

Syntax

fn from_addr_display_name(&self , FromAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

from_addr_group_name property (MailReader Struct)

The name of the group this address belongs to.

Syntax

fn from_addr_group_name(&self , FromAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

ignore_chain_validation_errors property (MailReader Struct)

Makes the struct tolerant to chain validation errors.

Syntax

fn ignore_chain_validation_errors(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ignore_chain_validation_errors(&self, value : bool) ->  Option<SecureBlackboxError> 

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

bool

known_cert_count property (MailReader Struct)

The number of records in the KnownCert arrays.

Syntax

fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_cert_bytes
• known_cert_handle

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

Data Type

i32

known_cert_bytes property (MailReader Struct)

Returns the raw certificate data in DER format.

Syntax

fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

known_cert_handle property (MailReader Struct)

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

Syntax

fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

known_crl_count property (MailReader Struct)

The number of records in the KnownCRL arrays.

Syntax

fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_crl_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_crl_bytes
• known_crl_handle

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

Data Type

i32

known_crl_bytes property (MailReader Struct)

Returns the raw CRL data in DER format.

Syntax

fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

known_crl_handle property (MailReader Struct)

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

Syntax

fn known_crl_handle(&self , KnownCRLIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_crl_handle(&self, KnownCRLIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

known_ocsp_count property (MailReader Struct)

The number of records in the KnownOCSP arrays.

Syntax

fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_ocsp_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_ocsp_bytes
• known_ocsp_handle

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

Data Type

i32

known_ocsp_bytes property (MailReader Struct)

A buffer containing the raw OCSP response data.

Syntax

fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

known_ocsp_handle property (MailReader Struct)

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

Syntax

fn known_ocsp_handle(&self , KnownOCSPIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_ocsp_handle(&self, KnownOCSPIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

msg_attachment_count property (MailReader Struct)

Returns the number of attachments in this message.

Syntax

fn msg_attachment_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the number of attachments in this message.

This property is read-only.

Data Type

i32

msg_bcc property (MailReader Struct)

The contents of the BCC header property.

Syntax

fn msg_bcc(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_bcc(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_bcc_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_cc property (MailReader Struct)

The value of the CC header property.

Syntax

fn msg_cc(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_cc(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_cc_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the CC header field.

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

Data Type

String

msg_comments property (MailReader Struct)

Contains additional information about the message body.

Syntax

fn msg_comments(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_comments(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_comments_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains additional information about the message body.

Data Type

String

msg_date property (MailReader Struct)

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

Syntax

fn msg_date(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_date(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_date_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_delivery_receipt property (MailReader Struct)

Enables delivery notification.

Syntax

fn msg_delivery_receipt(&self ) -> Result<bool, SecureBlackboxError> 
fn set_msg_delivery_receipt(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables delivery notification.

Data Type

bool

msg_from property (MailReader Struct)

Contains the value of the From header property.

Syntax

fn msg_from(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_from(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_from_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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 msg_sender to specify the sender separately.

Data Type

String

msg_handle property (MailReader Struct)

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

Syntax

fn msg_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_msg_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

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());

Data Type

i64

msg_html_text property (MailReader Struct)

The HTML version of the message.

Syntax

fn msg_html_text(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_html_text(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_html_text_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The HTML version of the message.

Data Type

String

msg_id property (MailReader Struct)

The contents of the Message-ID header property.

Syntax

fn msg_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_in_reply_to property (MailReader Struct)

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

Syntax

fn msg_in_reply_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_in_reply_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_in_reply_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_keywords property (MailReader Struct)

The value of the Keywords header property.

Syntax

fn msg_keywords(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_keywords(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_keywords_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_mailer property (MailReader Struct)

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

Syntax

fn msg_mailer(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

msg_plain_text property (MailReader Struct)

The plain text version of the message.

Syntax

fn msg_plain_text(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_plain_text(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_plain_text_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The plain text version of the message.

Data Type

String

msg_priority property (MailReader Struct)

Specifies the message priority.

Syntax

fn msg_priority(&self ) -> Result<i32, SecureBlackboxError> 
fn set_msg_priority(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Lowest
1   // Low
2   // Normal
3   // High
4   // Highest

Default Value

2

Remarks

Specifies the message priority.

Available options:

Data Type

i32

msg_read_receipt property (MailReader Struct)

Enables a read notification.

Syntax

fn msg_read_receipt(&self ) -> Result<bool, SecureBlackboxError> 
fn set_msg_read_receipt(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables a read notification.

Data Type

bool

msg_references property (MailReader Struct)

The value of the References header property.

Syntax

fn msg_references(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_references(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_references_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_reply_to property (MailReader Struct)

The value of the Reply-To header property.

Syntax

fn msg_reply_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_reply_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_reply_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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 msg_from field.

Data Type

String

msg_return_path property (MailReader Struct)

The value of the Return-Path header property.

Syntax

fn msg_return_path(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_return_path(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_return_path_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_sender property (MailReader Struct)

The value of the Sender header property.

Syntax

fn msg_sender(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_sender(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_sender_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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.

Data Type

String

msg_send_to property (MailReader Struct)

The value of the To header property.

Syntax

fn msg_send_to(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_send_to(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_send_to_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The value of the To header field.

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

Data Type

String

msg_subject property (MailReader Struct)

Contains the subject property of this message.

Syntax

fn msg_subject(&self ) -> Result<String, SecureBlackboxError> 
fn set_msg_subject(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_msg_subject_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the subject field of this message.

Data Type

String

offline_mode property (MailReader Struct)

Switches the struct to offline mode.

Syntax

fn offline_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_offline_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

When working in offline mode, the struct 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 known_certificates, known_crls, and other related properties.

Data Type

bool

header_field_count property (MailReader Struct)

The number of records in the HeaderField arrays.

Syntax

fn header_field_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• header_field_category
• header_field_format
• header_field_name
• header_field_value

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

This property is read-only.

Data Type

i32

header_field_category property (MailReader Struct)

Specifies the string category of the contained value.

Syntax

fn header_field_category(&self , HeaderFieldIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

header_field_format property (MailReader Struct)

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

Syntax

fn header_field_format(&self , HeaderFieldIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the format (encoding) of the value contained in the header_field_value 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.

Data Type

i32

header_field_name property (MailReader Struct)

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

Syntax

fn header_field_name(&self , HeaderFieldIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

header_field_value property (MailReader Struct)

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

Syntax

fn header_field_value(&self , HeaderFieldIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

profile property (MailReader Struct)

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

Syntax

fn profile(&self ) -> Result<String, SecureBlackboxError> 
fn set_profile(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_profile_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

proxy_address property (MailReader Struct)

The IP address of the proxy server.

Syntax

fn proxy_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

proxy_authentication property (MailReader Struct)

The authentication type used by the proxy server.

Syntax

fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_authentication(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

i32

proxy_password property (MailReader Struct)

The password to authenticate to the proxy server.

Syntax

fn proxy_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

proxy_port property (MailReader Struct)

The port on the proxy server to connect to.

Syntax

fn proxy_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

i32

proxy_type property (MailReader Struct)

The type of the proxy server.

Syntax

fn proxy_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

0

Remarks

The type of the proxy server.

Data Type

i32

proxy_request_headers property (MailReader Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_request_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

proxy_response_body property (MailReader Struct)

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

Syntax

fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

proxy_response_headers property (MailReader Struct)

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

Syntax

fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

proxy_use_ipv6 property (MailReader Struct)

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

Syntax

fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_proxy_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

proxy_username property (MailReader Struct)

Specifies the username credential for proxy authentication.

Syntax

fn proxy_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

reply_to_addr_count property (MailReader Struct)

The number of records in the ReplyToAddr arrays.

Syntax

fn reply_to_addr_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• reply_to_addr_address
• reply_to_addr_display_name
• reply_to_addr_group_name

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

This property is read-only.

Data Type

i32

reply_to_addr_address property (MailReader Struct)

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

Syntax

fn reply_to_addr_address(&self , ReplyToAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

reply_to_addr_display_name property (MailReader Struct)

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

Syntax

fn reply_to_addr_display_name(&self , ReplyToAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

reply_to_addr_group_name property (MailReader Struct)

The name of the group this address belongs to.

Syntax

fn reply_to_addr_group_name(&self , ReplyToAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

revocation_check property (MailReader Struct)

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

Syntax

fn revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

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

i32

sec_info_chain_validation_details property (MailReader Struct)

The details of a certificate chain validation outcome.

Syntax

fn sec_info_chain_validation_details(&self ) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

sec_info_chain_validation_result property (MailReader Struct)

The outcome of a certificate chain validation routine.

Syntax

fn sec_info_chain_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

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.

Data Type

i32

sec_info_claimed_signing_time property (MailReader Struct)

Returns the signature's claimed signing time.

Syntax

fn sec_info_claimed_signing_time(&self ) -> Result<String, SecureBlackboxError> 

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

sec_info_encrypted property (MailReader Struct)

Indicates whether the message is encrypted.

Syntax

fn sec_info_encrypted(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the message is encrypted.

This property is read-only.

Data Type

bool

sec_info_encryption_algorithm property (MailReader Struct)

Indicates the algorithm that was used to encrypt the message.

Syntax

fn sec_info_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the algorithm that was used to encrypt the message.

This property is read-only.

Data Type

String

sec_info_hash_algorithm property (MailReader Struct)

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

Syntax

fn sec_info_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

sec_info_signature_validation_result property (MailReader Struct)

The outcome of the cryptographic signature validation.

Syntax

fn sec_info_signature_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // Unknown
2   // Corrupted
3   // SignerNotFound
4   // Failure
5   // ReferenceCorrupted

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

This property is read-only.

Data Type

i32

sec_info_signed property (MailReader Struct)

Indicates whether the message is signed.

Syntax

fn sec_info_signed(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the message is signed.

This property is read-only.

Data Type

bool

sec_info_validation_log property (MailReader Struct)

Contains the signing certificate's chain validation log.

Syntax

fn sec_info_validation_log(&self ) -> Result<String, SecureBlackboxError> 

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

sender_addr_address property (MailReader Struct)

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

Syntax

fn sender_addr_address(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

sender_addr_display_name property (MailReader Struct)

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

Syntax

fn sender_addr_display_name(&self ) -> Result<String, SecureBlackboxError> 

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

sender_addr_group_name property (MailReader Struct)

The name of the group this address belongs to.

Syntax

fn sender_addr_group_name(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The name of the group this address belongs to.

This property is read-only.

Data Type

String

send_to_addr_count property (MailReader Struct)

The number of records in the SendToAddr arrays.

Syntax

fn send_to_addr_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• send_to_addr_address
• send_to_addr_display_name
• send_to_addr_group_name

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

This property is read-only.

Data Type

i32

send_to_addr_address property (MailReader Struct)

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

Syntax

fn send_to_addr_address(&self , SendToAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

send_to_addr_display_name property (MailReader Struct)

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

Syntax

fn send_to_addr_display_name(&self , SendToAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

send_to_addr_group_name property (MailReader Struct)

The name of the group this address belongs to.

Syntax

fn send_to_addr_group_name(&self , SendToAddrIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_bytes property (MailReader Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

signing_cert_ca property (MailReader Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn signing_cert_ca(&self ) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

signing_cert_ca_key_id property (MailReader Struct)

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

Syntax

fn signing_cert_ca_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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 signing_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

Vec

signing_cert_crl_distribution_points property (MailReader Struct)

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

Syntax

fn signing_cert_crl_distribution_points(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_curve property (MailReader Struct)

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

Syntax

fn signing_cert_curve(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_fingerprint property (MailReader Struct)

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

Syntax

fn signing_cert_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_friendly_name property (MailReader Struct)

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

Syntax

fn signing_cert_friendly_name(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_handle property (MailReader Struct)

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

Syntax

fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

signing_cert_hash_algorithm property (MailReader Struct)

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

Syntax

fn signing_cert_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 

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 signing_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

This property is read-only.

Data Type

String

signing_cert_issuer property (MailReader Struct)

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

Syntax

fn signing_cert_issuer(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

signing_cert_issuer_rdn property (MailReader Struct)

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

Syntax

fn signing_cert_issuer_rdn(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_key_algorithm property (MailReader Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn signing_cert_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the signing_cert_key_bits, signing_cert_curve, and signing_cert_public_key_bytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

String

signing_cert_key_bits property (MailReader Struct)

Returns the length of the public key in bits.

Syntax

fn signing_cert_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

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 signing_cert_public_key_bytes or signing_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

i32

signing_cert_key_fingerprint property (MailReader Struct)

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

Syntax

fn signing_cert_key_fingerprint(&self ) -> Result<String, SecureBlackboxError> 

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 signing_cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

String

signing_cert_key_usage property (MailReader Struct)

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

Syntax

fn signing_cert_key_usage(&self ) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

signing_cert_key_valid property (MailReader Struct)

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

Syntax

fn signing_cert_key_valid(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signing_cert_ocsp_locations property (MailReader Struct)

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

Syntax

fn signing_cert_ocsp_locations(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_policy_i_ds property (MailReader Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn signing_cert_policy_i_ds(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_public_key_bytes property (MailReader Struct)

Contains the certificate's public key in DER format.

Syntax

fn signing_cert_public_key_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

signing_cert_self_signed property (MailReader Struct)

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

Syntax

fn signing_cert_self_signed(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signing_cert_serial_number property (MailReader Struct)

Returns the certificate's serial number.

Syntax

fn signing_cert_serial_number(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

signing_cert_sig_algorithm property (MailReader Struct)

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

Syntax

fn signing_cert_sig_algorithm(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_subject property (MailReader Struct)

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

Syntax

fn signing_cert_subject(&self ) -> Result<String, SecureBlackboxError> 

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

This property is read-only.

Data Type

String

signing_cert_subject_key_id property (MailReader Struct)

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

Syntax

fn signing_cert_subject_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

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 signing_cert_subject_key_id and signing_cert_ca_key_id 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.

Data Type

Vec

signing_cert_subject_rdn property (MailReader Struct)

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

Syntax

fn signing_cert_subject_rdn(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

signing_cert_valid_from property (MailReader Struct)

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

Syntax

fn signing_cert_valid_from(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_valid_to property (MailReader Struct)

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

Syntax

fn signing_cert_valid_to(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

socket_dns_mode property (MailReader Struct)

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

Syntax

fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

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

i32

socket_dns_port property (MailReader Struct)

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

Syntax

fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_dns_query_timeout property (MailReader Struct)

The timeout (in milliseconds) for each DNS query.

Syntax

fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_dns_servers property (MailReader Struct)

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

Syntax

fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

socket_dns_total_timeout property (MailReader Struct)

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

Syntax

fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_incoming_speed_limit property (MailReader Struct)

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

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_local_address property (MailReader Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (MailReader Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (MailReader Struct)

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

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_timeout property (MailReader Struct)

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

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

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

i32

socket_use_ipv6 property (MailReader Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

tls_auto_validate_certificates property (MailReader Struct)

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

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_base_configuration property (MailReader Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

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

i32

tls_ciphersuites property (MailReader Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

tls_client_auth property (MailReader Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

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

i32

tls_extensions property (MailReader Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (MailReader Struct)

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

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

tls_groups property (MailReader Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (MailReader Struct)

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

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key property (MailReader Struct)

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

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key_ciphersuite property (MailReader Struct)

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

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_renegotiation_attack_prevention_mode property (MailReader Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (MailReader Struct)

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

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

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.

Data Type

i32

tls_ssl_options property (MailReader Struct)

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

Syntax

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (MailReader Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (MailReader Struct)

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

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_use_session_resumption property (MailReader Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (MailReader Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

trusted_cert_count property (MailReader Struct)

The number of records in the TrustedCert arrays.

Syntax

fn trusted_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_trusted_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• trusted_cert_bytes
• trusted_cert_handle

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

Data Type

i32

trusted_cert_bytes property (MailReader Struct)

Returns the raw certificate data in DER format.

Syntax

fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

trusted_cert_handle property (MailReader Struct)

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

Syntax

fn trusted_cert_handle(&self , TrustedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_trusted_cert_handle(&self, TrustedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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.

Data Type

i64

used_cert_count property (MailReader Struct)

The number of records in the UsedCert arrays.

Syntax

fn used_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• used_cert_bytes
• used_cert_ca
• used_cert_ca_key_id
• used_cert_cert_type
• used_cert_crl_distribution_points
• used_cert_curve
• used_cert_fingerprint
• used_cert_friendly_name
• used_cert_handle
• used_cert_hash_algorithm
• used_cert_issuer
• used_cert_issuer_rdn
• used_cert_key_algorithm
• used_cert_key_bits
• used_cert_key_fingerprint
• used_cert_key_usage
• used_cert_key_valid
• used_cert_ocsp_locations
• used_cert_ocsp_no_check
• used_cert_origin
• used_cert_policy_i_ds
• used_cert_private_key_bytes
• used_cert_private_key_exists
• used_cert_private_key_extractable
• used_cert_public_key_bytes
• used_cert_qualified
• used_cert_qualified_statements
• used_cert_qualifiers
• used_cert_self_signed
• used_cert_serial_number
• used_cert_sig_algorithm
• used_cert_source
• used_cert_subject
• used_cert_subject_alternative_name
• used_cert_subject_key_id
• used_cert_subject_rdn
• used_cert_valid
• used_cert_valid_from
• used_cert_valid_to

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

This property is read-only.

Data Type

i32

used_cert_bytes property (MailReader Struct)

Returns the raw certificate data in DER format.

Syntax

fn used_cert_bytes(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_ca property (MailReader Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn used_cert_ca(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_ca_key_id property (MailReader Struct)

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

Syntax

fn used_cert_ca_key_id(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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

Data Type

Vec

used_cert_cert_type property (MailReader Struct)

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

Syntax

fn used_cert_cert_type(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

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

Data Type

i32

used_cert_crl_distribution_points property (MailReader Struct)

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

Syntax

fn used_cert_crl_distribution_points(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_curve property (MailReader Struct)

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

Syntax

fn used_cert_curve(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_fingerprint property (MailReader Struct)

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

Syntax

fn used_cert_fingerprint(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_friendly_name property (MailReader Struct)

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

Syntax

fn used_cert_friendly_name(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_handle property (MailReader Struct)

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

Syntax

fn used_cert_handle(&self , UsedCertIndex : i32) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

used_cert_hash_algorithm property (MailReader Struct)

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

Syntax

fn used_cert_hash_algorithm(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

Data Type

String

used_cert_issuer property (MailReader Struct)

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

Syntax

fn used_cert_issuer(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

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.

Data Type

String

used_cert_issuer_rdn property (MailReader Struct)

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

Syntax

fn used_cert_issuer_rdn(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_key_algorithm property (MailReader Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn used_cert_key_algorithm(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the used_cert_key_bits, used_cert_curve, and used_cert_public_key_bytes 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.

Data Type

String

used_cert_key_bits property (MailReader Struct)

Returns the length of the public key in bits.

Syntax

fn used_cert_key_bits(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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 used_cert_public_key_bytes or used_cert_private_key_bytes 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.

Data Type

i32

used_cert_key_fingerprint property (MailReader Struct)

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

Syntax

fn used_cert_key_fingerprint(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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 used_cert_fingerprint property. The key fingerprint 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.

Data Type

String

used_cert_key_usage property (MailReader Struct)

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

Syntax

fn used_cert_key_usage(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

used_cert_key_valid property (MailReader Struct)

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

Syntax

fn used_cert_key_valid(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_ocsp_locations property (MailReader Struct)

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

Syntax

fn used_cert_ocsp_locations(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_ocsp_no_check property (MailReader Struct)

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

Syntax

fn used_cert_ocsp_no_check(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_origin property (MailReader Struct)

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

Syntax

fn used_cert_origin(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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.

Data Type

i32

used_cert_policy_i_ds property (MailReader Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn used_cert_policy_i_ds(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_private_key_bytes property (MailReader Struct)

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

Syntax

fn used_cert_private_key_bytes(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_private_key_exists property (MailReader Struct)

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

Syntax

fn used_cert_private_key_exists(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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 used_cert_private_key_bytes, 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.

Data Type

bool

used_cert_private_key_extractable property (MailReader Struct)

Indicates whether the private key is extractable (exportable).

Syntax

fn used_cert_private_key_extractable(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_public_key_bytes property (MailReader Struct)

Contains the certificate's public key in DER format.

Syntax

fn used_cert_public_key_bytes(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_qualified property (MailReader Struct)

Indicates whether the certificate is qualified.

Syntax

fn used_cert_qualified(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_qualified_statements property (MailReader Struct)

Returns a simplified qualified status of the certificate.

Syntax

fn used_cert_qualified_statements(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

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.

Data Type

i32

used_cert_qualifiers property (MailReader Struct)

A list of qualifiers.

Syntax

fn used_cert_qualifiers(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_self_signed property (MailReader Struct)

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

Syntax

fn used_cert_self_signed(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_serial_number property (MailReader Struct)

Returns the certificate's serial number.

Syntax

fn used_cert_serial_number(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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.

Data Type

Vec

used_cert_sig_algorithm property (MailReader Struct)

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

Syntax

fn used_cert_sig_algorithm(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_source property (MailReader Struct)

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

Syntax

fn used_cert_source(&self , UsedCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

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.

Data Type

i32

used_cert_subject property (MailReader Struct)

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

Syntax

fn used_cert_subject(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

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.

Data Type

String

used_cert_subject_alternative_name property (MailReader Struct)

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

Syntax

fn used_cert_subject_alternative_name(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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

Data Type

String

used_cert_subject_key_id property (MailReader Struct)

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

Syntax

fn used_cert_subject_key_id(&self , UsedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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 used_cert_subject_key_id and used_cert_ca_key_id 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.

Data Type

Vec

used_cert_subject_rdn property (MailReader Struct)

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

Syntax

fn used_cert_subject_rdn(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_valid property (MailReader Struct)

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

Syntax

fn used_cert_valid(&self , UsedCertIndex : i32) -> Result<bool, SecureBlackboxError> 

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.

Data Type

bool

used_cert_valid_from property (MailReader Struct)

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

Syntax

fn used_cert_valid_from(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

used_cert_valid_to property (MailReader Struct)

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

Syntax

fn used_cert_valid_to(&self , UsedCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

validation_moment property (MailReader Struct)

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

Syntax

fn validation_moment(&self ) -> Result<String, SecureBlackboxError> 
fn set_validation_moment(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_validation_moment_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

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

Data Type

String

config method (MailReader Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

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

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

do_action method (MailReader Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

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

Common ActionIDs:

find_attachment method (MailReader Struct)

Looks up a Message's attachment by its ID.

Syntax

fn find_attachment(&self, id : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to find the attachment by its ID.

load_from_bytes method (MailReader Struct)

Loads an e-mail message from a byte array.

Syntax

fn load_from_bytes(&self, message_bytes : &[u8]) -> Result<(), SecureBlackboxError>

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.

load_from_file method (MailReader Struct)

Loads an e-mail message from a file.

Syntax

fn load_from_file(&self, file_name : &str) -> Result<(), SecureBlackboxError>

Remarks

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

reset method (MailReader Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

on_chain_validated event (MailReader Struct)

Reports the completion of a certificate chain validation.

Syntax

// MailReaderChainValidatedEventArgs carries the MailReader ChainValidated event's parameters.
pub struct MailReaderChainValidatedEventArgs {
  fn subject_rdn(&self) -> &String
  fn validation_result(&self) -> i32
  fn validation_details(&self) -> i32
}

// MailReaderChainValidatedEvent defines the signature of the MailReader ChainValidated event's handler function.
pub trait MailReaderChainValidatedEvent {
  fn on_chain_validated(&self, sender : MailReader, e : &mut MailReaderChainValidatedEventArgs);
}

impl <'a> MailReader<'a> {
  pub fn on_chain_validated(&self) -> &'a dyn MailReaderChainValidatedEvent;
  pub fn set_on_chain_validated(&mut self, value : &'a dyn MailReaderChainValidatedEvent);
  ...
}

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.

on_decryption_info_needed event (MailReader Struct)

Asks the application to provide a decryption certificate.

Syntax

// MailReaderDecryptionInfoNeededEventArgs carries the MailReader DecryptionInfoNeeded event's parameters.
pub struct MailReaderDecryptionInfoNeededEventArgs {
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
}

// MailReaderDecryptionInfoNeededEvent defines the signature of the MailReader DecryptionInfoNeeded event's handler function.
pub trait MailReaderDecryptionInfoNeededEvent {
  fn on_decryption_info_needed(&self, sender : MailReader, e : &mut MailReaderDecryptionInfoNeededEventArgs);
}

impl <'a> MailReader<'a> {
  pub fn on_decryption_info_needed(&self) -> &'a dyn MailReaderDecryptionInfoNeededEvent;
  pub fn set_on_decryption_info_needed(&mut self, value : &'a dyn MailReaderDecryptionInfoNeededEvent);
  ...
}

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 decryption_certificate property.

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

on_error event (MailReader Struct)

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

Syntax

// MailReaderErrorEventArgs carries the MailReader Error event's parameters.
pub struct MailReaderErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// MailReaderErrorEvent defines the signature of the MailReader Error event's handler function.
pub trait MailReaderErrorEvent {
  fn on_error(&self, sender : MailReader, e : &mut MailReaderErrorEventArgs);
}

impl <'a> MailReader<'a> {
  pub fn on_error(&self) -> &'a dyn MailReaderErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn MailReaderErrorEvent);
  ...
}

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.

on_external_decrypt event (MailReader Struct)

Handles remote or external decryption.

Syntax

// MailReaderExternalDecryptEventArgs carries the MailReader ExternalDecrypt event's parameters.
pub struct MailReaderExternalDecryptEventArgs {
  fn operation_id(&self) -> &String
  fn algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn encrypted_data(&self) -> &String
  fn data(&self) -> &String
  fn set_data(&self, value : &str)
  fn set_data_ref(&self, value : &String)
}

// MailReaderExternalDecryptEvent defines the signature of the MailReader ExternalDecrypt event's handler function.
pub trait MailReaderExternalDecryptEvent {
  fn on_external_decrypt(&self, sender : MailReader, e : &mut MailReaderExternalDecryptEventArgs);
}

impl <'a> MailReader<'a> {
  pub fn on_external_decrypt(&self) -> &'a dyn MailReaderExternalDecryptEvent;
  pub fn set_on_external_decrypt(&mut self, value : &'a dyn MailReaderExternalDecryptEvent);
  ...
}

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

The struct 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

on_notification event (MailReader Struct)

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

Syntax

// MailReaderNotificationEventArgs carries the MailReader Notification event's parameters.
pub struct MailReaderNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// MailReaderNotificationEvent defines the signature of the MailReader Notification event's handler function.
pub trait MailReaderNotificationEvent {
  fn on_notification(&self, sender : MailReader, e : &mut MailReaderNotificationEventArgs);
}

impl <'a> MailReader<'a> {
  pub fn on_notification(&self) -> &'a dyn MailReaderNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn MailReaderNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

on_signature_found event (MailReader Struct)

Signifies the start of signature validation.

Syntax

// MailReaderSignatureFoundEventArgs carries the MailReader SignatureFound event's parameters.
pub struct MailReaderSignatureFoundEventArgs {
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn cert_found(&self) -> bool
  fn validate_signature(&self) -> bool
  fn set_validate_signature(&self, value : bool)
  fn validate_chain(&self) -> bool
  fn set_validate_chain(&self, value : bool)
}

// MailReaderSignatureFoundEvent defines the signature of the MailReader SignatureFound event's handler function.
pub trait MailReaderSignatureFoundEvent {
  fn on_signature_found(&self, sender : MailReader, e : &mut MailReaderSignatureFoundEventArgs);
}

impl <'a> MailReader<'a> {
  pub fn on_signature_found(&self) -> &'a dyn MailReaderSignatureFoundEvent;
  pub fn set_on_signature_found(&mut self, value : &'a dyn MailReaderSignatureFoundEvent);
  ...
}

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 struct 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 known_certificates 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.

on_signature_validated event (MailReader Struct)

Marks the completion of the signature validation routine.

Syntax

// MailReaderSignatureValidatedEventArgs carries the MailReader SignatureValidated event's parameters.
pub struct MailReaderSignatureValidatedEventArgs {
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn validation_result(&self) -> i32
}

// MailReaderSignatureValidatedEvent defines the signature of the MailReader SignatureValidated event's handler function.
pub trait MailReaderSignatureValidatedEvent {
  fn on_signature_validated(&self, sender : MailReader, e : &mut MailReaderSignatureValidatedEventArgs);
}

impl <'a> MailReader<'a> {
  pub fn on_signature_validated(&self) -> &'a dyn MailReaderSignatureValidatedEvent;
  pub fn set_on_signature_validated(&mut self, value : &'a dyn MailReaderSignatureValidatedEvent);
  ...
}

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

The struct 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 struct, access to these internal properties is provided through the config method.

MailReader Config Settings

Base Config Settings

Trappable Errors (MailReader Struct)

MailReader Errors