Click or drag to resize
MimeKit

IMailSpool Interface

An interface for retreiving messages from a spool.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
public interface IMailSpool : IMailService, 
	IDisposable, IEnumerable<MimeMessage>, IEnumerable

The IMailSpool type exposes the following members.

Properties
 NameDescription
Public propertyAuthenticationMechanisms Get the authentication mechanisms supported by the message service.
(Inherited from IMailService)
Public propertyCheckCertificateRevocation Get or set whether connecting via SSL/TLS should check certificate revocation.
(Inherited from IMailService)
Public propertyClientCertificates Get or set the client SSL certificates.
(Inherited from IMailService)
Public propertyCount Get the number of messages available in the message spool.
Public propertyIsAuthenticated Get whether or not the client is currently authenticated with the mail server.
(Inherited from IMailService)
Public propertyIsConnected Get whether or not the service is currently connected.
(Inherited from IMailService)
Public propertyIsEncrypted Get whether or not the connection is encrypted (typically via SSL or TLS).
(Inherited from IMailService)
Public propertyIsSecure Get whether or not the connection is secure (typically via SSL or TLS).
(Inherited from IMailService)
Public propertyIsSigned Get whether or not the connection is signed (typically via SSL or TLS).
(Inherited from IMailService)
Public propertyLocalEndPoint Get or set the local IP end point to use when connecting to a remote host.
(Inherited from IMailService)
Public propertyProxyClient Get or set the proxy client to use when connecting to a remote host.
(Inherited from IMailService)
Public propertyCode exampleServerCertificateValidationCallback Get or set a callback function to validate the server certificate.
(Inherited from IMailService)
Public propertySslCipherAlgorithm Get the negotiated SSL or TLS cipher algorithm.
(Inherited from IMailService)
Public propertySslCipherStrength Get the negotiated SSL or TLS cipher algorithm strength.
(Inherited from IMailService)
Public propertySslHashAlgorithm Get the negotiated SSL or TLS hash algorithm.
(Inherited from IMailService)
Public propertySslHashStrength Get the negotiated SSL or TLS hash algorithm strength.
(Inherited from IMailService)
Public propertySslKeyExchangeAlgorithm Get the negotiated SSL or TLS key exchange algorithm.
(Inherited from IMailService)
Public propertySslKeyExchangeStrength Get the negotiated SSL or TLS key exchange algorithm strength.
(Inherited from IMailService)
Public propertySslProtocol Get the negotiated SSL or TLS protocol version.
(Inherited from IMailService)
Public propertySslProtocols Get or set the set of enabled SSL and/or TLS protocol versions that the client is allowed to use.
(Inherited from IMailService)
Public propertySupportsUids Get whether or not the service supports referencing messages by UIDs.
Public propertySyncRoot Get an object that can be used to synchronize access to the folder.
(Inherited from IMailService)
Public propertyTimeout Get or set the timeout for network streaming operations, in milliseconds.
(Inherited from IMailService)
Top
Methods
 NameDescription
