SecureBlackbox 2020 iOS Edition

Questions / Feedback?

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.

- attachCountThe number of records in the Attach arrays.
- attachContentSubtype:(int)attachIndexContains the content subtype of the attachment.
- attachContentType:(int)attachIndexContain the content type of the attachment.
- attachCreationDate:(int)attachIndexThe creation date.
- attachData:(int)attachIndexThe content of the attachment.
- attachDescription:(int)attachIndexTextual description of the attachment.
- attachFilename:(int)attachIndexSpecifies the name of the attachment file.
- attachID:(int)attachIndexContains the attachment's unique identifier.
- attachModificationDate:(int)attachIndexSpecifies the date and time of the file's last modification.
- attachReadDate:(int)attachIndexSpecifies the file's last read date.
- attachSize:(int)attachIndexAttachment's size in bytes.
- bccAddrCountThe number of records in the BccAddr arrays.
- bccAddrAddress:(int)bccAddrIndexContains the e-mail address in the form of john@doe.
- bccAddrDisplayName:(int)bccAddrIndexContains the friendly name of the user of this address, such as John Doe.
- bccAddrGroupName:(int)bccAddrIndexThe name of the group this address belongs to.
- blockedCertCountThe number of records in the BlockedCert arrays.
- blockedCertBytes:(int)blockedCertIndexReturns raw certificate data in DER format.
- blockedCertHandle:(int)blockedCertIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- ccAddrCountThe number of records in the CcAddr arrays.
- ccAddrAddress:(int)ccAddrIndexContains the e-mail address in the form of john@doe.
- ccAddrDisplayName:(int)ccAddrIndexContains the friendly name of the user of this address, such as John Doe.
- ccAddrGroupName:(int)ccAddrIndexThe name of the group this address belongs to.
- decryptionCertBytesReturns raw certificate data in DER format.
- decryptionCertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
- decryptionCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
- decryptionCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
- decryptionCertCurveSpecifies the elliptic curve of the EC public key.
- decryptionCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
- decryptionCertFriendlyNameContains an associated alias (friendly name) of the certificate.
- decryptionCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
- decryptionCertHashAlgorithmSpecifies 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 .
- decryptionCertIssuerThe common name of the certificate issuer (CA), typically a company name.
- decryptionCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
- decryptionCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
- decryptionCertKeyBitsReturns the length of the public key.
- decryptionCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
- decryptionCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
- decryptionCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
- decryptionCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
- decryptionCertOriginReturns the origin of this certificate.
- decryptionCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
- decryptionCertPrivateKeyBytesContains the certificate's private key.
- decryptionCertPrivateKeyExistsIndicates whether the certificate has an associated private key.
- decryptionCertPrivateKeyExtractableIndicates whether the private key is extractable.
- decryptionCertPublicKeyBytesContains the certificate's public key in DER format.
- decryptionCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
- decryptionCertSerialNumberReturns the certificate's serial number.
- decryptionCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
- decryptionCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
- decryptionCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
- decryptionCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
- decryptionCertValidFromThe time point at which the certificate becomes valid, in UTC.
- decryptionCertValidToThe time point at which the certificate expires, in UTC.
- externalCryptoCustomParamsCustom parameters to be passed to the signing service (uninterpreted).
- externalCryptoDataAdditional data to be included in the async state and mirrored back by the requestor.
- externalCryptoExternalHashCalculationSpecifies whether the message hash is to be calculated at the external endpoint.
- externalCryptoHashAlgorithmSpecifies the request's signature hash algorithm.
- externalCryptoKeyIDThe ID of the pre-shared key used for DC request authentication.
- externalCryptoKeySecretThe pre-shared key used for DC request authentication.
- externalCryptoMethodSpecifies the asynchronous signing method.
- externalCryptoModeSpecifies the external cryptography mode.
- externalCryptoPublicKeyAlgorithmProvide public key algorithm here if the certificate is not available on the pre-signing stage.
- fromAddrCountThe number of records in the FromAddr arrays.
- fromAddrAddress:(int)fromAddrIndexContains the e-mail address in the form of john@doe.
- fromAddrDisplayName:(int)fromAddrIndexContains the friendly name of the user of this address, such as John Doe.
- fromAddrGroupName:(int)fromAddrIndexThe name of the group this address belongs to.
- ignoreChainValidationErrorsMakes the class tolerant to chain validation errors.
- knownCertCountThe number of records in the KnownCert arrays.
- knownCertBytes:(int)knownCertIndexReturns raw certificate data in DER format.
- knownCertHandle:(int)knownCertIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- knownCRLCountThe number of records in the KnownCRL arrays.
- knownCRLBytes:(int)knownCRLIndexReturns raw CRL data in DER format.
- knownCRLHandle:(int)knownCRLIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- knownOCSPCountThe number of records in the KnownOCSP arrays.
- knownOCSPBytes:(int)knownOCSPIndexBuffer containing raw OCSP response data.
- knownOCSPHandle:(int)knownOCSPIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- msgAttachmentCountReturns the number of attachments in this message.
- msgBccThe contents of the BCC header property.
- msgCcThe value of the CC header property.
- msgCommentsContains additional information about the message body.
- msgDateThe date and time when the message entered the mail delivery system.
- msgDeliveryReceiptEnables delivery notification.
- msgFromContains the value of the From header property.
- msgHtmlTextThe HTML version of the message.
- msgIDThe contents of the Message-ID header property.
- msgInReplyToThe value of the In-Reply-To header property.
- msgKeywordsThe value of the Keywords header property.
- msgMailerThe name of the software that was used to send the message.
- msgPlainTextThe plain text version of the message.
- msgPrioritySpecifies the message priority.
- msgReadReceiptEnables a read notification.
- msgReferencesThe value of the References header property.
- msgReplyToThe value of the Reply-To header property.
- msgReturnPathThe value of the Return-Path header property.
- msgSenderThe value of the Sender header property.
- msgSendToThe value of the To header property.
- msgSubjectContains the subject property of this message.
- offlineModeSwitches the class to the offline mode.
- headerFieldCountThe number of records in the HeaderField arrays.
- headerFieldName:(int)headerFieldIndexThe name element in a (name, value) pair.
- headerFieldValue:(int)headerFieldIndexThe value element in a (name, value) pair.
- profileSpecifies a pre-defined profile to apply when creating the signature.
- proxyAddressThe IP address of the proxy server.
- proxyAuthenticationThe authentication type used by the proxy server.
- proxyPasswordThe password to authenticate to the proxy server.
- proxyPortThe port on the proxy server to connect to.
- proxyProxyTypeThe type of the proxy server.
- proxyRequestHeadersContains HTTP request headers for WebTunnel and HTTP proxy.
- proxyResponseBodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
- proxyResponseHeadersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
- proxyUseIPv6Specifies whether IPv6 should be used when connecting through the proxy.
- proxyUseProxyEnables or disables proxy-driven connection.
- proxyUsernameSpecifies the username credential for proxy authentication.
- replyToAddrCountThe number of records in the ReplyToAddr arrays.
- replyToAddrAddress:(int)replyToAddrIndexContains the e-mail address in the form of john@doe.
- replyToAddrDisplayName:(int)replyToAddrIndexContains the friendly name of the user of this address, such as John Doe.
- replyToAddrGroupName:(int)replyToAddrIndexThe name of the group this address belongs to.
- revocationCheckSpecifies the kind(s) of revocation check to perform.
- secInfoChainValidationDetailsThe details of a certificate chain validation outcome.
- secInfoChainValidationResultThe outcome of a certificate chain validation routine.
- secInfoClaimedSigningTimeReturns the signature's claimed signing time.
- secInfoEncryptedIndicates whether the message is encrypted.
- secInfoEncryptionAlgorithmIndicates the algorithm that was used to encrypt the message.
- secInfoHashAlgorithmSpecifies the hash algorithm that was used to calculate the signature.
- secInfoSignatureValidationResultThe outcome of the cryptographic signature validation.
- secInfoSignedIndicates whether the message is signed.
- secInfoValidationLogContains the signing certificate's chain validation log.
- senderAddrAddressContains the e-mail address in the form of john@doe.
- senderAddrDisplayNameContains the friendly name of the user of this address, such as John Doe.
- senderAddrGroupNameThe name of the group this address belongs to.
- sendToAddrCountThe number of records in the SendToAddr arrays.
- sendToAddrAddress:(int)sendToAddrIndexContains the e-mail address in the form of john@doe.
- sendToAddrDisplayName:(int)sendToAddrIndexContains the friendly name of the user of this address, such as John Doe.
- sendToAddrGroupName:(int)sendToAddrIndexThe name of the group this address belongs to.
- signingCertBytesReturns raw certificate data in DER format.
- signingCertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
- signingCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
- signingCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
- signingCertCurveSpecifies the elliptic curve of the EC public key.
- signingCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
- signingCertFriendlyNameContains an associated alias (friendly name) of the certificate.
- signingCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
- signingCertHashAlgorithmSpecifies 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 .
- signingCertIssuerThe common name of the certificate issuer (CA), typically a company name.
- signingCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
- signingCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
- signingCertKeyBitsReturns the length of the public key.
- signingCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
- signingCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
- signingCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
- signingCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
- signingCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
- signingCertPublicKeyBytesContains the certificate's public key in DER format.
- signingCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
- signingCertSerialNumberReturns the certificate's serial number.
- signingCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
- signingCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
- signingCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
- signingCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
- signingCertValidFromThe time point at which the certificate becomes valid, in UTC.
- signingCertValidToThe time point at which the certificate expires, in UTC.
- socketDNSModeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
- socketDNSPortSpecifies the port number to be used for sending queries to the DNS server.
- socketDNSQueryTimeoutThe timeout (in milliseconds) for each DNS query.
- socketDNSServersThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
- socketDNSTotalTimeoutThe timeout (in milliseconds) for the whole resolution process.
- socketIncomingSpeedLimitThe maximum number of bytes to read from the socket, per second.
- socketLocalAddressThe local network interface to bind the socket to.
- socketLocalPortThe local port number to bind the socket to.
- socketOutgoingSpeedLimitThe maximum number of bytes to write to the socket, per second.
- socketTimeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
- socketUseIPv6Enables or disables IP protocol version 6.
- TLSAutoValidateCertificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
- TLSBaseConfigurationSelects the base configuration for the TLS settings.
- TLSCiphersuitesA list of ciphersuites separated with commas or semicolons.
- TLSECCurvesDefines the elliptic curves to enable.
- TLSForceResumeIfDestinationChangesWhether to force TLS session resumption when the destination address changes.
- TLSPreSharedIdentityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
- TLSPreSharedKeyContains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
- TLSPreSharedKeyCiphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
- TLSRenegotiationAttackPreventionModeSelects renegotiation attack prevention mechanism.
- TLSRevocationCheckSpecifies the kind(s) of revocation check to perform.
- TLSSSLOptionsVarious 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.
- TLSTLSModeSpecifies the TLS mode to use.
- TLSUseExtendedMasterSecretEnables Extended Master Secret Extension, as defined in RFC 7627.
- TLSUseSessionResumptionEnables or disables TLS session resumption capability.
- TLSVersionsTh SSL/TLS versions to enable by default.
- trustedCertCountThe number of records in the TrustedCert arrays.
- trustedCertBytes:(int)trustedCertIndexReturns raw certificate data in DER format.
- trustedCertHandle:(int)trustedCertIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- usedCertCountThe number of records in the UsedCert arrays.
- usedCertBytes:(int)usedCertIndexReturns raw certificate data in DER format.
- usedCertCA:(int)usedCertIndexIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
- usedCertCAKeyID:(int)usedCertIndexA unique identifier (fingerprint) of the CA certificate's private key.
- usedCertCRLDistributionPoints:(int)usedCertIndexLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
- usedCertCurve:(int)usedCertIndexSpecifies the elliptic curve of the EC public key.
- usedCertFingerprint:(int)usedCertIndexContains the fingerprint (a hash imprint) of this certificate.
- usedCertFriendlyName:(int)usedCertIndexContains an associated alias (friendly name) of the certificate.
- usedCertHandle:(int)usedCertIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- usedCertHashAlgorithm:(int)usedCertIndexSpecifies 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)usedCertIndexThe common name of the certificate issuer (CA), typically a company name.
- usedCertIssuerRDN:(int)usedCertIndexA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
- usedCertKeyAlgorithm:(int)usedCertIndexSpecifies the public key algorithm of this certificate.
- usedCertKeyBits:(int)usedCertIndexReturns the length of the public key.
- usedCertKeyFingerprint:(int)usedCertIndexReturns a fingerprint of the public key contained in the certificate.
- usedCertKeyUsage:(int)usedCertIndexIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
- usedCertKeyValid:(int)usedCertIndexReturns True if the certificate's key is cryptographically valid, and False otherwise.
- usedCertOCSPLocations:(int)usedCertIndexLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
- usedCertOrigin:(int)usedCertIndexReturns the origin of this certificate.
- usedCertPolicyIDs:(int)usedCertIndexContains identifiers (OIDs) of the applicable certificate policies.
- usedCertPrivateKeyBytes:(int)usedCertIndexContains the certificate's private key.
- usedCertPrivateKeyExists:(int)usedCertIndexIndicates whether the certificate has an associated private key.
- usedCertPrivateKeyExtractable:(int)usedCertIndexIndicates whether the private key is extractable.
- usedCertPublicKeyBytes:(int)usedCertIndexContains the certificate's public key in DER format.
- usedCertSelfSigned:(int)usedCertIndexIndicates whether the certificate is self-signed (root) or signed by an external CA.
- usedCertSerialNumber:(int)usedCertIndexReturns the certificate's serial number.
- usedCertSigAlgorithm:(int)usedCertIndexIndicates the algorithm that was used by the CA to sign this certificate.
- usedCertSubject:(int)usedCertIndexThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
- usedCertSubjectKeyID:(int)usedCertIndexContains a unique identifier (fingerprint) of the certificate's private key.
- usedCertSubjectRDN:(int)usedCertIndexA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
- usedCertValidFrom:(int)usedCertIndexThe time point at which the certificate becomes valid, in UTC.
- usedCertValidTo:(int)usedCertIndexThe time point at which the certificate expires, in UTC.
- validationMomentThe 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.

- configSets or retrieves a configuration setting.
- findAttachmentLooks up a Message's attachment by its ID.
- loadFromBytesLoads an e-mail message from a byte array.
- loadFromFileLoads 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.

- onChainValidatedReports the completion of a certificate chain validation.
- onDecryptionInfoNeededAsks the application to provide a decryption certificate.
- onErrorReports information about errors during e-mail message loading, parsing or saving.
- onExternalDecryptHandles remote or external decryption.
- onNotificationThis event notifies the application about an underlying control flow event.
- onSignatureFoundSignifies the start of signature validation.
- onSignatureValidatedMarks 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.

GracePeriodSpecifies a grace period to apply during revocation information checks.
HeaderCharsetCharset of the header. If not empty, the one specified in the message header will be ignored.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
TempPathPath for storing temporary files.
TextCharsetCharset of text parts, if any. If not empty, the one specified in the message text parts will be ignored.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseMicrosoftCTLEnables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 iOS Edition - Version 20.0 [Build 8165]