共用方式為

適用於 JavaScript 的 Azure 通訊電子郵件用戶端程式庫 - 1.1.0 版

此套件包含適用於電子郵件的 Azure 通訊服務的 JavaScript/TypeScript SDK。

入門指南

先決條件

您需要 Azure 訂用帳戶、通訊服務資源，以及具有作用中網域的電子郵件通訊資源。

若要建立這些資源，您可以使用 Azure 入口網站、 Azure PowerShell 或 .NET 管理用戶端程式庫。

安裝

npm install @azure/communication-email

範例

EmailClient 提供傳送電子郵件訊息的功能。

Authentication

電子郵件用戶端可以使用從 Azure 入口網站中的 Azure 通訊資源取得的連接字串進行驗證。

import { EmailClient } from "@azure/communication-email";

const connectionString = `endpoint=https://<resource-name>.communication.azure.com/;accessKey=<Base64-Encoded-Key>`;
const client = new EmailClient(connectionString);

您也可以使用 Azure 身分識別程式庫向 Azure Active Directory 進行驗證。 若要使用如下所示 的 DefaultAzureCredential 提供者，或 Azure SDK 所提供的其他認證提供者，請安裝 @azure/identity 套件：

npm install @azure/identity

@azure/identity 套件提供應用程式可用來執行這項作業的各種認證類型。 @azure/identity 的讀我檔案提供更多詳細資料和範例，讓您開始使用。 AZURE_CLIENT_SECRET，需要AZURE_CLIENT_ID和AZURE_TENANT_ID環境變數才能建立 DefaultAzureCredential 物件。

import { DefaultAzureCredential } from "@azure/identity";
import { EmailClient } from "@azure/communication-email";

const endpoint = "https://<resource-name>.communication.azure.com";
const credential = new DefaultAzureCredential();
const client = new EmailClient(endpoint, credential);

傳送電子郵件訊息

若要傳送電子郵件訊息，請從 beginSend 呼叫 EmailClient 函式。 這會傳回輪詢器。 您可以使用此輪詢器來檢查作業的狀態，並在作業完成後擷取結果。

import { DefaultAzureCredential } from "@azure/identity";
import { EmailClient } from "@azure/communication-email";

const endpoint = "https://<resource-name>.communication.azure.com";
const credential = new DefaultAzureCredential();
const client = new EmailClient(endpoint, credential);

const message = {
  senderAddress: "sender@contoso.com",
  content: {
    subject: "This is the subject",
    plainText: "This is the body",
  },
  recipients: {
    to: [
      {
        address: "customer@domain.com",
        displayName: "Customer Name",
      },
    ],
  },
};

const poller = await client.beginSend(message);
const response = await poller.pollUntilDone();

傳送電子郵件給多個收件者

若要將電子郵件傳送給多個收件者，請為每個收件者類型新增一個物件，並為每個收件者新增一個物件。

import { DefaultAzureCredential } from "@azure/identity";
import { EmailClient } from "@azure/communication-email";

const endpoint = "https://<resource-name>.communication.azure.com";
const credential = new DefaultAzureCredential();
const client = new EmailClient(endpoint, credential);

const message = {
  senderAddress: "sender@contoso.com",
  content: {
    subject: "This is the subject",
    plainText: "This is the body",
  },
  recipients: {
    to: [
      {
        address: "customer1@domain.com",
        displayName: "Customer Name 1",
      },
      {
        address: "customer2@domain.com",
        displayName: "Customer Name 2",
      },
    ],
    cc: [
      {
        address: "ccCustomer1@domain.com",
        displayName: " CC Customer 1",
      },
      {
        address: "ccCustomer2@domain.com",
        displayName: "CC Customer 2",
      },
    ],
    bcc: [
      {
        address: "bccCustomer1@domain.com",
        displayName: " BCC Customer 1",
      },
      {
        address: "bccCustomer2@domain.com",
        displayName: "BCC Customer 2",
      },
    ],
  },
};

const poller = await client.beginSend(message);
const response = await poller.pollUntilDone();

發送帶有附件的電子郵件

Azure 通訊服務支援傳送包含附件的電子郵件。

import { DefaultAzureCredential } from "@azure/identity";
import { EmailClient } from "@azure/communication-email";
import { basename } from "node:path";
import { readFileSync } from "node:fs";

const endpoint = "https://<resource-name>.communication.azure.com";
const credential = new DefaultAzureCredential();
const client = new EmailClient(endpoint, credential);

const filePath = "path/to/readme.txt";

const message = {
  senderAddress: "sender@contoso.com",
  content: {
    subject: "This is the subject",
    plainText: "This is the body",
  },
  recipients: {
    to: [
      {
        address: "customer@domain.com",
        displayName: "Customer Name",
      },
    ],
  },
  attachments: [
    {
      name: basename(filePath),
      contentType: "text/plain",
      contentInBase64: readFileSync(filePath, "base64"),
    },
  ],
};

const poller = await client.beginSend(message);
const response = await poller.pollUntilDone();

傳送包含內嵌附件的電子郵件

Azure 通訊服務支援傳送包含內嵌附件的電子郵件。 將可選 contentId 參數新增至 ， attachment 會使其成為內嵌附件。

import { DefaultAzureCredential } from "@azure/identity";
import { EmailClient } from "@azure/communication-email";
import { readFileSync } from "node:fs";

const endpoint = "https://<resource-name>.communication.azure.com";
const credential = new DefaultAzureCredential();
const client = new EmailClient(endpoint, credential);

const imageBuffer = readFileSync("path/to/my_inline_image.jpg");
const contentInBase64 = imageBuffer.toString("base64");

const message = {
  senderAddress: "sender@contoso.com",
  content: {
    subject: "This is the subject",
    plainText: "This is the body",
    html: '<html>This is the body<br /><img src="cid:inline_image" /></html>',
  },
  recipients: {
    to: [
      {
        address: "customer@domain.com",
        displayName: "Customer Name",
      },
    ],
  },
  attachments: [
    {
      name: "my_inline_image.jpg",
      contentType: "image/jpeg",
      contentInBase64: contentInBase64,
      contentId: "inline_image",
    },
  ],
};

const poller = await client.beginSend(message);
const response = await poller.pollUntilDone();

故障排除

森林伐木業

啟用記錄可能有助於找出有關失敗的實用資訊。 若要查看 HTTP 要求和回應的記錄，請將 AZURE_LOG_LEVEL 環境變數設定為 info。 或者，您可以在運行時間啟用記錄，方法是在 setLogLevel中呼叫 @azure/logger：

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

後續步驟

Contributing

此項目歡迎參與和建議。 大部分的捐款都要求您同意「參與者許可協定」（CLA），宣告您有權，而且實際上確實會授與我們使用您貢獻的許可權。 詳情請瀏覽 cla.microsoft.com。

此專案採用了 Microsoft 開放原始碼管理辦法。 如需詳細資訊，請參閱 《行為規範》常見問題 或連絡 opencode@microsoft.com，以取得任何其他問題或意見。

  • Last updated on