 | Mail |
An abstract mail store implementation.
Inheritance HierarchyNamespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
SyntaxC#
public abstract class MailStore : MailService, IMailStore, IMailService, IDisposable
The MailStore type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | AuthenticationMechanisms |
Gets the authentication mechanisms supported by the mail server.
(Inherited from MailService) |
| CheckCertificateRevocation |
Get or set whether connecting via SSL/TLS should check certificate revocation.
(Inherited from MailService) |
| ClientCertificates |
Get or set the client SSL certificates.
(Inherited from MailService) |
| Inbox | Get the Inbox folder. |
| IsAuthenticated |
Get whether or not the client is currently authenticated with the mail server.
(Inherited from MailService) |
| IsConnected |
Gets whether or not the client is currently connected to an mail server.
(Inherited from MailService) |
| IsEncrypted |
Get whether or not the connection is encrypted (typically via SSL or TLS).
(Inherited from MailService) |
| IsSecure |
Get whether or not the connection is secure (typically via SSL or TLS).
(Inherited from MailService) |
| IsSigned |
Get whether or not the connection is signed (typically via SSL or TLS).
(Inherited from MailService) |
| LocalEndPoint |
Get or set the local IP end point to use when connecting to the remote host.
(Inherited from MailService) |
| OtherNamespaces | Gets the other namespaces. |
| PersonalNamespaces | Gets the personal namespaces. |
 | Protocol |
Get the protocol supported by the message service.
(Inherited from MailService) |
| ProtocolLogger |
Get the protocol logger.
(Inherited from MailService) |
| ProxyClient |
Get or set the proxy client to use when connecting to a remote host.
(Inherited from MailService) |
 | ServerCertificateValidationCallback |
Get or set a callback function to validate the server certificate.
(Inherited from MailService) |
| SharedNamespaces | Gets the shared namespaces. |
| SslCipherAlgorithm |
Get the negotiated SSL or TLS cipher algorithm.
(Inherited from MailService) |
| SslCipherStrength |
Get the negotiated SSL or TLS cipher algorithm strength.
(Inherited from MailService) |
| SslHashAlgorithm |
Get the negotiated SSL or TLS hash algorithm.
(Inherited from MailService) |
| SslHashStrength |
Get the negotiated SSL or TLS hash algorithm strength.
(Inherited from MailService) |
| SslKeyExchangeAlgorithm |
Get the negotiated SSL or TLS key exchange algorithm.
(Inherited from MailService) |
| SslKeyExchangeStrength |
Get the negotiated SSL or TLS key exchange algorithm strength.
(Inherited from MailService) |
| SslProtocol |
Get the negotiated SSL or TLS protocol version.
(Inherited from MailService) |
| SslProtocols |
Get or set the set of enabled SSL and/or TLS protocol versions that the client is allowed to use.
(Inherited from MailService) |
| SupportsQuotas | Get whether or not the mail store supports quotas. |
| SyncRoot |
Get an object that can be used to synchronize access to the service.
(Inherited from MailService) |
| ThreadingAlgorithms | Get the threading algorithms supported by the mail store. |
| Timeout |
Gets or sets the timeout for network streaming operations, in milliseconds.
(Inherited from MailService) |
Methods| Name | Description | |
|---|---|---|
 | Authenticate(ICredentials, CancellationToken) |
