SmtpClient.SendAsync Método

Definición

Envía un mensaje de correo electrónico.Sends an email message. Estos métodos no bloquean el subproceso que realiza la llamada.These methods do not block the calling thread.

Sobrecargas

SendAsync(MailMessage, Object)

Envía el mensaje de correo electrónico especificado a un servidor SMTP para su entrega.Sends the specified email message to an SMTP server for delivery. Este método no bloquea el subproceso que realiza la llamada y permite al llamador pasar un objeto al método que se invoca cuando termina la operación.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)

Envía un mensaje de correo electrónico a un servidor SMTP para su entrega.Sends an email message to an SMTP server for delivery. El remitente del mensaje, los destinatarios, el asunto y el cuerpo del mensaje se especifican mediante objetos String.The message sender, recipients, subject, and message body are specified using String objects. Este método no bloquea el subproceso que realiza la llamada y permite al llamador pasar un objeto al método que se invoca cuando termina la operación.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)

Envía el mensaje de correo electrónico especificado a un servidor SMTP para su entrega.Sends the specified email message to an SMTP server for delivery. Este método no bloquea el subproceso que realiza la llamada y permite al llamador pasar un objeto al método que se invoca cuando termina la operación.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)

Parámetros

message
MailMessage

Objeto MailMessage que contiene el mensaje que se va a enviar.A MailMessage that contains the message to send.

userToken
Object

Objeto definido por el usuario que se pasa al método invocado cuando se completa la operación asincrónica.A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Excepciones

message es null.message is null.

o bien-or- From es null.From is null.

Este objeto SmtpClient tiene una llamada a SendAsync en curso.This SmtpClient has a SendAsync call in progress.

o bien-or- No hay ningún destinatario especificado en las propiedades To, CC y BccThere are no recipients specified in To, CC, and Bcc properties.

o bien-or- La propiedad DeliveryMethod se establece en Network y Host es null.DeliveryMethod property is set to Network and Host is null.

o bien-or- La propiedad DeliveryMethod se establece en Network y Hostes igual a la cadena vacía ("").DeliveryMethod property is set to Network and Host is equal to the empty string ("").

o bien-or- La propiedad DeliveryMethod se establece en Network y Port es cero, un número negativo o mayor que 65.535.DeliveryMethod property is set to Network and Port is zero, a negative number, or greater than 65,535.

Este objeto se ha eliminado.This object has been disposed.

Se ha producido un error de conexión al servidor SMTP.The connection to the SMTP server failed.

o bien-or- Error de autenticación.Authentication failed.

o bien-or- La operación agotó el tiempo de espera.The operation timed out. o bien-or- EnableSsl se establece en true pero la propiedad DeliveryMethod se establece en SpecifiedPickupDirectory o PickupDirectoryFromIis.EnableSsl is set to true but the DeliveryMethod property is set to SpecifiedPickupDirectory or PickupDirectoryFromIis.

o bien-or- EnableSsl está establecido en true, pero el servidor de correo de SMTP no anunció STARTTLS en la respuesta al comando EHLO.EnableSsl is set to true, but the SMTP mail server did not advertise STARTTLS in the response to the EHLO command.

o bien-or- No se pudo entregar message a uno o varios de los destinatarios de To, CC o Bcc.The message could not be delivered to one or more of the recipients in To, CC, or Bcc.

Ejemplos

En el ejemplo de código siguiente se muestra cómo llamar a este método.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.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

Comentarios

Para recibir una notificación cuando se haya enviado el correo electrónico o se haya cancelado la operación, agregue un controlador de eventos al evento SendCompleted.To receive notification when the email has been sent or the operation has been canceled, add an event handler to the SendCompleted event. Puede cancelar una operación de SendAsync llamando al método SendAsyncCancel.You can cancel a SendAsync operation by calling the SendAsyncCancel method.

Después de llamar a SendAsync, debe esperar a que se complete la transmisión de correo electrónico antes de intentar enviar otro mensaje de correo electrónico con Send o SendAsync.After calling SendAsync, you must wait for the email transmission to complete before attempting to send another email message using Send or SendAsync.

