SecureBlackbox 2020 Python Edition

Questions / Feedback?

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_encodingThe encoding to be applied to the attachments.
attach_countThe number of records in the Attach arrays.
attach_content_subtypeContains the content subtype of the attachment.
attach_content_typeContain the content type of the attachment.
attach_creation_dateThe creation date.
attach_dataThe content of the attachment.
attach_descriptionTextual description of the attachment.
attach_filenameSpecifies the name of the attachment file.
attach_idContains the attachment's unique identifier.
attach_modification_dateSpecifies the date and time of the file's last modification.
attach_read_dateSpecifies the file's last read date.
attach_sizeAttachment's size in bytes.
bcc_addr_countThe number of records in the BccAddr arrays.
bcc_addr_addressContains the e-mail address in the form of john@doe.
bcc_addr_display_nameContains the friendly name of the user of this address, such as John Doe.
bcc_addr_group_nameThe name of the group this address belongs to.
cc_addr_countThe number of records in the CcAddr arrays.
cc_addr_addressContains the e-mail address in the form of john@doe.
cc_addr_display_nameContains the friendly name of the user of this address, such as John Doe.
cc_addr_group_nameThe name of the group this address belongs to.
charsetThe charset to apply to Message .
encryption_cert_countThe number of records in the EncryptionCert arrays.
encryption_cert_bytesReturns raw certificate data in DER format.
encryption_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
external_crypto_custom_paramsCustom parameters to be passed to the signing service (uninterpreted).
external_crypto_dataAdditional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculationSpecifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithmSpecifies the request's signature hash algorithm.
external_crypto_key_idThe ID of the pre-shared key used for DC request authentication.
external_crypto_key_secretThe pre-shared key used for DC request authentication.
external_crypto_methodSpecifies the asynchronous signing method.
external_crypto_modeSpecifies the external cryptography mode.
external_crypto_public_key_algorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
from_addr_countThe number of records in the FromAddr arrays.
from_addr_addressContains the e-mail address in the form of john@doe.
from_addr_display_nameContains the friendly name of the user of this address, such as John Doe.
from_addr_group_nameThe name of the group this address belongs to.
header_encodingThe encoding to be applied to the message header.
mailerThe name of the software used to compose and/or send the message.
msg_attachment_countReturns the number of attachments in this message.
msg_bccThe contents of the BCC header property.
msg_ccThe value of the CC header property.
msg_commentsContains additional information about the message body.
msg_dateThe date and time when the message entered the mail delivery system.
msg_delivery_receiptEnables delivery notification.
msg_fromContains the value of the From header property.
msg_html_textThe HTML version of the message.
msg_idThe contents of the Message-ID header property.
msg_in_reply_toThe value of the In-Reply-To header property.
msg_keywordsThe value of the Keywords header property.
msg_mailerThe name of the software that was used to send the message.
msg_plain_textThe plain text version of the message.
msg_prioritySpecifies the message priority.
msg_read_receiptEnables a read notification.
msg_referencesThe value of the References header property.
msg_reply_toThe value of the Reply-To header property.
msg_return_pathThe value of the Return-Path header property.
msg_senderThe value of the Sender header property.
msg_send_toThe value of the To header property.
msg_subjectContains the subject property of this message.
header_field_countThe number of records in the HeaderField arrays.
header_field_nameThe name element in a (name, value) pair.
header_field_valueThe value element in a (name, value) pair.
profileSpecifies a pre-defined profile to apply when creating the signature.
reply_to_addr_countThe number of records in the ReplyToAddr arrays.
reply_to_addr_addressContains the e-mail address in the form of john@doe.
reply_to_addr_display_nameContains the friendly name of the user of this address, such as John Doe.
reply_to_addr_group_nameThe name of the group this address belongs to.
sec_settings_claimed_signing_timeSpecifies the signing time from the signer's computer.
sec_settings_encryptWhether to encrypt the message.
sec_settings_encryption_algorithmSpecifies the encryption algorithm to be used.
sec_settings_hash_algorithmSpecifies the hash algorithm to be used.
sec_settings_signWhether to sign the message.
sec_settings_signature_formatSpecifies the signature format to use for the signed message.
sec_settings_sign_before_encryptSpecifies the order of encryption and signing operations.
sec_settings_sign_message_headerSpecifies whether to include the message header in the signature calculation.
sender_addr_addressContains the e-mail address in the form of john@doe.
sender_addr_display_nameContains the friendly name of the user of this address, such as John Doe.
sender_addr_group_nameThe name of the group this address belongs to.
send_to_addr_countThe number of records in the SendToAddr arrays.
send_to_addr_addressContains the e-mail address in the form of john@doe.
send_to_addr_display_nameContains the friendly name of the user of this address, such as John Doe.
send_to_addr_group_nameThe name of the group this address belongs to.
signing_cert_bytesReturns raw certificate data in DER format.
signing_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
signing_chain_countThe number of records in the SigningChain arrays.
signing_chain_bytesReturns raw certificate data in DER format.
signing_chain_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
text_encodingThe 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_bytesCreates an attachment from a memory buffer.
attach_fileCreates an attachment from a file.
attach_imageCreates an image attachment from a memory buffer.
configSets or retrieves a configuration setting.
save_to_bytesSerializes the message to a byte array.
save_to_fileSerializes 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_errorReports information about errors during e-mail message assembling or saving.
on_external_signHandles remote or external signing initiated by the SignExternal method or other source.
on_notificationThis 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.

BitsInKeyKey length for the block cipher used for encryption. The value should be a multiple of 8.
IncludeSigningCertificateIf true (by default), the signing certificate is included into the signature. Otherwise, it is included only if SigningChain is not empty.
TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Python Edition - Version 20.0 [Build 8165]