MailWriter Class

Properties Methods Events Configuration Settings Errors

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

Syntax

class secureblackbox.MailWriter

Remarks

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

Property List

The following is the full list of the properties of the class 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	Contain 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_filename	Specifies the name of the attachment file.
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	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 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_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 public key algorithm here if the certificate is not available on the pre-signing stage.
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_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_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 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 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 class 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.
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 class 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.

Configuration Settings

The following is a list of configuration settings for the class 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.
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 class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
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.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.