SmtpClient.SendAsync SmtpClient.SendAsync SmtpClient.SendAsync SmtpClient.SendAsync Method

定義

電子メールを送信します。Sends an email message. これらのメソッドは、呼び出し元のスレッドをブロックしません。These methods do not block the calling thread.

オーバーロード

SendAsync(MailMessage, Object) SendAsync(MailMessage, Object) SendAsync(MailMessage, Object) SendAsync(MailMessage, Object)

指定した電子メール メッセージを、配信用 SMTP サーバーに送信します。Sends the specified email message to an SMTP server for delivery. このメソッドは、呼び出し元のスレッドをブロックしません。また、呼び出し元は、操作の完了時に呼び出されるメソッドにオブジェクトを渡すことができます。This method does not block the calling thread and allows the caller to pass an object to the method that is invoked when the operation completes.

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

電子メール メッセージを、配信用 SMTP サーバーに送信します。Sends an email message to an SMTP server for delivery. メッセージの差出人、受信者、件名、およびメッセージ本文は、String オブジェクトを使用して指定されます。The message sender, recipients, subject, and message body are specified using String objects. このメソッドは、呼び出し元のスレッドをブロックしません。また、呼び出し元は、操作の完了時に呼び出されるメソッドにオブジェクトを渡すことができます。This method does not block the calling thread and allows the caller to pass an object to the method that is invoked when the operation completes.

SendAsync(MailMessage, Object) SendAsync(MailMessage, Object) SendAsync(MailMessage, Object) SendAsync(MailMessage, Object)

指定した電子メール メッセージを、配信用 SMTP サーバーに送信します。Sends the specified email message to an SMTP server for delivery. このメソッドは、呼び出し元のスレッドをブロックしません。また、呼び出し元は、操作の完了時に呼び出されるメソッドにオブジェクトを渡すことができます。This method does not block the calling thread and allows the caller to pass an object to the method that is invoked when the operation completes.

