SmtpClient.SendAsync Метод

Определение

Отправляет сообщение электронной почты. Эти методы не блокируют вызывающий поток.

Перегрузки

SendAsync(MailMessage, Object)

Отправляет указанное сообщение электронной почты на сервер SMTP для доставки. Этот метод не блокирует вызывающий поток и позволяет вызывающей стороне передать объект в метод, вызванный после завершения операции.

SendAsync(String, String, String, String, Object)

Отправляет сообщение электронной почты на сервер SMTP для доставки. Отправитель, получатели, тема и основная часть сообщения указываются с помощью объектов String. Этот метод не блокирует вызывающий поток и позволяет вызывающей стороне передать объект в метод, вызванный после завершения операции.

SendAsync(MailMessage, Object)

Отправляет указанное сообщение электронной почты на сервер SMTP для доставки. Этот метод не блокирует вызывающий поток и позволяет вызывающей стороне передать объект в метод, вызванный после завершения операции.

public:
 void SendAsync(System::Net::Mail::MailMessage ^ message, System::Object ^ userToken);
public void SendAsync (System.Net.Mail.MailMessage message, object? userToken);
public void SendAsync (System.Net.Mail.MailMessage message, object userToken);
member this.SendAsync : System.Net.Mail.MailMessage * obj -> unit
Public Sub SendAsync (message As MailMessage, userToken As Object)

Параметры

message
MailMessage

Объект MailMessage, который содержит отправляемое сообщение.

userToken
Object

Пользовательский объект, передаваемый методу, вызываемому по завершении асинхронной операции.

Исключения

message имеет значение null.

-или- From имеет значение null.

Данный SmtpClient в настоящий момент вызывает SendAsync.

-или- Отсутствуют получатели в свойствах To, CC и Bcc.

-или- Свойству DeliveryMethod задано значение Network, а свойству Host задано значение null.

-или- Свойству DeliveryMethod задано значение Network и Host равно пустой строке ("").

-или- Свойство DeliveryMethod имеет значение Network, а свойство Port равно нулю, отрицательно или больше 65535.

Данный объект удален.

Сбой подключения к серверу SMTP.

-или- Проверка подлинности не пройдена.

-или- Истекло время ожидания для выполнения операции. -или- EnableSsl имеет значение true, а свойство DeliveryMethod имеет значение SpecifiedPickupDirectory или PickupDirectoryFromIis.

-или- Свойство EnableSsl имеет значение true, однако почтовый SMTP-сервер не отправил STARTTLS в ответ на команду EHLO.

-или- Сообщение message не удалось доставить одному или нескольким получателям To, CC или Bcc.

Примеры

В следующем примере кода демонстрируется вызов этого метода.

#using <System.dll>
using namespace System;
using namespace System::Net;
using namespace System::Net::Mail;
using namespace System::Net::Mime;
using namespace System::Threading;
using namespace System::ComponentModel;

static bool mailSent;

static void SendCompletedCallback(Object^ sender, AsyncCompletedEventArgs^ e)
{
    // Get the unique identifier for this asynchronous 
    // operation.
    String^ token = (String^) e->UserState;

    if (e->Cancelled)
    {
        Console::WriteLine("[{0}] Send canceled.", token);
    }
    if (e->Error != nullptr)
    {
        Console::WriteLine("[{0}] {1}", token, 
            e->Error->ToString());
    } else
    {
        Console::WriteLine("Message sent.");
    }
    mailSent = true;
}

