SecureBlackbox 2020 macOS Edition

Questions / Feedback?

POP3Client Module

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

nsoftware.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 module with short descriptions. Click on the links for further details.

BlockedCertificatesThe certificates that must be rejected as trust anchors.
ClientChainThe TLS client certificate chain.
ConnectionInfoReturns the details of the underlying network connection.
ExternalCryptoProvides access to external signing and DC parameters.
KnownCertificatesAdditional certificates for chain validation.
KnownCRLsAdditional CRLs for chain validation.
KnownOCSPsAdditional OCSP responses for chain validation.
MessageContains an e-mail message downloaded with ReceiveMessage call.
MessagesPopulates a list of messages available on the server.
PasswordA password to authenticate to the POP3 server.
ProxyThe proxy server settings.
ServerChainThe TLS server's certificate chain.
ServerInfoEncapsulates information about the server.
SocketSettingsManages network connection settings.
TLSSettingsManages TLS layer settings.
TrustedCertificatesA list of trusted certificates for chain validation.
UsernameA username to authenticate to the POP3 server.

Method List


The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
ConnectEstablishes connection to the POP3 server.
DeleteMessageDeletes a message from the server-side mailbox.
DisconnectCloses connection to the POP3 server.
ListMessagesQueries a list of messages available on the server.
PingSends a NOOP command to the POP3 server.
ReceiveBytesDownloads a message to a byte array.
ReceiveFileDownloads a message to a file.
ReceiveMessageDownloads a message.
UndeleteUndeletes messages marked for deletion.

Event List


The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

BeforeAuthFires before the authentication starts.
CertificateValidateFires when the server's TLS certificate has to be validated.
CommandReports a command sent to the server.
CommandReplyReports the receipt of a reply to a command.
CommandReplyDataReturns the data that accompanies a reply to a command.
ErrorProvides information about errors during POP3 operations.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
NotificationThis event notifies the application about an underlying control flow event.
ProgressReports the progress of the data transfer operation.

Configuration Settings


The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.

AuthenticationsSpecifies enabled authentication methods and their priorities.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
MaxLineLengthSpecifies maximum expected line length.
RequestUIDsSpecifies whether to request message UIDs when listing messages.
TempPathPath for storing temporary files.
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 component (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 components 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 macOS Edition - Version 20.0 [Build 8165]