Click or drag to resize
MimeKit

SaslMechanism Class

A SASL authentication mechanism.
Inheritance Hierarchy
SystemObject
  MailKit.SecuritySaslMechanism
    More...

Namespace:  MailKit.Security
Assembly:  MailKit (in MailKit.dll) Version: 3.0.0
Syntax
C#
public abstract class SaslMechanism

The SaslMechanism type exposes the following members.

Constructors
  NameDescription
Protected methodSaslMechanism(NetworkCredential)
Initializes a new instance of the SaslMechanism class.
Protected methodSaslMechanism(String, String)
Initializes a new instance of the SaslMechanism class.
Top
Properties
  NameDescription
Public propertyCredentials
Get the user's credentials.
Public propertyIsAuthenticated
Get or set whether the SASL mechanism has finished authenticating.
Public propertyMechanismName
Get the name of the SASL mechanism.
Public propertyNegotiatedChannelBinding
Get whether or not channel-binding was negotiated by the SASL mechanism.
Public propertyNegotiatedSecurityLayer
Get whether or not a security layer was negotiated by the SASL mechanism.
Public propertySupportsChannelBinding
Get whether or not the SASL mechanism supports channel binding.
Public propertySupportsInitialResponse
Get whether or not the SASL mechanism supports an initial response (SASL-IR).
Top
Methods
  NameDescription
Public methodChallenge(String, CancellationToken)
Decode the base64-encoded server challenge and return the next challenge response encoded in base64.
Protected methodChallenge(Byte, Int32, Int32, CancellationToken)
Parse the server's challenge token and return the next challenge response.
Public methodChallengeAsync(String, CancellationToken)
Asynchronously decode the base64-encoded server challenge and return the next challenge response encoded in base64.
Protected methodChallengeAsync(Byte, Int32, Int32, CancellationToken)
Asynchronously parse the server's challenge token and return the next challenge response.
Public methodStatic memberCreate(String, NetworkCredential)
Create an instance of the specified SASL mechanism using the supplied credentials.
Public methodStatic memberCreate(String, Encoding, NetworkCredential)
Create an instance of the specified SASL mechanism using the supplied credentials.
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 methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIsSupported
Determine if the specified SASL mechanism is supported by MailKit.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReset
Reset the state of the SASL mechanism.
Public methodStatic memberSaslPrep
Prepare the user name or password string.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodTryGetChannelBindingToken
Try to get a channel-binding token.
Top
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, CancellationToken).
See Also
Inheritance Hierarchy