Public methodAuthenticate(ICredentials, CancellationToken) Authenticate using the supplied credentials.
(Inherited from IMailService)
Public methodAuthenticate(SaslMechanism, CancellationToken) Authenticate using the specified SASL mechanism.
(Inherited from IMailService)
Public methodAuthenticate(Encoding, ICredentials, CancellationToken) Authenticate using the supplied credentials.
(Inherited from IMailService)
Public methodCode exampleAuthenticate(String, String, CancellationToken) Authenticate using the specified user name and password.
(Inherited from IMailService)
Public methodAuthenticate(Encoding, String, String, CancellationToken) Authenticate using the specified user name and password.
(Inherited from IMailService)
Public methodAuthenticateAsync(ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
(Inherited from IMailService)
Public methodAuthenticateAsync(SaslMechanism, CancellationToken) Asynchronously authenticate using the specified SASL mechanism.
(Inherited from IMailService)
Public methodAuthenticateAsync(Encoding, ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
(Inherited from IMailService)
Public methodAuthenticateAsync(String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
(Inherited from IMailService)
Public methodAuthenticateAsync(Encoding, String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
(Inherited from IMailService)
Public methodConnect(String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server.
(Inherited from IMailService)
Public methodConnect(String, Int32, Boolean, CancellationToken) Establish a connection to the specified mail server.
(Inherited from IMailService)
Public methodConnect(Socket, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server using the provided socket.
(Inherited from IMailService)
Public methodConnect(Stream, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server using the provided stream.
(Inherited from IMailService)
Public methodConnectAsync(String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server.
(Inherited from IMailService)
Public methodConnectAsync(String, Int32, Boolean, CancellationToken) Asynchronously establish a connection to the specified mail server.
(Inherited from IMailService)
Public methodConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server using the provided socket.
(Inherited from IMailService)
Public methodConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server using the provided stream.
(Inherited from IMailService)
Public methodDeleteAllMessages Mark all messages for deletion.
Public methodDeleteAllMessagesAsync Asynchronously mark all messages for deletion.
Public methodDeleteMessage Mark the specified message for deletion.
Public methodDeleteMessageAsync Asynchronously mark the specified message for deletion.
Public methodDeleteMessages(IListInt32, CancellationToken) Mark the specified messages for deletion.
Public methodDeleteMessages(Int32, Int32, CancellationToken) Mark the specified range of messages for deletion.
Public methodDeleteMessagesAsync(IListInt32, CancellationToken) Asynchronously mark the specified messages for deletion.
Public methodDeleteMessagesAsync(Int32, Int32, CancellationToken) Asynchronously mark the specified range of messages for deletion.
Public methodDisconnect Disconnect the service.
(Inherited from IMailService)
Public methodDisconnectAsync Asynchronously disconnect the service.
(Inherited from IMailService)
Public methodDispose
(Inherited from IDisposable)
Public methodGetEnumerator
(Inherited from IEnumerableMimeMessage)
Public methodGetMessage Get the message at the specified index.
Public methodGetMessageAsync Asynchronously get the message at the specified index.
Public methodGetMessageCount Get the message count.
Public methodGetMessageCountAsync Asynchronously get the message count.
Public methodGetMessageHeaders(IListInt32, CancellationToken) Get the headers for the specified messages.
Public methodGetMessageHeaders(Int32, CancellationToken) Get the headers for the specified message.
Public methodGetMessageHeaders(Int32, Int32, CancellationToken) Get the headers of the messages within the specified range.
Public methodGetMessageHeadersAsync(IListInt32, CancellationToken) Asynchronously get the headers for the specified messages.
Public methodGetMessageHeadersAsync(Int32, CancellationToken) Asynchronously get the headers for the specified message.
Public methodGetMessageHeadersAsync(Int32, Int32, CancellationToken) Get the headers of the messages within the specified range.
Public methodGetMessages(IListInt32, CancellationToken, ITransferProgress) Get the messages at the specified indexes.
Public methodGetMessages(Int32, Int32, CancellationToken, ITransferProgress) Get the messages within the specified range.
Public methodGetMessagesAsync(IListInt32, CancellationToken, ITransferProgress) Asynchronously get the messages at the specified indexes.
Public methodGetMessagesAsync(Int32, Int32, CancellationToken, ITransferProgress) Asynchronously get the messages within the specified range.
Public methodGetMessageSize Get the size of the specified message, in bytes.
Public methodGetMessageSizeAsync Asynchronously get the size of the specified message, in bytes.
Public methodGetMessageSizes Get the sizes for all available messages, in bytes.
Public methodGetMessageSizesAsync Asynchronously get the sizes for all available messages, in bytes.
Public methodGetMessageUid Get the UID of the message at the specified index.
Public methodGetMessageUidAsync Asynchronously get the UID of the message at the specified index.
Public methodGetMessageUids Get the full list of available message UIDs.
Public methodGetMessageUidsAsync Asynchronously get the full list of available message UIDs.
Public methodGetStream Get the message or header stream at the specified index.
Public methodGetStreamAsync Asynchronously get the message or header stream at the specified index.
Public methodGetStreams(IListInt32, Boolean, CancellationToken, ITransferProgress) Get the message or header streams at the specified index.
Public methodGetStreams(Int32, Int32, Boolean, CancellationToken, ITransferProgress) Get the message or header streams within the specified range.
Public methodGetStreamsAsync(IListInt32, Boolean, CancellationToken, ITransferProgress) Asynchronously get the message or header streams at the specified indexes.
Public methodGetStreamsAsync(Int32, Int32, Boolean, CancellationToken, ITransferProgress) Asynchronously get the message or header streams within the specified range.
Public methodNoOp Ping the message service to keep the connection alive.
(Inherited from IMailService)
Public methodNoOpAsync Asynchronously ping the mail server to keep the connection alive.
(Inherited from IMailService)
Public methodReset Reset the state of all messages marked for deletion.
Public methodResetAsync Asynchronously reset the state of all messages marked for deletion.
Top
Events
 NameDescription
Public eventAuthenticated Occurs when the client has been successfully authenticated.
(Inherited from IMailService)
Public eventConnected Occurs when the client has been successfully connected.
(Inherited from IMailService)
Public eventDisconnected Occurs when the client has been disconnected.
(Inherited from IMailService)
Top
Remarks

An interface for retreiving messages from a spool.

Implemented by Pop3Client.

See Also