View on GitHub

MailKit

MailKit: A cross-platform .NET mail-client library optimized for mobile.

Download this project as a .zip file Download this project as a tar.gz file

Pop3Client Class

A POP3 client that can be used to retrieve messages from a server.

Syntax

Remarks

The MailKit.Net.Pop3.Pop3Client class supports both the "pop3" and "pop3s" protocols. The "pop3" protocol makes a clear-text connection to the POP3 server and does not use SSL or TLS unless the POP3 server supports the STLS extension (as defined by rfc2595). The "pop3s" protocol, however, connects to the POP3 server using an SSL-wrapped connection.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Members

See Also: Inherited members from object.

Public Constructors

Initializes a new instance of the MailKit.Net.Pop3.Pop3Client class.
Initializes a new instance of the MailKit.Net.Pop3.Pop3Client class.

Public Properties

[read-only]
AuthenticationMechanisms HashSet<string> . Gets the authentication mechanisms supported by the POP3 server.
Capabilities Pop3Capabilities . Gets the capabilities supported by the POP3 server.
ClientCertificates System.Security.Cryptography.X509Certificates.X509CertificateCollection . Gets or sets the client SSL certificates.
[read-only]
ExpirePolicy int . Gets the expiration policy.
[read-only]
Implementation string . Gets the implementation details of the server.
[read-only]
IsConnected bool . Gets whether or not the client is currently connected to an POP3 server.
[read-only]
LoginDelay int . Gets the minimum delay, in milliseconds, between logins.
[read-only]
SupportsUids bool . Gets whether or not the MailKit.Net.Pop3.Pop3Client supports referencing messages by UIDs.

Public Methods

Authenticate (System.Net.ICredentials)
Authenticates using the supplied credentials.
Authenticate (System.Net.ICredentials, System.Threading.CancellationToken)
Authenticates using the supplied credentials.
Connect (Uri)
Establishes a connection to the specified POP3 server.
Connect (Uri, System.Threading.CancellationToken)
Establishes a connection to the specified POP3 server.
DeleteMessage (int)
Mark the specified message for deletion.
DeleteMessage (string)
Mark the specified message for deletion.
DeleteMessage (int, System.Threading.CancellationToken)
Mark the specified message for deletion.
DeleteMessage (string, System.Threading.CancellationToken)
Mark the specified message for deletion.
Disconnect (bool)
Disconnect the service.
Disconnect (bool, System.Threading.CancellationToken)
Disconnect the service.
Dispose ()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Finalize ()
Releases unmanaged resources and performs other cleanup operations before the MailKit.Net.Pop3.Pop3Client is reclaimed by garbage collection.
GetEnumerator () : IEnumerator<MimeKit.MimeMessage>
Gets an enumerator for the messages in the folder.
GetMessage (int) : MimeKit.MimeMessage
Gets the specified message.
GetMessage (string) : MimeKit.MimeMessage
Gets the specified message.
GetMessage (int, System.Threading.CancellationToken) : MimeKit.MimeMessage
Gets the specified message.
GetMessage (string, System.Threading.CancellationToken) : MimeKit.MimeMessage
Gets the specified message.
GetMessageCount () : int
Gets the number of messages available in the message spool.
GetMessageCount (System.Threading.CancellationToken) : int
Gets the number of messages available in the message spool.
GetMessageHeaders (int) : MimeKit.HeaderList
Gets the headers for the specified message.
GetMessageHeaders (string) : MimeKit.HeaderList
Gets the headers for the specified message.
GetMessageHeaders (int, System.Threading.CancellationToken) : MimeKit.HeaderList
Gets the headers for the specified message.
GetMessageHeaders (string, System.Threading.CancellationToken) : MimeKit.HeaderList
Gets the headers for the specified message.
GetMessageSize (int) : int
Gets the size of the specified message, in bytes.
GetMessageSize (string) : int
Gets the size of the specified message, in bytes.
GetMessageSize (int, System.Threading.CancellationToken) : int
Gets the size of the specified message, in bytes.
GetMessageSize (string, System.Threading.CancellationToken) : int
Gets the size of the specified message, in bytes.
GetMessageSizes () : int[]
Gets the sizes for all available messages, in bytes.
GetMessageSizes (System.Threading.CancellationToken) : int[]
Gets the sizes for all available messages, in bytes.
GetMessageUid (int) : string
Gets the UID of the message at the specified index.
GetMessageUid (int, System.Threading.CancellationToken) : string
Gets the UID of the message at the specified index.
GetMessageUids () : string[]
Gets the full list of available message UIDs.
GetMessageUids (System.Threading.CancellationToken) : string[]
Gets the full list of available message UIDs.
NoOp ()
Pings the POP3 server to keep the connection alive.
NoOp (System.Threading.CancellationToken)
Pings the POP3 server to keep the connection alive.
Reset ()
Reset the state of all messages marked for deletion.
Reset (System.Threading.CancellationToken)
Reset the state of all messages marked for deletion.