Authenticate using the supplied credentials.
(Inherited from MailService) |
| Authenticate(SaslMechanism, CancellationToken) |
Authenticate using the specified SASL mechanism.
(Inherited from MailService) |
| Authenticate(Encoding, ICredentials, CancellationToken) |
Authenticate using the supplied credentials.
(Inherited from MailService) |
| Authenticate(String, String, CancellationToken) |
Authenticate using the specified user name and password.
(Inherited from MailService) |
| Authenticate(Encoding, String, String, CancellationToken) |
Authenticate using the specified user name and password.
(Inherited from MailService) |
| AuthenticateAsync(ICredentials, CancellationToken) |
Asynchronously authenticate using the supplied credentials.
(Inherited from MailService) |
| AuthenticateAsync(SaslMechanism, CancellationToken) |
Asynchronously authenticate using the specified SASL mechanism.
(Inherited from MailService) |
| AuthenticateAsync(Encoding, ICredentials, CancellationToken) |
Asynchronously authenticate using the supplied credentials.
(Inherited from MailService) |
| AuthenticateAsync(String, String, CancellationToken) |
Asynchronously authenticate using the specified user name and password.
(Inherited from MailService) |
| AuthenticateAsync(Encoding, String, String, CancellationToken) |
Asynchronously authenticate using the specified user name and password.
(Inherited from MailService) |
| Connect(Uri, CancellationToken) |
Establish a connection to the specified mail server.
(Inherited from MailService) |
| Connect(String, Int32, SecureSocketOptions, CancellationToken) |
Establish a connection to the specified mail server.
(Inherited from MailService) |
| Connect(String, Int32, Boolean, CancellationToken) |
Establish a connection to the specified mail server.
(Inherited from MailService) |
| Connect(Socket, String, Int32, SecureSocketOptions, CancellationToken) |
Establish a connection to the specified mail server using the provided socket.
(Inherited from MailService) |
| Connect(Stream, String, Int32, SecureSocketOptions, CancellationToken) |
Establish a connection to the specified mail server using the provided stream.
(Inherited from MailService) |
| ConnectAsync(Uri, CancellationToken) |
Asynchronously establish a connection to the specified mail server.
(Inherited from MailService) |
| ConnectAsync(String, Int32, SecureSocketOptions, CancellationToken) |
Asynchronously establish a connection to the specified mail server.
(Inherited from MailService) |
| ConnectAsync(String, Int32, Boolean, CancellationToken) |
Asynchronously establish a connection to the specified mail server.
(Inherited from MailService) |
| ConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken) |
Asynchronously establish a connection to the specified mail server using the provided socket.
(Inherited from MailService) |
| ConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken) |
Asynchronously establish a connection to the specified mail server using the provided stream.
(Inherited from MailService) |
| Disconnect |
Disconnect the service.
(Inherited from MailService) |
| DisconnectAsync |
Asynchronously disconnect the service.
(Inherited from MailService) |
| Dispose |
Releases all resource used by the MailService object.
(Inherited from MailService) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the MailService and
optionally releases the managed resources.
(Inherited from MailService) |
| EnableQuickResync | Enable the quick resynchronization feature. |
| EnableQuickResyncAsync | Asynchronously enable the quick resynchronization feature. |
| Equals | (Inherited from Object) |
| Finalize |
Releases unmanaged resources and performs other cleanup operations before the
MailService is reclaimed by garbage collection.
(Inherited from MailService) |
| 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. |
| GetHashCode | (Inherited from Object) |
| 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. |
| GetType | (Inherited from Object) |
| MemberwiseClone | (Inherited from Object) |
| NoOp |
Ping the mail server to keep the connection alive.
(Inherited from MailService) |
| NoOpAsync |
Asynchronously ping the mail server to keep the connection alive.
(Inherited from MailService) |
| OnAlert | Raise the alert event. |
| OnAuthenticated |
Raise the authenticated event.
(Inherited from MailService) |
| OnConnected |
Raise the connected event.
(Inherited from MailService) |
| OnDisconnected |
Raise the disconnected event.
(Inherited from MailService) |
| OnFolderCreated | Raise the folder created event. |
| OnMetadataChanged | Raise the metadata changed event. |
| SetMetadata | Sets the specified metadata. |
| SetMetadataAsync | Asynchronously sets the specified metadata. |
| ToString | (Inherited from Object) |
Events| Name | Description | |
|---|---|---|
 | 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 MailService) |
| Connected |
Occurs when the client has been successfully connected.
(Inherited from MailService) |
| Disconnected |
Occurs when the client gets disconnected.
(Inherited from MailService) |
| FolderCreated | Occurs when a folder is created. |
| MetadataChanged | Occurs when metadata changes. |
Remarks
An abstract mail store implementation.
See Also