MailReader Class
Properties Methods Events Configuration Settings Errors
The MailReader class implements parsing and decryption of e-mail messages.
Syntax
SecureBlackboxMailReader
SecureBlackboxMailReaderSwift
Remarks
MailReader parses and decrypts e-mail messages, as well as verifies electronic signatures.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| - attachCount | The number of records in the Attach arrays. |
| - attachContentSubtype:(int)attachIndex | Contains the content subtype of the attachment. |
| - attachContentType:(int)attachIndex | Contain the content type of the attachment. |
| - attachCreationDate:(int)attachIndex | The creation date. |
| - attachData:(int)attachIndex | The content of the attachment. |
| - attachDescription:(int)attachIndex | Textual description of the attachment. |
| - attachFilename:(int)attachIndex | Specifies the name of the attachment file. |
| - attachID:(int)attachIndex | Contains the attachment's unique identifier. |
| - attachModificationDate:(int)attachIndex | Specifies the date and time of the file's last modification. |
| - attachReadDate:(int)attachIndex | Specifies the file's last read date. |
| - attachSize:(int)attachIndex | Attachment's size in bytes. |
| - bccAddrCount | The number of records in the BccAddr arrays. |
| - bccAddrAddress:(int)bccAddrIndex | Contains the e-mail address in the form of john@doe. |
| - bccAddrDisplayName:(int)bccAddrIndex | Contains the friendly name of the user of this address, such as John Doe. |
| - bccAddrGroupName:(int)bccAddrIndex | The name of the group this address belongs to. |
| - blockedCertCount | The number of records in the BlockedCert arrays. |
| - blockedCertBytes:(int)blockedCertIndex | Returns raw certificate data in DER format. |
| - blockedCertHandle:(int)blockedCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - ccAddrCount | The number of records in the CcAddr arrays. |
| - ccAddrAddress:(int)ccAddrIndex | Contains the e-mail address in the form of john@doe. |
| - ccAddrDisplayName:(int)ccAddrIndex | Contains the friendly name of the user of this address, such as John Doe. |
| - ccAddrGroupName:(int)ccAddrIndex | The name of the group this address belongs to. |
| - decryptionCertBytes | Returns raw certificate data in DER format. |
| - decryptionCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| - decryptionCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| - decryptionCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| - decryptionCertCurve | Specifies the elliptic curve of the EC public key. |
| - decryptionCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| - decryptionCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| - decryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - decryptionCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
| - decryptionCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| - decryptionCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| - decryptionCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| - decryptionCertKeyBits | Returns the length of the public key. |
| - decryptionCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| - decryptionCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| - decryptionCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| - decryptionCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| - decryptionCertOrigin | Returns the origin of this certificate. |
| - decryptionCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| - decryptionCertPrivateKeyBytes | Contains the certificate's private key. |
| - decryptionCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
| - decryptionCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
| - decryptionCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| - decryptionCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| - decryptionCertSerialNumber | Returns the certificate's serial number. |
| - decryptionCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| - decryptionCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| - decryptionCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| - decryptionCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| - decryptionCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| - decryptionCertValidTo | The time point at which the certificate expires, in UTC. |
| - externalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| - externalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| - externalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| - externalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| - externalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| - externalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| - externalCryptoMethod | Specifies the asynchronous signing method. |
| - externalCryptoMode | Specifies the external cryptography mode. |
| - externalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
| - fromAddrCount | The number of records in the FromAddr arrays. |
| - fromAddrAddress:(int)fromAddrIndex | Contains the e-mail address in the form of john@doe. |
| - fromAddrDisplayName:(int)fromAddrIndex | Contains the friendly name of the user of this address, such as John Doe. |
| - fromAddrGroupName:(int)fromAddrIndex | The name of the group this address belongs to. |
| - ignoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
| - knownCertCount | The number of records in the KnownCert arrays. |
| - knownCertBytes:(int)knownCertIndex | Returns raw certificate data in DER format. |
| - knownCertHandle:(int)knownCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - knownCRLCount | The number of records in the KnownCRL arrays. |
| - knownCRLBytes:(int)knownCRLIndex | Returns raw CRL data in DER format. |
| - knownCRLHandle:(int)knownCRLIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - knownOCSPCount | The number of records in the KnownOCSP arrays. |
| - knownOCSPBytes:(int)knownOCSPIndex | Buffer containing raw OCSP response data. |
| - knownOCSPHandle:(int)knownOCSPIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - msgAttachmentCount | Returns the number of attachments in this message. |
| - msgBcc | The contents of the BCC header property. |
| - msgCc | The value of the CC header property. |
| - msgComments | Contains additional information about the message body. |
| - msgDate | The date and time when the message entered the mail delivery system. |
| - msgDeliveryReceipt | Enables delivery notification. |
| - msgFrom | Contains the value of the From header property. |
| - msgHtmlText | The HTML version of the message. |
| - msgID | The contents of the Message-ID header property. |
| - msgInReplyTo | The value of the In-Reply-To header property. |
| - msgKeywords | The value of the Keywords header property. |
| - msgMailer | The name of the software that was used to send the message. |
| - msgPlainText | The plain text version of the message. |
| - msgPriority | Specifies the message priority. |
| - msgReadReceipt | Enables a read notification. |
| - msgReferences | The value of the References header property. |
| - msgReplyTo | The value of the Reply-To header property. |
| - msgReturnPath | The value of the Return-Path header property. |
| - msgSender | The value of the Sender header property. |
| - msgSendTo | The value of the To header property. |
| - msgSubject | Contains the subject property of this message. |
| - offlineMode | Switches the class to the offline mode. |
| - headerFieldCount | The number of records in the HeaderField arrays. |
| - headerFieldName:(int)headerFieldIndex | The name element in a (name, value) pair. |
| - headerFieldValue:(int)headerFieldIndex | The value element in a (name, value) pair. |
| - profile | Specifies a pre-defined profile to apply when creating the signature. |
| - proxyAddress | The IP address of the proxy server. |
| - proxyAuthentication | The authentication type used by the proxy server. |
| - proxyPassword | The password to authenticate to the proxy server. |
| - proxyPort | The port on the proxy server to connect to. |
| - proxyProxyType | The type of the proxy server. |
| - proxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| - proxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| - proxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| - proxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
| - proxyUseProxy | Enables or disables proxy-driven connection. |
| - proxyUsername | Specifies the username credential for proxy authentication. |
| - replyToAddrCount | The number of records in the ReplyToAddr arrays. |
| - replyToAddrAddress:(int)replyToAddrIndex | Contains the e-mail address in the form of john@doe. |
| - replyToAddrDisplayName:(int)replyToAddrIndex | Contains the friendly name of the user of this address, such as John Doe. |
| - replyToAddrGroupName:(int)replyToAddrIndex | The name of the group this address belongs to. |
| - revocationCheck | Specifies the kind(s) of revocation check to perform. |
| - secInfoChainValidationDetails | The details of a certificate chain validation outcome. |
| - secInfoChainValidationResult | The outcome of a certificate chain validation routine. |
| - secInfoClaimedSigningTime | Returns the signature's claimed signing time. |
| - secInfoEncrypted | Indicates whether the message is encrypted. |
| - secInfoEncryptionAlgorithm | Indicates the algorithm that was used to encrypt the message. |
| - secInfoHashAlgorithm | Specifies the hash algorithm that was used to calculate the signature. |
| - secInfoSignatureValidationResult | The outcome of the cryptographic signature validation. |
| - secInfoSigned | Indicates whether the message is signed. |
| - secInfoValidationLog | Contains the signing certificate's chain validation log. |
| - senderAddrAddress | Contains the e-mail address in the form of john@doe. |
| - senderAddrDisplayName | Contains the friendly name of the user of this address, such as John Doe. |
| - senderAddrGroupName | The name of the group this address belongs to. |
| - sendToAddrCount | The number of records in the SendToAddr arrays. |
| - sendToAddrAddress:(int)sendToAddrIndex | Contains the e-mail address in the form of john@doe. |
| - sendToAddrDisplayName:(int)sendToAddrIndex | Contains the friendly name of the user of this address, such as John Doe. |
| - sendToAddrGroupName:(int)sendToAddrIndex | The name of the group this address belongs to. |
| - signingCertBytes | Returns raw certificate data in DER format. |
| - signingCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| - signingCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| - signingCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| - signingCertCurve | Specifies the elliptic curve of the EC public key. |
| - signingCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| - signingCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| - signingCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - signingCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
| - signingCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| - signingCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| - signingCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| - signingCertKeyBits | Returns the length of the public key. |
| - signingCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| - signingCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| - signingCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| - signingCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| - signingCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| - signingCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| - signingCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| - signingCertSerialNumber | Returns the certificate's serial number. |
| - signingCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| - signingCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| - signingCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| - signingCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| - signingCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| - signingCertValidTo | The time point at which the certificate expires, in UTC. |
| - socketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
| - socketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
| - socketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
| - socketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| - socketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
| - socketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
| - socketLocalAddress | The local network interface to bind the socket to. |
| - socketLocalPort | The local port number to bind the socket to. |
| - socketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
| - socketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| - socketUseIPv6 | Enables or disables IP protocol version 6. |
| - TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| - TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
| - TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
| - TLSECCurves | Defines the elliptic curves to enable. |
| - TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
| - TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| - TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| - TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| - TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
| - TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
| - TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| - TLSTLSMode | Specifies the TLS mode to use. |
| - TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
| - TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
| - TLSVersions | Th SSL/TLS versions to enable by default. |
| - trustedCertCount | The number of records in the TrustedCert arrays. |
| - trustedCertBytes:(int)trustedCertIndex | Returns raw certificate data in DER format. |
| - trustedCertHandle:(int)trustedCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - usedCertCount | The number of records in the UsedCert arrays. |
| - usedCertBytes:(int)usedCertIndex | Returns raw certificate data in DER format. |
| - usedCertCA:(int)usedCertIndex | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| - usedCertCAKeyID:(int)usedCertIndex | A unique identifier (fingerprint) of the CA certificate's private key. |
| - usedCertCRLDistributionPoints:(int)usedCertIndex | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| - usedCertCurve:(int)usedCertIndex | Specifies the elliptic curve of the EC public key. |
| - usedCertFingerprint:(int)usedCertIndex | Contains the fingerprint (a hash imprint) of this certificate. |
| - usedCertFriendlyName:(int)usedCertIndex | Contains an associated alias (friendly name) of the certificate. |
| - usedCertHandle:(int)usedCertIndex | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| - usedCertHashAlgorithm:(int)usedCertIndex | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
| - usedCertIssuer:(int)usedCertIndex | The common name of the certificate issuer (CA), typically a company name. |
| - usedCertIssuerRDN:(int)usedCertIndex | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| - usedCertKeyAlgorithm:(int)usedCertIndex | Specifies the public key algorithm of this certificate. |
| - usedCertKeyBits:(int)usedCertIndex | Returns the length of the public key. |
| - usedCertKeyFingerprint:(int)usedCertIndex | Returns a fingerprint of the public key contained in the certificate. |
| - usedCertKeyUsage:(int)usedCertIndex | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| - usedCertKeyValid:(int)usedCertIndex | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| - usedCertOCSPLocations:(int)usedCertIndex | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| - usedCertOrigin:(int)usedCertIndex | Returns the origin of this certificate. |
| - usedCertPolicyIDs:(int)usedCertIndex | Contains identifiers (OIDs) of the applicable certificate policies. |
| - usedCertPrivateKeyBytes:(int)usedCertIndex | Contains the certificate's private key. |
| - usedCertPrivateKeyExists:(int)usedCertIndex | Indicates whether the certificate has an associated private key. |
| - usedCertPrivateKeyExtractable:(int)usedCertIndex | Indicates whether the private key is extractable. |
| - usedCertPublicKeyBytes:(int)usedCertIndex | Contains the certificate's public key in DER format. |
| - usedCertSelfSigned:(int)usedCertIndex | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| - usedCertSerialNumber:(int)usedCertIndex | Returns the certificate's serial number. |
| - usedCertSigAlgorithm:(int)usedCertIndex | Indicates the algorithm that was used by the CA to sign this certificate. |
| - usedCertSubject:(int)usedCertIndex | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| - usedCertSubjectKeyID:(int)usedCertIndex | Contains a unique identifier (fingerprint) of the certificate's private key. |
| - usedCertSubjectRDN:(int)usedCertIndex | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| - usedCertValidFrom:(int)usedCertIndex | The time point at which the certificate becomes valid, in UTC. |
| - usedCertValidTo:(int)usedCertIndex | The time point at which the certificate expires, in UTC. |
| - validationMoment | The time point at which signature validity is to be established. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| - config | Sets or retrieves a configuration setting. |
| - findAttachment | Looks up a Message's attachment by its ID. |
| - loadFromBytes | Loads an e-mail message from a byte array. |
| - loadFromFile | Loads an e-mail message from 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.
| - onChainValidated | Reports the completion of a certificate chain validation. |
| - onDecryptionInfoNeeded | Asks the application to provide a decryption certificate. |
| - onError | Reports information about errors during e-mail message loading, parsing or saving. |
| - onExternalDecrypt | Handles remote or external decryption. |
| - onNotification | This event notifies the application about an underlying control flow event. |
| - onSignatureFound | Signifies the start of signature validation. |
| - onSignatureValidated | Marks the completion of the signature validation routine. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| HeaderCharset | Charset of the header. If not empty, the one specified in the message header will be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| TempPath | Path for storing temporary files. |
| TextCharset | Charset of text parts, if any. If not empty, the one specified in the message text parts will be ignored. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |