POP3Client Component
Properties Methods Events Configuration Settings Errors
The POP3Client component provides client-side functionality of the POP3 protocol for collecting E-mail messages from the server.
Syntax
secureblackbox.Pop3client
Remarks
Use this class to retrieve e-mail messages from a POP3 server.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| ClientChain | The TLS client certificate chain. |
| ConnectionInfo | Returns the details of the underlying network connection. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| Message | Contains an e-mail message downloaded with ReceiveMessage call. |
| Messages | Populates a list of messages available on the server. |
| Password | A password to authenticate to the POP3 server. |
| Proxy | The proxy server settings. |
| ServerChain | The TLS server's certificate chain. |
| ServerInfo | Encapsulates information about the server. |
| SocketSettings | Manages network connection settings. |
| TLSSettings | Manages TLS layer settings. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| Username | A username to authenticate to the POP3 server. |
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. |
| Connect | Establishes connection to the POP3 server. |
| DeleteMessage | Deletes a message from the server-side mailbox. |
| Disconnect | Closes connection to the POP3 server. |
| ListMessages | Queries a list of messages available on the server. |
| Ping | Sends a NOOP command to the POP3 server. |
| ReceiveBytes | Downloads a message to a byte array. |
| ReceiveFile | Downloads a message to a file. |
| ReceiveMessage | Downloads a message. |
| ReceiveStream | Downloads a message to a stream. |
| Undelete | Undeletes messages marked for deletion. |
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.
| BeforeAuth | Fires before the authentication starts. |
| CertificateValidate | Fires when the server's TLS certificate has to be validated. |
| Command | Reports a command sent to the server. |
| CommandReply | Reports the receipt of a reply to a command. |
| CommandReplyData | Returns the data that accompanies a reply to a command. |
| Error | Provides information about errors during POP3 operations. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| Notification | This event notifies the application about an underlying control flow event. |
| Progress | Reports the progress of the data transfer operation. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| Authentications | Specifies enabled authentication methods and their priorities. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| MaxLineLength | Specifies maximum expected line length. |
| RequestUIDs | Specifies whether to request message UIDs when listing messages. |
| TempPath | Path for storing temporary files. |
| 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. |