Какие преимущества можно получить у объекта SmtpClient.SendAsync userToken?

Я использовал метод SMTPClient.Send(mail) для отправки электронных писем, но затем я увидел, что если идентификатор электронной почты отсутствует (не существует), мое приложение ожидает, пока оно получит исключение, а затем позволит пользователю выполнять дополнительные задачи.

Поэтому я подумал об использовании метода SMTPClient.SendAsync.

Мое сомнение! Где можно использовать этот userToken Object, который передается в качестве параметра метода? Я искал много вещей в Интернете, но не нашел хорошего примера. Даже в MSDN они используют его следующим образом

string userState = "test message1";
client.SendAsync(message, userState);

Но чем он может быть действительно использован?

Спасибо заранее.

Ответ 1

Вы можете использовать его в следующем случае: представьте, что у вас есть приложение для отправки пакетной электронной почты. Вы составляете сообщение (разные сообщения\вложения для каждого получателя, поэтому вы не можете объединить его в одно сообщение), выберите, например, 20 получателей и нажмите кнопку "Отправить все". Для отправки вы используете SendAsync и несколько экземпляров SmtpClient из "пула" (поскольку SmtpClient не позволяет дважды вызывать SendAsync на одном экземпляре до того, как предыдущий вызов не будет завершен).

У вас есть один обработчик SmtpClientSendCompleted для всех вызовов SendAsync, в которых необходимо выполнить расширенное ведение журнала: результат журнала отправки, имена (адреса или даже вложения) получатели неудавшихся сообщений, но AsyncCompletedEventArgs могут предоставлять эту информацию только с помощью UserState. Таким образом, основной шаблон для этой цели - использовать пользовательский объект состояния пользователя. См. Упрощенный пример:

Интерфейс, который содержит поля, которые вам понадобятся в обработчике:

public interface IEmailMessageInfo{
   string RecipientName {get;set;}
}

Класс состояния Async:

/// <summary>
/// User defined async state for SendEmailAsync method
/// </summary>
public class SendAsyncState {

    /// <summary>
    /// Contains all info that you need while handling message result
    /// </summary>
    public IEmailMessageInfo EmailMessageInfo { get; private set; }


    public SendAsyncState(IEmailMessageInfo emailMessageInfo) {
        EmailMessageInfo = emailMessageInfo;
    }
}

Здесь код для отправки электронной почты:

SmtpClient smtpClient = GetSmtpClient(smtpServerAddress);
smtpClient.SendCompleted += SmtpClientSendCompleted;
smtpClient.SendAsync(
   GetMailMessage()
   new SendAsyncState(new EmailMessageInfo{RecipientName = "Blah-blah"})
);

И пример кода обработчика:

private void SmtpClientSendCompleted(object sender, AsyncCompletedEventArgs e){
    var smtpClient = (SmtpClient) sender;
    var userAsyncState = (SendAsyncState) e.UserState;
    smtpClient.SendCompleted -= SmtpClientSendCompleted;

    if(e.Error != null) {
       tracer.ErrorEx(
          e.Error, 
          string.Format("Message sending for \"{0}\" failed.",userAsyncState.EmailMessageInfo.RecipientName)
       );
    }

    // Cleaning up resources
    .....
}

Пожалуйста, дайте мне знать, если вам нужна дополнительная информация.

Ответ 2

Если вы используете async(), вам также необходимо иметь обработчик событий.

   static void smtpClient_SendCompleted(object sender, System.ComponentModel.AsyncCompletedEventArgs e)
    {
        //to be implemented        
    }

Это нормально для отправки электронной почты с использованием метода Async(). Надеюсь, что это будет полезно.