int main(array<String^>^ args)
{
    if (args->Length > 1)
    {
        // Command-line argument must be the SMTP host.
        SmtpClient^ client = gcnew SmtpClient(args[1]);
        // Specify the email sender.
        // Create a mailing address that includes a UTF8 
        // character in the display name.
        MailAddress^ from = gcnew MailAddress("jane@contoso.com",
            "Jane " + (wchar_t)0xD8 + " Clayton",
            System::Text::Encoding::UTF8);
        // Set destinations for the email message.
        MailAddress^ to = gcnew MailAddress("ben@contoso.com");
        // Specify the message content.
        MailMessage^ message = gcnew MailMessage(from, to);
        message->Body = "This is a test email message sent" +
            " by an application. ";
        // Include some non-ASCII characters in body and 
        // subject.
        String^ someArrows = gcnew String(gcnew array<wchar_t>{L'\u2190', 
            L'\u2191', L'\u2192', L'\u2193'});
        message->Body += Environment::NewLine + someArrows;
        message->BodyEncoding = System::Text::Encoding::UTF8;
        message->Subject = "test message 1" + someArrows;
        message->SubjectEncoding = System::Text::Encoding::UTF8;
        // Set the method that is called back when the send
        // operation ends.
        client->SendCompleted += gcnew
            SendCompletedEventHandler(SendCompletedCallback);
        // The userState can be any object that allows your 
        // callback method to identify this send operation.
        // For this example, the userToken is a string constant.
        String^ userState = "test message1";
        client->SendAsync(message, userState);
        Console::WriteLine("Sending message... press c to" +
            " cancel mail. Press any other key to exit.");
        String^ answer = Console::ReadLine();
        // If the user canceled the send, and mail hasn't been 
        // sent yet,then cancel the pending operation.
        if (answer->ToLower()->StartsWith("c") && mailSent == false)
        {
            client->SendAsyncCancel();
        }
        // Clean up.
        delete message;
        client = nullptr;
        Console::WriteLine("Goodbye.");
    }
    else
    {
        Console::WriteLine("Please give SMTP server name!");
    }
}

using System;
using System.Net;
using System.Net.Mail;
using System.Net.Mime;
using System.Threading;
using System.ComponentModel;
namespace Examples.SmtpExamples.Async
{
    public class SimpleAsynchronousExample
    {
        static bool mailSent = false;
        private static void SendCompletedCallback(object sender, AsyncCompletedEventArgs e)
        {
            // Get the unique identifier for this asynchronous operation.
             String token = (string) e.UserState;

            if (e.Cancelled)
            {
                 Console.WriteLine("[{0}] Send canceled.", token);
            }
            if (e.Error != null)
            {
                 Console.WriteLine("[{0}] {1}", token, e.Error.ToString());
            } else
            {
                Console.WriteLine("Message sent.");
            }
            mailSent = true;
        }
        public static void Main(string[] args)
        {
            // Command-line argument must be the SMTP host.
            SmtpClient client = new SmtpClient(args[0]);
            // Specify the email sender.
            // Create a mailing address that includes a UTF8 character
            // in the display name.
            MailAddress from = new MailAddress("jane@contoso.com",
               "Jane " + (char)0xD8+ " Clayton",
            System.Text.Encoding.UTF8);
            // Set destinations for the email message.
            MailAddress to = new MailAddress("ben@contoso.com");
            // Specify the message content.
            MailMessage message = new MailMessage(from, to);
            message.Body = "This is a test email message sent by an application. ";
            // Include some non-ASCII characters in body and subject.
            string someArrows = new string(new char[] {'\u2190', '\u2191', '\u2192', '\u2193'});
            message.Body += Environment.NewLine + someArrows;
            message.BodyEncoding =  System.Text.Encoding.UTF8;
            message.Subject = "test message 1" + someArrows;
            message.SubjectEncoding = System.Text.Encoding.UTF8;
            // Set the method that is called back when the send operation ends.
            client.SendCompleted += new
            SendCompletedEventHandler(SendCompletedCallback);
            // The userState can be any object that allows your callback
            // method to identify this send operation.
            // For this example, the userToken is a string constant.
            string userState = "test message1";
            client.SendAsync(message, userState);
            Console.WriteLine("Sending message... press c to cancel mail. Press any other key to exit.");
            string answer = Console.ReadLine();
            // If the user canceled the send, and mail hasn't been sent yet,
            // then cancel the pending operation.
            if (answer.StartsWith("c") && mailSent == false)
            {
                client.SendAsyncCancel();
            }
            // Clean up.
            message.Dispose();
            Console.WriteLine("Goodbye.");
        }
    }
}

Imports System.Net
Imports System.Net.Mail
Imports System.Net.Mime
Imports System.Threading
Imports System.ComponentModel

