Click or drag to resize
MimeKit

IMailStore Interface

An interface for retreiving messages from a message store.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
public interface IMailStore : IMailService, 
	IDisposable

The IMailStore 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 propertyInbox Get the Inbox folder.
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 propertyOtherNamespaces Get the other namespaces.
Public propertyPersonalNamespaces Get the personal namespaces.
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 propertySharedNamespaces Get the shared namespaces.
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 propertySupportsQuotas Get whether or not the mail store supports quotas.
Public propertySyncRoot Get an object that can be used to synchronize access to the folder.
(Inherited from IMailService)
Public propertyCode exampleThreadingAlgorithms Get the threading algorithms supported by the mail store.
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 methodDisconnect Disconnect the service.
(Inherited from IMailService)
Public methodDisconnectAsync Asynchronously disconnect the service.
(Inherited from IMailService)
Public methodDispose
(Inherited from IDisposable)
Public methodEnableQuickResync Enable the quick resynchronization feature.
Public methodEnableQuickResyncAsync Asynchronously enable the quick resynchronization feature.
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 methodGetMetadata(IEnumerableMetadataTag, CancellationToken) Gets the specified metadata.
Public methodGetMetadata(MetadataTag, CancellationToken) Gets the specified metadata.
Public methodGetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken) Gets the specified metadata.
Public methodGetMetadataAsync(IEnumerableMetadataTag, CancellationToken) Asynchronously gets the specified metadata.
Public methodGetMetadataAsync(MetadataTag, CancellationToken) Asynchronously gets the specified metadata.
Public methodGetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken) Asynchronously gets the specified metadata.
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 methodSetMetadata Sets the specified metadata.
Public methodSetMetadataAsync Asynchronously sets the specified metadata.
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 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)
Public eventFolderCreated Occurs when a folder is created.
Public eventMetadataChanged Occurs when metadata changes.
Top
Remarks

An interface for retreiving messages from a message store.

Implemented by ImapClient.

See Also