SmtpClient.SendAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Отправляет сообщение электронной почты. Эти методы не блокируют вызывающий поток.
Перегрузки
| Имя | Описание |
|---|---|
| SendAsync(MailMessage, Object) |
Отправляет указанное сообщение электронной почты на SMTP-сервер для доставки. Этот метод не блокирует вызывающий поток и позволяет вызывающему объекту передавать объект методу, который вызывается при завершении операции. |
| SendAsync(String, String, String, String, Object) |
Отправляет сообщение электронной почты на SMTP-сервер для доставки. Отправитель сообщения, получатели, тема и текст сообщения указываются с помощью String объектов. Этот метод не блокирует вызывающий поток и позволяет вызывающему объекту передавать объект методу, который вызывается при завершении операции. |
SendAsync(MailMessage, Object)
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
Отправляет указанное сообщение электронной почты на 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
Определяемый пользователем объект, который передается методу, вызываемого при завершении асинхронной операции.
Исключения
Это SmtpClient еще одна операция отправки уже выполняется.
–или–
Нет получателей, указанных в To, CCи Bcc свойствах.
–или–
DeliveryMethod свойство имеет значение Network и Host имеет значение null.
–или–
DeliveryMethod свойство имеет значение Network и Host равно пустой строке ("").
–или–
DeliveryMethod свойство равно нулю NetworkPort , отрицательному числу или больше 65 535.
Этот объект был удален.
Сбой подключения к SMTP-серверу.
–или–
Сбой проверки подлинности.
–или–
Время ожидания операции истекло.
–или–
EnableSsl имеет true значение, но DeliveryMethod для свойства задано SpecifiedPickupDirectory значение или PickupDirectoryFromIis.
–или–
EnableSsl задано значение true, , но почтовый сервер SMTP не объявлял STARTTLS в ответе на команду EHLO.
–или–
Не message удалось передать одному или нескольким получателям в To, CCили Bcc.
Примеры
В следующем примере кода показано, как вызвать этот метод.
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)
{
client.SendAsyncCancel();
}
// Clean up.
message.Dispose();
client.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()
client.Dispose()
Console.WriteLine("Goodbye.")
End Sub
End Class
End Namespace
Комментарии
Чтобы получить уведомление о отправке сообщения электронной почты или отмене операции, добавьте обработчик событий в SendCompleted событие. Операцию можно отменить SendAsync , вызвав SendAsyncCancel метод.
После вызова SendAsyncнеобходимо дождаться завершения передачи электронной почты, прежде чем пытаться отправить другое сообщение электронной почты с помощью Send или SendAsync.
Перед вызовом этого метода и Port его необходимо задать с помощью файлов конфигурации, Host задав соответствующие свойства или передавая эти сведения в 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)
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
- Исходный код:
- SmtpClient.cs
Отправляет сообщение электронной почты на SMTP-сервер для доставки. Отправитель сообщения, получатели, тема и текст сообщения указываются с помощью String объектов. Этот метод не блокирует вызывающий поток и позволяет вызывающему объекту передавать объект методу, который вызывается при завершении операции.
public:
void SendAsync(System::String ^ from, System::String ^ recipients, 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);
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)
Параметры
- userToken
- Object
Определяемый пользователем объект, который передается методу, вызываемого при завершении асинхронной операции.
Исключения
SendAsync Этот SmtpClient вызов выполняется.
–или–
DeliveryMethod свойство имеет значение Network и Host имеет значение null.
–или–
DeliveryMethod свойство имеет значение Network и Host равно пустой строке ("").
–или–
DeliveryMethod свойство равно нулю NetworkPort , отрицательному числу или больше 65 535.
Этот объект был удален.
Сбой подключения к SMTP-серверу.
–или–
Сбой проверки подлинности.
–или–
Время ожидания операции истекло.
–или–
EnableSsl имеет true значение, но DeliveryMethod для свойства задано SpecifiedPickupDirectory значение или PickupDirectoryFromIis.
–или–
EnableSsl задано значение true, , но почтовый сервер SMTP не объявлял STARTTLS в ответе на команду EHLO.
–или–
Сообщение не удалось передать одному или нескольким получателям recipients.
Комментарии
Чтобы получить уведомление о отправке сообщения электронной почты или отмене операции, добавьте обработчик событий в SendCompleted событие. Операцию можно отменить SendAsync , вызвав SendAsyncCancel метод.
После вызова SendAsyncнеобходимо дождаться завершения передачи электронной почты, прежде чем пытаться отправить другое сообщение электронной почты с помощью Send или SendAsync.
Перед вызовом этого метода HostPort необходимо задать свойства с помощью файлов конфигурации или задать свойства или передать эти сведения в 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.