MailWriter Component

Properties Methods Events Config Settings Errors

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

Syntax

TsbxMailWriter

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");

Property List

The following is the full list of the properties of the component 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	Contains 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.
AttachHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
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	The 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 the raw certificate data in DER format.
EncryptionCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ExternalCryptoAsyncDocumentID	Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
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 the public key algorithm here if the certificate is not available on the pre-signing stage.
FIPSMode	Reserved.
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.
MsgHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
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.
HeaderFieldCategory	Specifies the string category of the contained value.
HeaderFieldFormat	Specifies the format (encoding) of the value contained in the Value property.
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 the 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 the 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 component 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.
CreateNew	Creates a template for a new message.
DoAction	Performs an additional action.
Reset	Resets the component settings.
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 component 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.

Config Settings

The following is a list of config settings for the component 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 component.
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.
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 components 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 components 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.

AttachEncoding Property (MailWriter Component)

The encoding to be applied to the attachments.

Syntax

__property TsbxMailWriterAttachEncodings AttachEncoding = { read=FAttachEncoding, write=FSetAttachEncoding };

enum TsbxMailWriterAttachEncodings {
  meAuto=0,
  me8bit=1,
  meBase64=2,
  meQuotedPrintable=3
};

Default Value

meAuto

Remarks

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


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

Data Type

Integer

AttachCount Property (MailWriter Component)

The number of records in the Attach arrays.

Syntax

__property int AttachCount = { read=FAttachCount, write=FSetAttachCount };

Default Value

Remarks

This property controls the size of the following arrays:

AttachContentSubtype
AttachContentType
AttachCreationDate
AttachData
AttachDescription
AttachFileName
AttachHandle
AttachID
AttachModificationDate
AttachReadDate
AttachSize

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

This property is not available at design time.

Data Type

Integer

AttachContentSubtype Property (MailWriter Component)

Contains the content subtype of the attachment.

Syntax

__property String AttachContentSubtype[int AttachIndex] = { read=FAttachContentSubtype, write=FSetAttachContentSubtype };

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.

This property is not available at design time.

Data Type

String

AttachContentType Property (MailWriter Component)

Contains the content type of the attachment.

Syntax

__property String AttachContentType[int AttachIndex] = { read=FAttachContentType, write=FSetAttachContentType };

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.

This property is not available at design time.

Data Type

String

AttachCreationDate Property (MailWriter Component)

The creation date.

Syntax

__property String AttachCreationDate[int AttachIndex] = { read=FAttachCreationDate, write=FSetAttachCreationDate };

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.

This property is not available at design time.

Data Type

String

AttachData Property (MailWriter Component)

The content of the attachment.

Syntax

__property DynamicArray AttachData[int AttachIndex] = { read=FAttachData, write=FSetAttachData };

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.

This property is not available at design time.

Data Type

Byte Array

AttachDescription Property (MailWriter Component)

Textual description of the attachment.

Syntax

__property String AttachDescription[int AttachIndex] = { read=FAttachDescription, write=FSetAttachDescription };

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.

This property is not available at design time.

Data Type

String

AttachFileName Property (MailWriter Component)

Specifies the name of the attachment file.

Syntax

__property String AttachFileName[int AttachIndex] = { read=FAttachFileName, write=FSetAttachFileName };

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.

This property is not available at design time.

Data Type

String

AttachHandle Property (MailWriter Component)

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

Syntax

__property __int64 AttachHandle[int AttachIndex] = { read=FAttachHandle, write=FSetAttachHandle };

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.

This property is not available at design time.

Data Type

Long64

AttachID Property (MailWriter Component)

Contains the attachment's unique identifier.

Syntax

__property String AttachID[int AttachIndex] = { read=FAttachID, write=FSetAttachID };

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.

This property is not available at design time.

Data Type

String

AttachModificationDate Property (MailWriter Component)

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

Syntax

__property String AttachModificationDate[int AttachIndex] = { read=FAttachModificationDate, write=FSetAttachModificationDate };

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.

This property is not available at design time.

Data Type

String

AttachReadDate Property (MailWriter Component)

Specifies the file's last read date.

Syntax

__property String AttachReadDate[int AttachIndex] = { read=FAttachReadDate, write=FSetAttachReadDate };

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.

This property is not available at design time.

Data Type

String

AttachSize Property (MailWriter Component)

The attachment's size in bytes.

Syntax

__property __int64 AttachSize[int AttachIndex] = { read=FAttachSize, write=FSetAttachSize };

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.

This property is not available at design time.

Data Type

Long64

BccAddrCount Property (MailWriter Component)

The number of records in the BccAddr arrays.

Syntax

__property int BccAddrCount = { read=FBccAddrCount, write=FSetBccAddrCount };

Default Value

Remarks

This property controls the size of the following arrays:

BccAddrAddress
BccAddrDisplayName
BccAddrGroupName

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

This property is not available at design time.

Data Type

Integer

BccAddrAddress Property (MailWriter Component)

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

Syntax

__property String BccAddrAddress[int BccAddrIndex] = { read=FBccAddrAddress, write=FSetBccAddrAddress };

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.

This property is not available at design time.

Data Type

String

BccAddrDisplayName Property (MailWriter Component)

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

Syntax

__property String BccAddrDisplayName[int BccAddrIndex] = { read=FBccAddrDisplayName, write=FSetBccAddrDisplayName };

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.

This property is not available at design time.

Data Type

String

BccAddrGroupName Property (MailWriter Component)

The name of the group this address belongs to.

Syntax

__property String BccAddrGroupName[int BccAddrIndex] = { read=FBccAddrGroupName, write=FSetBccAddrGroupName };

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.

This property is not available at design time.

Data Type

String

CcAddrCount Property (MailWriter Component)

The number of records in the CcAddr arrays.

Syntax

__property int CcAddrCount = { read=FCcAddrCount, write=FSetCcAddrCount };

Default Value

Remarks

This property controls the size of the following arrays:

CcAddrAddress
CcAddrDisplayName
CcAddrGroupName

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

This property is not available at design time.

Data Type

Integer

CcAddrAddress Property (MailWriter Component)

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

Syntax

__property String CcAddrAddress[int CcAddrIndex] = { read=FCcAddrAddress, write=FSetCcAddrAddress };

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.

This property is not available at design time.

Data Type

String

CcAddrDisplayName Property (MailWriter Component)

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

Syntax

__property String CcAddrDisplayName[int CcAddrIndex] = { read=FCcAddrDisplayName, write=FSetCcAddrDisplayName };

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.

This property is not available at design time.

Data Type

String

CcAddrGroupName Property (MailWriter Component)

The name of the group this address belongs to.

Syntax

__property String CcAddrGroupName[int CcAddrIndex] = { read=FCcAddrGroupName, write=FSetCcAddrGroupName };

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.

This property is not available at design time.

Data Type

String

Charset Property (MailWriter Component)

The charset to apply to Message .

Syntax

__property String Charset = { read=FCharset, write=FSetCharset };

Default Value

"utf-8"

Remarks

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

Data Type

String

EncryptionCertCount Property (MailWriter Component)

The number of records in the EncryptionCert arrays.

Syntax

__property int EncryptionCertCount = { read=FEncryptionCertCount, write=FSetEncryptionCertCount };

Default Value

Remarks

This property controls the size of the following arrays:

EncryptionCertBytes
EncryptionCertHandle

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

This property is not available at design time.

Data Type

Integer

