IMailServiceConnectAsync(String, Int32, Boolean, CancellationToken) Method

Asynchronously establish a connection to the specified mail server.

Namespace: MailKit
Assembly: MailKit (in MailKit.dll) Version: 4.7.1

Syntax

Task ConnectAsync(
	string host,
	int port,
	bool useSsl,
	CancellationToken cancellationToken = default
)

host String: The host name to connect to.
port Int32: The port to connect to. If the specified port is 0, then the default port will be used.
useSsl Boolean: Field Value
Task
true if the client should make an SSL-wrapped connection to the server; otherwise,
Field Value
Task
false.
cancellationToken CancellationToken (Optional): The cancellation token.

Task
An asynchronous task context.

Exceptions

Exception	Condition
ArgumentNullException	The host is null.
ArgumentOutOfRangeException	port is not between 0 and 65535.
ArgumentException	The host is a zero-length string.
ObjectDisposedException	The IMailService has been disposed.
InvalidOperationException	The IMailService is already connected.
OperationCanceledException	The operation was canceled via the cancellation token.
IOException	An I/O error occurred.
ProtocolException	A protocol error occurred.

Remarks

Asynchronously establishes a connection to the specified mail server.

If a successful connection is made, the AuthenticationMechanisms property will be populated.