Protected Methods

Dispose (bool)
Releases the unmanaged resources used by the MailKit.Net.Pop3.Pop3Client and optionally releases the managed resources.

Explicitly Implemented Interface Members

IEnumerable.GetEnumerator Gets an enumerator for the messages in the folder.

Member Details

Pop3Client Constructor

Initializes a new instance of the MailKit.Net.Pop3.Pop3Client class.

Syntax

public Pop3Client ()

Remarks

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Pop3Client Constructor

Initializes a new instance of the MailKit.Net.Pop3.Pop3Client class.

Syntax

public Pop3Client (MailKit.IProtocolLogger protocolLogger)

Parameters

protocolLogger
The protocol logger.

Exceptions

Type Reason
ArgumentNullException protocolLogger is null.

Remarks

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Authenticate Method

Authenticates using the supplied credentials.

Syntax

public void Authenticate (System.Net.ICredentials credentials)

Parameters

credentials
The user's credentials.

Exceptions

Type Reason
ArgumentNullException credentials is null.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected or is already authenticated.
MailKit.Security.AuthenticationException Authentication using the supplied credentials has failed.
MailKit.Security.SaslException A SASL authentication error occurred.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException A POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException An POP3 protocol error occurred.

Remarks

If the POP3 server supports the APOP authentication mechanism, then APOP is used.

If the APOP authentication mechanism is not supported and the server supports one or more SASL authentication mechanisms, then the SASL mechanisms that both the client and server support are tried in order of greatest security to weakest security. Once a SASL authentication mechanism is found that both client and server support, the credentials are used to authenticate.

If the server does not support SASL or if no common SASL mechanisms can be found, then the USER and PASS commands are used as a fallback.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Authenticate Method

Authenticates using the supplied credentials.

Syntax

public void Authenticate (System.Net.ICredentials credentials, System.Threading.CancellationToken cancellationToken)

Parameters

credentials
The user's credentials.
cancellationToken
A cancellation token.

Exceptions

Type Reason
ArgumentNullException credentials is null.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected or is already authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
System.Security.Authentication.AuthenticationException Authentication using the supplied credentials has failed.
MailKit.Security.SaslException A SASL authentication error occurred.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception An POP3 protocol error occurred.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
MailKit.Net.Pop3.Pop3CommandException A POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException An POP3 protocol error occurred.
MailKit.Security.AuthenticationException Authentication using the supplied credentials has failed.

Remarks

If the POP3 server supports the APOP authentication mechanism, then APOP is used.

If the APOP authentication mechanism is not supported and the server supports one or more SASL authentication mechanisms, then the SASL mechanisms that both the client and server support are tried in order of greatest security to weakest security. Once a SASL authentication mechanism is found that both client and server support, the credentials are used to authenticate.

If the server does not support SASL or if no common SASL mechanisms can be found, then the USER and PASS commands are used as a fallback.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

AuthenticationMechanisms Property

Gets the authentication mechanisms supported by the POP3 server.

Syntax

public HashSet<string> AuthenticationMechanisms { get; }

Value

The authentication mechanisms.

Remarks

The authentication mechanisms are queried durring the Pop3Client.Connect(Uri, System.Threading.CancellationToken) method.

Servers that do not support the SASL capability will typically support either the "APOP" authentication mechanism (Pop3Capabilities.Apop) or the ability to login using the "USER" and "PASS" commands (Pop3Capabilities.User).

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Capabilities Property

Gets the capabilities supported by the POP3 server.

Syntax

public Pop3Capabilities Capabilities { get; set; }

Value

The capabilities.

Exceptions

Type Reason
ArgumentException Capabilities cannot be enabled, they may only be disabled.

Remarks

