IMail Store Interface
An interface for retrieving messages from a message store.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public interface IMailStore : IMailService,
IDisposable, IAsyncDisposable- Implements
- IMailService, IAsyncDisposable, IDisposable
Remarks
An interface for retrieving messages from a message store.
Implemented by ImapClient.
Properties
| AuthenticationMechanisms |
Get the authentication mechanisms supported by the message service.
(Inherited from IMailService) |
| 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) |
| Inbox | Get the Inbox folder. |
| 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) |
| OtherNamespaces | Get the other namespaces. |
| PersonalNamespaces | Get the personal namespaces. |
| 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) |
| SharedNamespaces | Get the shared namespaces. |
| 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) |
| SupportsQuotas | Get whether or not the mail store supports quotas. |
| SyncRoot |
Get an object that can be used to synchronize access to the folder.
(Inherited from IMailService) |
| ThreadingAlgorithms | Get the threading algorithms supported by the mail store. |
| 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) |
| 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) |
| GetFolder(FolderNamespace) | Get the folder for the specified namespace. |
| GetFolder(SpecialFolder) | Get the specified special folder. |
| GetFolder(String, CancellationToken) | Get the folder for the specified path. |
| GetFolderAsync | Asynchronously get the folder for the specified path. |
| GetFolders(FolderNamespace, Boolean, CancellationToken) | Get all of the folders within the specified namespace. |
| GetFolders(FolderNamespace, StatusItems, Boolean, CancellationToken) | Get all of the folders within the specified namespace. |
| GetFoldersAsync(FolderNamespace, Boolean, CancellationToken) | Asynchronously get all of the folders within the specified namespace. |
| GetFoldersAsync(FolderNamespace, StatusItems, Boolean, CancellationToken) | Asynchronously get all of the folders within the specified namespace. |
| GetMetadata(IEnumerableMetadataTag, CancellationToken) | Gets the specified metadata. |
| GetMetadata(MetadataTag, CancellationToken) | Gets the specified metadata. |
| GetMetadata(MetadataOptions, IEnumerableMetadataTag, CancellationToken) | Gets the specified metadata. |
| GetMetadataAsync(IEnumerableMetadataTag, CancellationToken) | Asynchronously gets the specified metadata. |
| GetMetadataAsync(MetadataTag, CancellationToken) | Asynchronously gets the specified metadata. |
| GetMetadataAsync(MetadataOptions, IEnumerableMetadataTag, CancellationToken) | Asynchronously gets the specified metadata. |
| 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) |
| SetMetadata | Sets the specified metadata. |
| SetMetadataAsync | Asynchronously sets the specified metadata. |
Events
| Alert | Occurs when a remote message store receives an alert message from the server. |
| 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) |
| FolderCreated | Occurs when a folder is created. |
| MetadataChanged | Occurs when metadata changes. |