public:
 void SendAsync(System::Net::Mail::MailMessage ^ message, System::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 MailMessage MailMessage

送信するメッセージを格納した MailMessageA MailMessage that contains the message to send.

userToken
Object Object Object Object

非同期操作の完了時に呼び出されるメソッドに渡されるユーザー定義のオブジェクト。A user-defined object that is passed to the method invoked when the asynchronous operation completes.

例外

messagenullです。message is null.

- または --or- Fromnull です。From is null.

この SmtpClient は、SendAsync の呼び出し中です。This SmtpClient has a SendAsync call in progress.

- または --or- ToCC、および Bcc の各プロパティで受信者が指定されていません。There are no recipients specified in To, CC, and Bcc properties.

- または --or- DeliveryMethod プロパティは Network に設定され、Hostnull です。DeliveryMethod property is set to Network and Host is null.

- または --or- DeliveryMethod プロパティは Network に設定され、Host は空の文字列 ("") と等しくなります。DeliveryMethod property is set to Network and Host is equal to the empty string ("").

または-or- DeliveryMethod プロパティが Network に設定され、Port がゼロ、負の値、または 65,535 より大きい値になっています。DeliveryMethod property is set to Network and Port is zero, a negative number, or greater than 65,535.

このオブジェクトは破棄されました。This object has been disposed.

SMTP サーバーへの接続に失敗しました。The connection to the SMTP server failed.

- または --or- 認証に失敗しました。Authentication failed.

- または --or- 操作はタイムアウトしました。The operation timed out. - または --or- EnableSsltrue に設定されますが、DeliveryMethod プロパティは SpecifiedPickupDirectory または PickupDirectoryFromIis に設定されます。EnableSsl is set to true but the DeliveryMethod property is set to SpecifiedPickupDirectory or PickupDirectoryFromIis.

- または --or- EnableSsltrue, に設定されていますが、SMTP メール サーバーが EHLO コマンドに対する応答で STARTTLS をアドバタイズしませんでした。EnableSsl is set to true, but the SMTP mail server did not advertise STARTTLS in the response to the EHLO command.

- または --or- ToCC、または Bcc 内の 1 人以上の受信者に、message を配信できませんでした。The message could not be delivered to one or more of the recipients in To, CC, or Bcc.

次のコード例は、このメソッドの呼び出しを示しています。The following code example demonstrates calling this method.

#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
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には、イベントにイベントハンドラーを追加します。To receive notification when the email has been sent or the operation has been canceled, add an event handler to the SendCompleted event. メソッドSendAsyncCancelを呼び出すSendAsyncことによって、操作を取り消すことができます。You can cancel a SendAsync operation by calling the SendAsyncCancel method.

を呼び出しSendAsyncた後、またはSendAsyncを使用してSend別の電子メールメッセージを送信しようとする前に、電子メールの送信が完了するまで待機する必要があります。After calling SendAsync, you must wait for the email transmission to complete before attempting to send another email message using Send or SendAsync.

このメソッドをHost呼び出す前に、 Port関連するプロパティを設定するか、この情報をSmtpClient(String, Int32)コンストラクターに渡すことによって、およびを構成ファイルで設定する必要があります。Before calling this method, the Host and Port must be set through the configuration files by setting the relevant properties, or by passing this information into the SmtpClient(String, Int32) constructor.

SMTP ホストで資格情報が必要な場合は、このメソッドを呼び出す前に設定する必要があります。If the SMTP host requires credentials, you must set them before calling this method. 資格情報を指定するにUseDefaultCredentialsCredentials 、プロパティまたはプロパティを使用します。To specify credentials, use the UseDefaultCredentials or Credentials properties.

例外が発生SmtpExceptionした場合は、 StatusCodeプロパティをチェックして、操作が失敗した理由を調べます。If you receive an SmtpException exception, check the StatusCode property to find the reason the operation failed. SmtpExceptionは、操作が失敗した理由を示す内部例外を含めることもできます。The SmtpException can also contain an inner exception that indicates the reason the operation failed.

を使用してSendAsync複数の受信者に電子メールを送信する場合、SMTP サーバーが有効としSmtpExceptionて受信者をNullReferenceException受け入れ、他の受信者を拒否すると、内部例外に対してがスローされます。When sending email using SendAsync to multiple recipients, if the SMTP server accepts some recipients as valid and rejects others, a SmtpException is thrown with a NullReferenceException for the inner exception. このエラーが発生SendAsyncすると、は受信者に電子メールを送信できません。If this occurs, SendAsync fails to send email to any of the recipients.

アプリケーションでは、 Error SendCompletedEventHandlerデリゲートに渡されたプロパティを調べることによって、サーバー証明書の検証エラーを検出できます。Your application can detect a server certificate validation error by examining the Error property passed into the SendCompletedEventHandler delegate.

プロパティTimeoutは、 SendAsync呼び出しに影響を与えません。The Timeout property does not have any effect on a SendAsync call.

SMTP サーバーへの送信中にメールとブロックを送信するには、いずれかSendの方法を使用します。To send mail and block while it is transmitted to the SMTP server, use one of the Send methods.

注意

true Send SendAsyncプロパティがに設定されていて、SMTP メールサーバーが EHLO コマンドに対する応答で STARTTLS をアドバタイズしていない場合、メソッドまたはメソッドをSmtpException呼び出すと、がスローされます。 EnableSslIf the EnableSsl property is set to true, and the SMTP mail server does not advertise STARTTLS in the response to the EHLO command, then a call to the Send or SendAsync methods will throw an SmtpException.

セキュリティ

SmtpPermission
SMTP サーバーに接続します。to connect to the SMTP server. 関連付けられた列挙型:ConnectAssociated enumeration: Connect

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

電子メール メッセージを、配信用 SMTP サーバーに送信します。Sends an email message to an SMTP server for delivery. メッセージの差出人、受信者、件名、およびメッセージ本文は、String オブジェクトを使用して指定されます。The message sender, recipients, subject, and message body are specified using String objects. このメソッドは、呼び出し元のスレッドをブロックしません。また、呼び出し元は、操作の完了時に呼び出されるメソッドにオブジェクトを渡すことができます。This method does not block the calling thread and allows the caller to pass an object to the method that is invoked when the operation completes.

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

パラメーター

from
String String String String

メッセージの差出人のアドレス情報を格納している StringA String that contains the address information of the message sender.

recipients
String String String String

メッセージの送信先のアドレスを格納している StringA String that contains the address that the message is sent to.

subject
String String String String

メッセージの件名を格納している StringA String that contains the subject line for the message.

body
String String String String

メッセージ本文を格納している StringA String that contains the message body.

userToken
Object Object Object Object

非同期操作の完了時に呼び出されるメソッドに渡されるユーザー定義のオブジェクト。A user-defined object that is passed to the method invoked when the asynchronous operation completes.

例外

fromnull です。from is null.

- または --or- recipientnullです。recipient is null.

fromEmptyです。from is Empty.

- または --or- recipientEmpty です。recipient is Empty.

この SmtpClient は、SendAsync の呼び出し中です。This SmtpClient has a SendAsync call in progress.

- または --or- DeliveryMethod プロパティは Network に設定され、Hostnull です。DeliveryMethod property is set to Network and Host is null.

- または --or- DeliveryMethod プロパティは Network に設定され、Host は空の文字列 ("") と等しくなります。DeliveryMethod property is set to Network and Host is equal to the empty string ("").

- または --or- DeliveryMethod プロパティが Network に設定され、Port がゼロ、負の値、または 65,535 より大きい値になっています。DeliveryMethod property is set to Network and Port is zero, a negative number, or greater than 65,535.

このオブジェクトは破棄されました。This object has been disposed.

SMTP サーバーへの接続に失敗しました。The connection to the SMTP server failed.

- または --or- 認証に失敗しました。Authentication failed.

または-or- 操作はタイムアウトしました。The operation timed out. または-or- EnableSsltrue に設定されますが、DeliveryMethod プロパティは SpecifiedPickupDirectory または PickupDirectoryFromIis に設定されます。EnableSsl is set to true but the DeliveryMethod property is set to SpecifiedPickupDirectory or PickupDirectoryFromIis.

- または --or- EnableSsltrue, に設定されていますが、SMTP メール サーバーが EHLO コマンドに対する応答で STARTTLS をアドバタイズしませんでした。EnableSsl is set to true, but the SMTP mail server did not advertise STARTTLS in the response to the EHLO command.

- または --or- recipients 内の 1 人以上の受信者に、メッセージを配信できませんでした。The message could not be delivered to one or more of the recipients in recipients.

注釈

電子メールが送信されたとき、または操作が取り消されたときに通知を受信するSendCompletedには、イベントにイベントハンドラーを追加します。To receive notification when the email has been sent or the operation has been canceled, add an event handler to the SendCompleted event. メソッドSendAsyncCancelを呼び出すSendAsyncことによって、操作を取り消すことができます。You can cancel a SendAsync operation by calling the SendAsyncCancel method.

を呼び出しSendAsyncた後、またはSendAsyncを使用してSend別の電子メールメッセージを送信しようとする前に、電子メールの送信が完了するまで待機する必要があります。After calling SendAsync, you must wait for the email transmission to complete before attempting to send another email message using Send or SendAsync.

このメソッドを呼び出す前にHostPort構成ファイルを使用するかプロパティを設定するか、またはこの情報をSmtpClient(String, Int32)コンストラクターに渡すことによって、プロパティとプロパティを設定する必要があります。Before calling this method, the Host and Port properties must be set either through the configuration files or by setting the properties or passing this information into the SmtpClient(String, Int32) constructor.

SMTP ホストで資格情報が必要な場合は、このメソッドを呼び出す前に設定する必要があります。If the SMTP host requires credentials, you must set them before calling this method. 資格情報を指定するにUseDefaultCredentialsCredentials 、プロパティまたはプロパティを使用します。To specify credentials, use the UseDefaultCredentials or Credentials property.

例外が発生SmtpExceptionした場合は、 StatusCodeプロパティをチェックして、操作が失敗した理由を調べます。If you receive an SmtpException exception, check the StatusCode property to find the reason the operation failed. SmtpExceptionは、操作が失敗した理由を示す内部例外を含めることもできます。The SmtpException can also contain an inner exception that indicates the reason the operation failed.

を使用してSendAsync複数の受信者に電子メールを送信する場合、SMTP サーバーが有効としSmtpExceptionて受信者をNullReferenceException受け入れ、他の受信者を拒否すると、内部例外に対してがスローされます。When sending email using SendAsync to multiple recipients, if the SMTP server accepts some recipients as valid and rejects others, a SmtpException is thrown with a NullReferenceException for the inner exception. このエラーが発生SendAsyncすると、は受信者に電子メールを送信できません。If this occurs, SendAsync fails to send email to any of the recipients.

アプリケーションでは、 Error SendCompletedEventHandlerデリゲートに渡されたプロパティを調べることによって、サーバー証明書の検証エラーを検出できます。Your application can detect a server certificate validation error by examining the Error property passed into the SendCompletedEventHandler delegate.

プロパティTimeoutは、 SendAsync呼び出しに影響を与えません。The Timeout property does not have any effect on a SendAsync call.

SMTP サーバーへの送信中にメールとブロックを送信するには、いずれかSendの方法を使用します。To send mail and block while it is transmitted to the SMTP server, use one of the Send methods.

注意

true Send SendAsyncプロパティがに設定されていて、SMTP メールサーバーが EHLO コマンドに対する応答で STARTTLS をアドバタイズしていない場合、メソッドまたはメソッドをSmtpException呼び出すと、がスローされます。 EnableSslIf the EnableSsl property is set to true, and the SMTP mail server does not advertise STARTTLS in the response to the EHLO command, then a call to the Send or SendAsync methods will throw an SmtpException.

セキュリティ

SmtpPermission
SMTP サーバーに接続します。To connect to the SMTP server. 関連付けられた列挙型:ConnectAssociated enumeration: Connect

適用対象