Class Pop3ServerCapabilities

Extensions advertised by the POP3 server in its CAPA response (RFC 2449). Immutable.

Inheritance

object

Pop3ServerCapabilities

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 Pop3ServerCapabilities

Constructors

Pop3ServerCapabilities(bool, bool, bool, bool, IReadOnlyCollection<string>, string?)

Initializes a new instance of the Pop3ServerCapabilities class.

Declaration

public Pop3ServerCapabilities(bool supportsStls, bool supportsUidl, bool supportsTop, bool supportsSasl, IReadOnlyCollection<string> saslMechanisms, string? implementation)

Parameters

Type	Name	Description
bool	supportsStls
bool	supportsUidl
bool	supportsTop
bool	supportsSasl
IReadOnlyCollection<string>	saslMechanisms
string	implementation

Properties

Empty

Gets an empty capabilities instance, used before the CAPA response has been received.

Declaration

public static Pop3ServerCapabilities Empty { get; }

Property Value

Type	Description
Pop3ServerCapabilities

Implementation

Gets the server implementation string from the CAPA response, or null if not advertised.

Declaration

public string? Implementation { get; }

Property Value

Type	Description
string

SaslMechanisms

Gets the SASL authentication mechanisms advertised by the server (AUTH extension, RFC 5034), upper-cased. Empty if the server does not advertise SASL.

Declaration

public IReadOnlyCollection<string> SaslMechanisms { get; }

Property Value

Type	Description
IReadOnlyCollection<string>

SupportsSasl

Gets a value indicating whether the server supports the SASL AUTH extension (RFC 5034).

Declaration

public bool SupportsSasl { get; }

Property Value

Type	Description
bool

SupportsStls

Gets a value indicating whether the server supports the STLS extension (RFC 2595).

Declaration

public bool SupportsStls { get; }

Property Value

Type	Description
bool

SupportsTop

Gets a value indicating whether the server supports the TOP extension (RFC 1939 §6).

Declaration

public bool SupportsTop { get; }

Property Value

Type	Description
bool

SupportsUidl

Gets a value indicating whether the server supports the UIDL extension (RFC 1939 §7).

Declaration

public bool SupportsUidl { get; }

Property Value

Type	Description
bool

Methods

Parse(IReadOnlyList<string>)

Parses a CAPA response body into a Pop3ServerCapabilities instance.

Declaration

public static Pop3ServerCapabilities Parse(IReadOnlyList<string> bodyLines)

Parameters

Type	Name	Description
IReadOnlyList<string>	bodyLines	The de-dot-stuffed body lines of the CAPA response.

Returns

Type	Description
Pop3ServerCapabilities	The parsed capabilities.