IPop3Client Interface

An interface for a POP3 client.

Definition

Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public interface IPop3Client : IMailSpool, 
	IMailService, IDisposable, IAsyncDisposable, IEnumerable<MimeMessage>, 
	IEnumerable
Implements
IMailService, IMailSpool, IEnumerableMimeMessage, IEnumerable, IAsyncDisposable, IDisposable

Remarks

Implemented by Pop3Client.

Properties

AuthenticationMechanisms Get the authentication mechanisms supported by the message service.
(Inherited from IMailService)
Capabilities Gets the capabilities supported by the POP3 server.
CheckCertificateRevocation Get or set whether connecting via SSL/TLS should check certificate revocation.
(Inherited from IMailService)
ClientCertificates Get or set the client SSL certificates.
(Inherited from IMailService)
Count Get the number of messages available in the message spool.
(Inherited from IMailSpool)
ExpirePolicy Gets the expiration policy.
Implementation Gets the implementation details of the server.
IsAuthenticated Get whether or not the client is currently authenticated with the mail server.
(Inherited from IMailService)
IsConnected Get whether or not the service is currently connected.
(Inherited from IMailService)
IsEncrypted Get whether or not the connection is encrypted (typically via SSL or TLS).
(Inherited from IMailService)
IsSecure Get whether or not the connection is secure (typically via SSL or TLS).
(Inherited from IMailService)
IsSigned Get whether or not the connection is signed (typically via SSL or TLS).
(Inherited from IMailService)
LocalEndPoint Get or set the local IP end point to use when connecting to a remote host.
(Inherited from IMailService)
LoginDelay Gets the minimum delay, in milliseconds, between logins.
ProxyClient Get or set the proxy client to use when connecting to a remote host.
(Inherited from IMailService)
ServerCertificateValidationCallback Get or set a callback function to validate the server certificate.
(Inherited from IMailService)
SslCipherSuite Get the negotiated SSL or TLS cipher suite.
(Inherited from IMailService)
SslCipherSuitesPolicy Get or set the cipher suites allowed to be used when negotiating an SSL or TLS connection.
(Inherited from IMailService)
SslProtocol Get the negotiated SSL or TLS protocol version.
(Inherited from IMailService)
SslProtocols Get or set the set of enabled SSL and/or TLS protocol versions that the client is allowed to use.
(Inherited from IMailService)
SupportsUids Get whether or not the service supports referencing messages by UIDs.
(Inherited from IMailSpool)
SyncRoot Get an object that can be used to synchronize access to the folder.
(Inherited from IMailService)
Timeout Get or set the timeout for network streaming operations, in milliseconds.
(Inherited from IMailService)

Methods

