SslHandshakeException Class

The exception that is thrown when there is an error during the SSL/TLS handshake.

Definition

Namespace: MailKit.Security
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public class SslHandshakeException : Exception
Inheritance
Object    Exception    SslHandshakeException

Remarks

The exception that is thrown when there is an error during the SSL/TLS handshake.

When this exception occurs, it typically means that the IMAP, POP3 or SMTP server that you are connecting to is using an SSL certificate that is either expired or untrusted by your system.

Often times, mail servers will use self-signed certificates instead of using a certificate that has been signed by a trusted Certificate Authority. When your system is unable to validate the mail server's certificate because it is not signed by a known and trusted Certificate Authority, this exception will occur.

You can work around this problem by supplying a custom RemoteCertificateValidationCallback and setting it on the client's ServerCertificateValidationCallback property.

Most likely, you'll want to compare the thumbprint of the server's certificate with a known value and/or prompt the user to accept the certificate (similar to what you've probably seen web browsers do when they encounter untrusted certificates).

Constructors

SslHandshakeException Initializes a new instance of the SslHandshakeException class.
SslHandshakeException(String) Initializes a new instance of the SslHandshakeException class.
SslHandshakeException(String, Exception) Initializes a new instance of the SslHandshakeException class.

Properties

Data Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception)
HelpLink Gets or sets a link to the help file associated with this exception.
(Inherited from Exception)
HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception)
InnerException Gets the Exception instance that caused the current exception.
(Inherited from Exception)
Message Gets a message that describes the current exception.
(Inherited from Exception)
RootCertificateAuthority Get the certificate for the Root Certificate Authority.
ServerCertificate Get the server's SSL certificate.
Source Gets or sets the name of the application or the object that causes the error.
(Inherited from Exception)
StackTrace Gets a string representation of the immediate frames on the call stack.
(Inherited from Exception)
TargetSite Gets the method that throws the current exception.
(Inherited from Exception)

Methods

Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetType Gets the runtime type of the current instance.
(Inherited from Exception)
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
ToString Creates and returns a string representation of the current exception.
(Inherited from Exception)

Events

SerializeObjectState Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.
(Inherited from Exception)
Obsolete

See Also