ImapClientAuthenticate(SaslMechanism, CancellationToken) Method

Authenticate using the specified SASL mechanism.

Definition

Namespace: MailKit.Net.Imap
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override void Authenticate(
	SaslMechanism mechanism,
	CancellationToken cancellationToken = default
)

Parameters

mechanism  SaslMechanism
The SASL mechanism.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Implements

IMailServiceAuthenticate(SaslMechanism, CancellationToken)
IMailServiceAuthenticate(SaslMechanism, CancellationToken)

Remarks

Authenticates using the specified SASL mechanism.

For a list of available SASL authentication mechanisms supported by the server, check the AuthenticationMechanisms property after the service has been connected.

Exceptions

ArgumentNullException mechanism is .
ObjectDisposedException The ImapClient has been disposed.
ServiceNotConnectedException The ImapClient is not connected.
InvalidOperationException The ImapClient is already authenticated.
OperationCanceledException The operation was canceled via the cancellation token.
AuthenticationException Authentication using the supplied credentials has failed.
SaslException A SASL authentication error occurred.
IOException An I/O error occurred.
ImapCommandException An IMAP command failed.
ImapProtocolException An IMAP protocol error occurred.

See Also