SmtpClient Класс

Определение

public ref class SmtpClient : IDisposable

public ref class SmtpClient

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public class SmtpClient : IDisposable

public class SmtpClient : IDisposable

public class SmtpClient

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
type SmtpClient = class
    interface IDisposable

type SmtpClient = class
    interface IDisposable

type SmtpClient = class

Public Class SmtpClient
Implements IDisposable

Public Class SmtpClient

Наследование

Object

SmtpClient

Атрибуты

UnsupportedOSPlatformAttribute

Реализации

IDisposable

Примеры

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

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

Комментарии

Класс SmtpClient используется для отправки электронной почты на SMTP-сервер для доставки. Протокол SMTP определен в RFC 2821, который доступен по адресу https://www.ietf.org.

Класс SmtpClient :

• Включены в .NET Standard 2.0 и более поздних версий и поэтому должны быть частью любой реализации .NET, поддерживающей эти версии.
• Присутствует и может использоваться в .NET Framework 4 через .NET Framework 4.8.
• Использовать в .NET (Core), но его использование не рекомендуется.

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

Чтобы создать и отправить сообщение электронной почты с помощью SmtpClient, необходимо указать следующие сведения:

• Сервер узла SMTP, используемый для отправки электронной почты. См. раздел Host и Port свойства.
• Учетные данные для проверки подлинности, если требуется SMTP-сервером. См. Credentials свойство.
• Адрес электронной почты отправителя. Send См. методы, SendAsync которые принимают from параметр. Также см. MailMessage.From свойство.
• Адрес электронной почты или адреса получателей. Send См. методы, SendAsync которые принимают recipient параметр. Также см. MailMessage.To свойство.
• Содержимое сообщения. Send См. методы, SendAsync которые принимают body параметр. Также см. MailMessage.Body свойство.

Чтобы включить вложение с сообщением электронной почты, сначала создайте вложение с помощью Attachment класса, а затем добавьте его в сообщение с помощью MailMessage.Attachments свойства. В зависимости от средства чтения электронной почты, используемого получателями и типом файла вложения, некоторые получатели могут не считывать вложение. Для клиентов, которые не могут отображать вложение в исходной форме, можно указать альтернативные представления с помощью MailMessage.AlternateViews свойства.

В .NET Framework можно использовать файлы конфигурации приложения или компьютера, чтобы указать значения узлов, портов и учетных данных по умолчанию для всех SmtpClient объектов. Дополнительные сведения см. в разделе< mailSettings Element (Network Settings>). .NET Core не поддерживает параметры по умолчанию. В качестве обходного решения необходимо задать соответствующие свойства SmtpClient напрямую.

Чтобы отправить сообщение электронной почты и заблокировать при ожидании передачи сообщения электронной почты на SMTP-сервер, используйте один из синхронных Send методов. Чтобы разрешить основной поток программы продолжать выполняться во время передачи электронной почты, используйте один из асинхронных SendAsync методов. Событие SendCompleted возникает при SendAsync завершении операции. Чтобы получить это событие, необходимо добавить SendCompletedEventHandler делегат SendCompletedв . Делегат SendCompletedEventHandler должен ссылаться на метод обратного вызова, обрабатывающий уведомление о событиях SendCompleted . Чтобы отменить асинхронную передачу электронной почты, используйте SendAsyncCancel этот метод.

Подключение, установленное текущим экземпляром SmtpClient класса к SMTP-серверу, может быть повторно использовано, если приложение хочет отправить несколько сообщений на один SMTP-сервер. Это особенно полезно при использовании проверки подлинности или шифрования подключения к SMTP-серверу. Процесс проверки подлинности и установления сеанса TLS может быть дорогостоящими операциями. Требование повторного установления подключения для каждого сообщения при отправке большого количества сообщений электронной почты на один SMTP-сервер может оказать значительное влияние на производительность. Существует несколько приложений электронной почты с большим объемом, которые отправляют обновления состояния электронной почты, рассылки бюллетеней или оповещения электронной почты. Кроме того, многие клиентские приложения электронной почты поддерживают режим внестроки, в котором пользователи могут создавать множество сообщений электронной почты, отправляемых позже при установке подключения к SMTP-серверу. Обычно клиент электронной почты отправляет все сообщения SMTP на определенный SMTP-сервер (предоставляемый поставщиком услуг Интернета), который затем перенаправит этот адрес электронной почты на другие SMTP-серверы.

Пулы SmtpClient smtp-подключений реализации класса позволяют избежать дополнительных затрат на повторное создание подключения для каждого сообщения с тем же сервером. Приложение может повторно использовать один и тот же SmtpClient объект для отправки нескольких разных сообщений электронной почты на один SMTP-сервер и на множество разных SMTP-серверов. В результате невозможно определить, когда приложение завершится с помощью SmtpClient объекта, и его следует очистить.

Когда сеанс SMTP завершится, и клиент хочет завершить подключение, он должен отправить сообщение QUIT на сервер, чтобы указать, что у него больше нет сообщений для отправки. Это позволяет серверу освободить ресурсы, связанные с подключением от клиента, и обработать сообщения, отправленные клиентом.

Класс SmtpClient не Finalize имеет метода, поэтому приложение должно явно Dispose освободить ресурсы. Метод Dispose выполняет итерацию по всем установленным подключениям к SMTP-серверу, указанному в Host свойстве, и отправляет сообщение QUIT, за которым следует корректное завершение TCP-подключения. Метод Dispose также освобождает неуправляемые ресурсы, используемые Socket и при необходимости удаляет управляемые ресурсы.

Вызов Dispose по завершении работы с помощью SmtpClient. Метод Dispose покидает SmtpClient неиспользуемое состояние. После вызова Disposeнеобходимо освободить все ссылки на SmtpClient сборщик мусора, чтобы освободить память, SmtpClient занятую.

См. также раздел

• System.Net.Mime
• Сетевое программирование в .NET Framework
• Примеры сетевого программирования
• Трассировка сети в .NET Framework
• Безопасность в сетевом программировании