 | SaslMechanism Class |
A SASL authentication mechanism.
Inheritance HierarchyNamespace: MailKit.Security
Assembly: MailKit (in MailKit.dll) Version: 2.3.0
SyntaxC#
public abstract class SaslMechanism
The SaslMechanism type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SaslMechanism(NetworkCredential) |
Initializes a new instance of the SaslMechanism class.
|
| SaslMechanism(String, String) |
Initializes a new instance of the SaslMechanism class.
|
| SaslMechanism(Uri, ICredentials) | Obsolete.
Initializes a new instance of the SaslMechanism class.
|
| SaslMechanism(Uri, String, String) | Obsolete.
Initializes a new instance of the SaslMechanism class.
|
Properties| Name | Description | |
|---|---|---|
 | Credentials |
Gets the user's credentials.
|
| IsAuthenticated |
Gets or sets whether the SASL mechanism has finished authenticating.
|
| MechanismName |
Gets the name of the mechanism.
|
| NegotiatedSecurityLayer |
Gets whether or not a security layer was negotiated.
|
| SupportsInitialResponse |
Gets whether or not the mechanism supports an initial response (SASL-IR).
|
Methods| Name | Description | |
|---|---|---|
 | Challenge(String) |
Decodes the base64-encoded server challenge and returns the next challenge response encoded in base64.
|
| Challenge(Byte, Int32, Int32) |
Parses the server's challenge token and returns the next challenge response.
|
 | Create(String, Uri, ICredentials) |
Create an instance of the specified SASL mechanism using the uri and credentials.
|
| Create(String, Uri, Encoding, ICredentials) |
Create an instance of the specified SASL mechanism using the uri and credentials.
|
| 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.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsSupported |
Determines if the specified SASL mechanism is supported by MailKit.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Reset |
Resets the state of the SASL mechanism.
|
| SaslPrep |
Prepares the user name or password string.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | AuthMechanismRank |
The supported authentication mechanisms in order of strongest to weakest.
|
Remarks
Authenticating via a SASL mechanism may be a multi-step process.
To determine if the mechanism has completed the necessary steps
to authentication, check the IsAuthenticated after
each call to Challenge(String).
See AlsoReference
Inheritance Hierarchy