# @azure/communication-email > The is the JS Client SDK for email. This SDK enables users to send emails and get the status of sent email message. Latest version **1.1.0** (published 2025-10-08) · MIT license · 0 weekly downloads ## Install ```sh npm install @azure/communication-email pnpm add @azure/communication-email yarn add @azure/communication-email bun add @azure/communication-email ``` ## Health **Score 65/100 (B)** — status: stable. Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2025-10-08 | | First published | 2022-05-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=20.0.0 | | Dependencies | 9 | | Unpacked size | 440.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 2298 | | Author | Microsoft Corporation | | Maintainers | azure-sdk, microsoft1es | | Keywords | azure, cloud, communication, email | ## Links - npm: https://www.npmjs.com/package/@azure/communication-email - Repository: https://github.com/Azure/azure-sdk-for-js - Homepage: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-email/ - Issues: https://github.com/Azure/azure-sdk-for-js/issues - npm.io page: https://npm.io/package/@azure/communication-email ## Dependencies (9) - [tslib](https://npm.io/package/tslib.md) ^2.8.1 - [@azure/logger](https://npm.io/package/@azure/logger.md) ^1.1.4 - [@azure/core-lro](https://npm.io/package/@azure/core-lro.md) ^2.7.2 - [@azure/core-auth](https://npm.io/package/@azure/core-auth.md) ^1.9.0 - [@azure/core-util](https://npm.io/package/@azure/core-util.md) ^1.11.0 - [@azure/core-client](https://npm.io/package/@azure/core-client.md) ^1.9.2 - [@azure/abort-controller](https://npm.io/package/@azure/abort-controller.md) ^2.1.2 - [@azure/core-rest-pipeline](https://npm.io/package/@azure/core-rest-pipeline.md) ^1.18.0 - [@azure/communication-common](https://npm.io/package/@azure/communication-common.md) ^2.3.1 ## Alternatives - [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads - [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads - [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads - [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads - [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads ## Recent versions - 1.1.0 (latest) — 2025-10-08 - 1.1.0-alpha.20260211.1 (dev) — 2026-02-11 - 1.0.1-beta.1 (next) — 2024-09-25 - 1.1.0-alpha.20260210.1 — 2026-02-10 - 1.1.0-alpha.20260209.1 — 2026-02-09 - 1.1.0-alpha.20260206.1 — 2026-02-06 - 1.1.0-alpha.20260205.1 — 2026-02-05 - 1.1.0-alpha.20260204.1 — 2026-02-04 - 1.1.0-alpha.20260203.1 — 2026-02-03 - 1.1.0-alpha.20260130.1 — 2026-01-30 - 1.1.0-alpha.20260129.1 — 2026-01-29 - 1.1.0-alpha.20260128.1 — 2026-01-28 - 1.1.0-alpha.20260127.1 — 2026-01-27 - 1.1.0-alpha.20260126.1 — 2026-01-26 - 1.1.0-alpha.20260123.1 — 2026-01-23 - … 326 more at https://npm.io/package/@azure/communication-email/versions ## README # Azure Communication Email client library for JavaScript This package contains a JavaScript/TypeScript SDK for Azure Communication Services for Email. ## Getting started ### Prerequisites You need an [Azure subscription][azure_sub], a [Communication Service Resource][communication_resource_docs], and an [Email Communication Resource][email_resource_docs] with an active [Domain][domain_overview]. To create these resource, you can use the [Azure Portal][communication_resource_create_portal], the [Azure PowerShell][communication_resource_create_power_shell], or the [.NET management client library][communication_resource_create_net]. ### Installing ```bash npm install @azure/communication-email ``` ## Examples `EmailClient` provides the functionality to send email messages. ## Authentication Email clients can be authenticated using the connection string acquired from an Azure Communication Resource in the [Azure Portal][azure_portal]. ```ts snippet:ReadmeSampleCreateClient_ConnectionString import { EmailClient } from "@azure/communication-email"; const connectionString = `endpoint=https://.communication.azure.com/;accessKey=`; const client = new EmailClient(connectionString); ``` You can also authenticate with Azure Active Directory using the [Azure Identity library][azure_identity]. To use the [DefaultAzureCredential][defaultazurecredential] provider shown below, or other credential providers provided with the Azure SDK, please install the [`@azure/identity`][azure_identity] package: ```bash npm install @azure/identity ``` The [`@azure/identity`][azure_identity] package provides a variety of credential types that your application can use to do this. The README for @azure/identity provides more details and samples to get you started. AZURE_CLIENT_SECRET, AZURE_CLIENT_ID and AZURE_TENANT_ID environment variables are needed to create a DefaultAzureCredential object. ```ts snippet:ReadmeSampleCreateClient_AAD import { DefaultAzureCredential } from "@azure/identity"; import { EmailClient } from "@azure/communication-email"; const endpoint = "https://.communication.azure.com"; const credential = new DefaultAzureCredential(); const client = new EmailClient(endpoint, credential); ``` ### Send an Email Message To send an email message, call the `beginSend` function from the `EmailClient`. This will return a poller. You can use this poller to check on the status of the operation and retrieve the result once it's finished. ```ts snippet:ReadmeSample_SendEmail import { DefaultAzureCredential } from "@azure/identity"; import { EmailClient } from "@azure/communication-email"; const endpoint = "https://.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(); ``` ### Send an Email Message to Multiple Recipients To send an email message to multiple recipients, add a object for each recipient type and an object for each recipient. ```ts snippet:ReadmeSample_SendEmailToMultipleRecipients import { DefaultAzureCredential } from "@azure/identity"; import { EmailClient } from "@azure/communication-email"; const endpoint = "https://.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(); ``` ### Send Email with Attachments Azure Communication Services support sending email with attachments. ```ts snippet:ReadmeSample_SendEmailWithAttachments import { DefaultAzureCredential } from "@azure/identity"; import { EmailClient } from "@azure/communication-email"; import { basename } from "node:path"; import { readFileSync } from "node:fs"; const endpoint = "https://.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(); ``` ### Send Email with Inline Attachments Azure Communication Services support sending email with inline attachments. Adding an optional `contentId` parameter to an `attachment` will make it an inline attachment. ```ts snippet:ReadmeSample_SendEmailWithInlineAttachments import { DefaultAzureCredential } from "@azure/identity"; import { EmailClient } from "@azure/communication-email"; import { readFileSync } from "node:fs"; const endpoint = "https://.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: 'This is the body
', }, 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(); ``` ## Troubleshooting ### Logging Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`: ```ts snippet:SetLogLevel import { setLogLevel } from "@azure/logger"; setLogLevel("info"); ``` ## Next steps - [Read more about Email in Azure Communication Services][nextsteps] ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla]. This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. [azure_sub]: https://azure.microsoft.com/free/dotnet/ [azure_portal]: https://portal.azure.com [cla]: https://cla.microsoft.com [coc]: https://opensource.microsoft.com/codeofconduct/ [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ [coc_contact]: mailto:opencode@microsoft.com [defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential [azure_identity]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity [communication_resource_docs]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp [email_resource_docs]: https://aka.ms/acsemail/createemailresource [communication_resource_create_portal]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp [communication_resource_create_power_shell]: https://learn.microsoft.com/powershell/module/az.communication/new-azcommunicationservice [communication_resource_create_net]: https://learn.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-net [package]: https://www.nuget.org/packages/Azure.Communication.Common/ [product_docs]: https://aka.ms/acsemail/overview [nextsteps]: https://aka.ms/acsemail/overview [nuget]: https://www.nuget.org/ [source]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/communication [domain_overview]: https://aka.ms/acsemail/domainsoverview --- _Source: https://npm.io/package/@azure/communication-email · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._