MailWriter Class
Properties Methods Events Configuration Settings Errors
The MailWriter class composes, encrypts, and signs e-mail messages.
Syntax
MailWriter
Remarks
Use MailWriter to compose, sign, and encrypt e-mail messages, and prepare them for sending or saving.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| AttachEncoding | The encoding to be applied to the attachments. |
| AttachCount | The number of records in the Attach arrays. |
| AttachContentSubtype | Contains the content subtype of the attachment. |
| AttachContentType | Contain the content type of the attachment. |
| AttachCreationDate | The creation date. |
| AttachData | The content of the attachment. |
| AttachDescription | Textual description of the attachment. |
| AttachFilename | Specifies the name of the attachment file. |
| AttachID | Contains the attachment's unique identifier. |
| AttachModificationDate | Specifies the date and time of the file's last modification. |
| AttachReadDate | Specifies the file's last read date. |
| AttachSize | Attachment's size in bytes. |
| BccAddrCount | The number of records in the BccAddr arrays. |
| BccAddrAddress | Contains the e-mail address in the form of john@doe. |
| BccAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
| BccAddrGroupName | The name of the group this address belongs to. |
| CcAddrCount | The number of records in the CcAddr arrays. |
| CcAddrAddress | Contains the e-mail address in the form of john@doe. |
| CcAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
| CcAddrGroupName | The name of the group this address belongs to. |
| Charset | The charset to apply to Message . |
| EncryptionCertCount | The number of records in the EncryptionCert arrays. |
| EncryptionCertBytes | Returns raw certificate data in DER format. |
| EncryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ExternalCryptoAsyncDocumentID | Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. |
| ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| ExternalCryptoMethod | Specifies the asynchronous signing method. |
| ExternalCryptoMode | Specifies the external cryptography mode. |
| ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
| 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. |
| HeaderFieldName | The name element in a (name, value) pair. |
| HeaderFieldValue | The value element in a (name, value) pair. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| ReplyToAddrCount | The number of records in the ReplyToAddr arrays. |
| ReplyToAddrAddress | Contains the e-mail address in the form of john@doe. |
| ReplyToAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
| ReplyToAddrGroupName | The name of the group this address belongs to. |
| SecSettingsClaimedSigningTime | Specifies the signing time from the signer's computer. |
| SecSettingsEncrypt | Whether to encrypt the message. |
| SecSettingsEncryptionAlgorithm | Specifies the encryption algorithm to be used. |
| SecSettingsHashAlgorithm | Specifies the hash algorithm to be used. |
| SecSettingsSign | Whether to sign the message. |
| SecSettingsSignatureFormat | Specifies the signature format to use for the signed message. |
| SecSettingsSignBeforeEncrypt | Specifies the order of encryption and signing operations. |
| SecSettingsSignMessageHeader | Specifies whether to include the message header in the signature calculation. |
| SenderAddrAddress | Contains the e-mail address in the form of john@doe. |
| SenderAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
| SenderAddrGroupName | The name of the group this address belongs to. |
| SendToAddrCount | The number of records in the SendToAddr arrays. |
| SendToAddrAddress | Contains the e-mail address in the form of john@doe. |
| SendToAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
| SendToAddrGroupName | The name of the group this address belongs to. |
| SigningCertBytes | Returns raw certificate data in DER format. |
| SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SigningChainCount | The number of records in the SigningChain arrays. |
| SigningChainBytes | Returns raw certificate data in DER format. |
| SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| TextEncoding | The encoding to be applied to the message. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| AttachBytes | Creates an attachment from a memory buffer. |
| AttachFile | Creates an attachment from a file. |
| AttachImage | Creates an image attachment from a memory buffer. |
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| SaveToBytes | Serializes the message to a byte array. |
| SaveToFile | Serializes the message to a file. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Reports information about errors during e-mail message assembling or saving. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| BitsInKey | Key length for the block cipher used for encryption. The value should be a multiple of 8. |
| IncludeSigningCertificate | If true (by default), the signing certificate is included into the signature. Otherwise, it is included only if SigningChain is not empty. |
| TempPath | Path for storing temporary files. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| Tag | Allows to store any custom data. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
AttachEncoding Property (MailWriter Class)
The encoding to be applied to the attachments.
Syntax
int GetAttachEncoding();
int SetAttachEncoding(int iAttachEncoding);
Possible Values
ME_AUTO(0),
ME_8BIT(1),
ME_BASE_64(2),
ME_QUOTED_PRINTABLE(3)
Default Value
0
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 Class)
The number of records in the Attach arrays.
Syntax
int GetAttachCount();
int SetAttachCount(int iAttachCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- AttachContentSubtype
- AttachContentType
- AttachCreationDate
- AttachData
- AttachDescription
- AttachFilename
- AttachID
- AttachModificationDate
- AttachReadDate
- AttachSize
This property is not available at design time.
Data Type
Integer
AttachContentSubtype Property (MailWriter Class)
Contains the content subtype of the attachment.
Syntax
QString GetAttachContentSubtype(int iAttachIndex);
int SetAttachContentSubtype(int iAttachIndex, QString qsAttachContentSubtype);
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 Class)
Contain the content type of the attachment.
Syntax
QString GetAttachContentType(int iAttachIndex);
int SetAttachContentType(int iAttachIndex, QString qsAttachContentType);
Default Value
""
Remarks
Contain 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 Class)
The creation date.
Syntax
QString GetAttachCreationDate(int iAttachIndex);
int SetAttachCreationDate(int iAttachIndex, QString qsAttachCreationDate);
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 Class)
The content of the attachment.
Syntax
QByteArray GetAttachData(int iAttachIndex);
int SetAttachData(int iAttachIndex, QByteArray qbaAttachData);
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 Class)
Textual description of the attachment.
Syntax
QString GetAttachDescription(int iAttachIndex);
int SetAttachDescription(int iAttachIndex, QString qsAttachDescription);
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 Class)
Specifies the name of the attachment file.
Syntax
QString GetAttachFilename(int iAttachIndex);
int SetAttachFilename(int iAttachIndex, QString qsAttachFilename);
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
AttachID Property (MailWriter Class)
Contains the attachment's unique identifier.
Syntax
QString GetAttachID(int iAttachIndex);
int SetAttachID(int iAttachIndex, QString qsAttachID);
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 Class)
Specifies the date and time of the file's last modification.
Syntax
QString GetAttachModificationDate(int iAttachIndex);
int SetAttachModificationDate(int iAttachIndex, QString qsAttachModificationDate);
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 Class)
Specifies the file's last read date.
Syntax
QString GetAttachReadDate(int iAttachIndex);
int SetAttachReadDate(int iAttachIndex, QString qsAttachReadDate);
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 Class)
Attachment's size in bytes.
Syntax
qint64 GetAttachSize(int iAttachIndex);
int SetAttachSize(int iAttachIndex, qint64 lAttachSize);
Default Value
0
Remarks
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 Class)
The number of records in the BccAddr arrays.
Syntax
int GetBccAddrCount();
int SetBccAddrCount(int iBccAddrCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Class)
Contains the e-mail address in the form of john@doe.
Syntax
QString GetBccAddrAddress(int iBccAddrIndex);
int SetBccAddrAddress(int iBccAddrIndex, QString qsBccAddrAddress);
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 Class)
Contains the friendly name of the user of this address, such as John Doe.
Syntax
QString GetBccAddrDisplayName(int iBccAddrIndex);
int SetBccAddrDisplayName(int iBccAddrIndex, QString qsBccAddrDisplayName);
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 Class)
The name of the group this address belongs to.
Syntax
QString GetBccAddrGroupName(int iBccAddrIndex);
int SetBccAddrGroupName(int iBccAddrIndex, QString qsBccAddrGroupName);
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 Class)
The number of records in the CcAddr arrays.
Syntax
int GetCcAddrCount();
int SetCcAddrCount(int iCcAddrCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Class)
Contains the e-mail address in the form of john@doe.
Syntax
QString GetCcAddrAddress(int iCcAddrIndex);
int SetCcAddrAddress(int iCcAddrIndex, QString qsCcAddrAddress);
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 Class)
Contains the friendly name of the user of this address, such as John Doe.
Syntax
QString GetCcAddrDisplayName(int iCcAddrIndex);
int SetCcAddrDisplayName(int iCcAddrIndex, QString qsCcAddrDisplayName);
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 Class)
The name of the group this address belongs to.
Syntax
QString GetCcAddrGroupName(int iCcAddrIndex);
int SetCcAddrGroupName(int iCcAddrIndex, QString qsCcAddrGroupName);
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 Class)
The charset to apply to Message .
Syntax
QString GetCharset();
int SetCharset(QString qsCharset);
Default Value
"utf-8"
Remarks
Use this property to specify the character set to use in the message.
Data Type
String
EncryptionCertCount Property (MailWriter Class)
The number of records in the EncryptionCert arrays.
Syntax
int GetEncryptionCertCount();
int SetEncryptionCertCount(int iEncryptionCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetEncryptionCertBytes(int iEncryptionCertIndex);
Remarks
Returns 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 Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetEncryptionCertHandle(int iEncryptionCertIndex);
int SetEncryptionCertHandle(int iEncryptionCertIndex, qint64 lEncryptionCertHandle);
Default Value
0
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 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 Class)
Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
Syntax
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);
Default Value
""
Remarks
Specifies the document ID for SignAsyncEnd() call
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner 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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
String
ExternalCryptoCustomParams Property (MailWriter Class)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);
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 Class)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);
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 Class)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);
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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.
Data Type
Boolean
ExternalCryptoHashAlgorithm Property (MailWriter Class)
Specifies the request's signature hash algorithm.
Syntax
QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);
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 Class)
The ID of the pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);
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 extra protection layer for the protocol and diminishes the risk of 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 Class)
The pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);
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 Class)
Specifies the asynchronous signing method.
Syntax
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);
Possible Values
ASMD_PKCS1(0),
ASMD_PKCS7(1)
Default Value
0
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 Class)
Specifies the external cryptography mode.
Syntax
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);
Possible Values
ECM_DEFAULT(0),
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
Default Value
0
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 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 Class)
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Default Value
""
Remarks
Provide 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 Class)
Reserved.
Syntax
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
FromAddrCount Property (MailWriter Class)
The number of records in the FromAddr arrays.
Syntax
int GetFromAddrCount();
int SetFromAddrCount(int iFromAddrCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Class)
Contains the e-mail address in the form of john@doe.
Syntax
QString GetFromAddrAddress(int iFromAddrIndex);
int SetFromAddrAddress(int iFromAddrIndex, QString qsFromAddrAddress);
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 Class)
Contains the friendly name of the user of this address, such as John Doe.
Syntax
QString GetFromAddrDisplayName(int iFromAddrIndex);
int SetFromAddrDisplayName(int iFromAddrIndex, QString qsFromAddrDisplayName);
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 Class)
The name of the group this address belongs to.
Syntax
QString GetFromAddrGroupName(int iFromAddrIndex);
int SetFromAddrGroupName(int iFromAddrIndex, QString qsFromAddrGroupName);
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 Class)
The encoding to be applied to the message header.
Syntax
int GetHeaderEncoding();
int SetHeaderEncoding(int iHeaderEncoding);
Possible Values
ME_AUTO(0),
ME_8BIT(1),
ME_BASE_64(2),
ME_QUOTED_PRINTABLE(3)
Default Value
0
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 Class)
The name of the software used to compose and/or send the message.
Syntax
QString GetMailer();
int SetMailer(QString qsMailer);
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 Class)
Returns the number of attachments in this message.
Syntax
int GetMsgAttachmentCount();
Default Value
0
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 Class)
The contents of the BCC header property.
Syntax
QString GetMsgBcc();
int SetMsgBcc(QString qsMsgBcc);
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 Class)
The value of the CC header property.
Syntax
QString GetMsgCc();
int SetMsgCc(QString qsMsgCc);
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 Class)
Contains additional information about the message body.
Syntax
QString GetMsgComments();
int SetMsgComments(QString qsMsgComments);
Default Value
""
Remarks
Contains additional information about the message body.
This property is not available at design time.
Data Type
String
MsgDate Property (MailWriter Class)
The date and time when the message entered the mail delivery system.
Syntax
QString GetMsgDate();
int SetMsgDate(QString qsMsgDate);
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 Class)
Enables delivery notification.
Syntax
bool GetMsgDeliveryReceipt();
int SetMsgDeliveryReceipt(bool bMsgDeliveryReceipt);
Default Value
false
Remarks
Enables delivery notification.
This property is not available at design time.
Data Type
Boolean
MsgFrom Property (MailWriter Class)
Contains the value of the From header property.
Syntax
QString GetMsgFrom();
int SetMsgFrom(QString qsMsgFrom);
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 Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetMsgHandle();
int SetMsgHandle(qint64 lMsgHandle);
Default Value
0
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());
This property is not available at design time.
Data Type
Long64
MsgHtmlText Property (MailWriter Class)
The HTML version of the message.
Syntax
QString GetMsgHtmlText();
int SetMsgHtmlText(QString qsMsgHtmlText);
Default Value
""
Remarks
The HTML version of the message.
This property is not available at design time.
Data Type
String
MsgID Property (MailWriter Class)
The contents of the Message-ID header property.
Syntax
QString GetMsgID();
int SetMsgID(QString qsMsgID);
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 Class)
The value of the In-Reply-To header property.
Syntax
QString GetMsgInReplyTo();
int SetMsgInReplyTo(QString qsMsgInReplyTo);
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 Class)
The value of the Keywords header property.
Syntax
QString GetMsgKeywords();
int SetMsgKeywords(QString qsMsgKeywords);
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 Class)
The name of the software that was used to send the message.
Syntax
QString GetMsgMailer();
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 Class)
The plain text version of the message.
Syntax
QString GetMsgPlainText();
int SetMsgPlainText(QString qsMsgPlainText);
Default Value
""
Remarks
The plain text version of the message.
This property is not available at design time.
Data Type
String
MsgPriority Property (MailWriter Class)
Specifies the message priority.
Syntax
int GetMsgPriority();
int SetMsgPriority(int iMsgPriority);
Possible Values
MP_LOWEST(0),
MP_LOW(1),
MP_NORMAL(2),
MP_HIGH(3),
MP_HIGHEST(4)
Default Value
2
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 Class)
Enables a read notification.
Syntax
bool GetMsgReadReceipt();
int SetMsgReadReceipt(bool bMsgReadReceipt);
Default Value
false
Remarks
Enables a read notification.
This property is not available at design time.
Data Type
Boolean
MsgReferences Property (MailWriter Class)
The value of the References header property.
Syntax
QString GetMsgReferences();
int SetMsgReferences(QString qsMsgReferences);
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 Class)
The value of the Reply-To header property.
Syntax
QString GetMsgReplyTo();
int SetMsgReplyTo(QString qsMsgReplyTo);
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 Class)
The value of the Return-Path header property.
Syntax
QString GetMsgReturnPath();
int SetMsgReturnPath(QString qsMsgReturnPath);
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 Class)
The value of the Sender header property.
Syntax
QString GetMsgSender();
int SetMsgSender(QString qsMsgSender);
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 Class)
The value of the To header property.
Syntax
QString GetMsgSendTo();
int SetMsgSendTo(QString qsMsgSendTo);
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 Class)
Contains the subject property of this message.
Syntax
QString GetMsgSubject();
int SetMsgSubject(QString qsMsgSubject);
Default Value
""
Remarks
Contains the subject field of this message.
This property is not available at design time.
Data Type
String
HeaderFieldCount Property (MailWriter Class)
The number of records in the HeaderField arrays.
Syntax
int GetHeaderFieldCount();
int SetHeaderFieldCount(int iHeaderFieldCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at HeaderFieldCount - 1.This property is not available at design time.
Data Type
Integer
HeaderFieldName Property (MailWriter Class)
The name element in a (name, value) pair.
Syntax
QString GetHeaderFieldName(int iHeaderFieldIndex);
int SetHeaderFieldName(int iHeaderFieldIndex, QString qsHeaderFieldName);
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 Class)
The value element in a (name, value) pair.
Syntax
QString GetHeaderFieldValue(int iHeaderFieldIndex);
int SetHeaderFieldValue(int iHeaderFieldIndex, QString qsHeaderFieldValue);
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 Class)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
QString GetProfile();
int SetProfile(QString qsProfile);
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 Class)
The number of records in the ReplyToAddr arrays.
Syntax
int GetReplyToAddrCount();
int SetReplyToAddrCount(int iReplyToAddrCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Class)
Contains the e-mail address in the form of john@doe.
Syntax
QString GetReplyToAddrAddress(int iReplyToAddrIndex);
int SetReplyToAddrAddress(int iReplyToAddrIndex, QString qsReplyToAddrAddress);
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 Class)
Contains the friendly name of the user of this address, such as John Doe.
Syntax
QString GetReplyToAddrDisplayName(int iReplyToAddrIndex);
int SetReplyToAddrDisplayName(int iReplyToAddrIndex, QString qsReplyToAddrDisplayName);
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 Class)
The name of the group this address belongs to.
Syntax
QString GetReplyToAddrGroupName(int iReplyToAddrIndex);
int SetReplyToAddrGroupName(int iReplyToAddrIndex, QString qsReplyToAddrGroupName);
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 Class)
Specifies the signing time from the signer's computer.
Syntax
QString GetSecSettingsClaimedSigningTime();
int SetSecSettingsClaimedSigningTime(QString qsSecSettingsClaimedSigningTime);
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 Class)
Whether to encrypt the message.
Syntax
bool GetSecSettingsEncrypt();
int SetSecSettingsEncrypt(bool bSecSettingsEncrypt);
Default Value
false
Remarks
Whether to encrypt the message.
Data Type
Boolean
SecSettingsEncryptionAlgorithm Property (MailWriter Class)
Specifies the encryption algorithm to be used.
Syntax
QString GetSecSettingsEncryptionAlgorithm();
int SetSecSettingsEncryptionAlgorithm(QString qsSecSettingsEncryptionAlgorithm);
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 Class)
Specifies the hash algorithm to be used.
Syntax
QString GetSecSettingsHashAlgorithm();
int SetSecSettingsHashAlgorithm(QString qsSecSettingsHashAlgorithm);
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 Class)
Whether to sign the message.
Syntax
bool GetSecSettingsSign();
int SetSecSettingsSign(bool bSecSettingsSign);
Default Value
false
Remarks
Whether to sign the message.
Data Type
Boolean
SecSettingsSignatureFormat Property (MailWriter Class)
Specifies the signature format to use for the signed message.
Syntax
int GetSecSettingsSignatureFormat();
int SetSecSettingsSignatureFormat(int iSecSettingsSignatureFormat);
Possible Values
MS_MULTIPART_SIGNED(0),
MS_SIGNED_DATA(1)
Default Value
0
Remarks
Specifies the signature format to use for the signed message.
Available options:
| msMultipartSigned | 0 | |
| msSignedData | 1 |
Data Type
Integer
SecSettingsSignBeforeEncrypt Property (MailWriter Class)
Specifies the order of encryption and signing operations.
Syntax
bool GetSecSettingsSignBeforeEncrypt();
int SetSecSettingsSignBeforeEncrypt(bool bSecSettingsSignBeforeEncrypt);
Default Value
true
Remarks
Specifies the order of encryption and signing operations.
Data Type
Boolean
SecSettingsSignMessageHeader Property (MailWriter Class)
Specifies whether to include the message header in the signature calculation.
Syntax
bool GetSecSettingsSignMessageHeader();
int SetSecSettingsSignMessageHeader(bool bSecSettingsSignMessageHeader);
Default Value
false
Remarks
Specifies whether to include the message header in the signature calculation.
Data Type
Boolean
SenderAddrAddress Property (MailWriter Class)
Contains the e-mail address in the form of john@doe.
Syntax
QString GetSenderAddrAddress();
int SetSenderAddrAddress(QString qsSenderAddrAddress);
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 Class)
Contains the friendly name of the user of this address, such as John Doe.
Syntax
QString GetSenderAddrDisplayName();
int SetSenderAddrDisplayName(QString qsSenderAddrDisplayName);
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 Class)
The name of the group this address belongs to.
Syntax
QString GetSenderAddrGroupName();
int SetSenderAddrGroupName(QString qsSenderAddrGroupName);
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 Class)
The number of records in the SendToAddr arrays.
Syntax
int GetSendToAddrCount();
int SetSendToAddrCount(int iSendToAddrCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Class)
Contains the e-mail address in the form of john@doe.
Syntax
QString GetSendToAddrAddress(int iSendToAddrIndex);
int SetSendToAddrAddress(int iSendToAddrIndex, QString qsSendToAddrAddress);
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 Class)
Contains the friendly name of the user of this address, such as John Doe.
Syntax
QString GetSendToAddrDisplayName(int iSendToAddrIndex);
int SetSendToAddrDisplayName(int iSendToAddrIndex, QString qsSendToAddrDisplayName);
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 Class)
The name of the group this address belongs to.
Syntax
QString GetSendToAddrGroupName(int iSendToAddrIndex);
int SetSendToAddrGroupName(int iSendToAddrIndex, QString qsSendToAddrGroupName);
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 Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetSigningCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
SigningCertHandle Property (MailWriter Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigningCertHandle();
int SetSigningCertHandle(qint64 lSigningCertHandle);
Default Value
0
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());
This property is not available at design time.
Data Type
Long64
SigningChainCount Property (MailWriter Class)
The number of records in the SigningChain arrays.
Syntax
int GetSigningChainCount();
int SetSigningChainCount(int iSigningChainCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetSigningChainBytes(int iSigningChainIndex);
Remarks
Returns 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 Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetSigningChainHandle(int iSigningChainIndex);
int SetSigningChainHandle(int iSigningChainIndex, qint64 lSigningChainHandle);
Default Value
0
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 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 Class)
The encoding to be applied to the message.
Syntax
int GetTextEncoding();
int SetTextEncoding(int iTextEncoding);
Possible Values
ME_AUTO(0),
ME_8BIT(1),
ME_BASE_64(2),
ME_QUOTED_PRINTABLE(3)
Default Value
0
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 Class)
Creates an attachment from a memory buffer.
Syntax
int AttachBytes(QByteArray qbaData);
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
AttachFile Method (MailWriter Class)
Creates an attachment from a file.
Syntax
int AttachFile(const QString& qsFilename);
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
AttachImage Method (MailWriter Class)
Creates an image attachment from a memory buffer.
Syntax
int AttachImage(const QString& qsID, QByteArray qbaData);
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.
Error Handling
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Config Method (MailWriter Class)
Sets or retrieves a configuration setting.
Syntax
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (MailWriter Class)
Performs an additional action.
Syntax
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SaveToBytes Method (MailWriter Class)
Serializes the message to a byte array.
Syntax
QByteArray SaveToBytes();
Remarks
Use this method to assemble the message and save it to a byte array.
Error Handling
This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SaveToFile Method (MailWriter Class)
Serializes the message to a file.
Syntax
int SaveToFile(const QString& qsFilename);
Remarks
Use this method to assemble the message and save it to a file.
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (MailWriter Class)
Reports information about errors during e-mail message assembling or saving.
Syntax
class MailWriterErrorEventParams {
public:
int ErrorCode();
const QString &Description();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Error(MailWriterErrorEventParams *e);
// Or, subclass MailWriter and override this emitter function.
virtual int FireError(MailWriterErrorEventParams *e) {...}
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 Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
class MailWriterExternalSignEventParams {
public:
const QString &OperationId();
const QString &HashAlgorithm();
const QString &Pars();
const QString &Data();
const QString &SignedData();
void SetSignedData(const QString &qsSignedData);
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void ExternalSign(MailWriterExternalSignEventParams *e);
// Or, subclass MailWriter and override this emitter function.
virtual int FireExternalSign(MailWriterExternalSignEventParams *e) {...}
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 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 contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for 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 a .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 Class)
This event notifies the application about an underlying control flow event.
Syntax
class MailWriterNotificationEventParams {
public:
const QString &EventID();
const QString &EventParam();
int EventRetVal();
void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal.
void Notification(MailWriterNotificationEventParams *e);
// Or, subclass MailWriter and override this emitter function.
virtual int FireNotification(MailWriterNotificationEventParams *e) {...}
Remarks
The class 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 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.
Configuration Settings (MailWriter Class)
The class 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 class, access to these internal properties is provided through the Config method.MailWriter Configuration 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 Configuration Settings | ||||||||||||||||||||||||||||||
| 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 class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class 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. | ||||||||||||||||||||||||||||||
| 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 classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| 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 classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. |
Trappable Errors (MailWriter Class)
MailWriter Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 22020097 Failed to assemble a mail message (SB_ERROR_MAIL_ASSEMBLY_FAILED) | |
| 22020098 Failed to parse a mail message (SB_ERROR_MAIL_PARSING_FAILED) | |
| 22020099 Failed to decrypt a message because there is no decryption certificate provided (SB_ERROR_MAIL_NO_DECRYPTION_CERTIFICATE) |