Click or drag to resize
MimeKit

MailSpool Class

An abstract mail spool implementation.
Inheritance Hierarchy

Namespace:  MailKit
Assembly:  MailKit (in MailKit.dll) Version: 2.3.0
Syntax
C#
public abstract class MailSpool : MailService, 
	IMailSpool, IMailService, IDisposable, IEnumerable<MimeMessage>, 
	IEnumerable

The MailSpool type exposes the following members.

Constructors
  NameDescription
Protected methodMailSpool
Initializes a new instance of the MailSpool class.
Top
Properties
  NameDescription
Public propertyAuthenticationMechanisms
Gets the authentication mechanisms supported by the mail server.
(Inherited from MailService.)
Public propertyCheckCertificateRevocation
Get or set whether connecting via SSL/TLS should check certificate revocation.
(Inherited from MailService.)
Public propertyClientCertificates
Gets or sets the client SSL certificates.
(Inherited from MailService.)
Public propertyCode exampleCount
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 MailService.)
Public propertyIsConnected
Gets whether or not the client is currently connected to an mail server.
(Inherited from MailService.)
Public propertyIsSecure
Get whether or not the connection is secure (typically via SSL or TLS).
(Inherited from MailService.)
Public propertyLocalEndPoint
Get or set the local IP end point to use when connecting to the remote host.
(Inherited from MailService.)
Protected propertyProtocol
Gets the protocol supported by the message service.
(Inherited from MailService.)
Public propertyProtocolLogger
Get the protocol logger.
(Inherited from MailService.)
Public propertyProxyClient
Get or set the proxy client to use when connecting to a remote host.
(Inherited from MailService.)
Public propertyCode exampleServerCertificateValidationCallback
Get or sets a callback function to validate the server certificate.
(Inherited from MailService.)
Public propertySslProtocols
Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
(Inherited from MailService.)
Public propertySupportsUids
Get whether or not the service supports referencing messages by UIDs.
Public propertySyncRoot
Gets an object that can be used to synchronize access to the service.
(Inherited from MailService.)
Public propertyTimeout
Gets or sets the timeout for network streaming operations, in milliseconds.
(Inherited from MailService.)
Top
Methods
  NameDescription
Public methodAuthenticate(ICredentials, CancellationToken)
Authenticate using the supplied credentials.
(Inherited from MailService.)
Public methodAuthenticate(SaslMechanism, CancellationToken)
Authenticate using the specified SASL mechanism.
(Inherited from MailService.)
Public methodCode exampleAuthenticate(String, String, CancellationToken)
Authenticate using the specified user name and password.
(Inherited from MailService.)
Public methodAuthenticate(Encoding, ICredentials, CancellationToken)
Authenticate using the supplied credentials.
(Inherited from MailService.)
Public methodAuthenticate(Encoding, String, String, CancellationToken)
Authenticate using the specified user name and password.
(Inherited from MailService.)
Public methodAuthenticateAsync(ICredentials, CancellationToken)
Asynchronously authenticate using the supplied credentials.
(Inherited from MailService.)
Public methodAuthenticateAsync(SaslMechanism, CancellationToken)
Asynchronously authenticate using the specified SASL mechanism.
(Inherited from MailService.)
Public methodAuthenticateAsync(String, String, CancellationToken)
Asynchronously authenticate using the specified user name and password.
(Inherited from MailService.)
Public methodAuthenticateAsync(Encoding, ICredentials, CancellationToken)
Asynchronously authenticate using the supplied credentials.
(Inherited from MailService.)
Public methodAuthenticateAsync(Encoding, String, String, CancellationToken)
Asynchronously authenticate using the specified user name and password.
(Inherited from MailService.)
Public methodCode exampleConnect(Uri, CancellationToken)
Establish a connection to the specified mail server.
(Inherited from MailService.)
Public methodCode exampleConnect(String, Int32, SecureSocketOptions, CancellationToken)
Establish a connection to the specified mail server.
(Inherited from MailService.)
Public methodConnect(String, Int32, Boolean, CancellationToken)
Establish a connection to the specified mail server.
(Inherited from MailService.)
Public methodConnect(Stream, String, Int32, SecureSocketOptions, CancellationToken)
Establish a connection to the specified mail server using the provided stream.
(Inherited from MailService.)
Public methodConnect(Socket, String, Int32, SecureSocketOptions, CancellationToken)
Establish a connection to the specified mail server using the provided socket.
(Inherited from MailService.)
Public methodConnectAsync(Uri, CancellationToken)
Asynchronously establish a connection to the specified mail server.
(Inherited from MailService.)
Public methodConnectAsync(String, Int32, SecureSocketOptions, CancellationToken)
Asynchronously establish a connection to the specified mail server.
(Inherited from MailService.)
Public methodConnectAsync(String, Int32, Boolean, CancellationToken)
Asynchronously establish a connection to the specified mail server.
(Inherited from MailService.)
Public methodConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken)
Asynchronously establish a connection to the specified mail server using the provided stream.
(Inherited from MailService.)
Public methodConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken)
Asynchronously establish a connection to the specified mail server using the provided socket.
(Inherited from MailService.)
Public methodDeleteAllMessages
Mark all messages for deletion.
Public methodDeleteAllMessagesAsync
Asynchronously mark all messages for deletion.
Public methodCode exampleDeleteMessage
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 methodCode exampleDeleteMessages(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 methodCode exampleDisconnect
Disconnect the service.
(Inherited from MailService.)
Public methodDisconnectAsync
Asynchronously disconnect the service.
(Inherited from MailService.)
Public methodDispose
Releases all resource used by the MailService object.
(Inherited from MailService.)
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the MailService and optionally releases the managed resources.
(Inherited from MailService.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the MailService is reclaimed by garbage collection.
(Inherited from MailService.)
Public methodGetEnumerator
Get an enumerator for the messages in the folder.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodCode exampleGetMessage
Get the message at the specified index.
Public methodGetMessageAsync
Asynchronously get the message at the specified index.
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 methodCode exampleGetMessages(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 methodCode exampleGetMessageUids
Get the full list of available message UIDs.
Public methodGetMessageUidsAsync
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 indexes.
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 methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNoOp
Ping the mail server to keep the connection alive.
(Inherited from MailService.)
Public methodNoOpAsync
Asynchronously ping the mail server to keep the connection alive.
(Inherited from MailService.)
Protected methodOnAuthenticated
Raise the authenticated event.
(Inherited from MailService.)
Protected methodOnConnected
Raise the connected event.
(Inherited from MailService.)
Protected methodOnDisconnected
Raise the disconnected event.
(Inherited from MailService.)
Public methodReset
Reset the state of all messages marked for deletion.
Public methodResetAsync
Asynchronously reset the state of all messages marked for deletion.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventAuthenticated
Occurs when the client has been successfully authenticated.
(Inherited from MailService.)
Public eventConnected
Occurs when the client has been successfully connected.
(Inherited from MailService.)
Public eventDisconnected
Occurs when the client gets disconnected.
(Inherited from MailService.)
Top
Remarks
An abstract mail spool implementation.
See Also