Struct secureblackbox::MailWriter

Properties Methods Events Config Settings Errors

The MailWriter struct composes, encrypts, and signs e-mail messages.

Syntax

secureblackbox::MailWriter

Remarks

Use MailWriter to compose, sign, and encrypt e-mail messages, and prepare them for sending or saving.

Preparing a very simple message and saving it to a file: MailWriter writer = new MailWriter(); writer.From.Add(new MailAddress("John Doe", "jdoe@company.com")); writer.SendTo.Add(new MailAddress("Mary Dow", "mdow@home.com")); writer.Message.Subject = "Lating to the party"; writer.Message.PlainText = "Hi Mary!\r\nStill in the office waiting for my partner.\r\nProbably I'll be late to the party for about an hour.\r\nSorry.\r\nJohn"; writer.SaveToFile("path\\message.eml");

Attaching an image and referencing it from the message text: writer.AttachImage("myimage", File.ReadAllBytes("path\\image.jpg")); writer.Attachments[0].ContentSubtype = "jpeg"; writer.Message.HtmlText = "<html><body>Message with an image<p><img src=\"cid:myimage\"></body></html>";

Signing a message with a certificate (note that the certificate should contain its private key): CertificateManager manager = new CertificateManager(); manager.ImportFromFile("path\\cert.pfx", "password"); writer.SecuritySettings.Sign = true; writer.SecuritySettings.HashAlgorithm = "SHA256"; writer.SigningCertificate = manager.Certificate; writer.SaveToFile("path\\message.eml");

Encrypting a message with one or more certificates (no private key is required): CertificateManager manager = new CertificateManager(); manager.ImportFromFile("path\\cert.cer", ""); writer.SecuritySettings.Encrypt = true; writer.SecuritySettings.EncryptionAlgorithm = "AES256"; writer.EncryptionCertificates.Add(manager.Certificate); // add more certificates if needed writer.SaveToFile("D:\\test.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 MailWriter struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of MailWriter 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.