Namespace Examples.SmtpExamples.Async
    Public Class SimpleAsynchronousExample
        Private Shared mailSent As Boolean = False
        Private Shared Sub SendCompletedCallback(ByVal sender As Object, ByVal e As AsyncCompletedEventArgs)
            ' Get the unique identifier for this asynchronous operation.
            Dim token As String = CStr(e.UserState)

            If e.Cancelled Then
                Console.WriteLine("[{0}] Send canceled.", token)
            End If
            If e.Error IsNot Nothing Then
                Console.WriteLine("[{0}] {1}", token, e.Error.ToString())
            Else
                Console.WriteLine("Message sent.")
            End If
            mailSent = True
        End Sub
        Public Shared Sub Main(ByVal args() As String)
            ' Command line argument must the SMTP host.
            Dim client As New SmtpClient(args(0))
            ' Specify the email sender.
            ' Create a mailing address that includes a UTF8 character
            ' in the display name.
            Dim mailFrom As New MailAddress("jane@contoso.com", "Jane " & ChrW(&HD8) & " Clayton", System.Text.Encoding.UTF8)
            ' Set destinations for the email message.
            Dim mailTo As New MailAddress("ben@contoso.com")
            ' Specify the message content.
            Dim message As New MailMessage(mailFrom, mailTo)
            message.Body = "This is a test email message sent by an application. "
            ' Include some non-ASCII characters in body and subject.
            Dim someArrows As New String(New Char() {ChrW(&H2190), ChrW(&H2191), ChrW(&H2192), ChrW(&H2193)})
            message.Body += Environment.NewLine & someArrows
            message.BodyEncoding = System.Text.Encoding.UTF8
            message.Subject = "test message 1" & someArrows
            message.SubjectEncoding = System.Text.Encoding.UTF8
            ' Set the method that is called back when the send operation ends.
            AddHandler client.SendCompleted, AddressOf SendCompletedCallback
            ' The userState can be any object that allows your callback 
            ' method to identify this send operation.
            ' For this example, the userToken is a string constant.
            Dim userState As String = "test message1"
            client.SendAsync(message, userState)
            Console.WriteLine("Sending message... press c to cancel mail. Press any other key to exit.")
            Dim answer As String = Console.ReadLine()
            ' If the user canceled the send, and mail hasn't been sent yet,
            ' then cancel the pending operation.
            If answer.StartsWith("c") AndAlso mailSent = False Then
                client.SendAsyncCancel()
            End If
            ' Clean up.
            message.Dispose()
            Console.WriteLine("Goodbye.")
        End Sub
    End Class
End Namespace

Комментарии

Чтобы получить уведомление о том, что сообщение отправлено или операция отменена, добавьте обработчик событий в SendCompleted событие. Операцию можно отменить SendAsync , вызвав SendAsyncCancel метод.

После вызова SendAsync необходимо дождаться завершения передачи электронной почты, прежде чем пытаться отправить другое сообщение электронной почты с помощью Send или SendAsync .

Перед вызовом этого метода Host Port необходимо задать и с помощью файлов конфигурации, задав соответствующие свойства или передав эту информацию в SmtpClient(String, Int32) конструктор.

Если SMTP-узлу требуются учетные данные, их необходимо задать перед вызовом этого метода. Чтобы указать учетные данные, UseDefaultCredentials Используйте Credentials свойства или.

Если вы получаете SmtpException исключение, проверьте свойство, StatusCode чтобы найти причину сбоя операции. SmtpExceptionТакже может содержать внутреннее исключение, указывающее причину сбоя операции.

При отправке сообщения электронной почты с помощью SendAsync нескольких получателей, если SMTP-сервер принимает некоторых получателей как допустимый и отклоняет другие, SmtpException NullReferenceException для внутреннего исключения создается исключение. В этом случае SendAsync не удается отправить сообщение электронной почты ни одному из получателей.

Приложение может обнаружить ошибку проверки сертификата сервера путем проверки Error свойства, переданного в SendCompletedEventHandler делегат.

TimeoutСвойство не влияет на SendAsync вызов.

Для отправки почты и блокировки при передаче на SMTP-сервер используйте один из Send методов.

Примечание

Если EnableSsl свойство имеет значение true , а почтовый сервер SMTP не объявляет STARTTLS в ответ на команду EHLO, то вызов Send методов или выдаст SendAsync исключение SmtpException .

Применяется к

SendAsync(String, String, String, String, Object)

