MailWriter Class
Properties Methods Events Configuration Settings Errors
The MailWriter class composes, encrypts, and signs e-mail messages.
Syntax
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.
AttachEncoding | The encoding to be applied to the attachments. |
AttachCount | The number of records in the Attach arrays. |
AttachContentSubtype | Contains the content subtype of the attachment. |
AttachContentType | Contain the content type of the attachment. |
AttachCreationDate | The creation date. |
AttachData | The content of the attachment. |
AttachDescription | Textual description of the attachment. |
AttachFilename | Specifies the name of the attachment file. |
AttachID | Contains the attachment's unique identifier. |
AttachModificationDate | Specifies the date and time of the file's last modification. |
AttachReadDate | Specifies the file's last read date. |
AttachSize | Attachment's size in bytes. |
BccAddrCount | The number of records in the BccAddr arrays. |
BccAddrAddress | Contains the e-mail address in the form of john@doe. |
BccAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
BccAddrGroupName | The name of the group this address belongs to. |
CcAddrCount | The number of records in the CcAddr arrays. |
CcAddrAddress | Contains the e-mail address in the form of john@doe. |
CcAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
CcAddrGroupName | The name of the group this address belongs to. |
Charset | The charset to apply to Message . |
EncryptionCertCount | The number of records in the EncryptionCert arrays. |
EncryptionCertBytes | Returns raw certificate data in DER format. |
EncryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
FromAddrCount | The number of records in the FromAddr arrays. |
FromAddrAddress | Contains the e-mail address in the form of john@doe. |
FromAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
FromAddrGroupName | The name of the group this address belongs to. |
HeaderEncoding | The encoding to be applied to the message header. |
Mailer | The name of the software used to compose and/or send the message. |
MsgAttachmentCount | Returns the number of attachments in this message. |
MsgBcc | The contents of the BCC header property. |
MsgCc | The value of the CC header property. |
MsgComments | Contains additional information about the message body. |
MsgDate | The date and time when the message entered the mail delivery system. |
MsgDeliveryReceipt | Enables delivery notification. |
MsgFrom | Contains the value of the From header property. |
MsgHtmlText | The HTML version of the message. |
MsgID | The contents of the Message-ID header property. |
MsgInReplyTo | The value of the In-Reply-To header property. |
MsgKeywords | The value of the Keywords header property. |
MsgMailer | The name of the software that was used to send the message. |
MsgPlainText | The plain text version of the message. |
MsgPriority | Specifies the message priority. |
MsgReadReceipt | Enables a read notification. |
MsgReferences | The value of the References header property. |
MsgReplyTo | The value of the Reply-To header property. |
MsgReturnPath | The value of the Return-Path header property. |
MsgSender | The value of the Sender header property. |
MsgSendTo | The value of the To header property. |
MsgSubject | Contains the subject property of this message. |
HeaderFieldCount | The number of records in the HeaderField arrays. |
HeaderFieldName | The name element in a (name, value) pair. |
HeaderFieldValue | The value element in a (name, value) pair. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
ReplyToAddrCount | The number of records in the ReplyToAddr arrays. |
ReplyToAddrAddress | Contains the e-mail address in the form of john@doe. |
ReplyToAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
ReplyToAddrGroupName | The name of the group this address belongs to. |
SecSettingsClaimedSigningTime | Specifies the signing time from the signer's computer. |
SecSettingsEncrypt | Whether to encrypt the message. |
SecSettingsEncryptionAlgorithm | Specifies the encryption algorithm to be used. |
SecSettingsHashAlgorithm | Specifies the hash algorithm to be used. |
SecSettingsSign | Whether to sign the message. |
SecSettingsSignatureFormat | Specifies the signature format to use for the signed message. |
SecSettingsSignBeforeEncrypt | Specifies the order of encryption and signing operations. |
SecSettingsSignMessageHeader | Specifies whether to include the message header in the signature calculation. |
SenderAddrAddress | Contains the e-mail address in the form of john@doe. |
SenderAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
SenderAddrGroupName | The name of the group this address belongs to. |
SendToAddrCount | The number of records in the SendToAddr arrays. |
SendToAddrAddress | Contains the e-mail address in the form of john@doe. |
SendToAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
SendToAddrGroupName | The name of the group this address belongs to. |
SigningCertBytes | Returns raw certificate data in DER format. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningChainCount | The number of records in the SigningChain arrays. |
SigningChainBytes | Returns raw certificate data in DER format. |
SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TextEncoding | 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.
AttachBytes | Creates an attachment from a memory buffer. |
AttachFile | Creates an attachment from a file. |
AttachImage | Creates an image attachment from a memory buffer. |
Config | Sets or retrieves a configuration setting. |
SaveToBytes | Serializes the message to a byte array. |
SaveToFile | 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.
Error | Reports information about errors during e-mail message assembling or saving. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
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. |