attach_encoding	The encoding to be applied to the attachments.
attach_count	The number of records in the Attach arrays.
attach_content_subtype	Contains the content subtype of the attachment.
attach_content_type	Contains the content type of the attachment.
attach_creation_date	The creation date.
attach_data	The content of the attachment.
attach_description	Textual description of the attachment.
attach_file_name	Specifies the name of the attachment file.
attach_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
attach_id	Contains the attachment's unique identifier.
attach_modification_date	Specifies the date and time of the file's last modification.
attach_read_date	Specifies the file's last read date.
attach_size	The attachment's size in bytes.
bcc_addr_count	The number of records in the BccAddr arrays.
bcc_addr_address	Contains the e-mail address in the form of john@doe.
bcc_addr_display_name	Contains the friendly name of the user of this address, such as John Doe.
bcc_addr_group_name	The name of the group this address belongs to.
cc_addr_count	The number of records in the CcAddr arrays.
cc_addr_address	Contains the e-mail address in the form of john@doe.
cc_addr_display_name	Contains the friendly name of the user of this address, such as John Doe.
cc_addr_group_name	The name of the group this address belongs to.
charset	The charset to apply to Message .
encryption_cert_count	The number of records in the EncryptionCert arrays.
encryption_cert_bytes	Returns the raw certificate data in DER format.
encryption_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
external_crypto_async_document_id	Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
external_crypto_custom_params	Custom parameters to be passed to the signing service (uninterpreted).
external_crypto_data	Additional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculation	Specifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithm	Specifies the request's signature hash algorithm.
external_crypto_key_id	The ID of the pre-shared key used for DC request authentication.
external_crypto_key_secret	The pre-shared key used for DC request authentication.
external_crypto_method	Specifies the asynchronous signing method.
external_crypto_mode	Specifies the external cryptography mode.
external_crypto_public_key_algorithm	Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
fips_mode	Reserved.
from_addr_count	The number of records in the FromAddr arrays.
from_addr_address	Contains the e-mail address in the form of john@doe.
from_addr_display_name	Contains the friendly name of the user of this address, such as John Doe.
from_addr_group_name	The name of the group this address belongs to.
header_encoding	The encoding to be applied to the message header.
mailer	The name of the software used to compose and/or send the message.
msg_attachment_count	Returns the number of attachments in this message.
msg_bcc	The contents of the BCC header property.
msg_cc	The value of the CC header property.
msg_comments	Contains additional information about the message body.
msg_date	The date and time when the message entered the mail delivery system.
msg_delivery_receipt	Enables delivery notification.
msg_from	Contains the value of the From header property.
msg_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
msg_html_text	The HTML version of the message.
msg_id	The contents of the Message-ID header property.
msg_in_reply_to	The value of the In-Reply-To header property.
msg_keywords	The value of the Keywords header property.
msg_mailer	The name of the software that was used to send the message.
msg_plain_text	The plain text version of the message.
msg_priority	Specifies the message priority.
msg_read_receipt	Enables a read notification.
msg_references	The value of the References header property.
msg_reply_to	The value of the Reply-To header property.
msg_return_path	The value of the Return-Path header property.
msg_sender	The value of the Sender header property.
msg_send_to	The value of the To header property.
msg_subject	Contains the subject property of this message.
header_field_count	The number of records in the HeaderField arrays.
header_field_category	Specifies the string category of the contained value.
header_field_format	Specifies the format (encoding) of the value contained in the Value property.
header_field_name	The name element in a (name, value) pair.
header_field_value	The value element in a (name, value) pair.
profile	Specifies a pre-defined profile to apply when creating the signature.
reply_to_addr_count	The number of records in the ReplyToAddr arrays.
reply_to_addr_address	Contains the e-mail address in the form of john@doe.
reply_to_addr_display_name	Contains the friendly name of the user of this address, such as John Doe.
reply_to_addr_group_name	The name of the group this address belongs to.
sec_settings_claimed_signing_time	Specifies the signing time from the signer's computer.
sec_settings_encrypt	Whether to encrypt the message.
sec_settings_encryption_algorithm	Specifies the encryption algorithm to be used.
sec_settings_hash_algorithm	Specifies the hash algorithm to be used.
sec_settings_sign	Whether to sign the message.
sec_settings_signature_format	Specifies the signature format to use for the signed message.
sec_settings_sign_before_encrypt	Specifies the order of encryption and signing operations.
sec_settings_sign_message_header	Specifies whether to include the message header in the signature calculation.
sender_addr_address	Contains the e-mail address in the form of john@doe.
sender_addr_display_name	Contains the friendly name of the user of this address, such as John Doe.
sender_addr_group_name	The name of the group this address belongs to.
send_to_addr_count	The number of records in the SendToAddr arrays.
send_to_addr_address	Contains the e-mail address in the form of john@doe.
send_to_addr_display_name	Contains the friendly name of the user of this address, such as John Doe.
send_to_addr_group_name	The name of the group this address belongs to.
signing_cert_bytes	Returns the raw certificate data in DER format.
signing_cert_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
signing_chain_count	The number of records in the SigningChain arrays.
signing_chain_bytes	Returns the raw certificate data in DER format.
signing_chain_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
text_encoding	The encoding to be applied to the message.

Method List

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


attach_bytes	Creates an attachment from a memory buffer.
attach_file	Creates an attachment from a file.
attach_image	Creates an image attachment from a memory buffer.
config	Sets or retrieves a configuration setting.
create_new	Creates a template for a new message.
do_action	Performs an additional action.
reset	Resets the struct settings.
save_to_bytes	Serializes the message to a byte array.
save_to_file	Serializes the message to a file.

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.


on_error	Reports information about errors during e-mail message assembling or saving.
on_external_sign	Handles remote or external signing initiated by the SignExternal method or other source.
on_notification	This event notifies the application about an underlying control flow event.

Config Settings

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


BitsInKey	Key length for the block cipher used for encryption. The value should be a multiple of 8.
IncludeSigningCertificate	If true (by default), the signing certificate is included into the signature. Otherwise, it is included only if SigningChain is not empty.
TempPath	Path for storing temporary files.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the struct.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
EnableSSHMLKEM	Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs.
EnableTLSMLKEM	Enables support for ML-KEM and hybrid groups in TLS client and server structs.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client structs created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client structs should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