Отправляет сообщение электронной почты на сервер SMTP для доставки. Отправитель, получатели, тема и основная часть сообщения указываются с помощью объектов String. Этот метод не блокирует вызывающий поток и позволяет вызывающей стороне передать объект в метод, вызванный после завершения операции.

public:
 void SendAsync(System::String ^ from, System::String ^ recipients, System::String ^ subject, System::String ^ body, System::Object ^ userToken);
public:
 void SendAsync(System::String ^ from, System::String ^ to, System::String ^ subject, System::String ^ body, System::Object ^ userToken);
public void SendAsync (string from, string recipients, string? subject, string? body, object? userToken);
public void SendAsync (string from, string recipients, string subject, string body, object userToken);
public void SendAsync (string from, string to, string subject, string body, object userToken);
member this.SendAsync : string * string * string * string * obj -> unit
member this.SendAsync : string * string * string * string * obj -> unit
Public Sub SendAsync (from As String, recipients As String, subject As String, body As String, userToken As Object)
Public Sub SendAsync (from As String, to As String, subject As String, body As String, userToken As Object)

Параметры

from
String

Значение String, содержащее информацию об адресе отправителя сообщения.

recipientsto
String

Значение String, содержащее адрес, по которому отправляется сообщение.

subject
String

Значение String, содержащее строку темы сообщения.

body
String

Значение String, содержащее основную часть сообщения.

userToken
Object

Пользовательский объект, передаваемый методу, вызываемому по завершении асинхронной операции.

Исключения

from имеет значение null.

-или- recipient имеет значение null.

from имеет значение Empty.

-или- recipient имеет значение Empty.

Данный SmtpClient в настоящий момент вызывает SendAsync.

-или- Свойству DeliveryMethod задано значение Network, а свойству Host задано значение null.

-или- Свойству DeliveryMethod задано значение Network и Host равно пустой строке ("").

-или- Свойство DeliveryMethod имеет значение Network, а свойство Port равно нулю, отрицательно или больше 65535.

Данный объект удален.

Сбой подключения к серверу SMTP.

-или- Проверка подлинности не пройдена.

-или- Истекло время ожидания для выполнения операции. -или- EnableSsl имеет значение true, а свойство DeliveryMethod имеет значение SpecifiedPickupDirectory или PickupDirectoryFromIis.

-или- Свойство EnableSsl имеет значение true, однако почтовый SMTP-сервер не отправил STARTTLS в ответ на команду EHLO.

-или- Сообщение не удалось доставить одному или нескольким получателям recipients.

Комментарии

Чтобы получить уведомление о том, что сообщение отправлено или операция отменена, добавьте обработчик событий в SendCompleted событие. Операцию можно отменить SendAsync , вызвав SendAsyncCancel метод.

После вызова SendAsync необходимо дождаться завершения передачи электронной почты, прежде чем пытаться отправить другое сообщение электронной почты с помощью Send или SendAsync .

Перед вызовом этого метода Host Свойства и Port должны быть заданы либо через файлы конфигурации, либо путем установки свойств или передачи этой информации в SmtpClient(String, Int32) конструктор.

Если SMTP-узлу требуются учетные данные, их необходимо задать перед вызовом этого метода. Чтобы указать учетные данные, UseDefaultCredentials Используйте Credentials свойство или.

Если вы получаете SmtpException исключение, проверьте свойство, StatusCode чтобы найти причину сбоя операции. SmtpExceptionТакже может содержать внутреннее исключение, указывающее причину сбоя операции.

При отправке сообщения электронной почты с помощью SendAsync нескольких получателей, если SMTP-сервер принимает некоторых получателей как допустимый и отклоняет другие, SmtpException NullReferenceException для внутреннего исключения создается исключение. В этом случае SendAsync не удается отправить сообщение электронной почты ни одному из получателей.

Приложение может обнаружить ошибку проверки сертификата сервера путем проверки Error свойства, переданного в SendCompletedEventHandler делегат.

TimeoutСвойство не влияет на SendAsync вызов.

Для отправки почты и блокировки при передаче на SMTP-сервер используйте один из Send методов.

Примечание

Если EnableSsl свойство имеет значение true , а почтовый сервер SMTP не объявляет STARTTLS в ответ на команду EHLO, то вызов Send методов или выдаст SendAsync исключение SmtpException .

Применяется к