# MailWriter Class The MailWriter class composes, encrypts, and signs e-mail messages. ## Class Name **SecureBlackbox_MailWriter** ## Procedural Interface ```text secureblackbox_mailwriter_open(); secureblackbox_mailwriter_close($res); secureblackbox_mailwriter_register_callback($res, $id, $function); secureblackbox_mailwriter_get_last_error($res); secureblackbox_mailwriter_get_last_error_code($res); secureblackbox_mailwriter_set($res, $id, $index, $value); secureblackbox_mailwriter_get($res, $id, $index); secureblackbox_mailwriter_do_attachbytes($res, $data); secureblackbox_mailwriter_do_attachfile($res, $filename); secureblackbox_mailwriter_do_attachimage($res, $id, $data); secureblackbox_mailwriter_do_config($res, $configurationstring); secureblackbox_mailwriter_do_createnew($res); secureblackbox_mailwriter_do_doaction($res, $actionid, $actionparams); secureblackbox_mailwriter_do_reset($res); secureblackbox_mailwriter_do_savetobytes($res); secureblackbox_mailwriter_do_savetofile($res, $filename); ``` ## 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: ```text 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: ```text writer.AttachImage("myimage", File.ReadAllBytes("path\\image.jpg")); writer.Attachments[0].ContentSubtype = "jpeg"; writer.Message.HtmlText = "Message with an image