EncryptionCertBytes Property (MailWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray EncryptionCertBytes[int EncryptionCertIndex] = { read=FEncryptionCertBytes };

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 and not available at design time.

Data Type

Byte Array

EncryptionCertHandle Property (MailWriter Component)

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

Syntax

__property __int64 EncryptionCertHandle[int EncryptionCertIndex] = { read=FEncryptionCertHandle, write=FSetEncryptionCertHandle };

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.

This property is not available at design time.

Data Type

Long64

ExternalCryptoAsyncDocumentID Property (MailWriter Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

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

ExternalCryptoCustomParams Property (MailWriter Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (MailWriter Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (MailWriter Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

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 component.

If set to true, the component 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

Boolean

ExternalCryptoHashAlgorithm Property (MailWriter Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

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

ExternalCryptoKeyID Property (MailWriter Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

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 ExternalCryptoKeySecret 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

ExternalCryptoKeySecret Property (MailWriter Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

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 ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (MailWriter Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxMailWriterExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxMailWriterExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

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

Integer

ExternalCryptoMode Property (MailWriter Component)

Specifies the external cryptography mode.

Syntax

__property TsbxMailWriterExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxMailWriterExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

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`)

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (MailWriter Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

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`

Data Type

String

FIPSMode Property (MailWriter Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

FromAddrCount Property (MailWriter Component)

The number of records in the FromAddr arrays.

Syntax

__property int FromAddrCount = { read=FFromAddrCount, write=FSetFromAddrCount };

Default Value

Remarks

This property controls the size of the following arrays:

FromAddrAddress
FromAddrDisplayName
FromAddrGroupName

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

This property is not available at design time.

Data Type

Integer

FromAddrAddress Property (MailWriter Component)

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

Syntax

__property String FromAddrAddress[int FromAddrIndex] = { read=FFromAddrAddress, write=FSetFromAddrAddress };

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.

This property is not available at design time.

Data Type

String

FromAddrDisplayName Property (MailWriter Component)

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

Syntax

__property String FromAddrDisplayName[int FromAddrIndex] = { read=FFromAddrDisplayName, write=FSetFromAddrDisplayName };

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.

This property is not available at design time.

Data Type

String

FromAddrGroupName Property (MailWriter Component)

The name of the group this address belongs to.

Syntax

__property String FromAddrGroupName[int FromAddrIndex] = { read=FFromAddrGroupName, write=FSetFromAddrGroupName };

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.

This property is not available at design time.

Data Type

String

HeaderEncoding Property (MailWriter Component)

The encoding to be applied to the message header.

Syntax

__property TsbxMailWriterHeaderEncodings HeaderEncoding = { read=FHeaderEncoding, write=FSetHeaderEncoding };

enum TsbxMailWriterHeaderEncodings {
  meAuto=0,
  me8bit=1,
  meBase64=2,
  meQuotedPrintable=3
};

Default Value

meAuto

Remarks

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


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

Data Type

Integer

Mailer Property (MailWriter Component)

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

Syntax

__property String Mailer = { read=FMailer, write=FSetMailer };

Default Value

Remarks

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

Data Type

String

MsgAttachmentCount Property (MailWriter Component)

Returns the number of attachments in this message.

Syntax

__property int MsgAttachmentCount = { read=FMsgAttachmentCount };

Default Value

Remarks

Returns the number of attachments in this message.

This property is read-only and not available at design time.

Data Type

Integer

MsgBcc Property (MailWriter Component)

The contents of the BCC header property.

Syntax

__property String MsgBcc = { read=FMsgBcc, write=FSetMsgBcc };

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.

This property is not available at design time.

Data Type

String

MsgCc Property (MailWriter Component)

The value of the CC header property.

Syntax

__property String MsgCc = { read=FMsgCc, write=FSetMsgCc };

Default Value

Remarks

The value of the CC header field.

The CC field contains the addresses of secondary recipients of the message.

This property is not available at design time.

Data Type

String

MsgComments Property (MailWriter Component)

Contains additional information about the message body.

Syntax

__property String MsgComments = { read=FMsgComments, write=FSetMsgComments };

Default Value

Remarks

Contains additional information about the message body.

This property is not available at design time.

Data Type

String

MsgDate Property (MailWriter Component)

The date and time when the message entered the mail delivery system.

Syntax

__property String MsgDate = { read=FMsgDate, write=FSetMsgDate };

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.

This property is not available at design time.

Data Type

String

MsgDeliveryReceipt Property (MailWriter Component)

Enables delivery notification.

Syntax

__property bool MsgDeliveryReceipt = { read=FMsgDeliveryReceipt, write=FSetMsgDeliveryReceipt };

Default Value

false

Remarks

Enables delivery notification.

This property is not available at design time.

Data Type

Boolean

MsgFrom Property (MailWriter Component)

Contains the value of the From header property.

Syntax

__property String MsgFrom = { read=FMsgFrom, write=FSetMsgFrom };

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 MsgSender to specify the sender separately.

This property is not available at design time.

Data Type

String

MsgHandle Property (MailWriter Component)

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

Syntax

__property __int64 MsgHandle = { read=FMsgHandle, write=FSetMsgHandle };

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.

This property is not available at design time.

Data Type

Long64

MsgHtmlText Property (MailWriter Component)

The HTML version of the message.

Syntax

__property String MsgHtmlText = { read=FMsgHtmlText, write=FSetMsgHtmlText };

Default Value

Remarks

The HTML version of the message.

This property is not available at design time.

Data Type

String

MsgID Property (MailWriter Component)

The contents of the Message-ID header property.

Syntax

__property String MsgID = { read=FMsgID, write=FSetMsgID };

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.

This property is not available at design time.

Data Type

String

MsgInReplyTo Property (MailWriter Component)

The value of the In-Reply-To header property.

Syntax

__property String MsgInReplyTo = { read=FMsgInReplyTo, write=FSetMsgInReplyTo };

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.

This property is not available at design time.

Data Type

String

MsgKeywords Property (MailWriter Component)

The value of the Keywords header property.

Syntax

__property String MsgKeywords = { read=FMsgKeywords, write=FSetMsgKeywords };

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.

This property is not available at design time.

Data Type

String

MsgMailer Property (MailWriter Component)

The name of the software that was used to send the message.

Syntax

__property String MsgMailer = { read=FMsgMailer };

Default Value

Remarks

The name of the software that was used to send the message.

This property is read-only and not available at design time.

Data Type

String

MsgPlainText Property (MailWriter Component)

The plain text version of the message.

Syntax

__property String MsgPlainText = { read=FMsgPlainText, write=FSetMsgPlainText };

Default Value

Remarks

The plain text version of the message.

This property is not available at design time.

Data Type

String

MsgPriority Property (MailWriter Component)

Specifies the message priority.

Syntax

__property TsbxMailWriterMsgPriorities MsgPriority = { read=FMsgPriority, write=FSetMsgPriority };

enum TsbxMailWriterMsgPriorities {
  mpLowest=0,
  mpLow=1,
  mpNormal=2,
  mpHigh=3,
  mpHighest=4
};

Default Value

mpNormal

Remarks

Specifies the message priority.

Available options:


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

This property is not available at design time.

Data Type

Integer

MsgReadReceipt Property (MailWriter Component)

Enables a read notification.

Syntax

__property bool MsgReadReceipt = { read=FMsgReadReceipt, write=FSetMsgReadReceipt };

Default Value

false

Remarks

Enables a read notification.

This property is not available at design time.

Data Type

Boolean

MsgReferences Property (MailWriter Component)

The value of the References header property.

Syntax

__property String MsgReferences = { read=FMsgReferences, write=FSetMsgReferences };

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.

This property is not available at design time.

Data Type

String

MsgReplyTo Property (MailWriter Component)

The value of the Reply-To header property.

Syntax

__property String MsgReplyTo = { read=FMsgReplyTo, write=FSetMsgReplyTo };

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 MsgFrom field.

This property is not available at design time.

Data Type

String

MsgReturnPath Property (MailWriter Component)

The value of the Return-Path header property.

Syntax

__property String MsgReturnPath = { read=FMsgReturnPath, write=FSetMsgReturnPath };

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.

This property is not available at design time.

Data Type

String

MsgSender Property (MailWriter Component)

The value of the Sender header property.

Syntax

__property String MsgSender = { read=FMsgSender, write=FSetMsgSender };

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.

This property is not available at design time.

Data Type

String

MsgSendTo Property (MailWriter Component)

The value of the To header property.

Syntax

__property String MsgSendTo = { read=FMsgSendTo, write=FSetMsgSendTo };

Default Value

Remarks

The value of the To header field.

This field specifies the address(es) of the primary recipient(s) of the message.

This property is not available at design time.

Data Type

String

MsgSubject Property (MailWriter Component)

Contains the subject property of this message.

Syntax

__property String MsgSubject = { read=FMsgSubject, write=FSetMsgSubject };

Default Value

Remarks

Contains the subject field of this message.

This property is not available at design time.

Data Type

String

HeaderFieldCount Property (MailWriter Component)

The number of records in the HeaderField arrays.

Syntax

__property int HeaderFieldCount = { read=FHeaderFieldCount, write=FSetHeaderFieldCount };

Default Value

Remarks

This property controls the size of the following arrays:

HeaderFieldCategory
HeaderFieldFormat
HeaderFieldName
HeaderFieldValue

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

This property is not available at design time.

Data Type

Integer

HeaderFieldCategory Property (MailWriter Component)

Specifies the string category of the contained value.

Syntax

__property String HeaderFieldCategory[int HeaderFieldIndex] = { read=FHeaderFieldCategory, write=FSetHeaderFieldCategory };

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.

This property is not available at design time.

Data Type

String

HeaderFieldFormat Property (MailWriter Component)

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

Syntax

__property int HeaderFieldFormat[int HeaderFieldIndex] = { read=FHeaderFieldFormat, write=FSetHeaderFieldFormat };

Default Value

Remarks

Specifies the format (encoding) of the value contained in the HeaderFieldValue 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.

This property is not available at design time.

Data Type

Integer

HeaderFieldName Property (MailWriter Component)

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

Syntax

__property String HeaderFieldName[int HeaderFieldIndex] = { read=FHeaderFieldName, write=FSetHeaderFieldName };

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.

This property is not available at design time.

Data Type

String

HeaderFieldValue Property (MailWriter Component)

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

Syntax

__property String HeaderFieldValue[int HeaderFieldIndex] = { read=FHeaderFieldValue, write=FSetHeaderFieldValue };

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.

This property is not available at design time.

Data Type

String

Profile Property (MailWriter Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

__property String Profile = { read=FProfile, write=FSetProfile };

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

ReplyToAddrCount Property (MailWriter Component)

The number of records in the ReplyToAddr arrays.

Syntax

__property int ReplyToAddrCount = { read=FReplyToAddrCount, write=FSetReplyToAddrCount };

Default Value

Remarks

This property controls the size of the following arrays:

ReplyToAddrAddress
ReplyToAddrDisplayName
ReplyToAddrGroupName

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

This property is not available at design time.

Data Type

Integer

ReplyToAddrAddress Property (MailWriter Component)

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

Syntax

__property String ReplyToAddrAddress[int ReplyToAddrIndex] = { read=FReplyToAddrAddress, write=FSetReplyToAddrAddress };

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.

This property is not available at design time.

Data Type

String

ReplyToAddrDisplayName Property (MailWriter Component)

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

Syntax

__property String ReplyToAddrDisplayName[int ReplyToAddrIndex] = { read=FReplyToAddrDisplayName, write=FSetReplyToAddrDisplayName };

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.

This property is not available at design time.

Data Type

String

ReplyToAddrGroupName Property (MailWriter Component)

The name of the group this address belongs to.

Syntax

__property String ReplyToAddrGroupName[int ReplyToAddrIndex] = { read=FReplyToAddrGroupName, write=FSetReplyToAddrGroupName };

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.

This property is not available at design time.

Data Type

String

SecSettingsClaimedSigningTime Property (MailWriter Component)

Specifies the signing time from the signer's computer.

Syntax

__property String SecSettingsClaimedSigningTime = { read=FSecSettingsClaimedSigningTime, write=FSetSecSettingsClaimedSigningTime };

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

SecSettingsEncrypt Property (MailWriter Component)

Whether to encrypt the message.

Syntax

__property bool SecSettingsEncrypt = { read=FSecSettingsEncrypt, write=FSetSecSettingsEncrypt };

Default Value

false

Remarks

Whether to encrypt the message.

Data Type

Boolean

SecSettingsEncryptionAlgorithm Property (MailWriter Component)

Specifies the encryption algorithm to be used.

Syntax

__property String SecSettingsEncryptionAlgorithm = { read=FSecSettingsEncryptionAlgorithm, write=FSetSecSettingsEncryptionAlgorithm };

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

SecSettingsHashAlgorithm Property (MailWriter Component)

Specifies the hash algorithm to be used.

Syntax

__property String SecSettingsHashAlgorithm = { read=FSecSettingsHashAlgorithm, write=FSetSecSettingsHashAlgorithm };

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

SecSettingsSign Property (MailWriter Component)

Whether to sign the message.

Syntax

__property bool SecSettingsSign = { read=FSecSettingsSign, write=FSetSecSettingsSign };

Default Value

false

Remarks

Whether to sign the message.

Data Type

Boolean

SecSettingsSignatureFormat Property (MailWriter Component)

Specifies the signature format to use for the signed message.

Syntax

__property TsbxMailWriterSecSettingsSignatureFormats SecSettingsSignatureFormat = { read=FSecSettingsSignatureFormat, write=FSetSecSettingsSignatureFormat };

enum TsbxMailWriterSecSettingsSignatureFormats {
  msMultipartSigned=0,
  msSignedData=1
};

Default Value

msMultipartSigned

Remarks

Specifies the signature format to use for the signed message.

Available options:


msMultipartSigned	`0`
msSignedData	`1`

Data Type

Integer

SecSettingsSignBeforeEncrypt Property (MailWriter Component)

Specifies the order of encryption and signing operations.

Syntax

__property bool SecSettingsSignBeforeEncrypt = { read=FSecSettingsSignBeforeEncrypt, write=FSetSecSettingsSignBeforeEncrypt };

Default Value

true

Remarks

Specifies the order of encryption and signing operations.

Data Type

Boolean

SecSettingsSignMessageHeader Property (MailWriter Component)

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

Syntax

__property bool SecSettingsSignMessageHeader = { read=FSecSettingsSignMessageHeader, write=FSetSecSettingsSignMessageHeader };

Default Value

false

Remarks

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

Data Type

Boolean

SenderAddrAddress Property (MailWriter Component)

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

Syntax

__property String SenderAddrAddress = { read=FSenderAddrAddress, write=FSetSenderAddrAddress };

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

SenderAddrDisplayName Property (MailWriter Component)

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

Syntax

__property String SenderAddrDisplayName = { read=FSenderAddrDisplayName, write=FSetSenderAddrDisplayName };

Default Value

Remarks

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

This property is not available at design time.

Data Type

String

SenderAddrGroupName Property (MailWriter Component)

The name of the group this address belongs to.

Syntax

__property String SenderAddrGroupName = { read=FSenderAddrGroupName, write=FSetSenderAddrGroupName };

Default Value

Remarks

The name of the group this address belongs to.

This property is not available at design time.

Data Type

String

SendToAddrCount Property (MailWriter Component)

The number of records in the SendToAddr arrays.

Syntax

__property int SendToAddrCount = { read=FSendToAddrCount, write=FSetSendToAddrCount };

Default Value

Remarks

This property controls the size of the following arrays:

SendToAddrAddress
SendToAddrDisplayName
SendToAddrGroupName

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

This property is not available at design time.

Data Type

Integer

SendToAddrAddress Property (MailWriter Component)

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

Syntax

__property String SendToAddrAddress[int SendToAddrIndex] = { read=FSendToAddrAddress, write=FSetSendToAddrAddress };

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.

This property is not available at design time.

Data Type

String

SendToAddrDisplayName Property (MailWriter Component)

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

Syntax

__property String SendToAddrDisplayName[int SendToAddrIndex] = { read=FSendToAddrDisplayName, write=FSetSendToAddrDisplayName };

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.

This property is not available at design time.

Data Type

String

SendToAddrGroupName Property (MailWriter Component)

The name of the group this address belongs to.

Syntax

__property String SendToAddrGroupName[int SendToAddrIndex] = { read=FSendToAddrGroupName, write=FSetSendToAddrGroupName };

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.

This property is not available at design time.

Data Type

String

SigningCertBytes Property (MailWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertHandle Property (MailWriter Component)

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

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle, write=FSetSigningCertHandle };

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.

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (MailWriter Component)

The number of records in the SigningChain arrays.

Syntax

__property int SigningChainCount = { read=FSigningChainCount, write=FSetSigningChainCount };

Default Value

Remarks

This property controls the size of the following arrays:

SigningChainBytes
SigningChainHandle

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

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (MailWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningChainBytes[int SigningChainIndex] = { read=FSigningChainBytes };

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 and not available at design time.

Data Type

Byte Array

SigningChainHandle Property (MailWriter Component)

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

Syntax

__property __int64 SigningChainHandle[int SigningChainIndex] = { read=FSigningChainHandle, write=FSetSigningChainHandle };

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.

This property is not available at design time.

Data Type

Long64

TextEncoding Property (MailWriter Component)

The encoding to be applied to the message.

Syntax

__property TsbxMailWriterTextEncodings TextEncoding = { read=FTextEncoding, write=FSetTextEncoding };

enum TsbxMailWriterTextEncodings {
  meAuto=0,
  me8bit=1,
  meBase64=2,
  meQuotedPrintable=3
};

Default Value

meAuto

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

Integer

AttachBytes Method (MailWriter Component)

Creates an attachment from a memory buffer.

Syntax

int __fastcall AttachBytes(DynamicArray<Byte> Data);

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.

AttachFile Method (MailWriter Component)

Creates an attachment from a file.

Syntax

int __fastcall AttachFile(String FileName);

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.

AttachImage Method (MailWriter Component)

Creates an image attachment from a memory buffer.

Syntax

int __fastcall AttachImage(String ID, DynamicArray<Byte> Data);

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 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

CreateNew Method (MailWriter Component)

Creates a template for a new message.

Syntax

void __fastcall CreateNew();

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.

DoAction Method (MailWriter Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. 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 Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

SaveToBytes Method (MailWriter Component)

Serializes the message to a byte array.

Syntax

DynamicArray<Byte> __fastcall SaveToBytes();

Remarks

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

SaveToFile Method (MailWriter Component)

Serializes the message to a file.

Syntax

void __fastcall SaveToFile(String FileName);

Remarks

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

Error Event (MailWriter Component)

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

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxMailWriterErrorEventParams;
typedef void __fastcall (__closure *TsbxMailWriterErrorEvent)(System::TObject* Sender, TsbxMailWriterErrorEventParams *e);
__property TsbxMailWriterErrorEvent OnError = { read=FOnError, write=FOnError };

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.

ExternalSign Event (MailWriter Component)

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

Syntax

typedef struct {
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxMailWriterExternalSignEventParams;
typedef void __fastcall (__closure *TsbxMailWriterExternalSignEvent)(System::TObject* Sender, TsbxMailWriterExternalSignEventParams *e);
__property TsbxMailWriterExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

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 component via the SignedData parameter.

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

The component 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(); };

Notification Event (MailWriter Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxMailWriterNotificationEventParams;
typedef void __fastcall (__closure *TsbxMailWriterNotificationEvent)(System::TObject* Sender, TsbxMailWriterNotificationEventParams *e);
__property TsbxMailWriterNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. 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 component, the exact action it is performing, or the document being processed, one or both may be omitted.

Config Settings (MailWriter Component)

The component 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 component, 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.

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 component.

Supported values are:


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

Cookies: Gets or sets local cookies for the component.

Use this property to get cookies from the internal cookie storage of the component 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.

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 components that have its CookieCaching property set to "global".

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

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 components.

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 component. 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 component) 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 devided 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 component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component 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 chached 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 components.

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 Component)

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`)