The capabilities will not be known until a successful connection has been made via the Pop3Client.Connect(Uri, System.Threading.CancellationToken) method and may change as a side-effect of the Pop3Client.Authenticate(System.Net.ICredentials, System.Threading.CancellationToken) method.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

ClientCertificates Property

Gets or sets the client SSL certificates.

Syntax

Value

The client SSL certificates.

Remarks

Some servers may require the client SSL certificates in order to allow the user to connect.

This property should be set before calling Pop3Client.Connect(Uri, System.Threading.CancellationToken).

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Connect Method

Establishes a connection to the specified POP3 server.

Syntax

public void Connect (Uri uri)

Parameters

uri
The server URI. The Uri.Scheme should either be "pop" to make a clear-text connection or "pops" to make an SSL connection.

Exceptions

Type Reason
ArgumentNullException The uri is null.
ArgumentException The uri is not an absolute URI.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is already connected.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException A POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Establishes a connection to an POP3 or POP3/S server. If the schema in the uri is "pop", a clear-text connection is made and defaults to using port 110 if no port is specified in the URI. However, if the schema in the uri is "pops", an SSL connection is made using the Pop3Client.ClientCertificates and defaults to port 995 unless a port is specified in the URI.

It should be noted that when using a clear-text POP3 connection, if the server advertizes support for the STLS extension, the client will automatically switch into TLS mode before authenticating unless the uri contains a query string to disable it.

If a successful connection is made, the Pop3Client.AuthenticationMechanisms and Pop3Client.Capabilities properties will be populated.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Connect Method

Establishes a connection to the specified POP3 server.

Syntax

public void Connect (Uri uri, System.Threading.CancellationToken cancellationToken)

Parameters

uri
The server URI. The Uri.Scheme should either be "pop" to make a clear-text connection or "pops" to make an SSL connection.
cancellationToken
A cancellation token.

Exceptions

Type Reason
ArgumentNullException The uri is null.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is already connected.
MailKit.Net.Pop3.Pop3CommandException A POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.
ArgumentException The uri is not an absolute URI.

Remarks

Establishes a connection to an POP3 or POP3/S server. If the schema in the uri is "pop", a clear-text connection is made and defaults to using port 110 if no port is specified in the URI. However, if the schema in the uri is "pops", an SSL connection is made using the Pop3Client.ClientCertificates and defaults to port 995 unless a port is specified in the URI.

It should be noted that when using a clear-text POP3 connection, if the server advertizes support for the STLS extension, the client will automatically switch into TLS mode before authenticating unless the uri contains a query string to disable it.

If a successful connection is made, the Pop3Client.AuthenticationMechanisms and Pop3Client.Capabilities properties will be populated.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

DeleteMessage Method

Mark the specified message for deletion.

Syntax

public void DeleteMessage (int index)

Parameters

index
The index of the message.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Messages marked for deletion are not actually deleted until the session is cleanly disconnected (see MailKit.IMessageService.Disconnect(bool)).

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

DeleteMessage Method

Mark the specified message for deletion.

Syntax

public void DeleteMessage (string uid)

Parameters

uid
The UID of the message.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Messages marked for deletion are not actually deleted until the session is cleanly disconnected (see MailKit.IMessageService.Disconnect(bool)).

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

DeleteMessage Method

Mark the specified message for deletion.

Syntax