"; ``` Signing a message with a certificate (note that the certificate should contain its private key): ```text 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): ```text 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 class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AttachEncoding](#attachencoding-property-secureblackbox_mailwriter-class) | The encoding to be applied to the attachments. | | [AttachCount](#attachcount-property-secureblackbox_mailwriter-class) | The number of records in the Attach arrays. | | [AttachContentSubtype](#attachcontentsubtype-property-secureblackbox_mailwriter-class) | Contains the content subtype of the attachment. | | [AttachContentType](#attachcontenttype-property-secureblackbox_mailwriter-class) | Contains the content type of the attachment. | | [AttachCreationDate](#attachcreationdate-property-secureblackbox_mailwriter-class) | The creation date. | | [AttachData](#attachdata-property-secureblackbox_mailwriter-class) | The content of the attachment. | | [AttachDescription](#attachdescription-property-secureblackbox_mailwriter-class) | Textual description of the attachment. | | [AttachFileName](#attachfilename-property-secureblackbox_mailwriter-class) | Specifies the name of the attachment file. | | [AttachHandle](#attachhandle-property-secureblackbox_mailwriter-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [AttachID](#attachid-property-secureblackbox_mailwriter-class) | Contains the attachment's unique identifier. | | [AttachModificationDate](#attachmodificationdate-property-secureblackbox_mailwriter-class) | Specifies the date and time of the file's last modification. | | [AttachReadDate](#attachreaddate-property-secureblackbox_mailwriter-class) | Specifies the file's last read date. | | [AttachSize](#attachsize-property-secureblackbox_mailwriter-class) | The attachment's size in bytes. | | [BccAddrCount](#bccaddrcount-property-secureblackbox_mailwriter-class) | The number of records in the BccAddr arrays. | | [BccAddrAddress](#bccaddraddress-property-secureblackbox_mailwriter-class) | Contains the e-mail address in the form of john@doe. | | [BccAddrDisplayName](#bccaddrdisplayname-property-secureblackbox_mailwriter-class) | Contains the friendly name of the user of this address, such as John Doe. | | [BccAddrGroupName](#bccaddrgroupname-property-secureblackbox_mailwriter-class) | The name of the group this address belongs to. | | [CcAddrCount](#ccaddrcount-property-secureblackbox_mailwriter-class) | The number of records in the CcAddr arrays. | | [CcAddrAddress](#ccaddraddress-property-secureblackbox_mailwriter-class) | Contains the e-mail address in the form of john@doe. | | [CcAddrDisplayName](#ccaddrdisplayname-property-secureblackbox_mailwriter-class) | Contains the friendly name of the user of this address, such as John Doe. | | [CcAddrGroupName](#ccaddrgroupname-property-secureblackbox_mailwriter-class) | The name of the group this address belongs to. | | [Charset](#charset-property-secureblackbox_mailwriter-class) | The charset to apply to Message . | | [EncryptionCertCount](#encryptioncertcount-property-secureblackbox_mailwriter-class) | The number of records in the EncryptionCert arrays. | | [EncryptionCertBytes](#encryptioncertbytes-property-secureblackbox_mailwriter-class) | Returns the raw certificate data in DER format. | | [EncryptionCertHandle](#encryptioncerthandle-property-secureblackbox_mailwriter-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-secureblackbox_mailwriter-class) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-secureblackbox_mailwriter-class) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-secureblackbox_mailwriter-class) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-secureblackbox_mailwriter-class) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-secureblackbox_mailwriter-class) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_mailwriter-class) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_mailwriter-class) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-secureblackbox_mailwriter-class) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-secureblackbox_mailwriter-class) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-secureblackbox_mailwriter-class) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [FIPSMode](#fipsmode-property-secureblackbox_mailwriter-class) | Reserved. | | [FromAddrCount](#fromaddrcount-property-secureblackbox_mailwriter-class) | The number of records in the FromAddr arrays. | | [FromAddrAddress](#fromaddraddress-property-secureblackbox_mailwriter-class) | Contains the e-mail address in the form of john@doe. | | [FromAddrDisplayName](#fromaddrdisplayname-property-secureblackbox_mailwriter-class) | Contains the friendly name of the user of this address, such as John Doe. | | [FromAddrGroupName](#fromaddrgroupname-property-secureblackbox_mailwriter-class) | The name of the group this address belongs to. | | [HeaderEncoding](#headerencoding-property-secureblackbox_mailwriter-class) | The encoding to be applied to the message header. | | [Mailer](#mailer-property-secureblackbox_mailwriter-class) | The name of the software used to compose and/or send the message. | | [MsgAttachmentCount](#msgattachmentcount-property-secureblackbox_mailwriter-class) | Returns the number of attachments in this message. | | [MsgBcc](#msgbcc-property-secureblackbox_mailwriter-class) | The contents of the BCC header property. | | [MsgCc](#msgcc-property-secureblackbox_mailwriter-class) | The value of the CC header property. | | [MsgComments](#msgcomments-property-secureblackbox_mailwriter-class) | Contains additional information about the message body. | | [MsgDate](#msgdate-property-secureblackbox_mailwriter-class) | The date and time when the message entered the mail delivery system. | | [MsgDeliveryReceipt](#msgdeliveryreceipt-property-secureblackbox_mailwriter-class) | Enables delivery notification. | | [MsgFrom](#msgfrom-property-secureblackbox_mailwriter-class) | Contains the value of the From header property. | | [MsgHandle](#msghandle-property-secureblackbox_mailwriter-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [MsgHtmlText](#msghtmltext-property-secureblackbox_mailwriter-class) | The HTML version of the message. | | [MsgID](#msgid-property-secureblackbox_mailwriter-class) | The contents of the Message-ID header property. | | [MsgInReplyTo](#msginreplyto-property-secureblackbox_mailwriter-class) | The value of the In-Reply-To header property. | | [MsgKeywords](#msgkeywords-property-secureblackbox_mailwriter-class) | The value of the Keywords header property. | | [MsgMailer](#msgmailer-property-secureblackbox_mailwriter-class) | The name of the software that was used to send the message. | | [MsgPlainText](#msgplaintext-property-secureblackbox_mailwriter-class) | The plain text version of the message. | | [MsgPriority](#msgpriority-property-secureblackbox_mailwriter-class) | Specifies the message priority. | | [MsgReadReceipt](#msgreadreceipt-property-secureblackbox_mailwriter-class) | Enables a read notification. | | [MsgReferences](#msgreferences-property-secureblackbox_mailwriter-class) | The value of the References header property. | | [MsgReplyTo](#msgreplyto-property-secureblackbox_mailwriter-class) | The value of the Reply-To header property. | | [MsgReturnPath](#msgreturnpath-property-secureblackbox_mailwriter-class) | The value of the Return-Path header property. | | [MsgSender](#msgsender-property-secureblackbox_mailwriter-class) | The value of the Sender header property. | | [MsgSendTo](#msgsendto-property-secureblackbox_mailwriter-class) | The value of the To header property. | | [MsgSubject](#msgsubject-property-secureblackbox_mailwriter-class) | Contains the subject property of this message. | | [HeaderFieldCount](#headerfieldcount-property-secureblackbox_mailwriter-class) | The number of records in the HeaderField arrays. | | [HeaderFieldCategory](#headerfieldcategory-property-secureblackbox_mailwriter-class) | Specifies the string category of the contained value. | | [HeaderFieldFormat](#headerfieldformat-property-secureblackbox_mailwriter-class) | Specifies the format (encoding) of the value contained in the Value property. | | [HeaderFieldName](#headerfieldname-property-secureblackbox_mailwriter-class) | The name element in a (name, value) pair. | | [HeaderFieldValue](#headerfieldvalue-property-secureblackbox_mailwriter-class) | The value element in a (name, value) pair. | | [Profile](#profile-property-secureblackbox_mailwriter-class) | Specifies a pre-defined profile to apply when creating the signature. | | [ReplyToAddrCount](#replytoaddrcount-property-secureblackbox_mailwriter-class) | The number of records in the ReplyToAddr arrays. | | [ReplyToAddrAddress](#replytoaddraddress-property-secureblackbox_mailwriter-class) | Contains the e-mail address in the form of john@doe. | | [ReplyToAddrDisplayName](#replytoaddrdisplayname-property-secureblackbox_mailwriter-class) | Contains the friendly name of the user of this address, such as John Doe. | | [ReplyToAddrGroupName](#replytoaddrgroupname-property-secureblackbox_mailwriter-class) | The name of the group this address belongs to. | | [SecSettingsClaimedSigningTime](#secsettingsclaimedsigningtime-property-secureblackbox_mailwriter-class) | Specifies the signing time from the signer's computer. | | [SecSettingsEncrypt](#secsettingsencrypt-property-secureblackbox_mailwriter-class) | Whether to encrypt the message. | | [SecSettingsEncryptionAlgorithm](#secsettingsencryptionalgorithm-property-secureblackbox_mailwriter-class) | Specifies the encryption algorithm to be used. | | [SecSettingsHashAlgorithm](#secsettingshashalgorithm-property-secureblackbox_mailwriter-class) | Specifies the hash algorithm to be used. | | [SecSettingsSign](#secsettingssign-property-secureblackbox_mailwriter-class) | Whether to sign the message. | | [SecSettingsSignatureFormat](#secsettingssignatureformat-property-secureblackbox_mailwriter-class) | Specifies the signature format to use for the signed message. | | [SecSettingsSignBeforeEncrypt](#secsettingssignbeforeencrypt-property-secureblackbox_mailwriter-class) | Specifies the order of encryption and signing operations. | | [SecSettingsSignMessageHeader](#secsettingssignmessageheader-property-secureblackbox_mailwriter-class) | Specifies whether to include the message header in the signature calculation. | | [SenderAddrAddress](#senderaddraddress-property-secureblackbox_mailwriter-class) | Contains the e-mail address in the form of john@doe. | | [SenderAddrDisplayName](#senderaddrdisplayname-property-secureblackbox_mailwriter-class) | Contains the friendly name of the user of this address, such as John Doe. | | [SenderAddrGroupName](#senderaddrgroupname-property-secureblackbox_mailwriter-class) | The name of the group this address belongs to. | | [SendToAddrCount](#sendtoaddrcount-property-secureblackbox_mailwriter-class) | The number of records in the SendToAddr arrays. | | [SendToAddrAddress](#sendtoaddraddress-property-secureblackbox_mailwriter-class) | Contains the e-mail address in the form of john@doe. | | [SendToAddrDisplayName](#sendtoaddrdisplayname-property-secureblackbox_mailwriter-class) | Contains the friendly name of the user of this address, such as John Doe. | | [SendToAddrGroupName](#sendtoaddrgroupname-property-secureblackbox_mailwriter-class) | The name of the group this address belongs to. | | [SigningCertBytes](#signingcertbytes-property-secureblackbox_mailwriter-class) | Returns the raw certificate data in DER format. | | [SigningCertHandle](#signingcerthandle-property-secureblackbox_mailwriter-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningChainCount](#signingchaincount-property-secureblackbox_mailwriter-class) | The number of records in the SigningChain arrays. | | [SigningChainBytes](#signingchainbytes-property-secureblackbox_mailwriter-class) | Returns the raw certificate data in DER format. | | [SigningChainHandle](#signingchainhandle-property-secureblackbox_mailwriter-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TextEncoding](#textencoding-property-secureblackbox_mailwriter-class) | 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](#attachbytes-method-secureblackbox_mailwriter-class) | Creates an attachment from a memory buffer. | | [AttachFile](#attachfile-method-secureblackbox_mailwriter-class) | Creates an attachment from a file. | | [AttachImage](#attachimage-method-secureblackbox_mailwriter-class) | Creates an image attachment from a memory buffer. | | [Config](#config-method-secureblackbox_mailwriter-class) | Sets or retrieves a configuration setting. | | [CreateNew](#createnew-method-secureblackbox_mailwriter-class) | Creates a template for a new message. | | [DoAction](#doaction-method-secureblackbox_mailwriter-class) | Performs an additional action. | | [Reset](#reset-method-secureblackbox_mailwriter-class) | Resets the class settings. | | [SaveToBytes](#savetobytes-method-secureblackbox_mailwriter-class) | Serializes the message to a byte array. | | [SaveToFile](#savetofile-method-secureblackbox_mailwriter-class) | 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](#error-event-secureblackbox_mailwriter-class) | Reports information about errors during e-mail message assembling or saving. | | [ExternalSign](#externalsign-event-secureblackbox_mailwriter-class) | Handles remote or external signing initiated by the SignExternal method or other source. | | [Notification](#notification-event-secureblackbox_mailwriter-class) | This event notifies the application about an underlying control flow event. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BitsInKey](#BitsInKey) | Key length for the block cipher used for encryption. The value should be a multiple of 8. | | [IncludeSigningCertificate](#IncludeSigningCertificate) | If true (by default), the signing certificate is included into the signature. Otherwise, it is included only if SigningChain is not empty. | | [TempPath](#TempPath) | Path for storing temporary files. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # AttachEncoding Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The encoding to be applied to the attachments. ## Object Oriented Interface ```text public function getAttachEncoding(); public function setAttachEncoding($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 1 ); secureblackbox_mailwriter_set($res, 1, $value ); ``` ## Possible Values ```text MAILWRITER_ATTACHENCODING_AUTO(0), MAILWRITER_ATTACHENCODING_8BIT(1), MAILWRITER_ATTACHENCODING_BASE_64(2), MAILWRITER_ATTACHENCODING_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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the Attach arrays. ## Object Oriented Interface ```text public function getAttachCount(); public function setAttachCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 2 ); secureblackbox_mailwriter_set($res, 2, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [AttachContentSubtype](#attachcontentsubtype-property-secureblackbox_mailwriter-class) - [AttachContentType](#attachcontenttype-property-secureblackbox_mailwriter-class) - [AttachCreationDate](#attachcreationdate-property-secureblackbox_mailwriter-class) - [AttachData](#attachdata-property-secureblackbox_mailwriter-class) - [AttachDescription](#attachdescription-property-secureblackbox_mailwriter-class) - [AttachFileName](#attachfilename-property-secureblackbox_mailwriter-class) - [AttachHandle](#attachhandle-property-secureblackbox_mailwriter-class) - [AttachID](#attachid-property-secureblackbox_mailwriter-class) - [AttachModificationDate](#attachmodificationdate-property-secureblackbox_mailwriter-class) - [AttachReadDate](#attachreaddate-property-secureblackbox_mailwriter-class) - [AttachSize](#attachsize-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *AttachCount - 1*. This property is not available at design time. ## Data Type Integer # AttachContentSubtype Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the content subtype of the attachment. ## Object Oriented Interface ```text public function getAttachContentSubtype($attachindex); public function setAttachContentSubtype($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 3 , $attachindex); secureblackbox_mailwriter_set($res, 3, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachContentType Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the content type of the attachment. ## Object Oriented Interface ```text public function getAttachContentType($attachindex); public function setAttachContentType($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 4 , $attachindex); secureblackbox_mailwriter_set($res, 4, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachCreationDate Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The creation date. ## Object Oriented Interface ```text public function getAttachCreationDate($attachindex); public function setAttachCreationDate($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 5 , $attachindex); secureblackbox_mailwriter_set($res, 5, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachData Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The content of the attachment. ## Object Oriented Interface ```text public function getAttachData($attachindex); public function setAttachData($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 6 , $attachindex); secureblackbox_mailwriter_set($res, 6, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type Byte Array # AttachDescription Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Textual description of the attachment. ## Object Oriented Interface ```text public function getAttachDescription($attachindex); public function setAttachDescription($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 7 , $attachindex); secureblackbox_mailwriter_set($res, 7, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachFileName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the name of the attachment file. ## Object Oriented Interface ```text public function getAttachFileName($attachindex); public function setAttachFileName($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 8 , $attachindex); secureblackbox_mailwriter_set($res, 8, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachHandle Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getAttachHandle($attachindex); public function setAttachHandle($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 9 , $attachindex); secureblackbox_mailwriter_set($res, 9, $value , $attachindex); ``` ## 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. ```text 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type Long64 # AttachID Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the attachment's unique identifier. ## Object Oriented Interface ```text public function getAttachID($attachindex); public function setAttachID($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 10 , $attachindex); secureblackbox_mailwriter_set($res, 10, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachModificationDate Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the date and time of the file's last modification. ## Object Oriented Interface ```text public function getAttachModificationDate($attachindex); public function setAttachModificationDate($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 11 , $attachindex); secureblackbox_mailwriter_set($res, 11, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachReadDate Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the file's last read date. ## Object Oriented Interface ```text public function getAttachReadDate($attachindex); public function setAttachReadDate($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 12 , $attachindex); secureblackbox_mailwriter_set($res, 12, $value , $attachindex); ``` ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # AttachSize Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The attachment's size in bytes. ## Object Oriented Interface ```text public function getAttachSize($attachindex); public function setAttachSize($attachindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 13 , $attachindex); secureblackbox_mailwriter_set($res, 13, $value , $attachindex); ``` ## Default Value 0 ## 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](#attachcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type Long64 # BccAddrCount Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the BccAddr arrays. ## Object Oriented Interface ```text public function getBccAddrCount(); public function setBccAddrCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 14 ); secureblackbox_mailwriter_set($res, 14, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [BccAddrAddress](#bccaddraddress-property-secureblackbox_mailwriter-class) - [BccAddrDisplayName](#bccaddrdisplayname-property-secureblackbox_mailwriter-class) - [BccAddrGroupName](#bccaddrgroupname-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *BccAddrCount - 1*. This property is not available at design time. ## Data Type Integer # BccAddrAddress Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the e-mail address in the form of john@doe. ## Object Oriented Interface ```text public function getBccAddrAddress($bccaddrindex); public function setBccAddrAddress($bccaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 15 , $bccaddrindex); secureblackbox_mailwriter_set($res, 15, $value , $bccaddrindex); ``` ## 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](#bccaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # BccAddrDisplayName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the friendly name of the user of this address, such as John Doe. ## Object Oriented Interface ```text public function getBccAddrDisplayName($bccaddrindex); public function setBccAddrDisplayName($bccaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 16 , $bccaddrindex); secureblackbox_mailwriter_set($res, 16, $value , $bccaddrindex); ``` ## 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](#bccaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # BccAddrGroupName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the group this address belongs to. ## Object Oriented Interface ```text public function getBccAddrGroupName($bccaddrindex); public function setBccAddrGroupName($bccaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 17 , $bccaddrindex); secureblackbox_mailwriter_set($res, 17, $value , $bccaddrindex); ``` ## 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](#bccaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # CcAddrCount Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the CcAddr arrays. ## Object Oriented Interface ```text public function getCcAddrCount(); public function setCcAddrCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 18 ); secureblackbox_mailwriter_set($res, 18, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CcAddrAddress](#ccaddraddress-property-secureblackbox_mailwriter-class) - [CcAddrDisplayName](#ccaddrdisplayname-property-secureblackbox_mailwriter-class) - [CcAddrGroupName](#ccaddrgroupname-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *CcAddrCount - 1*. This property is not available at design time. ## Data Type Integer # CcAddrAddress Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the e-mail address in the form of john@doe. ## Object Oriented Interface ```text public function getCcAddrAddress($ccaddrindex); public function setCcAddrAddress($ccaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 19 , $ccaddrindex); secureblackbox_mailwriter_set($res, 19, $value , $ccaddrindex); ``` ## 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](#ccaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # CcAddrDisplayName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the friendly name of the user of this address, such as John Doe. ## Object Oriented Interface ```text public function getCcAddrDisplayName($ccaddrindex); public function setCcAddrDisplayName($ccaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 20 , $ccaddrindex); secureblackbox_mailwriter_set($res, 20, $value , $ccaddrindex); ``` ## 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](#ccaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # CcAddrGroupName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the group this address belongs to. ## Object Oriented Interface ```text public function getCcAddrGroupName($ccaddrindex); public function setCcAddrGroupName($ccaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 21 , $ccaddrindex); secureblackbox_mailwriter_set($res, 21, $value , $ccaddrindex); ``` ## 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](#ccaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # Charset Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The charset to apply to Message . ## Object Oriented Interface ```text public function getCharset(); public function setCharset($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 22 ); secureblackbox_mailwriter_set($res, 22, $value ); ``` ## Default Value 'utf-8' ## Remarks Use this property to specify the character set to use in the message. ## Data Type String # EncryptionCertCount Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the EncryptionCert arrays. ## Object Oriented Interface ```text public function getEncryptionCertCount(); public function setEncryptionCertCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 23 ); secureblackbox_mailwriter_set($res, 23, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [EncryptionCertBytes](#encryptioncertbytes-property-secureblackbox_mailwriter-class) - [EncryptionCertHandle](#encryptioncerthandle-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *EncryptionCertCount - 1*. This property is not available at design time. ## Data Type Integer # EncryptionCertBytes Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getEncryptionCertBytes($encryptioncertindex); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 24 , $encryptioncertindex); ``` ## 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](#encryptioncertcount-property-secureblackbox_mailwriter-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # EncryptionCertHandle Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getEncryptionCertHandle($encryptioncertindex); public function setEncryptionCertHandle($encryptioncertindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 32 , $encryptioncertindex); secureblackbox_mailwriter_set($res, 32, $value , $encryptioncertindex); ``` ## 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. ```text 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](#encryptioncertcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type Long64 # ExternalCryptoAsyncDocumentID Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Object Oriented Interface ```text public function getExternalCryptoAsyncDocumentID(); public function setExternalCryptoAsyncDocumentID($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 63 ); secureblackbox_mailwriter_set($res, 63, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Custom parameters to be passed to the signing service (uninterpreted). ## Object Oriented Interface ```text public function getExternalCryptoCustomParams(); public function setExternalCryptoCustomParams($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 64 ); secureblackbox_mailwriter_set($res, 64, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Additional data to be included in the async state and mirrored back by the requestor. ## Object Oriented Interface ```text public function getExternalCryptoData(); public function setExternalCryptoData($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 65 ); secureblackbox_mailwriter_set($res, 65, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies whether the message hash is to be calculated at the external endpoint. ## Object Oriented Interface ```text public function getExternalCryptoExternalHashCalculation(); public function setExternalCryptoExternalHashCalculation($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 66 ); secureblackbox_mailwriter_set($res, 66, $value ); ``` ## 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 class. If set to true, the class 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the request's signature hash algorithm. ## Object Oriented Interface ```text public function getExternalCryptoHashAlgorithm(); public function setExternalCryptoHashAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 67 ); secureblackbox_mailwriter_set($res, 67, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The ID of the pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeyID(); public function setExternalCryptoKeyID($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 68 ); secureblackbox_mailwriter_set($res, 68, $value ); ``` ## 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](#externalcryptokeysecret-property-secureblackbox_mailwriter-class) 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: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type String # ExternalCryptoKeySecret Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The pre-shared key used for DC request authentication. ## Object Oriented Interface ```text public function getExternalCryptoKeySecret(); public function setExternalCryptoKeySecret($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 69 ); secureblackbox_mailwriter_set($res, 69, $value ); ``` ## 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](#externalcryptokeyid-property-secureblackbox_mailwriter-class) topic. ## Data Type String # ExternalCryptoMethod Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the asynchronous signing method. ## Object Oriented Interface ```text public function getExternalCryptoMethod(); public function setExternalCryptoMethod($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 70 ); secureblackbox_mailwriter_set($res, 70, $value ); ``` ## Possible Values ```text MAILWRITER_EXTERNALCRYPTOMETHOD_PKCS1(0), MAILWRITER_EXTERNALCRYPTOMETHOD_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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the external cryptography mode. ## Object Oriented Interface ```text public function getExternalCryptoMode(); public function setExternalCryptoMode($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 71 ); secureblackbox_mailwriter_set($res, 71, $value ); ``` ## Possible Values ```text MAILWRITER_EXTERNALCRYPTOMODE_DEFAULT(0), MAILWRITER_EXTERNALCRYPTOMODE_DISABLED(1), MAILWRITER_EXTERNALCRYPTOMODE_GENERIC(2), MAILWRITER_EXTERNALCRYPTOMODE_DCAUTH(3), MAILWRITER_EXTERNALCRYPTOMODE_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 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Object Oriented Interface ```text public function getExternalCryptoPublicKeyAlgorithm(); public function setExternalCryptoPublicKeyAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 72 ); secureblackbox_mailwriter_set($res, 72, $value ); ``` ## 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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Data Type String # FIPSMode Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Reserved. ## Object Oriented Interface ```text public function getFIPSMode(); public function setFIPSMode($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 73 ); secureblackbox_mailwriter_set($res, 73, $value ); ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # FromAddrCount Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the FromAddr arrays. ## Object Oriented Interface ```text public function getFromAddrCount(); public function setFromAddrCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 74 ); secureblackbox_mailwriter_set($res, 74, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [FromAddrAddress](#fromaddraddress-property-secureblackbox_mailwriter-class) - [FromAddrDisplayName](#fromaddrdisplayname-property-secureblackbox_mailwriter-class) - [FromAddrGroupName](#fromaddrgroupname-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *FromAddrCount - 1*. This property is not available at design time. ## Data Type Integer # FromAddrAddress Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the e-mail address in the form of john@doe. ## Object Oriented Interface ```text public function getFromAddrAddress($fromaddrindex); public function setFromAddrAddress($fromaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 75 , $fromaddrindex); secureblackbox_mailwriter_set($res, 75, $value , $fromaddrindex); ``` ## 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](#fromaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # FromAddrDisplayName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the friendly name of the user of this address, such as John Doe. ## Object Oriented Interface ```text public function getFromAddrDisplayName($fromaddrindex); public function setFromAddrDisplayName($fromaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 76 , $fromaddrindex); secureblackbox_mailwriter_set($res, 76, $value , $fromaddrindex); ``` ## 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](#fromaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # FromAddrGroupName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the group this address belongs to. ## Object Oriented Interface ```text public function getFromAddrGroupName($fromaddrindex); public function setFromAddrGroupName($fromaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 77 , $fromaddrindex); secureblackbox_mailwriter_set($res, 77, $value , $fromaddrindex); ``` ## 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](#fromaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # HeaderEncoding Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The encoding to be applied to the message header. ## Object Oriented Interface ```text public function getHeaderEncoding(); public function setHeaderEncoding($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 78 ); secureblackbox_mailwriter_set($res, 78, $value ); ``` ## Possible Values ```text MAILWRITER_HEADERENCODING_AUTO(0), MAILWRITER_HEADERENCODING_8BIT(1), MAILWRITER_HEADERENCODING_BASE_64(2), MAILWRITER_HEADERENCODING_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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the software used to compose and/or send the message. ## Object Oriented Interface ```text public function getMailer(); public function setMailer($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 79 ); secureblackbox_mailwriter_set($res, 79, $value ); ``` ## Default Value '' ## Remarks Use this property to specify the software that was used to compose and send this message. ## Data Type String # MsgAttachmentCount Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Returns the number of attachments in this message. ## Object Oriented Interface ```text public function getMsgAttachmentCount(); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 80 ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The contents of the BCC header property. ## Object Oriented Interface ```text public function getMsgBcc(); public function setMsgBcc($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 81 ); secureblackbox_mailwriter_set($res, 81, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the CC header property. ## Object Oriented Interface ```text public function getMsgCc(); public function setMsgCc($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 82 ); secureblackbox_mailwriter_set($res, 82, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains additional information about the message body. ## Object Oriented Interface ```text public function getMsgComments(); public function setMsgComments($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 83 ); secureblackbox_mailwriter_set($res, 83, $value ); ``` ## Default Value '' ## Remarks Contains additional information about the message body. This property is not available at design time. ## Data Type String # MsgDate Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The date and time when the message entered the mail delivery system. ## Object Oriented Interface ```text public function getMsgDate(); public function setMsgDate($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 84 ); secureblackbox_mailwriter_set($res, 84, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Enables delivery notification. ## Object Oriented Interface ```text public function getMsgDeliveryReceipt(); public function setMsgDeliveryReceipt($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 85 ); secureblackbox_mailwriter_set($res, 85, $value ); ``` ## Default Value false ## Remarks Enables delivery notification. This property is not available at design time. ## Data Type Boolean # MsgFrom Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the value of the From header property. ## Object Oriented Interface ```text public function getMsgFrom(); public function setMsgFrom($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 86 ); secureblackbox_mailwriter_set($res, 86, $value ); ``` ## 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](#msgsender-property-secureblackbox_mailwriter-class) to specify the sender separately. This property is not available at design time. ## Data Type String # MsgHandle Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getMsgHandle(); public function setMsgHandle($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 87 ); secureblackbox_mailwriter_set($res, 87, $value ); ``` ## 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # MsgHtmlText Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The HTML version of the message. ## Object Oriented Interface ```text public function getMsgHtmlText(); public function setMsgHtmlText($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 88 ); secureblackbox_mailwriter_set($res, 88, $value ); ``` ## Default Value '' ## Remarks The HTML version of the message. This property is not available at design time. ## Data Type String # MsgID Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The contents of the Message-ID header property. ## Object Oriented Interface ```text public function getMsgID(); public function setMsgID($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 89 ); secureblackbox_mailwriter_set($res, 89, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the In-Reply-To header property. ## Object Oriented Interface ```text public function getMsgInReplyTo(); public function setMsgInReplyTo($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 90 ); secureblackbox_mailwriter_set($res, 90, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the Keywords header property. ## Object Oriented Interface ```text public function getMsgKeywords(); public function setMsgKeywords($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 91 ); secureblackbox_mailwriter_set($res, 91, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the software that was used to send the message. ## Object Oriented Interface ```text public function getMsgMailer(); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 92 ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The plain text version of the message. ## Object Oriented Interface ```text public function getMsgPlainText(); public function setMsgPlainText($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 93 ); secureblackbox_mailwriter_set($res, 93, $value ); ``` ## Default Value '' ## Remarks The plain text version of the message. This property is not available at design time. ## Data Type String # MsgPriority Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the message priority. ## Object Oriented Interface ```text public function getMsgPriority(); public function setMsgPriority($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 94 ); secureblackbox_mailwriter_set($res, 94, $value ); ``` ## Possible Values ```text MAILWRITER_MSGPRIORITY_LOWEST(0), MAILWRITER_MSGPRIORITY_LOW(1), MAILWRITER_MSGPRIORITY_NORMAL(2), MAILWRITER_MSGPRIORITY_HIGH(3), MAILWRITER_MSGPRIORITY_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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Enables a read notification. ## Object Oriented Interface ```text public function getMsgReadReceipt(); public function setMsgReadReceipt($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 95 ); secureblackbox_mailwriter_set($res, 95, $value ); ``` ## Default Value false ## Remarks Enables a read notification. This property is not available at design time. ## Data Type Boolean # MsgReferences Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the References header property. ## Object Oriented Interface ```text public function getMsgReferences(); public function setMsgReferences($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 96 ); secureblackbox_mailwriter_set($res, 96, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the Reply-To header property. ## Object Oriented Interface ```text public function getMsgReplyTo(); public function setMsgReplyTo($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 97 ); secureblackbox_mailwriter_set($res, 97, $value ); ``` ## 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](#msgfrom-property-secureblackbox_mailwriter-class) field. This property is not available at design time. ## Data Type String # MsgReturnPath Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the Return-Path header property. ## Object Oriented Interface ```text public function getMsgReturnPath(); public function setMsgReturnPath($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 98 ); secureblackbox_mailwriter_set($res, 98, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the Sender header property. ## Object Oriented Interface ```text public function getMsgSender(); public function setMsgSender($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 99 ); secureblackbox_mailwriter_set($res, 99, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value of the To header property. ## Object Oriented Interface ```text public function getMsgSendTo(); public function setMsgSendTo($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 100 ); secureblackbox_mailwriter_set($res, 100, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the subject property of this message. ## Object Oriented Interface ```text public function getMsgSubject(); public function setMsgSubject($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 101 ); secureblackbox_mailwriter_set($res, 101, $value ); ``` ## Default Value '' ## Remarks Contains the subject field of this message. This property is not available at design time. ## Data Type String # HeaderFieldCount Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the HeaderField arrays. ## Object Oriented Interface ```text public function getHeaderFieldCount(); public function setHeaderFieldCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 102 ); secureblackbox_mailwriter_set($res, 102, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [HeaderFieldCategory](#headerfieldcategory-property-secureblackbox_mailwriter-class) - [HeaderFieldFormat](#headerfieldformat-property-secureblackbox_mailwriter-class) - [HeaderFieldName](#headerfieldname-property-secureblackbox_mailwriter-class) - [HeaderFieldValue](#headerfieldvalue-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *HeaderFieldCount - 1*. This property is not available at design time. ## Data Type Integer # HeaderFieldCategory Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the string category of the contained value. ## Object Oriented Interface ```text public function getHeaderFieldCategory($headerfieldindex); public function setHeaderFieldCategory($headerfieldindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 103 , $headerfieldindex); secureblackbox_mailwriter_set($res, 103, $value , $headerfieldindex); ``` ## 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](#headerfieldcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # HeaderFieldFormat Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the format (encoding) of the value contained in the Value property. ## Object Oriented Interface ```text public function getHeaderFieldFormat($headerfieldindex); public function setHeaderFieldFormat($headerfieldindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 104 , $headerfieldindex); secureblackbox_mailwriter_set($res, 104, $value , $headerfieldindex); ``` ## Default Value 0 ## Remarks Specifies the format (encoding) of the value contained in the [HeaderFieldValue](#headerfieldvalue-property-secureblackbox_mailwriter-class) 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: ```text 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](#headerfieldcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type Integer # HeaderFieldName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name element in a (name, value) pair. ## Object Oriented Interface ```text public function getHeaderFieldName($headerfieldindex); public function setHeaderFieldName($headerfieldindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 105 , $headerfieldindex); secureblackbox_mailwriter_set($res, 105, $value , $headerfieldindex); ``` ## 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](#headerfieldcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # HeaderFieldValue Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The value element in a (name, value) pair. ## Object Oriented Interface ```text public function getHeaderFieldValue($headerfieldindex); public function setHeaderFieldValue($headerfieldindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 106 , $headerfieldindex); secureblackbox_mailwriter_set($res, 106, $value , $headerfieldindex); ``` ## 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](#headerfieldcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # Profile Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies a pre-defined profile to apply when creating the signature. ## Object Oriented Interface ```text public function getProfile(); public function setProfile($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 107 ); secureblackbox_mailwriter_set($res, 107, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the ReplyToAddr arrays. ## Object Oriented Interface ```text public function getReplyToAddrCount(); public function setReplyToAddrCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 108 ); secureblackbox_mailwriter_set($res, 108, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [ReplyToAddrAddress](#replytoaddraddress-property-secureblackbox_mailwriter-class) - [ReplyToAddrDisplayName](#replytoaddrdisplayname-property-secureblackbox_mailwriter-class) - [ReplyToAddrGroupName](#replytoaddrgroupname-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *ReplyToAddrCount - 1*. This property is not available at design time. ## Data Type Integer # ReplyToAddrAddress Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the e-mail address in the form of john@doe. ## Object Oriented Interface ```text public function getReplyToAddrAddress($replytoaddrindex); public function setReplyToAddrAddress($replytoaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 109 , $replytoaddrindex); secureblackbox_mailwriter_set($res, 109, $value , $replytoaddrindex); ``` ## 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](#replytoaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # ReplyToAddrDisplayName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the friendly name of the user of this address, such as John Doe. ## Object Oriented Interface ```text public function getReplyToAddrDisplayName($replytoaddrindex); public function setReplyToAddrDisplayName($replytoaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 110 , $replytoaddrindex); secureblackbox_mailwriter_set($res, 110, $value , $replytoaddrindex); ``` ## 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](#replytoaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # ReplyToAddrGroupName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the group this address belongs to. ## Object Oriented Interface ```text public function getReplyToAddrGroupName($replytoaddrindex); public function setReplyToAddrGroupName($replytoaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 111 , $replytoaddrindex); secureblackbox_mailwriter_set($res, 111, $value , $replytoaddrindex); ``` ## 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](#replytoaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # SecSettingsClaimedSigningTime Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the signing time from the signer's computer. ## Object Oriented Interface ```text public function getSecSettingsClaimedSigningTime(); public function setSecSettingsClaimedSigningTime($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 112 ); secureblackbox_mailwriter_set($res, 112, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Whether to encrypt the message. ## Object Oriented Interface ```text public function getSecSettingsEncrypt(); public function setSecSettingsEncrypt($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 113 ); secureblackbox_mailwriter_set($res, 113, $value ); ``` ## Default Value false ## Remarks Whether to encrypt the message. ## Data Type Boolean # SecSettingsEncryptionAlgorithm Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the encryption algorithm to be used. ## Object Oriented Interface ```text public function getSecSettingsEncryptionAlgorithm(); public function setSecSettingsEncryptionAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 114 ); secureblackbox_mailwriter_set($res, 114, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the hash algorithm to be used. ## Object Oriented Interface ```text public function getSecSettingsHashAlgorithm(); public function setSecSettingsHashAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 115 ); secureblackbox_mailwriter_set($res, 115, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Whether to sign the message. ## Object Oriented Interface ```text public function getSecSettingsSign(); public function setSecSettingsSign($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 116 ); secureblackbox_mailwriter_set($res, 116, $value ); ``` ## Default Value false ## Remarks Whether to sign the message. ## Data Type Boolean # SecSettingsSignatureFormat Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the signature format to use for the signed message. ## Object Oriented Interface ```text public function getSecSettingsSignatureFormat(); public function setSecSettingsSignatureFormat($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 117 ); secureblackbox_mailwriter_set($res, 117, $value ); ``` ## Possible Values ```text MAILWRITER_SECSETTINGSSIGNATUREFORMAT_MULTIPART_SIGNED(0), MAILWRITER_SECSETTINGSSIGNATUREFORMAT_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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies the order of encryption and signing operations. ## Object Oriented Interface ```text public function getSecSettingsSignBeforeEncrypt(); public function setSecSettingsSignBeforeEncrypt($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 118 ); secureblackbox_mailwriter_set($res, 118, $value ); ``` ## Default Value true ## Remarks Specifies the order of encryption and signing operations. ## Data Type Boolean # SecSettingsSignMessageHeader Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Specifies whether to include the message header in the signature calculation. ## Object Oriented Interface ```text public function getSecSettingsSignMessageHeader(); public function setSecSettingsSignMessageHeader($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 119 ); secureblackbox_mailwriter_set($res, 119, $value ); ``` ## Default Value false ## Remarks Specifies whether to include the message header in the signature calculation. ## Data Type Boolean # SenderAddrAddress Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the e-mail address in the form of john@doe. ## Object Oriented Interface ```text public function getSenderAddrAddress(); public function setSenderAddrAddress($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 120 ); secureblackbox_mailwriter_set($res, 120, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the friendly name of the user of this address, such as John Doe. ## Object Oriented Interface ```text public function getSenderAddrDisplayName(); public function setSenderAddrDisplayName($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 121 ); secureblackbox_mailwriter_set($res, 121, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the group this address belongs to. ## Object Oriented Interface ```text public function getSenderAddrGroupName(); public function setSenderAddrGroupName($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 122 ); secureblackbox_mailwriter_set($res, 122, $value ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the SendToAddr arrays. ## Object Oriented Interface ```text public function getSendToAddrCount(); public function setSendToAddrCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 123 ); secureblackbox_mailwriter_set($res, 123, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SendToAddrAddress](#sendtoaddraddress-property-secureblackbox_mailwriter-class) - [SendToAddrDisplayName](#sendtoaddrdisplayname-property-secureblackbox_mailwriter-class) - [SendToAddrGroupName](#sendtoaddrgroupname-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *SendToAddrCount - 1*. This property is not available at design time. ## Data Type Integer # SendToAddrAddress Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the e-mail address in the form of john@doe. ## Object Oriented Interface ```text public function getSendToAddrAddress($sendtoaddrindex); public function setSendToAddrAddress($sendtoaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 124 , $sendtoaddrindex); secureblackbox_mailwriter_set($res, 124, $value , $sendtoaddrindex); ``` ## 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](#sendtoaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # SendToAddrDisplayName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Contains the friendly name of the user of this address, such as John Doe. ## Object Oriented Interface ```text public function getSendToAddrDisplayName($sendtoaddrindex); public function setSendToAddrDisplayName($sendtoaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 125 , $sendtoaddrindex); secureblackbox_mailwriter_set($res, 125, $value , $sendtoaddrindex); ``` ## 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](#sendtoaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # SendToAddrGroupName Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The name of the group this address belongs to. ## Object Oriented Interface ```text public function getSendToAddrGroupName($sendtoaddrindex); public function setSendToAddrGroupName($sendtoaddrindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 126 , $sendtoaddrindex); secureblackbox_mailwriter_set($res, 126, $value , $sendtoaddrindex); ``` ## 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](#sendtoaddrcount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type String # SigningCertBytes Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getSigningCertBytes(); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 127 ); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getSigningCertHandle(); public function setSigningCertHandle($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 135 ); secureblackbox_mailwriter_set($res, 135, $value ); ``` ## 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # SigningChainCount Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The number of records in the SigningChain arrays. ## Object Oriented Interface ```text public function getSigningChainCount(); public function setSigningChainCount($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 166 ); secureblackbox_mailwriter_set($res, 166, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SigningChainBytes](#signingchainbytes-property-secureblackbox_mailwriter-class) - [SigningChainHandle](#signingchainhandle-property-secureblackbox_mailwriter-class) The array indices start at *0* and end at *SigningChainCount - 1*. This property is not available at design time. ## Data Type Integer # SigningChainBytes Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getSigningChainBytes($signingchainindex); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 167 , $signingchainindex); ``` ## 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](#signingchaincount-property-secureblackbox_mailwriter-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # SigningChainHandle Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getSigningChainHandle($signingchainindex); public function setSigningChainHandle($signingchainindex, $value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 175 , $signingchainindex); secureblackbox_mailwriter_set($res, 175, $value , $signingchainindex); ``` ## 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. ```text 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](#signingchaincount-property-secureblackbox_mailwriter-class) property. This property is not available at design time. ## Data Type Long64 # TextEncoding Property ([SecureBlackbox_MailWriter](#mailwriter-class) Class) The encoding to be applied to the message. ## Object Oriented Interface ```text public function getTextEncoding(); public function setTextEncoding($value); ``` ## Procedural Interface ```text secureblackbox_mailwriter_get($res, 206 ); secureblackbox_mailwriter_set($res, 206, $value ); ``` ## Possible Values ```text MAILWRITER_TEXTENCODING_AUTO(0), MAILWRITER_TEXTENCODING_8BIT(1), MAILWRITER_TEXTENCODING_BASE_64(2), MAILWRITER_TEXTENCODING_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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Creates an attachment from a memory buffer. ## Object Oriented Interface ```text public function doAttachBytes($data); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_attachbytes($res, $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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Creates an attachment from a file. ## Object Oriented Interface ```text public function doAttachFile($filename); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_attachfile($res, $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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Creates an image attachment from a memory buffer. ## Object Oriented Interface ```text public function doAttachImage($id, $data); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_attachimage($res, $id, $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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_config($res, $configurationstring); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-mailwriter-class) 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](#config-settings-mailwriter-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # CreateNew Method ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Creates a template for a new message. ## Object Oriented Interface ```text public function doCreateNew(); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_createnew($res); ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Performs an additional action. ## Object Oriented Interface ```text public function doDoAction($actionid, $actionparams); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_doaction($res, $actionid, $actionparams); ``` ## 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 (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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Resets the class settings. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_reset($res); ``` ## Remarks Reset is a generic method available in every class. # SaveToBytes Method ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Serializes the message to a byte array. ## Object Oriented Interface ```text public function doSaveToBytes(); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_savetobytes($res); ``` ## Remarks Use this method to assemble the message and save it to a byte array. # SaveToFile Method ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Serializes the message to a file. ## Object Oriented Interface ```text public function doSaveToFile($filename); ``` ## Procedural Interface ```text secureblackbox_mailwriter_do_savetofile($res, $filename); ``` ## Remarks Use this method to assemble the message and save it to a file. # Error Event ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Reports information about errors during e-mail message assembling or saving. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text secureblackbox_mailwriter_register_callback($res, 1, array($this, 'fireError')); ``` ## Parameter List ```text 'errorcode' 'description' ``` ## 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) Handles remote or external signing initiated by the SignExternal method or other source. ## Object Oriented Interface ```text public function fireExternalSign($param); ``` ## Procedural Interface ```text secureblackbox_mailwriter_register_callback($res, 2, array($this, 'fireExternalSign')); ``` ## Parameter List ```text 'operationid' 'hashalgorithm' 'pars' 'data' 'signeddata' ``` ## 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 class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class 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: ```text 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 ([SecureBlackbox_MailWriter](#mailwriter-class) Class) This event notifies the application about an underlying control flow event. ## Object Oriented Interface ```text public function fireNotification($param); ``` ## Procedural Interface ```text secureblackbox_mailwriter_register_callback($res, 3, array($this, 'fireNotification')); ``` ## Parameter List ```text 'eventid' 'eventparam' ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted. # Config Settings ([MailWriter](#mailwriter-class) 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](#config-method-secureblackbox_mailwriter-class) 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. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. ### 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 class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.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. **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. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **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". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **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. **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): ```text 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: ```text 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 class. 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 class) 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 divided 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 class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class 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 cached 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 classes. **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: ```text 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: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text 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](#mailwriter-class) Class) ### MailWriter Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 22020097 | Failed to assemble the mail message ([SB_ERROR_MAIL_ASSEMBLY_FAILED](constants.md#const_SBERRORMAILASSEMBLYFAILED)) | | 22020098 | Failed to assemble the mail message ([SB_ERROR_MAIL_PARSING_FAILED](constants.md#const_SBERRORMAILPARSINGFAILED)) | | 22020099 | No decryption certificate found ([SB_ERROR_MAIL_NO_DECRYPTION_CERTIFICATE](constants.md#const_SBERRORMAILNODECRYPTIONCERTIFICATE)) |