@azure/communication-email 1.0.0-beta.1 → 1.0.0

package/README.md

@@ -16,34 +16,46 @@ To create these resource, you can use the [Azure Portal][communication_resource_
 npm install @azure/communication-email
 ```
 
-### Browser support
-
-## Key concepts
-
-`EmailClient` provides the functionality to send email messages .
-
 ## 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].
 
-```typescript
-import { EmailClient } from "@azure/communication-email";
+```javascript
+const { EmailClient } = require("@azure/communication-email");
 
 const connectionString = `endpoint=https://<resource-name>.communication.azure.com/;accessKey=<Base64-Encoded-Key>`;
 const client = new EmailClient(connectionString);
 ```
 
-## Examples
+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.
+
+```typescript
+import { DefaultAzureCredential } from "@azure/identity";
+import { EmailClient } from "@azure/communication-email";
+
+const endpoint = "https://<resource-name>.communication.azure.com";
+let credential = new DefaultAzureCredential();
+const client = new EmailClient(endpoint, credential);
+```
 
 ### Send an Email Message
 
-To send an email message, call the `send` function from the `EmailClient`.
+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.
 
-```typescript Snippet:Azure_Communication_Email_Send
-const emailMessage: EmailMessage = {
-  sender: "sender@contoso.com",
+```javascript Snippet:Azure_Communication_Email_Send
+const message = {
+  senderAddress: "sender@contoso.com",
   content: {
     subject: "This is the subject",
     plainText: "This is the body",
@@ -51,23 +63,24 @@ const emailMessage: EmailMessage = {
   recipients: {
     to: [
       {
-        email: "customer@domain.com",
+        address: "customer@domain.com",
         displayName: "Customer Name",
       },
     ],
   },
 };
 
-const response = await emailClient.send(emailMessage);
+const poller = await emailClient.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.
 
-```typescript Snippet:Azure_Communication_Email_Send_Multiple_Recipients
-const emailMessage: EmailMessage = {
-  sender: "sender@contoso.com",
+```javascript Snippet:Azure_Communication_Email_Send_Multiple_Recipients
+const message = {
+  senderAddress: "sender@contoso.com",
   content: {
     subject: "This is the subject",
     plainText: "This is the body",
@@ -75,57 +88,58 @@ const emailMessage: EmailMessage = {
   recipients: {
     to: [
       {
-        email: "customer1@domain.com",
+        address: "customer1@domain.com",
         displayName: "Customer Name 1",
       },
       {
-        email: "customer2@domain.com",
+        address: "customer2@domain.com",
         displayName: "Customer Name 2",
       },
     ],
-    cC: [
+    cc: [
       {
-        email: "ccCustomer1@domain.com",
+        address: "ccCustomer1@domain.com",
         displayName: " CC Customer 1",
       },
       {
-        email: "ccCustomer2@domain.com",
+        address: "ccCustomer2@domain.com",
         displayName: "CC Customer 2",
       },
     ],
-    bCC: [
+    bcc: [
       {
-        email: "bccCustomer1@domain.com",
+        address: "bccCustomer1@domain.com",
         displayName: " BCC Customer 1",
       },
       {
-        email: "bccCustomer2@domain.com",
+        address: "bccCustomer2@domain.com",
         displayName: "BCC Customer 2",
       },
     ],
   },
 };
 
-const response = await emailClient.send(emailMessage);
+const poller = await emailClient.beginSend(message);
+const response = await poller.pollUntilDone();
 ```
 
 ### Send Email with Attachments
 
 Azure Communication Services support sending email with attachments.
 
-```typescript Snippet:Azure_Communication_Email_Send_With_Attachments
+```javascript Snippet:Azure_Communication_Email_Send_With_Attachments
 const filePath = "C://readme.txt";
 
-const emailMessage: EmailMessage = {
-  sender: "sender@contoso.com",
+const message = {
+  senderAddress: "sender@contoso.com",
   content: {
     subject: "This is the subject",
     plainText: "This is the body",
   },
   recipients: {
-    toRecipients: [
+    to: [
       {
-        email: "customer@domain.com",
+        address: "customer@domain.com",
         displayName: "Customer Name",
       },
     ],
@@ -133,23 +147,14 @@ const emailMessage: EmailMessage = {
   attachments: [
     {
       name: path.basename(filePath),
-      attachmentType: "txt",
-      contentBytesBase64: readFileSync(filePath, "base64"),
+      contentType: "text/plain",
+      contentInBase64: readFileSync(filePath, "base64"),
     },
   ],
 };
 
-const response = await emailClient.send(emailMessage);
-```
-
-### Get Email Message Status
-
-The result from the `send` call contains a `messageId` which can be used to query the status of the email.
-
-```typescript Snippet:Azure_Communication_Email_GetSendStatus
-const messageId = await emailClient.send(emailMessage);
-
-const status = await emailClient.getSendStatus(messageId);
+const poller = await emailClient.beginSend(message);
+const response = await poller.pollUntilDone();
 ```
 
 ## Next steps
@@ -170,6 +175,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
 [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://docs.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://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp