MailReader Component
Properties Methods Events Configuration Settings Errors
The MailReader component implements parsing and decryption of e-mail messages.
Syntax
nsoftware.SecureBlackbox.Mailreader
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 component with short descriptions. Click on the links for further details.
| Attachments | Provides access to Message's attachments. |
| Bcc | The contents of the BCC header field of the Message. |
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| Cc | The value of the CC header field of the Message. |
| DecryptionCertificate | The certificate to be used for decryption. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| From | Contains the value of the From header of the Message. |
| IgnoreChainValidationErrors | Makes the component tolerant to chain validation errors. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| Message | The message that is currently stored in the component. |
| OfflineMode | Switches the component to the offline mode. |
| OtherHeaders | Contains secondary headers of the mail message. |
| Profile | Specifies a pre-defined profile to apply when creating the signature. |
| Proxy | The proxy server settings. |
| ReplyTo | The value of the Reply-To header field of the Message. |
| RevocationCheck | Specifies the kind(s) of revocation check to perform. |
| SecurityInfo | Contains the Message's security info. |
| Sender | The value of the Sender header field of the Message. |
| SendTo | The value of the To header field of the Message. |
| SigningCertificate | The certificate of the signature creator. |
| SocketSettings | Manages network connection settings. |
| TLSSettings | Manages TLS layer settings. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| UsedCertificates | Contains a list of certificates used during the chain validation routine. |
| 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 component 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. |
| LoadFromStream | Loads an e-mail message from a stream. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| ChainValidated | Reports the completion of a certificate chain validation. |
| DecryptionInfoNeeded | Asks the application to provide a decryption certificate. |
| Error | Reports information about errors during e-mail message loading, parsing or saving. |
| ExternalDecrypt | Handles remote or external decryption. |
| Notification | This event notifies the application about an underlying control flow event. |
| SignatureFound | Signifies the start of signature validation. |
| SignatureValidated | Marks the completion of the signature validation routine. |
Configuration Settings
The following is a list of configuration settings for the component 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 component (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 components 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. |