attach_encoding property (MailWriter Struct)

The encoding to be applied to the attachments.

Syntax

fn attach_encoding(&self ) -> Result<i32, SecureBlackboxError> 
fn set_attach_encoding(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // Auto
1   // 8bit
2   // Base64
3   // QuotedPrintable

Default Value

Remarks

Use this property to specify the encoding method for the attached files.


meAuto	`0`
me8bit	`1`
meBase64	`2`
meQuotedPrintable	`3`

Data Type

i32

attach_count property (MailWriter Struct)

The number of records in the Attach arrays.

Syntax

fn attach_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_attach_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

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.

Data Type

i32

attach_content_subtype property (MailWriter Struct)

Contains the content subtype of the attachment.

Syntax

fn attach_content_subtype(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_content_subtype(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_content_subtype_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_content_type property (MailWriter Struct)

Contains the content type of the attachment.

Syntax

fn attach_content_type(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_content_type(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_content_type_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_creation_date property (MailWriter Struct)

The creation date.

Syntax

fn attach_creation_date(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_creation_date(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_creation_date_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_data property (MailWriter Struct)

The content of the attachment.

Syntax

fn attach_data(&self , AttachIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_attach_data(&self, AttachIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_attach_data_ref(&self, AttachIndex : i32, value : &[u8]) ->  Option<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.

Data Type

Vec

attach_description property (MailWriter Struct)

Textual description of the attachment.

Syntax

fn attach_description(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_description(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_description_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_file_name property (MailWriter Struct)

Specifies the name of the attachment file.

Syntax

fn attach_file_name(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_file_name(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_file_name_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_handle property (MailWriter 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> 
fn set_attach_handle(&self, AttachIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. 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.

Data Type

i64

attach_id property (MailWriter Struct)

Contains the attachment's unique identifier.

Syntax

fn attach_id(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_id(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_id_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_modification_date property (MailWriter Struct)

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

Syntax

fn attach_modification_date(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_modification_date(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_modification_date_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_read_date property (MailWriter Struct)

Specifies the file's last read date.

Syntax

fn attach_read_date(&self , AttachIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_attach_read_date(&self, AttachIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_attach_read_date_ref(&self, AttachIndex : i32, value : &String) ->  Option<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.

Data Type

String

attach_size property (MailWriter Struct)

The attachment's size in bytes.

Syntax

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

Default Value

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.

Data Type

i64

bcc_addr_count property (MailWriter Struct)

The number of records in the BccAddr arrays.

Syntax

fn bcc_addr_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_bcc_addr_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

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.

Data Type

i32

bcc_addr_address property (MailWriter Struct)

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

Syntax

fn bcc_addr_address(&self , BccAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_bcc_addr_address(&self, BccAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_bcc_addr_address_ref(&self, BccAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

bcc_addr_display_name property (MailWriter 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> 
fn set_bcc_addr_display_name(&self, BccAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_bcc_addr_display_name_ref(&self, BccAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

bcc_addr_group_name property (MailWriter Struct)

The name of the group this address belongs to.

Syntax

fn bcc_addr_group_name(&self , BccAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_bcc_addr_group_name(&self, BccAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_bcc_addr_group_name_ref(&self, BccAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

cc_addr_count property (MailWriter Struct)

The number of records in the CcAddr arrays.

Syntax

fn cc_addr_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_cc_addr_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

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.

Data Type

i32

cc_addr_address property (MailWriter Struct)

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

Syntax

fn cc_addr_address(&self , CcAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_cc_addr_address(&self, CcAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_cc_addr_address_ref(&self, CcAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

cc_addr_display_name property (MailWriter 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> 
fn set_cc_addr_display_name(&self, CcAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_cc_addr_display_name_ref(&self, CcAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

cc_addr_group_name property (MailWriter Struct)

The name of the group this address belongs to.

Syntax

fn cc_addr_group_name(&self , CcAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_cc_addr_group_name(&self, CcAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_cc_addr_group_name_ref(&self, CcAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

charset property (MailWriter Struct)

The charset to apply to Message .

Syntax

fn charset(&self ) -> Result<String, SecureBlackboxError> 
fn set_charset(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_charset_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

"utf-8"

Remarks

Use this property to specify the character set to use in the message.

Data Type

String

encryption_cert_count property (MailWriter Struct)

The number of records in the EncryptionCert arrays.

Syntax

fn encryption_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_encryption_cert_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

encryption_cert_bytes
encryption_cert_handle

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

Data Type

i32

encryption_cert_bytes property (MailWriter Struct)

Returns the raw certificate data in DER format.

Syntax

fn encryption_cert_bytes(&self , EncryptionCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns the raw certificate data in DER format.

The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is read-only.

Data Type

Vec

encryption_cert_handle property (MailWriter Struct)

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

Syntax

fn encryption_cert_handle(&self , EncryptionCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_encryption_cert_handle(&self, EncryptionCertIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

The EncryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

Data Type

i64

external_crypto_async_document_id property (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

Data Type

String

external_crypto_key_id property (MailWriter 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 (MailWriter 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 (MailWriter 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

Remarks

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Data Type

i32

external_crypto_mode property (MailWriter 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

Remarks

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

Data Type

i32

external_crypto_public_key_algorithm property (MailWriter 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.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Data Type

String

fips_mode property (MailWriter 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 (MailWriter Struct)

The number of records in the FromAddr arrays.

Syntax

fn from_addr_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_from_addr_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

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.

Data Type

i32

from_addr_address property (MailWriter Struct)

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

Syntax

fn from_addr_address(&self , FromAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_from_addr_address(&self, FromAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_from_addr_address_ref(&self, FromAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

from_addr_display_name property (MailWriter 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> 
fn set_from_addr_display_name(&self, FromAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_from_addr_display_name_ref(&self, FromAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

from_addr_group_name property (MailWriter Struct)

The name of the group this address belongs to.

Syntax

fn from_addr_group_name(&self , FromAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_from_addr_group_name(&self, FromAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_from_addr_group_name_ref(&self, FromAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

header_encoding property (MailWriter Struct)

The encoding to be applied to the message header.

Syntax

fn header_encoding(&self ) -> Result<i32, SecureBlackboxError> 
fn set_header_encoding(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // Auto
1   // 8bit
2   // Base64
3   // QuotedPrintable

Default Value

Remarks

Use this property to specify the encoding to use with the message header.


meAuto	`0`
me8bit	`1`
meBase64	`2`
meQuotedPrintable	`3`

Data Type

i32

mailer property (MailWriter Struct)

The name of the software used to compose and/or send the message.

Syntax

fn mailer(&self ) -> Result<String, SecureBlackboxError> 
fn set_mailer(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_mailer_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Use this property to specify the software that was used to compose and send this message.

Data Type

String

msg_attachment_count property (MailWriter Struct)

Returns the number of attachments in this message.

Syntax

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

Default Value

Remarks

Returns the number of attachments in this message.

This property is read-only.

Data Type

i32

msg_bcc property (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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

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.

Data Type

i64

msg_html_text property (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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

Remarks

Specifies the message priority.

Available options:


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

Data Type

i32

msg_read_receipt property (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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 (MailWriter 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

header_field_count property (MailWriter Struct)

The number of records in the HeaderField arrays.

Syntax

fn header_field_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_header_field_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

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.

Data Type

i32

header_field_category property (MailWriter Struct)

Specifies the string category of the contained value.

Syntax

fn header_field_category(&self , HeaderFieldIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_header_field_category(&self, HeaderFieldIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_header_field_category_ref(&self, HeaderFieldIndex : i32, value : &String) ->  Option<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.

Data Type

String

header_field_format property (MailWriter Struct)

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

Syntax

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

Default Value

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:


svfText	`0`	The property contains text
svfBinary	`1`	The property contains binary data. The Value property contains a hex encoding of it.

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

Data Type

i32

header_field_name property (MailWriter Struct)

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

Syntax

fn header_field_name(&self , HeaderFieldIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_header_field_name(&self, HeaderFieldIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_header_field_name_ref(&self, HeaderFieldIndex : i32, value : &String) ->  Option<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.

Data Type

String

header_field_value property (MailWriter Struct)

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

Syntax

fn header_field_value(&self , HeaderFieldIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_header_field_value(&self, HeaderFieldIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_header_field_value_ref(&self, HeaderFieldIndex : i32, value : &String) ->  Option<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.

Data Type

String

profile property (MailWriter 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

reply_to_addr_count property (MailWriter Struct)

The number of records in the ReplyToAddr arrays.

Syntax

fn reply_to_addr_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_reply_to_addr_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

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.

Data Type

i32

reply_to_addr_address property (MailWriter Struct)

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

Syntax

fn reply_to_addr_address(&self , ReplyToAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reply_to_addr_address(&self, ReplyToAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reply_to_addr_address_ref(&self, ReplyToAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

reply_to_addr_display_name property (MailWriter 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> 
fn set_reply_to_addr_display_name(&self, ReplyToAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reply_to_addr_display_name_ref(&self, ReplyToAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

reply_to_addr_group_name property (MailWriter Struct)

The name of the group this address belongs to.

Syntax

fn reply_to_addr_group_name(&self , ReplyToAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_reply_to_addr_group_name(&self, ReplyToAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_reply_to_addr_group_name_ref(&self, ReplyToAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

sec_settings_claimed_signing_time property (MailWriter Struct)

Specifies the signing time from the signer's computer.

Syntax

fn sec_settings_claimed_signing_time(&self ) -> Result<String, SecureBlackboxError> 
fn set_sec_settings_claimed_signing_time(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sec_settings_claimed_signing_time_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

Specifies the signing time from the signer's computer.

Use this property to specify the signature production time. The claimed time is not covered by the signature, may be forfeited or wrong, and as such is usually taken by verifiers for informational purposes only.

Data Type

String

sec_settings_encrypt property (MailWriter Struct)

Whether to encrypt the message.

Syntax

fn sec_settings_encrypt(&self ) -> Result<bool, SecureBlackboxError> 
fn set_sec_settings_encrypt(&self, value : bool) ->  Option<SecureBlackboxError>

Default Value

false

Remarks

Whether to encrypt the message.

Data Type

bool

sec_settings_encryption_algorithm property (MailWriter Struct)

Specifies the encryption algorithm to be used.

Syntax

fn sec_settings_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_sec_settings_encryption_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sec_settings_encryption_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

"AES128"

Remarks

Specifies the encryption algorithm to be used.


SB_SYMMETRIC_ALGORITHM_RC4	`RC4`
SB_SYMMETRIC_ALGORITHM_DES	`DES`
SB_SYMMETRIC_ALGORITHM_3DES	`3DES`
SB_SYMMETRIC_ALGORITHM_RC2	`RC2`
SB_SYMMETRIC_ALGORITHM_AES128	`AES128`
SB_SYMMETRIC_ALGORITHM_AES192	`AES192`
SB_SYMMETRIC_ALGORITHM_AES256	`AES256`
SB_SYMMETRIC_ALGORITHM_AES128_GCM	`AES128-GCM`
SB_SYMMETRIC_ALGORITHM_AES192_GCM	`AES192-GCM`
SB_SYMMETRIC_ALGORITHM_AES256_GCM	`AES256-GCM`

Data Type

String

sec_settings_hash_algorithm property (MailWriter Struct)

Specifies the hash algorithm to be used.

Syntax

fn sec_settings_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_sec_settings_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sec_settings_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

"SHA256"

Remarks

Specifies the hash algorithm to be used.


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`

Data Type

String

sec_settings_sign property (MailWriter Struct)

Whether to sign the message.

Syntax

fn sec_settings_sign(&self ) -> Result<bool, SecureBlackboxError> 
fn set_sec_settings_sign(&self, value : bool) ->  Option<SecureBlackboxError>

Default Value

false

Remarks

Whether to sign the message.

Data Type

bool

sec_settings_signature_format property (MailWriter Struct)

Specifies the signature format to use for the signed message.

Syntax

fn sec_settings_signature_format(&self ) -> Result<i32, SecureBlackboxError> 
fn set_sec_settings_signature_format(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // MultipartSigned
1   // SignedData

Default Value

Remarks

Specifies the signature format to use for the signed message.

Available options:


msMultipartSigned	`0`
msSignedData	`1`

Data Type

i32

sec_settings_sign_before_encrypt property (MailWriter Struct)

Specifies the order of encryption and signing operations.

Syntax

fn sec_settings_sign_before_encrypt(&self ) -> Result<bool, SecureBlackboxError> 
fn set_sec_settings_sign_before_encrypt(&self, value : bool) ->  Option<SecureBlackboxError>

Default Value

true

Remarks

Specifies the order of encryption and signing operations.

Data Type

bool

sec_settings_sign_message_header property (MailWriter Struct)

Specifies whether to include the message header in the signature calculation.

Syntax

fn sec_settings_sign_message_header(&self ) -> Result<bool, SecureBlackboxError> 
fn set_sec_settings_sign_message_header(&self, value : bool) ->  Option<SecureBlackboxError>

Default Value

false

Remarks

Specifies whether to include the message header in the signature calculation.

Data Type

bool

sender_addr_address property (MailWriter Struct)

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

Syntax

fn sender_addr_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_sender_addr_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sender_addr_address_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

Data Type

String

sender_addr_display_name property (MailWriter 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> 
fn set_sender_addr_display_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sender_addr_display_name_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

Data Type

String

sender_addr_group_name property (MailWriter Struct)

The name of the group this address belongs to.

Syntax

fn sender_addr_group_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_sender_addr_group_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_sender_addr_group_name_ref(&self, value : &String) ->  Option<SecureBlackboxError>

Default Value

Remarks

The name of the group this address belongs to.

Data Type

String

send_to_addr_count property (MailWriter Struct)

The number of records in the SendToAddr arrays.

Syntax

fn send_to_addr_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_send_to_addr_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

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.

Data Type

i32

send_to_addr_address property (MailWriter Struct)

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

Syntax

fn send_to_addr_address(&self , SendToAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_send_to_addr_address(&self, SendToAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_send_to_addr_address_ref(&self, SendToAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

send_to_addr_display_name property (MailWriter 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> 
fn set_send_to_addr_display_name(&self, SendToAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_send_to_addr_display_name_ref(&self, SendToAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

send_to_addr_group_name property (MailWriter Struct)

The name of the group this address belongs to.

Syntax

fn send_to_addr_group_name(&self , SendToAddrIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_send_to_addr_group_name(&self, SendToAddrIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_send_to_addr_group_name_ref(&self, SendToAddrIndex : i32, value : &String) ->  Option<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.

Data Type

String

signing_cert_bytes property (MailWriter 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_handle property (MailWriter 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> 
fn set_signing_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

Data Type

i64

signing_chain_count property (MailWriter Struct)

The number of records in the SigningChain arrays.

Syntax

fn signing_chain_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_signing_chain_count(&self, value : i32) ->  Option<SecureBlackboxError>

Default Value

Remarks

This property controls the size of the following arrays:

signing_chain_bytes
signing_chain_handle

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

Data Type

i32

signing_chain_bytes property (MailWriter Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only.

Data Type

Vec

signing_chain_handle property (MailWriter Struct)

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

Syntax

fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) ->  Option<SecureBlackboxError>

Default Value

Remarks

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

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

Data Type

i64

text_encoding property (MailWriter Struct)

The encoding to be applied to the message.

Syntax

fn text_encoding(&self ) -> Result<i32, SecureBlackboxError> 
fn set_text_encoding(&self, value : i32) ->  Option<SecureBlackboxError>

Possible Values

0   // Auto
1   // 8bit
2   // Base64
3   // QuotedPrintable

Default Value

Remarks

Use this property to specify the encoding to use for the content of the message.


meAuto	`0`
me8bit	`1`
meBase64	`2`
meQuotedPrintable	`3`

Data Type

i32

attach_bytes method (MailWriter Struct)

Creates an attachment from a memory buffer.

Syntax

fn attach_bytes(&self, data : &[u8]) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to create an attachment from a memory buffer. Use attachments property to provide further attachment details.

The method returns the index of the new attachment in the attachments list.

attach_file method (MailWriter Struct)

Creates an attachment from a file.

Syntax

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

Remarks

Use this method to create an attachment from a file. Use attachments property to provide further attachment details.

The method returns the index of the new attachment in the attachments list.

attach_image method (MailWriter Struct)

Creates an image attachment from a memory buffer.

Syntax

fn attach_image(&self, id : &str, data : &[u8]) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to create a picture attachment from a memory buffer. Use attachments property to provide further attachment details.

The method returns the index of the new attachment in the attachments list.

config method (MailWriter 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.

create_new method (MailWriter Struct)

Creates a template for a new message.

Syntax

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

Remarks

This method cleans up the current message and makes the component ready for new operation.

Use this method to create a fresh email message for further editing and saving.

do_action method (MailWriter 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:


Action	Parameters	Returned value	Description
ResetTrustedListCache	none	none	Clears the cached list of trusted lists.
ResetCertificateCache	none	none	Clears the cached certificates.
ResetCRLCache	none	none	Clears the cached CRLs.
ResetOCSPResponseCache	none	none	Clears the cached OCSP responses.

reset method (MailWriter Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

save_to_bytes method (MailWriter Struct)

Serializes the message to a byte array.

Syntax

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

Remarks

Use this method to assemble the message and save it to a byte array.

save_to_file method (MailWriter Struct)

Serializes the message to a file.

Syntax

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

Remarks

Use this method to assemble the message and save it to a file.

on_error event (MailWriter Struct)

Reports information about errors during e-mail message assembling or saving.

Syntax

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

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

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

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_sign event (MailWriter Struct)

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

Syntax

// MailWriterExternalSignEventArgs carries the MailWriter ExternalSign event's parameters.
pub struct MailWriterExternalSignEventArgs {
  fn operation_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn data(&self) -> &String
  fn signed_data(&self) -> &String
  fn set_signed_data(&self, value : &str)
  fn set_signed_data_ref(&self, value : &String)
}

// MailWriterExternalSignEvent defines the signature of the MailWriter ExternalSign event's handler function.
pub trait MailWriterExternalSignEvent {
  fn on_external_sign(&self, sender : MailWriter, e : &mut MailWriterExternalSignEventArgs);
}

impl <'a> MailWriter<'a> {
  pub fn on_external_sign(&self) -> &'a dyn MailWriterExternalSignEvent;
  pub fn set_on_external_sign(&mut self, value : &'a dyn MailWriterExternalSignEvent);
  ...
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the struct via the SignedData parameter.

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

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

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

on_notification event (MailWriter Struct)

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

Syntax

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

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

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

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.

Config Settings (MailWriter 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.

MailWriter Config Settings

BitsInKey: Key length for the block cipher used for encryption. The value should be a multiple of 8.

IncludeSigningCertificate: If true (by default), the signing certificate is included into the signature. Otherwise, it is included only if SigningChain is not empty.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except PDFSigner, where this limitation does not apply.

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the struct.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the struct.

Use this property to get cookies from the internal cookie storage of the struct and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

EnableSSHMLKEM: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.

Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

EnableTLSMLKEM: Enables support for ML-KEM and hybrid groups in TLS client and server components.

Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the structs that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy.

Supported Values:


auto	Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default).
enable	Always attempt to use hardware cryptography. If unavailable, exception will be thrown.
disable	Do not use hardware cryptography.

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other structs.

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:


certificate	Enables caching of certificates.
crl	Enables caching of Certificate Revocation Lists (CRLs).
ocsp	Enables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath: Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the struct. Works only if UseOwnDNSResolver is set to true.

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the struct) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character.

StaticIPAddresses: Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the struct is set to "local", the property returns/restores the rules from/to the internal storage of the struct. If StaticDNS of the struct is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup: Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the structs.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval: Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseCRLObjectCaching: Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching: Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

XMLRDNDescriptorName[OID]: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]: Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder: Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator: Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (MailWriter Struct)

MailWriter Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)
22020097	Failed to assemble the mail message (`SB_ERROR_MAIL_ASSEMBLY_FAILED`)
22020098	Failed to assemble the mail message (`SB_ERROR_MAIL_PARSING_FAILED`)
22020099	No decryption certificate found (`SB_ERROR_MAIL_NO_DECRYPTION_CERTIFICATE`)