SecureBlackbox 2020 Java Edition

Questions / Feedback?

MailWriter Class

Properties   Methods   Events   Configuration Settings   Errors  

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




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.

AttachEncodingThe encoding to be applied to the attachments.
AttachmentsContains a list of attachments to the message.
BccThe BCC header of the Message.
CcThe CC header of the Message.
CharsetThe charset to apply to Message .
EncryptionCertificatesThe recipients' encryption certificates.
ExternalCryptoProvides access to external signing and DC parameters.
FromThe From header of the Message.
HeaderEncodingThe encoding to be applied to the message header.
MailerThe name of the software used to compose and/or send the message.
MessageThe message that is currently being composed.
OtherHeadersProvides access to secondary message headers.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
ReplyToThe value of the Reply-To header field of the Message.
SecuritySettingsA container for the message's security settings.
SenderThe value of the Sender header field of the Message.
SendToThe value of the To header field of the Message.
SigningCertificateThe certificate to be used for signing.
SigningChainThe signing certificate chain.
TextEncodingThe 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.

AttachBytesCreates an attachment from a memory buffer.
AttachFileCreates an attachment from a file.
AttachImageCreates an image attachment from a memory buffer.
ConfigSets or retrieves a configuration setting.
SaveToBytesSerializes the message to a byte array.
SaveToFileSerializes the message to a file.
SaveToStreamSerializes the message to a stream.

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.

ErrorReports information about errors during e-mail message assembling or saving.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
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 Java Edition - Version 20.0 [Build 8165]