Pop 3ClientConnect Async(Socket, String, Int 32, Secure Socket Options, Cancellation Token) Method
Asynchronously establish a connection to the specified POP3 or POP3/S server using the provided socket.
Definition
Namespace: MailKit.Net.Pop3
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
An asynchronous task context.
IMailServiceConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken)
Assembly: MailKit (in MailKit.dll) Version: 5.0.0
C#
public override Task ConnectAsync(
Socket socket,
string host,
int port = 0,
SecureSocketOptions options = SecureSocketOptions.Auto,
CancellationToken cancellationToken = default
)Parameters
- socket Socket
- The socket to use for the connection.
- host String
- The host name to connect to.
- port Int32 (Optional)
- The port to connect to. If the specified port is 0, then the default port will be used.
- options SecureSocketOptions (Optional)
- The secure socket options to when connecting.
- cancellationToken CancellationToken (Optional)
- The cancellation token.
Return Value
TaskAn asynchronous task context.
Implements
IMailServiceConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken)IMailServiceConnectAsync(Socket, String, Int32, SecureSocketOptions, CancellationToken)
Remarks
Establishes a connection to the specified POP3 or POP3/S server using the provided socket.
If the options has a value of Auto, then the port is used to determine the default security options. If the port has a value of 995, then the default options used will be SslOnConnect. All other values will use StartTlsWhenAvailable.
Once a connection is established, properties such as AuthenticationMechanisms and Capabilities will be populated.
Exceptions
| ArgumentNullException |
socket is . -or- host is . |
| ArgumentOutOfRangeException | port is not between 0 and 65535. |
| ArgumentException |
socket is not connected. -or- The host is a zero-length string. |
| ObjectDisposedException | The Pop3Client has been disposed. |
| InvalidOperationException | The Pop3Client is already connected. |
| NotSupportedException | options was set to StartTls and the POP3 server does not support the STLS extension. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| SslHandshakeException | An error occurred during the SSL/TLS negotiations. |
| IOException | An I/O error occurred. |
| Pop3CommandException | A POP3 command failed. |
| Pop3ProtocolException | A POP3 protocol error occurred. |