你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

快速入门：发送电子邮件时手动轮询电子邮件状态

项目
07/26/2023

本快速入门介绍如何使用我们的电子邮件 SDK 在发送电子邮件时手动轮询电子邮件状态。

通过使用通信服务 .NET 电子邮件客户端库来发送电子邮件，开启 Azure 通信服务使用旅程。

提示

通过直接跳到 GitHub 上的基本电子邮件发送和高级电子邮件发送示例代码，率先启动使用 Azure 通信服务发送电子邮件的体验。

了解电子邮件对象模型

以下类和接口处理适用于 C# 的 Azure 通信服务电子邮件客户端库的某些主要功能。

名称	说明
EmailAddress	此类包含一个电子邮件地址和一个显示名称选项。
EmailAttachment	此类通过接受唯一 ID、电子邮件附件 MIME 类型字符串和内容的二进制数据来创建电子邮件附件。
EmailClient	所有电子邮件功能需要此类。使用连接字符串将其实例化，然后使用它来发送电子邮件。
EmailClientOptions	可将此类添加到EmailClient 实例化以面向特定的 API 版本。
EmailContent	此类包含电子邮件的主题和正文。必须至少指定纯文本或 Html 内容之一
EmailCustomHeader	使用此类可为自定义标头添加名称和值对。还可以使用标头名称“x-priority”或“x-msmail-priority”通过这些标头指定电子邮件重要性
EmailMessage	此类合并发件人、内容和收件人。还可以选择添加自定义标头、附件和回复电子邮件地址。
EmailRecipients	此类保存电子邮件收件人的 EmailAddress 对象列表，包括抄送和密件抄送收件人的可选列表。
EmailSendOperation	此类表示异步电子邮件发送操作，并从电子邮件发送 API 调用返回。
EmailSendResult	此类保存电子邮件发送操作的结果。它具有操作 ID、操作状态和错误对象（如果适用）。

EmailSendResult 返回执行的电子邮件操作的以下状态。

状态	说明
NotStarted	目前，我们不会从我们的服务发送此状态。
正在运行	电子邮件发送操作当前正在进行且正在处理中。
已成功	如果电子邮件发送操作已完成且未出错，并且电子邮件正在传送中。在此阶段之外传送的电子邮件的任何详细状态都可以通过 Azure Monitor 或 Azure 事件网格获取。了解如何订阅电子邮件事件
已失败	电子邮件发送操作未成功，并遇到错误。电子邮件未发送。结果包含错误对象，以及有关失败原因的更多详细信息。

先决条件

具有活动订阅的 Azure 帐户。免费创建帐户。
适用于你的操作系统的最新版本 .NET Core 客户端库。
已使用预配的域创建并准备好了一个 Azure 电子邮件通信服务资源。开始创建电子邮件通信资源
一个与电子邮件域连接的活动通信服务资源，以及一个连接字符串。开始将电子邮件资源与通信资源相连接

完成本快速入门会从你的 Azure 帐户中扣取最多几美分的费用。

注意

我们还可以从我们自己的已验证域发送电子邮件。将自定义的已验证域添加到电子邮件通信服务。

先决条件检查

在终端或命令窗口中，运行 dotnet 命令来查看是否安装了 .NET 客户端。
若要查看与电子邮件通信服务资源关联的子域，请登录到 Azure 门户，找到你的电子邮件通信服务资源，然后从左侧导航窗格中打开“预配域”选项卡。

新建 C# 应用程序

在控制台窗口（例如 cmd、PowerShell 或 Bash）中，使用 dotnet new 命令创建名为 EmailQuickstart 的新控制台应用。此命令将创建包含单个源文件的简单“Hello World”C# 项目：Program.cs。

dotnet new console -o EmailQuickstart

将目录更改为新创建的应用文件夹，并使用 dotnet build 命令编译应用程序。

cd EmailQuickstart
dotnet build

安装包

仍在应用程序目录中时，使用 dotnet add package 命令安装适用于 .NET 包的 Azure 通信服务电子邮件客户端库。

dotnet add package Azure.Communication.Email

创建具有身份验证的电子邮件客户端

打开 Program.cs，将现有代码替换为以下内容，以添加 using 指令，用于包含 Azure.Communication.Email 命名空间和程序的执行起点。


using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;

using Azure;
using Azure.Communication.Email;

namespace SendEmail
{
  internal class Program
  {
    static async Task Main(string[] args)
    {

    }
  }
}

可使用几个不同的选项对电子邮件客户端进行身份验证：

在文本编辑器中打开 Program.cs，并将 Main 方法的主体替换为使用连接字符串初始化 EmailClient 的代码。以下代码从名为 COMMUNICATION_SERVICES_CONNECTION_STRING 的环境变量中检索资源的连接字符串。了解如何管理资源的连接字符串。

