@azure/communication-email 1.0.0-alpha.20230301.3 → 1.0.0-alpha.20230303.3

package/README.md

@@ -18,7 +18,7 @@ npm install @azure/communication-email
 
 ## Examples
 
-`EmailClient` provides the functionality to send email messages.
+`EmailClient` provides the functionality to send email messages .
 
 ## Authentication
 
@@ -42,7 +42,7 @@ AZURE_CLIENT_SECRET, AZURE_CLIENT_ID and AZURE_TENANT_ID environment variables a
 
 ```typescript
 import { DefaultAzureCredential } from "@azure/identity";
-import { EmailClient } from "@azure/communication-email";
+import { SmsClient } from "@azure/communication-email";
 
 const endpoint = "https://<resource-name>.communication.azure.com";
 let credential = new DefaultAzureCredential();
@@ -51,11 +51,11 @@ 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.
+To send an email message, call the `send` function from the `EmailClient`.
 
 ```javascript Snippet:Azure_Communication_Email_Send
-const message = {
-  senderAddress: "sender@contoso.com",
+const emailMessage = {
+  sender: "sender@contoso.com",
   content: {
     subject: "This is the subject",
     plainText: "This is the body",
@@ -63,15 +63,14 @@ const message = {
   recipients: {
     to: [
       {
-        address: "customer@domain.com",
+        email: "customer@domain.com",
         displayName: "Customer Name",
       },
     ],
   },
 };
 
-const poller = await emailClient.beginSend(message);
-const response = await poller.pollUntilDone();
+const response = await emailClient.send(emailMessage);
 ```
 
 ### Send an Email Message to Multiple Recipients
@@ -79,8 +78,8 @@ const response = await poller.pollUntilDone();
 To send an email message to multiple recipients, add a object for each recipient type and an object for each recipient.
 
 ```javascript Snippet:Azure_Communication_Email_Send_Multiple_Recipients
-const message = {
-  senderAddress: "sender@contoso.com",
+const emailMessage = {
+  sender: "sender@contoso.com",
   content: {
     subject: "This is the subject",
     plainText: "This is the body",
@@ -88,39 +87,38 @@ const message = {
   recipients: {
     to: [
       {
-        address: "customer1@domain.com",
+        email: "customer1@domain.com",
         displayName: "Customer Name 1",
       },
       {
-        address: "customer2@domain.com",
+        email: "customer2@domain.com",
         displayName: "Customer Name 2",
       },
     ],
     cc: [
       {
-        address: "ccCustomer1@domain.com",
+        email: "ccCustomer1@domain.com",
         displayName: " CC Customer 1",
       },
       {
-        address: "ccCustomer2@domain.com",
+        email: "ccCustomer2@domain.com",
         displayName: "CC Customer 2",
       },
     ],
     bcc: [
       {
-        address: "bccCustomer1@domain.com",
+        email: "bccCustomer1@domain.com",
         displayName: " BCC Customer 1",
       },
       {
-        address: "bccCustomer2@domain.com",
+        email: "bccCustomer2@domain.com",
         displayName: "BCC Customer 2",
       },
     ],
   },
 };
 
-const poller = await emailClient.beginSend(message);
-const response = await poller.pollUntilDone();
+const response = await emailClient.send(emailMessage);
 ```
 
 ### Send Email with Attachments
@@ -130,8 +128,8 @@ Azure Communication Services support sending email with attachments.
 ```javascript Snippet:Azure_Communication_Email_Send_With_Attachments
 const filePath = "C://readme.txt";
 
-const message = {
-  senderAddress: "sender@contoso.com",
+const emailMessage = {
+  sender: "sender@contoso.com",
   content: {
     subject: "This is the subject",
     plainText: "This is the body",
@@ -139,7 +137,7 @@ const message = {
   recipients: {
     to: [
       {
-        address: "customer@domain.com",
+        email: "customer@domain.com",
         displayName: "Customer Name",
       },
     ],
@@ -147,13 +145,23 @@ const message = {
   attachments: [
     {
       name: path.basename(filePath),
-      contentType: "text/plain",
-      contentInBase64: readFileSync(filePath, "base64"),
+      attachmentType: "txt",
+      contentBytesBase64: readFileSync(filePath, "base64"),
     },
   ],
 };
 
-const response = await emailClient.send(message);
+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.
+
+```javascript Snippet:Azure_Communication_Email_GetSendStatus
+const response = await emailClient.send(emailMessage);
+
+const status = await emailClient.getSendStatus(response.messageId);
 ```
 
 ## Next steps