Click or drag to resize
MimeKit

SslHandshakeException Class

The exception that is thrown when there is an error during the SSL/TLS handshake.
Inheritance Hierarchy
SystemObject
  SystemException
    MailKit.SecuritySslHandshakeException

Namespace:  MailKit.Security
Assembly:  MailKit (in MailKit.dll) Version: 2.3.0
Syntax
C#
[SerializableAttribute]
public class SslHandshakeException : Exception

The SslHandshakeException type exposes the following members.

Constructors
  NameDescription
Public methodSslHandshakeException
Initializes a new instance of the SslHandshakeException class.
Public methodSslHandshakeException(String)
Initializes a new instance of the SslHandshakeException class.
Protected methodSslHandshakeException(SerializationInfo, StreamingContext)
Initializes a new instance of the SslHandshakeException class.
Public methodSslHandshakeException(String, Exception)
Initializes a new instance of the SslHandshakeException class.
Top
Properties
  NameDescription
Public propertyData
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from Exception.)
Public propertyHelpLink
Gets or sets a link to the help file associated with this exception.
(Inherited from Exception.)
Public propertyHResult
Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.
(Inherited from Exception.)
Public propertyInnerException
Gets the Exception instance that caused the current exception.
(Inherited from Exception.)
Public propertyMessage
Gets a message that describes the current exception.
(Inherited from Exception.)
Public propertySource
Gets or sets the name of the application or the object that causes the error.
(Inherited from Exception.)
Public propertyStackTrace
Gets a string representation of the immediate frames on the call stack.
(Inherited from Exception.)
Public propertyTargetSite
Gets the method that throws the current exception.
(Inherited from Exception.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetBaseException
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
When overridden in a derived class, sets the SerializationInfo with information about the exception.
(Inherited from Exception.)
Public methodGetType
Gets the runtime type of the current instance.
(Inherited from Exception.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Creates and returns a string representation of the current exception.
(Inherited from Exception.)
Top
Events
  NameDescription
Protected eventSerializeObjectState
Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.
(Inherited from Exception.)
Top
Remarks

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

When this exception occurrs, 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).

See Also