 | ISmtp |
An interface for an SMTP client.
Namespace: MailKit.Net.Smtp
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
SyntaxC#
public interface ISmtpClient : IMailTransport, IMailService, IDisposable
The ISmtpClient type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AuthenticationMechanisms |
Get the authentication mechanisms supported by the message service.
(Inherited from IMailService) |
 | Capabilities | Get the capabilities supported by the SMTP server. |
| 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) |
| DeliveryStatusNotificationType | Get or set how much of the message to include in any failed delivery status notifications. |
| 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) |
| LocalDomain | Get or set the local domain. |
| LocalEndPoint |
Get or set the local IP end point to use when connecting to a remote host.
(Inherited from IMailService) |
| MaxSize | Get the maximum message size supported by the server. |
| ProxyClient |
Get or set the proxy client to use when connecting to a remote host.
(Inherited from IMailService) |
| RequireTLS | Get or set whether the client should use the REQUIRETLS extension if it is available. |
| ServerCertificateValidationCallback |
Get or set a callback function to validate the server certificate.
(Inherited from IMailService) |
| SslCipherAlgorithm |
Get the negotiated SSL or TLS cipher algorithm.
(Inherited from IMailService) |
| SslCipherStrength |
Get the negotiated SSL or TLS cipher algorithm strength.
(Inherited from IMailService) |
| SslHashAlgorithm |
Get the negotiated SSL or TLS hash algorithm.
(Inherited from IMailService) |
| SslHashStrength |
Get the negotiated SSL or TLS hash algorithm strength.
(Inherited from IMailService) |
| SslKeyExchangeAlgorithm |
Get the negotiated SSL or TLS key exchange algorithm.
(Inherited from IMailService) |
| SslKeyExchangeStrength |
Get the negotiated SSL or TLS key exchange algorithm strength.
(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) |
| SyncRoot |
Get an object that can be used to synchronize access to the folder.
(Inherited from IMailService) |
| Timeout |
Get or set the timeout for network streaming operations, in milliseconds.
(Inherited from IMailService) |
Methods| Name | Description | |
|---|---|---|
 | 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 | (Inherited from IDisposable) |
| Expand | Expand a mailing address alias. |
| ExpandAsync | Asynchronously expand a mailing address alias. |
| 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) |
| Send(MimeMessage, CancellationToken, ITransferProgress) |
Send the specified message.
(Inherited from IMailTransport) |
| Send(FormatOptions, MimeMessage, CancellationToken, ITransferProgress) |
Send the specified message.
(Inherited from IMailTransport) |
| Send(MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress) |
Send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport) |
| Send(FormatOptions, MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress) |
Send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport) |
| SendAsync(MimeMessage, CancellationToken, ITransferProgress) |
Asynchronously send the specified message.
(Inherited from IMailTransport) |
| SendAsync(FormatOptions, MimeMessage, CancellationToken, ITransferProgress) |
Asynchronously send the specified message.
(Inherited from IMailTransport) |
| SendAsync(MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress) |
Asynchronously send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport) |
| SendAsync(FormatOptions, MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress) |
Asynchronously send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport) |
| Verify | Verify the existence of a mailbox address. |
| VerifyAsync | Asynchronously verify the existence of a mailbox address. |
Events| Name | Description | |
|---|---|---|
 | 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) |
| MessageSent |
Occurs when a message is successfully sent via the transport.
(Inherited from IMailTransport) |
Remarks
Implemented by SmtpClient.
See Also