Click or drag to resize
MimeKit

SmtpClientExpandAsync Method

Asynchronously expand a mailing address alias.

Namespace: MailKit.Net.Smtp
Assembly: MailKit (in MailKit.dll) Version: 4.7.1
Syntax
C#
Copy
public Task<InternetAddressList> ExpandAsync(
	string alias,
	CancellationToken cancellationToken = default
)

Parameters

alias  String
The mailing address alias.
cancellationToken  CancellationToken  (Optional)
The cancellation token.

Return Value

TaskInternetAddressList
The expanded list of mailbox addresses.

Implements

ISmtpClientExpandAsync(String, CancellationToken)
Exceptions
ExceptionCondition
ArgumentNullExceptionalias is null.
ArgumentExceptionalias is an empty string.
ObjectDisposedException The SmtpClient has been disposed.
ServiceNotConnectedException The SmtpClient is not connected.
ServiceNotAuthenticatedException Authentication is required before expanding an alias.
OperationCanceledException The operation has been canceled.
IOException An I/O error occurred.
SmtpCommandException The SMTP command failed.
SmtpProtocolException An SMTP protocol exception occurred.
Remarks
Expands a mailing address alias.
Example
C#
Copy
public static void ExpandAlias (string alias)
{
    using (var client = new SmtpClient ()) {
        client.Connect ("smtp.mail-server.com", 465, SecureSocketOptions.SslOnConnect);
        client.Authenticate ("username", "password");

        var expanded = client.Expand (alias);

        Console.WriteLine ($"Expanding the alias '{alias}' results in the following list of addresses:");
        foreach (var mailbox in expanded.Mailboxes)
            Console.WriteLine ($"* {mailbox}");

        client.Disconnect (true);
    }
}
See Also