Click or drag to resize
MimeKit

ISmtpClient Interface

An interface for an SMTP client.

Namespace:  MailKit.Net.Smtp
Assembly:  MailKit (in MailKit.dll) Version: 3.0.0
Syntax
C#
public interface ISmtpClient : IMailTransport, 
	IMailService, IDisposable

The ISmtpClient type exposes the following members.

Properties
  NameDescription
Public propertyAuthenticationMechanisms
Get the authentication mechanisms supported by the message service.
(Inherited from IMailService.)
Public propertyCode exampleCapabilities
Get the capabilities supported by the SMTP server.
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 propertyDeliveryStatusNotificationType
Get or set how much of the message to include in any failed delivery status notifications.
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 propertyLocalDomain
Get or set the local domain.
Public propertyLocalEndPoint
Get or set the local IP end point to use when connecting to a remote host.
(Inherited from IMailService.)
Public propertyCode exampleMaxSize
Get the maximum message size supported by the server.
Public propertyProxyClient
Get or set the proxy client to use when connecting to a remote host.
(Inherited from IMailService.)
Public propertyCode exampleServerCertificateValidationCallback
Get or sets a callback function to validate the server certificate.
(Inherited from IMailService.)
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
Gets or sets the set of enabled SSL and/or TLS protocol versions that the client is allowed to use.
(Inherited from IMailService.)
Public propertySyncRoot
Gets an object that can be used to synchronize access to the folder.
(Inherited from IMailService.)
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
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodExpand
Expand a mailing address alias.
Public methodExpandAsync
Asynchronously expand a mailing address alias.
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 methodSend(MimeMessage, CancellationToken, ITransferProgress)
Send the specified message.
(Inherited from IMailTransport.)
Public methodSend(FormatOptions, MimeMessage, CancellationToken, ITransferProgress)
Send the specified message.
(Inherited from IMailTransport.)
Public methodSend(MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress)
Send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport.)
Public methodSend(FormatOptions, MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress)
Send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport.)
Public methodSendAsync(MimeMessage, CancellationToken, ITransferProgress)
Asynchronously send the specified message.
(Inherited from IMailTransport.)
Public methodSendAsync(FormatOptions, MimeMessage, CancellationToken, ITransferProgress)
Asynchronously send the specified message.
(Inherited from IMailTransport.)
Public methodSendAsync(MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress)
Asynchronously send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport.)
Public methodSendAsync(FormatOptions, MimeMessage, MailboxAddress, IEnumerableMailboxAddress, CancellationToken, ITransferProgress)
Asynchronously send the specified message using the supplied sender and recipients.
(Inherited from IMailTransport.)
Public methodVerify
Verify the existence of a mailbox address.
Public methodVerifyAsync
Asynchronously verify the existence of a mailbox address.
Top
Events
  NameDescription
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 eventMessageSent
Occurs when a message is successfully sent via the transport.
(Inherited from IMailTransport.)
Top
Remarks
Implemented by SmtpClient.
See Also