public void DeleteMessage (int index, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
cancellationToken
A cancellation token.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Messages marked for deletion are not actually deleted until the session is cleanly disconnected (see MailKit.IMessageService.Disconnect(bool, System.Threading.CancellationToken)).

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

DeleteMessage Method

Mark the specified message for deletion.

Syntax

public void DeleteMessage (string uid, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
cancellationToken
A cancellation token.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Messages marked for deletion are not actually deleted until the session is cleanly disconnected (see MailKit.IMessageService.Disconnect(bool, System.Threading.CancellationToken)).

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Disconnect Method

Disconnect the service.

Syntax

public void Disconnect (bool quit)

Parameters

quit
If set to true, a "QUIT" command will be issued in order to disconnect cleanly.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.

Remarks

If quit is true, a "QUIT" command will be issued in order to disconnect cleanly.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Disconnect Method

Disconnect the service.

Syntax

public void Disconnect (bool quit, System.Threading.CancellationToken cancellationToken)

Parameters

quit
If set to true, a "QUIT" command will be issued in order to disconnect cleanly.
cancellationToken
A cancellation token.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.

Remarks

If quit is true, a "QUIT" command will be issued in order to disconnect cleanly.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Dispose Method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Syntax

public void Dispose ()

Remarks

Call Pop3Client.Dispose when you are finished using the MailKit.Net.Pop3.Pop3Client. The Pop3Client.Dispose method leaves the MailKit.Net.Pop3.Pop3Client in an unusable state. After calling Pop3Client.Dispose, you must release all references to the MailKit.Net.Pop3.Pop3Client so the garbage collector can reclaim the memory that the MailKit.Net.Pop3.Pop3Client was occupying.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Dispose Method

Releases the unmanaged resources used by the MailKit.Net.Pop3.Pop3Client and optionally releases the managed resources.

Syntax

protected virtual void Dispose (bool disposing)

Parameters

disposing
true to release both managed and unmanaged resources; false to release only the unmanaged resources.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

ExpirePolicy Property

Gets the expiration policy.

Syntax

public int ExpirePolicy { get; }

Value

The expiration policy.

Remarks

If the server supports the EXPIRE capability (Pop3Capabilities.Expire), the value of the Pop3Client.ExpirePolicy property will reflect the value advertized by the server.

A value of -1 indicates that messages will never expire.

A value of 0 indicates that messages that have been retrieved during the current session will be purged immediately after the connection is closed via the "QUIT" command.

Values larger than 0 indicate the minimum number of days that the server will retain messages which have been retrieved.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Finalize Method

Releases unmanaged resources and performs other cleanup operations before the MailKit.Net.Pop3.Pop3Client is reclaimed by garbage collection.

Syntax

void Finalize ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetEnumerator Method

Gets an enumerator for the messages in the folder.

Syntax

public IEnumerator<MimeKit.MimeMessage> GetEnumerator ()

Returns

The enumerator.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
MailKit.Net.Pop3.Pop3CommandException A POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (int index)

Parameters

index
The index of the message.

Returns

The message.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (string uid)

Parameters

uid
The UID of the message.

Returns

The message.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (int index, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
cancellationToken
A cancellation token.

Returns

The message.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessage Method

Gets the specified message.

Syntax

public MimeKit.MimeMessage GetMessage (string uid, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
cancellationToken
A cancellation token.

Returns

The message.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageCount Method

Gets the number of messages available in the message spool.

Syntax

public int GetMessageCount ()

Returns

The number of available messages.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageCount Method

Gets the number of messages available in the message spool.

Syntax

public int GetMessageCount (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
A cancellation token.

Returns

The number of available messages.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageHeaders Method

Gets the headers for the specified message.

Syntax

public MimeKit.HeaderList GetMessageHeaders (int index)

Parameters

index
The index of the message.

Returns

The message headers.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageHeaders Method

Gets the headers for the specified message.

Syntax

public MimeKit.HeaderList GetMessageHeaders (string uid)

Parameters

uid
The UID of the message.

Returns

The message headers.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageHeaders Method

Gets the headers for the specified message.

Syntax

public MimeKit.HeaderList GetMessageHeaders (int index, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
cancellationToken
A cancellation token.

Returns

The message headers.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageHeaders Method

Gets the headers for the specified message.

Syntax

public MimeKit.HeaderList GetMessageHeaders (string uid, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
cancellationToken
A cancellation token.

Returns

The message headers.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageSize Method

Gets the size of the specified message, in bytes.

Syntax

public int GetMessageSize (int index)

Parameters

index
The index of the message.

Returns

The message size, in bytes.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageSize Method

Gets the size of the specified message, in bytes.

Syntax

public int GetMessageSize (string uid)

Parameters

uid
The UID of the message.

Returns

The message size, in bytes.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageSize Method

Gets the size of the specified message, in bytes.

Syntax

public int GetMessageSize (int index, System.Threading.CancellationToken cancellationToken)

Parameters

index
The index of the message.
cancellationToken
A cancellation token.

Returns

The message size, in bytes.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageSize Method

Gets the size of the specified message, in bytes.

Syntax

public int GetMessageSize (string uid, System.Threading.CancellationToken cancellationToken)

Parameters

uid
The UID of the message.
cancellationToken
A cancellation token.

Returns

The message size, in bytes.

Exceptions

Type Reason
ArgumentNullException uid is null.
ArgumentException uid is not a valid message UID.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageSizes Method

Gets the sizes for all available messages, in bytes.

Syntax

public int[] GetMessageSizes ()

Returns

The message sizes, in bytes.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageSizes Method

Gets the sizes for all available messages, in bytes.

Syntax

public int[] GetMessageSizes (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
A cancellation token.

Returns

The message sizes, in bytes.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageUid Method

Gets the UID of the message at the specified index.

Syntax

public string GetMessageUid (int index)

Parameters

index
The message index.

Returns

The message UID.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageUid Method

Gets the UID of the message at the specified index.

Syntax

public string GetMessageUid (int index, System.Threading.CancellationToken cancellationToken)

Parameters

index
The message index.
cancellationToken
A cancellation token.

Returns

The message UID.

Exceptions

Type Reason
ArgumentOutOfRangeException index is not a valid message index.
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
NotSupportedException The POP3 server does not support the UIDL extension.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageUids Method

Gets the full list of available message UIDs.

Syntax

public string[] GetMessageUids ()

Returns

The message uids.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
NotSupportedException The POP3 server does not support the UIDL extension.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

GetMessageUids Method

Gets the full list of available message UIDs.

Syntax

public string[] GetMessageUids (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
A cancellation token.

Returns

The message uids.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
NotSupportedException The POP3 server does not support the UIDL extension.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Implementation Property

Gets the implementation details of the server.

Syntax

public string Implementation { get; }

Value

The implementation details.

Remarks

If the server advertizes its implementation details, this value will be set to a string containing the information details provided by the server.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

IsConnected Property

Gets whether or not the client is currently connected to an POP3 server.

Syntax

public bool IsConnected { get; }

Value

true if the client is connected; otherwise, false.

Remarks

When a MailKit.Net.Pop3.Pop3ProtocolException is caught, the connection state of the MailKit.Net.Pop3.Pop3Client should be checked before continuing.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

LoginDelay Property

Gets the minimum delay, in milliseconds, between logins.

Syntax

public int LoginDelay { get; }

Value

The login delay.

Remarks

If the server supports the LOGIN-DELAY capability (Pop3Capabilities.LoginDelay), this value will be set to the minimum number of milliseconds that the client must wait between logins.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

NoOp Method

Pings the POP3 server to keep the connection alive.

Syntax

public void NoOp ()

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected or authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Mail servers, if left idle for too long, will automatically drop the connection.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

NoOp Method

Pings the POP3 server to keep the connection alive.

Syntax

public void NoOp (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
A cancellation token.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected or authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception The NOOP command failed.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Mail servers, if left idle for too long, will automatically drop the connection.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Reset Method

Reset the state of all messages marked for deletion.

Syntax

public void Reset ()

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

Reset Method

Reset the state of all messages marked for deletion.

Syntax

public void Reset (System.Threading.CancellationToken cancellationToken)

Parameters

cancellationToken
A cancellation token.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
MailKit.Net.Pop3.Pop3CommandException The POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

SupportsUids Property

Gets whether or not the MailKit.Net.Pop3.Pop3Client supports referencing messages by UIDs.

Syntax

public bool SupportsUids { get; }

Value

true if supports UIDs; otherwise, false.

Remarks

Not all servers support referencing messages by UID, so this property should be checked before using Pop3Client.GetMessageUid(int, System.Threading.CancellationToken) and Pop3Client.GetMessageUids(System.Threading.CancellationToken).

If the server does not support UIDs, then all methods that take UID arguments along with Pop3Client.GetMessageUid(int, System.Threading.CancellationToken) and Pop3Client.GetMessageUids(System.Threading.CancellationToken) will fail.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0

System.Collections.IEnumerable.GetEnumerator Method

Gets an enumerator for the messages in the folder.

Syntax

IEnumerator System.Collections.IEnumerable.GetEnumerator ()

Returns

The enumerator.

Exceptions

Type Reason
ObjectDisposedException The MailKit.Net.Pop3.Pop3Client has been disposed.
InvalidOperationException The MailKit.Net.Pop3.Pop3Client is not connected.
UnauthorizedAccessException The MailKit.Net.Pop3.Pop3Client is not authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
System.IO.IOException An I/O error occurred.
MailKit.Net.Pop3.Pop3Exception A POP3 protocol error occurred.
MailKit.Net.Pop3.Pop3CommandException A POP3 command failed.
MailKit.Net.Pop3.Pop3ProtocolException A POP3 protocol error occurred.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll)
Assembly Versions: 0.11.0.0