Authenticate(ICredentials, CancellationToken) Authenticate using the supplied credentials.
(Inherited from IMailService)
Authenticate(SaslMechanism, CancellationToken) Authenticate using the specified SASL mechanism.
(Inherited from IMailService)
Authenticate(Encoding, ICredentials, CancellationToken) Authenticate using the supplied credentials.
(Inherited from IMailService)
Authenticate(String, String, CancellationToken) Authenticate using the specified user name and password.
(Inherited from IMailService)
Authenticate(Encoding, String, String, CancellationToken) Authenticate using the specified user name and password.
(Inherited from IMailService)
AuthenticateAsync(ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
(Inherited from IMailService)
AuthenticateAsync(SaslMechanism, CancellationToken) Asynchronously authenticate using the specified SASL mechanism.
(Inherited from IMailService)
AuthenticateAsync(Encoding, ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
(Inherited from IMailService)
AuthenticateAsync(String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
(Inherited from IMailService)
AuthenticateAsync(Encoding, String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
(Inherited from IMailService)
Connect(String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server.
(Inherited from IMailService)
Connect(String, Int32, Boolean, CancellationToken) Establish a connection to the specified mail server.
(Inherited from IMailService)
Connect(Socket, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server using the provided socket.
(Inherited from IMailService)
Connect(Stream, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server using the provided stream.
(Inherited from IMailService)
ConnectAsync(String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server.
(Inherited from IMailService)
ConnectAsync(String, Int32, Boolean, CancellationToken) Asynchronously establish a connection to the specified mail server.
(Inherited from IMailService)
ConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server using the provided socket.
(Inherited from IMailService)
ConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server using the provided stream.
(Inherited from IMailService)
DeleteAllMessages Mark all messages for deletion.
(Inherited from IMailSpool)
DeleteAllMessagesAsync Asynchronously mark all messages for deletion.
(Inherited from IMailSpool)
DeleteMessage Mark the specified message for deletion.
(Inherited from IMailSpool)
DeleteMessageAsync Asynchronously mark the specified message for deletion.
(Inherited from IMailSpool)
DeleteMessages(IListInt32, CancellationToken) Mark the specified messages for deletion.
(Inherited from IMailSpool)
DeleteMessages(Int32, Int32, CancellationToken) Mark the specified range of messages for deletion.
(Inherited from IMailSpool)
DeleteMessagesAsync(IListInt32, CancellationToken) Asynchronously mark the specified messages for deletion.
(Inherited from IMailSpool)
DeleteMessagesAsync(Int32, Int32, CancellationToken) Asynchronously mark the specified range of messages for deletion.
(Inherited from IMailSpool)
Disconnect Disconnect the service.
(Inherited from IMailService)
DisconnectAsync Asynchronously disconnect the service.
(Inherited from IMailService)
Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
DisposeAsync Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
(Inherited from IAsyncDisposable)
EnableUTF8 Enable UTF8 mode.
EnableUTF8Async Asynchronously enable UTF8 mode.
GetEnumerator Returns an enumerator that iterates through the collection.
(Inherited from IEnumerableMimeMessage)
GetLanguages Get the list of languages supported by the POP3 server.
GetLanguagesAsync Asynchronously get the list of languages supported by the POP3 server.
GetMessage Get the message at the specified index.
(Inherited from IMailSpool)
GetMessageAsync Asynchronously get the message at the specified index.
(Inherited from IMailSpool)
GetMessageCount Get the message count.
(Inherited from IMailSpool)
GetMessageCountAsync Asynchronously get the message count.
(Inherited from IMailSpool)
GetMessageHeaders(IListInt32, CancellationToken) Get the headers for the specified messages.
(Inherited from IMailSpool)
GetMessageHeaders(Int32, CancellationToken) Get the headers for the specified message.
(Inherited from IMailSpool)
GetMessageHeaders(Int32, Int32, CancellationToken) Get the headers of the messages within the specified range.
(Inherited from IMailSpool)
GetMessageHeadersAsync(IListInt32, CancellationToken) Asynchronously get the headers for the specified messages.
(Inherited from IMailSpool)
GetMessageHeadersAsync(Int32, CancellationToken) Asynchronously get the headers for the specified message.
(Inherited from IMailSpool)
GetMessageHeadersAsync(Int32, Int32, CancellationToken) Get the headers of the messages within the specified range.
(Inherited from IMailSpool)
GetMessages(IListInt32, CancellationToken, ITransferProgress) Get the messages at the specified indexes.
(Inherited from IMailSpool)
GetMessages(Int32, Int32, CancellationToken, ITransferProgress) Get the messages within the specified range.
(Inherited from IMailSpool)
GetMessagesAsync(IListInt32, CancellationToken, ITransferProgress) Asynchronously get the messages at the specified indexes.
(Inherited from IMailSpool)
GetMessagesAsync(Int32, Int32, CancellationToken, ITransferProgress) Asynchronously get the messages within the specified range.
(Inherited from IMailSpool)
GetMessageSize Get the size of the specified message, in bytes.
(Inherited from IMailSpool)
GetMessageSizeAsync Asynchronously get the size of the specified message, in bytes.
(Inherited from IMailSpool)
GetMessageSizes Get the sizes for all available messages, in bytes.
(Inherited from IMailSpool)
GetMessageSizesAsync Asynchronously get the sizes for all available messages, in bytes.
(Inherited from IMailSpool)
GetMessageUid Get the UID of the message at the specified index.
(Inherited from IMailSpool)
GetMessageUidAsync Asynchronously get the UID of the message at the specified index.
(Inherited from IMailSpool)
GetMessageUids Get the full list of available message UIDs.
(Inherited from IMailSpool)
GetMessageUidsAsync Asynchronously get the full list of available message UIDs.
(Inherited from IMailSpool)
GetStream Get the message or header stream at the specified index.
(Inherited from IMailSpool)
GetStreamAsync Asynchronously get the message or header stream at the specified index.
(Inherited from IMailSpool)
GetStreams(IListInt32, Boolean, CancellationToken, ITransferProgress) Get the message or header streams at the specified index.
(Inherited from IMailSpool)
GetStreams(Int32, Int32, Boolean, CancellationToken, ITransferProgress) Get the message or header streams within the specified range.
(Inherited from IMailSpool)
GetStreamsAsync(IListInt32, Boolean, CancellationToken, ITransferProgress) Asynchronously get the message or header streams at the specified indexes.
(Inherited from IMailSpool)
GetStreamsAsync(Int32, Int32, Boolean, CancellationToken, ITransferProgress) Asynchronously get the message or header streams within the specified range.
(Inherited from IMailSpool)
NoOp Ping the message service to keep the connection alive.
(Inherited from IMailService)
NoOpAsync Asynchronously ping the mail server to keep the connection alive.
(Inherited from IMailService)
Reset Reset the state of all messages marked for deletion.
(Inherited from IMailSpool)
ResetAsync Asynchronously reset the state of all messages marked for deletion.
(Inherited from IMailSpool)
SetLanguage Set the language used by the POP3 server for error messages.
SetLanguageAsync Asynchronously set the language used by the POP3 server for error messages.

Events

Authenticated Occurs when the client has been successfully authenticated.
(Inherited from IMailService)
Connected Occurs when the client has been successfully connected.
(Inherited from IMailService)
Disconnected Occurs when the client has been disconnected.
(Inherited from IMailService)

See Also