Antes de llamar a este método, el Host y Port se deben establecer a través de los archivos de configuración mediante el establecimiento de las propiedades pertinentes o pasando esta información en el constructor de 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.

Si el host SMTP requiere credenciales, debe establecerlas antes de llamar a este método.If the SMTP host requires credentials, you must set them before calling this method. Para especificar las credenciales, use las propiedades UseDefaultCredentials o Credentials.To specify credentials, use the UseDefaultCredentials or Credentials properties.

Si recibe una excepción SmtpException, Compruebe la propiedad StatusCode para encontrar la razón por la que se produjo un error en la operación.If you receive an SmtpException exception, check the StatusCode property to find the reason the operation failed. El SmtpException también puede contener una excepción interna que indica la razón por la que se produjo un error en la operación.The SmtpException can also contain an inner exception that indicates the reason the operation failed.

Al enviar correo electrónico con SendAsync a varios destinatarios, si el servidor SMTP acepta algunos destinatarios como válidos y los rechaza, se produce una SmtpException con un NullReferenceException para la excepción interna.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. Si esto ocurre, SendAsync no puede enviar correo electrónico a ninguno de los destinatarios.If this occurs, SendAsync fails to send email to any of the recipients.

La aplicación puede detectar un error de validación de certificado de servidor examinando la Error propiedad que se pasa al delegado de SendCompletedEventHandler.Your application can detect a server certificate validation error by examining the Error property passed into the SendCompletedEventHandler delegate.

La propiedad Timeout no tiene ningún efecto en una llamada SendAsync.The Timeout property does not have any effect on a SendAsync call.

Para enviar correo y bloquear mientras se transmite al servidor SMTP, use uno de los métodos de Send.To send mail and block while it is transmitted to the SMTP server, use one of the Send methods.

Nota

Si la propiedad EnableSsl está establecida en truey el servidor de correo SMTP no anuncia STARTTLS en la respuesta al comando EHLO, una llamada a los métodos Send o SendAsync producirá una SmtpException.If 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.

Seguridad

SmtpPermission
Para conectarse al servidor SMTP.to connect to the SMTP server. Enumeración asociada: ConnectAssociated enumeration: Connect

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

Envía un mensaje de correo electrónico a un servidor SMTP para su entrega.Sends an email message to an SMTP server for delivery. El remitente del mensaje, los destinatarios, el asunto y el cuerpo del mensaje se especifican mediante objetos String.The message sender, recipients, subject, and message body are specified using String objects. Este método no bloquea el subproceso que realiza la llamada y permite al llamador pasar un objeto al método que se invoca cuando termina la operación.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)

Parámetros

from
String

Objeto String que contiene la información de dirección del remitente del mensaje.A String that contains the address information of the message sender.

recipients
String

Objeto String que contiene la dirección a la que se envía el mensaje.A String that contains the address that the message is sent to.

subject
String

Objeto String que contiene la línea de asunto del mensaje.A String that contains the subject line for the message.

body
String

Objeto String que contiene el cuerpo del mensaje.A String that contains the message body.

userToken
Object

Objeto definido por el usuario que se pasa al método invocado cuando se completa la operación asincrónica.A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Excepciones

from es null.from is null.

o bien-or- recipient es null.recipient is null.

from es Empty.from is Empty.

o bien-or- recipient es Empty.recipient is Empty.

Este objeto SmtpClient tiene una llamada a SendAsync en curso.This SmtpClient has a SendAsync call in progress.

o bien-or- La propiedad DeliveryMethod se establece en Network y Host es null.DeliveryMethod property is set to Network and Host is null.

o bien-or- La propiedad DeliveryMethod se establece en Network y Hostes igual a la cadena vacía ("").DeliveryMethod property is set to Network and Host is equal to the empty string ("").

