 | IMail |
An interface for message services such as SMTP, POP3, or IMAP.
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.10.0
SyntaxC#
public interface IMailService : IDisposable
The IMailService type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AuthenticationMechanisms | Get the authentication mechanisms supported by the message service. |
| CheckCertificateRevocation | Get or set whether connecting via SSL/TLS should check certificate revocation. |
| ClientCertificates | Get or set the client SSL certificates. |
| IsAuthenticated | Get whether or not the client is currently authenticated with the mail server. |
| IsConnected | Get whether or not the service is currently connected. |
| IsEncrypted | Get whether or not the connection is encrypted (typically via SSL or TLS). |
| IsSecure | Get whether or not the connection is secure (typically via SSL or TLS). |
| IsSigned | Get whether or not the connection is signed (typically via SSL or TLS). |
| LocalEndPoint | Get or set the local IP end point to use when connecting to a remote host. |
 | ProxyClient | Get or set the proxy client to use when connecting to a remote host. |
| ServerCertificateValidationCallback | Get or set a callback function to validate the server certificate. |
| SslCipherAlgorithm | Get the negotiated SSL or TLS cipher algorithm. |
| SslCipherStrength | Get the negotiated SSL or TLS cipher algorithm strength. |
| SslHashAlgorithm | Get the negotiated SSL or TLS hash algorithm. |
| SslHashStrength | Get the negotiated SSL or TLS hash algorithm strength. |
| SslKeyExchangeAlgorithm | Get the negotiated SSL or TLS key exchange algorithm. |
| SslKeyExchangeStrength | Get the negotiated SSL or TLS key exchange algorithm strength. |
| SslProtocol | Get the negotiated SSL or TLS protocol version. |
| SslProtocols | Get or set the set of enabled SSL and/or TLS protocol versions that the client is allowed to use. |
| SyncRoot | Get an object that can be used to synchronize access to the folder. |
| Timeout | Get or set the timeout for network streaming operations, in milliseconds. |
Methods| Name | Description | |
|---|---|---|
 | Authenticate(ICredentials, CancellationToken) | Authenticate using the supplied credentials. |
| Authenticate(SaslMechanism, CancellationToken) | Authenticate using the specified SASL mechanism. |
| Authenticate(Encoding, ICredentials, CancellationToken) | Authenticate using the supplied credentials. |
| Authenticate(String, String, CancellationToken) | Authenticate using the specified user name and password. |
| Authenticate(Encoding, String, String, CancellationToken) | Authenticate using the specified user name and password. |
| AuthenticateAsync(ICredentials, CancellationToken) | Asynchronously authenticate using the supplied credentials. |
| AuthenticateAsync(SaslMechanism, CancellationToken) | Asynchronously authenticate using the specified SASL mechanism. |
| AuthenticateAsync(Encoding, ICredentials, CancellationToken) | Asynchronously authenticate using the supplied credentials. |
| AuthenticateAsync(String, String, CancellationToken) | Asynchronously authenticate using the specified user name and password. |
| AuthenticateAsync(Encoding, String, String, CancellationToken) | Asynchronously authenticate using the specified user name and password. |
| Connect(String, Int32, SecureSocketOptions, CancellationToken) | Establish a connection to the specified mail server. |
| Connect(String, Int32, Boolean, CancellationToken) | Establish a connection to the specified mail server. |
| Connect(Socket, String, Int32, SecureSocketOptions, CancellationToken) | Establish a connection to the specified mail server using the provided socket. |
| Connect(Stream, String, Int32, SecureSocketOptions, CancellationToken) | Establish a connection to the specified mail server using the provided stream. |
| ConnectAsync(String, Int32, SecureSocketOptions, CancellationToken) | Asynchronously establish a connection to the specified mail server. |
| ConnectAsync(String, Int32, Boolean, CancellationToken) | Asynchronously establish a connection to the specified mail server. |
| ConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken) | Asynchronously establish a connection to the specified mail server using the provided socket. |
| ConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken) | Asynchronously establish a connection to the specified mail server using the provided stream. |
| Disconnect | Disconnect the service. |
| DisconnectAsync | Asynchronously disconnect the service. |
| Dispose | (Inherited from IDisposable) |
| NoOp | Ping the message service to keep the connection alive. |
| NoOpAsync | Asynchronously ping the mail server to keep the connection alive. |
Events| Name | Description | |
|---|---|---|
 | Authenticated | Occurs when the client has been successfully authenticated. |
| Connected | Occurs when the client has been successfully connected. |
| Disconnected | Occurs when the client has been disconnected. |
RemarksSee Also