Class Pop3ClientOptions

Configuration for Pop3Client. Mutable during construction; set all properties before calling Connect().

Inheritance

object

Pop3ClientOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: DRIT.Mail.Rfc.Pop3

Assembly: DRIT.Mail.dll

Syntax

public sealed class Pop3ClientOptions

Constructors

Pop3ClientOptions(string, int)

Initializes a new instance of the Pop3ClientOptions class.

Declaration

public Pop3ClientOptions(string host, int port)

Parameters

Type	Name	Description
string	host	The POP3 server hostname.
int	port	The POP3 server port (110, 995).

Properties

AutoAuthenticate

Gets or sets a value indicating whether Connect() should automatically authenticate after connecting. Default is true.

Declaration

public bool AutoAuthenticate { get; set; }

Property Value

Type	Description
bool

AutoConnect

Gets or sets a value indicating whether Pop3Client should automatically connect if not already connected. Default is true.

Declaration

public bool AutoConnect { get; set; }

Property Value

Type	Description
bool

CertificateValidationCallback

Gets or sets a custom SSL certificate validation callback, or null to use the platform default chain validation.

Declaration

public RemoteCertificateValidationCallback? CertificateValidationCallback { get; set; }

Property Value

Type	Description
RemoteCertificateValidationCallback

Credentials

Gets or sets the credentials for POP3 authentication, or null to skip authentication.

Declaration

public SaslCredentials? Credentials { get; set; }

Property Value

Type	Description
SaslCredentials

Host

Gets the POP3 server hostname.

Declaration

public string Host { get; }

Property Value

Type	Description
string

OAuth2Token

Gets or sets the OAuth 2.0 access token for XOAUTH2 authentication, or null to use password-based credentials. When set, this takes precedence over Credentials for mechanism selection.

Declaration

public SaslOAuth2Token? OAuth2Token { get; set; }

Property Value

Type	Description
SaslOAuth2Token

Port

Gets the POP3 server port.

Declaration

public int Port { get; }

Property Value

Type	Description
int

PreferredAuth

Gets or sets the preferred authentication mechanism. Default is Auto.

Declaration

public SaslAuthenticationMechanism PreferredAuth { get; set; }

Property Value

Type	Description
SaslAuthenticationMechanism

RequireEncryption

Gets or sets a value indicating whether authentication is refused over an unencrypted connection. Default is false.

Declaration

public bool RequireEncryption { get; set; }

Property Value

Type	Description
bool

SslMode

Gets or sets the TLS mode. Default is Auto.

Declaration

public Pop3SslMode SslMode { get; set; }

Property Value

Type	Description
Pop3SslMode

Timeout

Gets or sets the timeout for connect, read, and write operations. Default is 30 seconds.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

UseApop

Gets or sets a value indicating whether to prefer APOP authentication over USER/PASS when the server supports it. Default is true.

Declaration

public bool UseApop { get; set; }

Property Value

Type	Description
bool