// This code demonstrates how to fetch your connection string
// from an environment variable.
string connectionString = Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");
EmailClient emailClient = new EmailClient(connectionString);

要使用 Azure Active Directory 进行身份验证，请使用 dotnet add package 命令安装适用于 .NET 的 Azure.Identity 库包。

dotnet add package Azure.Identity

在文本编辑器中打开 Program.cs，并将 Main 方法的主体替换为使用 DefaultAzureCredential 初始化 EmailClient 的代码。 Azure 标识 SDK 会在运行时读取三个环境变量中的值，以对应用程序进行身份验证。了解如何创建 Azure Active Directory 注册应用程序并设置环境变量。

// This code demonstrates how to authenticate to your Communication Service resource using
// DefaultAzureCredential and the environment variables AZURE_CLIENT_ID, AZURE_TENANT_ID,
// and AZURE_CLIENT_SECRET.
string resourceEndpoint = "<ACS_RESOURCE_ENDPOINT>";
EmailClient emailClient = new EmailClient(new Uri(resourceEndpoint), new DefaultAzureCredential());

电子邮件客户端也可以使用 AzureKeyCredential 进行身份验证。可以在通信服务资源“设置”下的“密钥”窗格中找到key 和 endpoint。

var key = new AzureKeyCredential("<your-key-credential>");
var endpoint = new Uri("<your-endpoint-uri>");

var emailClient = new EmailClient(endpoint, key);

发送电子邮件异步和轮询电子邮件发送状态

使用 Azure.WaitUntil.Started 调用 SendAsync 时，方法在启动操作后返回。方法返回 EmailSendOperation 对象。可以调用 UpdateStatusAsync 方法来刷新电子邮件操作状态。

返回的 EmailSendOperation 对象包含 EmailSendStatus 对象，该对象包含：

电子邮件发送操作的当前状态。
一个错误对象，如果当前状态处于失败状态，其中包含失败详细信息。


//Replace with your domain and modify the content, recipient details as required
var subject = "Welcome to Azure Communication Service Email APIs.";
var htmlContent = "<html><body><h1>Quick send email test</h1><br/><h4>This email message is sent from Azure Communication Service Email.</h4><p>This mail was sent using .NET SDK!!</p></body></html>";
var sender = "donotreply@xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.azurecomm.net";
var recipient = "emailalias@contoso.com";

/// Send the email message with WaitUntil.Started
EmailSendOperation emailSendOperation = await emailClient.SendAsync(
    Azure.WaitUntil.Started,
    sender,
    recipient,
    subject,
    htmlContent);

/// Call UpdateStatus on the email send operation to poll for the status
/// manually.
try
{
    while (true)
    {
        await emailSendOperation.UpdateStatusAsync();
        if (emailSendOperation.HasCompleted)
        {
            break;
        }
        await Task.Delay(100);
    }

    if (emailSendOperation.HasValue)
    {
        Console.WriteLine($"Email queued for delivery. Status = {emailSendOperation.Value.Status}");
    }
}
catch (RequestFailedException ex)
{
    Console.WriteLine($"Email send failed with Code = {ex.ErrorCode} and Message = {ex.Message}");
}

/// Get the OperationId so that it can be used for tracking the message for troubleshooting
string operationId = emailSendOperation.Id;
Console.WriteLine($"Email operation id = {operationId}");

从应用程序目录使用 dotnet run 命令运行应用程序。

dotnet run

代码示例

可以从 GitHub 下载示例应用

故障排除

电子邮件发送

要排查与电子邮件发送相关的问题，可以获取电子邮件发送状态来捕获发送详细信息。

重要

通过轮询发送操作的状态返回的成功结果只能确认电子邮件已成功发送以供传递这一事实。要获取有关收件人端送达状态的其他信息，需要参考如何处理电子邮件事件。

电子邮件限制

如果看到应用程序挂起，可能是由于电子邮件发送被限制。可以通过日志记录或实现自定义策略来处理此问题。

注意

此沙盒设置可帮助开发人员开始构建应用程序。应用程序准备好发布后，可以逐渐请求增加发送量。如果需要发送超出速率限制的消息量，请提交支持请求以提高所需的发送限制。

清理 Azure 通信服务资源

如果想要清理并删除通信服务订阅，可以删除资源或资源组。删除资源组同时也会删除与之相关联的任何其他资源。了解有关清理资源的详细信息。

后续步骤

在本快速入门中，你学习了如何在使用 Azure 通信服务发送电子邮件时手动轮询状态。

你可能还想要：

通过