Mail ServiceAuthenticate Async(Encoding, ICredentials, Cancellation Token) Method
Asynchronously authenticate using the supplied credentials.
Definition
Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An asynchronous task context.
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public abstract Task AuthenticateAsync(
Encoding encoding,
ICredentials credentials,
CancellationToken cancellationToken = default
)Parameters
- encoding Encoding
- The encoding to use for the user's credentials.
- credentials ICredentials
- The user's credentials.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskAn asynchronous task context.
Implements
IMailServiceAuthenticateAsync(Encoding, ICredentials, CancellationToken)Remarks
Asynchronously authenticates using the supplied credentials.
If the server supports one or more SASL authentication mechanisms, then the SASL mechanisms that both the client and server support (not including any OAUTH mechanisms) are tried in order of greatest security to weakest security. Once a SASL authentication mechanism is found that both client and server support, the credentials are used to authenticate.
If the server does not support SASL or if no common SASL mechanisms can be found, then the default login command is used as a fallback.
Exceptions
| ArgumentNullException |
encoding is . -or- credentials is . |
| ObjectDisposedException | The MailService has been disposed. |
| InvalidOperationException | The MailService is not connected or 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. |
| ProtocolException | A protocol error occurred. |