o bien-or- La propiedad DeliveryMethod se establece en Network y Port es cero, un número negativo o mayor que 65.535.DeliveryMethod property is set to Network and Port is zero, a negative number, or greater than 65,535.

Este objeto se ha eliminado.This object has been disposed.

Se ha producido un error de conexión al servidor SMTP.The connection to the SMTP server failed.

o bien-or- Error de autenticación.Authentication failed.

o bien-or- La operación agotó el tiempo de espera.The operation timed out. o bien-or- EnableSsl se establece en true pero la propiedad DeliveryMethod se establece en SpecifiedPickupDirectory o PickupDirectoryFromIis.EnableSsl is set to true but the DeliveryMethod property is set to SpecifiedPickupDirectory or PickupDirectoryFromIis.

o bien-or- EnableSsl está establecido en true, pero el servidor de correo de SMTP no anunció STARTTLS en la respuesta al comando EHLO.EnableSsl is set to true, but the SMTP mail server did not advertise STARTTLS in the response to the EHLO command.

o bien-or- No se ha podido entregar el mensaje a uno o varios de los destinatarios de recipients.The message could not be delivered to one or more of the recipients in recipients.

Comentarios

Para recibir una notificación cuando se haya enviado el correo electrónico o se haya cancelado la operación, agregue un controlador de eventos al evento SendCompleted.To receive notification when the email has been sent or the operation has been canceled, add an event handler to the SendCompleted event. Puede cancelar una operación de SendAsync llamando al método SendAsyncCancel.You can cancel a SendAsync operation by calling the SendAsyncCancel method.

Después de llamar a SendAsync, debe esperar a que se complete la transmisión de correo electrónico antes de intentar enviar otro mensaje de correo electrónico con Send o SendAsync.After calling SendAsync, you must wait for the email transmission to complete before attempting to send another email message using Send or SendAsync.

Antes de llamar a este método, las propiedades Host y Port se deben establecer a través de los archivos de configuración o estableciendo las propiedades o pasando esta información en el constructor 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.

Si el host SMTP requiere credenciales, debe establecerlas antes de llamar a este método.If the SMTP host requires credentials, you must set them before calling this method. Para especificar las credenciales, use la propiedad UseDefaultCredentials o Credentials.To specify credentials, use the UseDefaultCredentials or Credentials property.

Si recibe una excepción SmtpException, Compruebe la propiedad StatusCode para encontrar la razón por la que se produjo un error en la operación.If you receive an SmtpException exception, check the StatusCode property to find the reason the operation failed. El SmtpException también puede contener una excepción interna que indica la razón por la que se produjo un error en la operación.The SmtpException can also contain an inner exception that indicates the reason the operation failed.

Al enviar correo electrónico con SendAsync a varios destinatarios, si el servidor SMTP acepta algunos destinatarios como válidos y los rechaza, se produce una SmtpException con un NullReferenceException para la excepción interna.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. Si esto ocurre, SendAsync no puede enviar correo electrónico a ninguno de los destinatarios.If this occurs, SendAsync fails to send email to any of the recipients.

La aplicación puede detectar un error de validación de certificado de servidor examinando la Error propiedad que se pasa al delegado de SendCompletedEventHandler.Your application can detect a server certificate validation error by examining the Error property passed into the SendCompletedEventHandler delegate.

La propiedad Timeout no tiene ningún efecto en una llamada SendAsync.The Timeout property does not have any effect on a SendAsync call.

Para enviar correo y bloquear mientras se transmite al servidor SMTP, use uno de los métodos de Send.To send mail and block while it is transmitted to the SMTP server, use one of the Send methods.

Nota

Si la propiedad EnableSsl está establecida en truey el servidor de correo SMTP no anuncia STARTTLS en la respuesta al comando EHLO, una llamada a los métodos Send o SendAsync producirá una SmtpException.If 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.

Seguridad

SmtpPermission
Para conectarse al servidor SMTP.To connect to the SMTP server. Enumeración asociada: ConnectAssociated enumeration: Connect

Se aplica a