Click or drag to resize
MimeKit

MailStore Class

An abstract mail store implementation.
Inheritance Hierarchy

Namespace:  MailKit
Assembly:  MailKit (in MailKit.dll) Version: 2.3.0
Syntax
C#
public abstract class MailStore : MailService, 
	IMailStore, IMailService, IDisposable

The MailStore type exposes the following members.

Constructors
  NameDescription
Protected methodMailStore
Initializes a new instance of the MailStore 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 propertyInbox
Get the Inbox folder.
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.)
Public propertyOtherNamespaces
Gets the other namespaces.
Public propertyPersonalNamespaces
Gets the personal namespaces.
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 propertySharedNamespaces
Gets the shared namespaces.
Public propertySslProtocols
Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
(Inherited from MailService.)
Public propertySupportsQuotas
Get whether or not the mail store supports quotas.
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 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 methodEnableQuickResync
Enable the quick resynchronization feature.
Public methodEnableQuickResyncAsync
Asynchronously enable the quick resynchronization feature.
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 methodGetFolder(FolderNamespace)
Get the folder for the specified namespace.
Public methodGetFolder(SpecialFolder)
Get the specified special folder.
Public methodGetFolder(String, CancellationToken)
Get the folder for the specified path.
Public methodGetFolderAsync
Asynchronously get the folder for the specified path.
Public methodGetFolders(FolderNamespace, Boolean, CancellationToken)
Get all of the folders within the specified namespace.
Public methodGetFolders(FolderNamespace, StatusItems, Boolean, CancellationToken)
Get all of the folders within the specified namespace.
Public methodGetFoldersAsync(FolderNamespace, Boolean, CancellationToken)
Asynchronously get all of the folders within the specified namespace.
Public methodGetFoldersAsync(FolderNamespace, StatusItems, Boolean, CancellationToken)
Asynchronously get all of the folders within the specified namespace.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetMetadata(MetadataTag, CancellationToken)
Gets the specified metadata.
Public methodGetMetadata(IEnumerableMetadataTag, CancellationToken)
Gets the specified metadata.
Public methodGetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Gets the specified metadata.
Public methodGetMetadataAsync(MetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
Public methodGetMetadataAsync(IEnumerableMetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
Public methodGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken)
Asynchronously gets the specified metadata.
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 methodOnAlert
Raise the alert event.
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.)
Protected methodOnFolderCreated
Raise the folder created event.
Protected methodOnMetadataChanged
Raise the metadata changed event.
Public methodSetMetadata
Sets the specified metadata.
Public methodSetMetadataAsync
Asynchronously sets the specified metadata.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventAlert
Occurs when a remote message store receives an alert message from the server.
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.)
Public eventFolderCreated
Occurs when a folder is created.
Public eventMetadataChanged
Occurs when metadata changes.
Top
Remarks
An abstract mail store implementation.
See Also