Click or drag to resize
MimeKit

MailService Class

An abstract mail service implementation.
Inheritance Hierarchy
SystemObject
  MailKitMailService
    MailKitMailSpool
    MailKitMailStore
    MailKitMailTransport

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.3.0
Syntax
C#
public abstract class MailService : IMailService, 
	IDisposable

The MailService type exposes the following members.

Constructors
 NameDescription
Protected methodMailService Initializes a new instance of the MailService class.
Protected methodMailService(IProtocolLogger) Initializes a new instance of the MailService class.
Top
Properties
 NameDescription
Public propertyAuthenticationMechanisms Gets the authentication mechanisms supported by the mail server.
Public propertyCheckCertificateRevocation Get or set whether connecting via SSL/TLS should check certificate revocation.
Public propertyClientCertificates Get or set the client SSL certificates.
Public propertyIsAuthenticated Get whether or not the client is currently authenticated with the mail server.
Public propertyIsConnected Gets whether or not the client is currently connected to an mail server.
Public propertyIsEncrypted Get whether or not the connection is encrypted (typically via SSL or TLS).
Public propertyIsSecure Get whether or not the connection is secure (typically via SSL or TLS).
Public propertyIsSigned Get whether or not the connection is signed (typically via SSL or TLS).
Public propertyLocalEndPoint Get or set the local IP end point to use when connecting to the remote host.
Protected propertyProtocol Get the protocol supported by the message service.
Public propertyProtocolLogger Get the protocol logger.
Public propertyProxyClient Get or set the proxy client to use when connecting to a remote host.
Public propertyCode exampleServerCertificateValidationCallback Get or set a callback function to validate the server certificate.
Public propertySslCipherAlgorithm Get the negotiated SSL or TLS cipher algorithm.
Public propertySslCipherStrength Get the negotiated SSL or TLS cipher algorithm strength.
Public propertySslHashAlgorithm Get the negotiated SSL or TLS hash algorithm.
Public propertySslHashStrength Get the negotiated SSL or TLS hash algorithm strength.
Public propertySslKeyExchangeAlgorithm Get the negotiated SSL or TLS key exchange algorithm.
Public propertySslKeyExchangeStrength Get the negotiated SSL or TLS key exchange algorithm strength.
Public propertySslProtocol Get the negotiated SSL or TLS protocol version.
Public propertySslProtocols Get or set the set of enabled SSL and/or TLS protocol versions that the client is allowed to use.
Public propertySyncRoot Get an object that can be used to synchronize access to the service.
Public propertyTimeout Gets or sets the timeout for network streaming operations, in milliseconds.
Top
Methods
 NameDescription
Public methodAuthenticate(ICredentials, CancellationToken) Authenticate using the supplied credentials.
Public methodAuthenticate(SaslMechanism, CancellationToken) Authenticate using the specified SASL mechanism.
Public methodAuthenticate(Encoding, ICredentials, CancellationToken) Authenticate using the supplied credentials.
Public methodCode exampleAuthenticate(String, String, CancellationToken) Authenticate using the specified user name and password.
Public methodAuthenticate(Encoding, String, String, CancellationToken) Authenticate using the specified user name and password.
Public methodAuthenticateAsync(ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
Public methodAuthenticateAsync(SaslMechanism, CancellationToken) Asynchronously authenticate using the specified SASL mechanism.
Public methodAuthenticateAsync(Encoding, ICredentials, CancellationToken) Asynchronously authenticate using the supplied credentials.
Public methodAuthenticateAsync(String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
Public methodAuthenticateAsync(Encoding, String, String, CancellationToken) Asynchronously authenticate using the specified user name and password.
Public methodCode exampleConnect(Uri, CancellationToken) Establish a connection to the specified mail server.
Public methodCode exampleConnect(String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server.
Public methodConnect(String, Int32, Boolean, CancellationToken) Establish a connection to the specified mail server.
Public methodConnect(Socket, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server using the provided socket.
Public methodConnect(Stream, String, Int32, SecureSocketOptions, CancellationToken) Establish a connection to the specified mail server using the provided stream.
Public methodConnectAsync(Uri, CancellationToken) Asynchronously establish a connection to the specified mail server.
Public methodConnectAsync(String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server.
Public methodConnectAsync(String, Int32, Boolean, CancellationToken) Asynchronously establish a connection to the specified mail server.
Public methodConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server using the provided socket.
Public methodConnectAsync(Stream, String, Int32, SecureSocketOptions, CancellationToken) Asynchronously establish a connection to the specified mail server using the provided stream.
Protected methodStatic memberDefaultServerCertificateValidationCallback The default server certificate validation callback used when connecting via SSL or TLS.
Public methodCode exampleDisconnect Disconnect the service.
Public methodDisconnectAsync Asynchronously disconnect the service.
Public methodDispose Releases all resource used by the MailService object.
Protected methodDispose(Boolean) Releases the unmanaged resources used by the MailService and optionally releases the managed resources.
Public methodEquals
(Inherited from Object)
Protected methodFinalize Releases unmanaged resources and performs other cleanup operations before the MailService is reclaimed by garbage collection.
(Overrides ObjectFinalize)
Public methodGetHashCode
(Inherited from Object)
Public methodGetType
(Inherited from Object)
Protected methodMemberwiseClone
(Inherited from Object)
Public methodNoOp Ping the mail server to keep the connection alive.
Public methodNoOpAsync Asynchronously ping the mail server to keep the connection alive.
Protected methodOnAuthenticated Raise the authenticated event.
Protected methodOnConnected Raise the connected event.
Protected methodOnDisconnected Raise the disconnected event.
Public methodToString
(Inherited from Object)
Top
Events
 NameDescription
Public eventAuthenticated Occurs when the client has been successfully authenticated.
Public eventConnected Occurs when the client has been successfully connected.
Public eventDisconnected Occurs when the client gets disconnected.
Top
Remarks
An abstract mail service implementation.
See Also