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

package/types/communication-email.d.ts

@@ -1,11 +1,14 @@
 import { CommonClientOptions } from '@azure/core-client';
 import { KeyCredential } from '@azure/core-auth';
+import { OperationOptions } from '@azure/core-client';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
 import { TokenCredential } from '@azure/core-auth';
 
 /** An object representing the email address and its display name */
 export declare interface EmailAddress {
     /** Email address. */
-    email: string;
+    address: string;
     /** Email display name. */
     displayName?: string;
 }
@@ -14,48 +17,12 @@ export declare interface EmailAddress {
 export declare interface EmailAttachment {
     /** Name of the attachment */
     name: string;
-    /** The type of attachment file. */
-    attachmentType: EmailAttachmentType;
+    /** MIME type of the content being attached. */
+    contentType: string;
     /** Base64 encoded contents of the attachment */
-    contentBytesBase64: string;
+    contentInBase64: string;
 }
 
-/**
- * Defines values for EmailAttachmentType. \
- * {@link KnownEmailAttachmentType} can be used interchangeably with EmailAttachmentType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **avi** \
- * **bmp** \
- * **doc** \
- * **docm** \
- * **docx** \
- * **gif** \
- * **jpeg** \
- * **mp3** \
- * **one** \
- * **pdf** \
- * **png** \
- * **ppsm** \
- * **ppsx** \
- * **ppt** \
- * **pptm** \
- * **pptx** \
- * **pub** \
- * **rpmsg** \
- * **rtf** \
- * **tif** \
- * **txt** \
- * **vsd** \
- * **wav** \
- * **wma** \
- * **xls** \
- * **xlsb** \
- * **xlsm** \
- * **xlsx**
- */
-export declare type EmailAttachmentType = string;
-
 /**
  *  The Email service client.
  */
@@ -74,79 +41,42 @@ export declare class EmailClient {
      * @param credential - An object that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.
      * @param options - Optional. Options to configure the HTTP pipeline.
      */
-    constructor(endpoint: string, credential: KeyCredential, options?: EmailClientOptions);
-    /**
-     * Initializes a new instance of the EmailClient class using a TokenCredential.
-     * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
-     * @param credential - TokenCredential that is used to authenticate requests to the service. Use the Azure KeyCredential or `@azure/identity` to create a credential.
-     * @param options - Optional. Options to configure the HTTP pipeline.
-     */
-    constructor(endpoint: string, credential: TokenCredential, options?: EmailClientOptions);
+    constructor(endpoint: string, credential: KeyCredential | TokenCredential, options?: EmailClientOptions);
     /**
      * Queues an email message to be sent to one or more recipients
-     * @param emailMessage - Message payload for sending an email
+     * @param message - Message payload for sending an email
+     * @param options - The options parameters.
      */
-    send(emailMessage: EmailMessage): Promise<SendEmailResult>;
-    /**
-     * Gets the status of a message sent previously.
-     * @param messageId - System generated message id (GUID) returned from a previous call to send email
-     */
-    getSendStatus(messageId: string): Promise<SendStatusResult>;
+    beginSend(message: EmailMessage, options?: EmailSendOptionalParams): Promise<PollerLike<PollOperationState<EmailSendResponse>, EmailSendResponse>>;
 }
 
 /**
- * Client options used to configure SMS Client API requests.
+ * Client options used to configure Email Client API requests.
  */
 export declare interface EmailClientOptions extends CommonClientOptions {
 }
 
 /** Content of the email. */
-export declare interface EmailContent {
-    /** Subject of the email message */
-    subject: string;
-    /** Plain text version of the email message. */
-    plainText?: string;
-    /** Html version of the email message. */
-    html?: string;
-}
-
-/** Custom header for email. */
-export declare interface EmailCustomHeader {
-    /** Header name. */
-    name: string;
-    /** Header value. */
-    value: string;
-}
-
-/**
- * Defines values for EmailImportance. \
- * {@link KnownEmailImportance} can be used interchangeably with EmailImportance,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **high** \
- * **normal** \
- * **low**
- */
-export declare type EmailImportance = string;
+export declare type EmailContent = HtmlEmailContent | PlainTextEmailContent;
 
 /** Message payload for sending an email */
 export declare interface EmailMessage {
     /** Custom email headers to be passed. */
-    customHeaders?: EmailCustomHeader[];
+    headers?: {
+        [propertyName: string]: string;
+    };
     /** Sender email address from a verified domain. */
-    sender: string;
+    senderAddress: string;
     /** Email content to be sent. */
     content: EmailContent;
-    /** The importance type for the email. */
-    importance?: EmailImportance;
     /** Recipients for the email. */
     recipients: EmailRecipients;
-    /** list of attachments */
+    /** List of attachments. Please note that we limit the total size of an email request (which includes attachments) to 10MB. */
     attachments?: EmailAttachment[];
     /** Email addresses where recipients' replies will be sent to. */
     replyTo?: EmailAddress[];
     /** Indicates whether user engagement tracking should be disabled for this request if the resource-level user engagement tracking setting was already enabled in the control plane. */
-    disableUserEngagementTracking?: boolean;
+    userEngagementTrackingDisabled?: boolean;
 }
 
 /** Recipients of the email */
@@ -159,33 +89,125 @@ export declare interface EmailRecipients {
     bcc?: EmailAddress[];
 }
 
-/**
- * Results of a sent email.
- */
-export declare interface SendEmailResult {
-    /**
-     * MessageId of the sent email.
-     */
-    messageId: string;
+/** Defines headers for Email_send operation. */
+export declare interface EmailSendHeaders {
+    /** Location url of where to poll the status of this operation from. */
+    operationLocation?: string;
+    /** This header will only be present when the operation status is a non-terminal status. It indicates the minimum amount of time in seconds to wait before polling for operation status again. */
+    retryAfter?: number;
+}
+
+/** Optional parameters for the beginSend method. */
+export declare interface EmailSendOptionalParams extends OperationOptions {
+    /** This is the ID used by the status monitor for this long running operation. */
+    operationId?: string;
+    /** Delay to wait until next poll, in milliseconds. */
+    updateIntervalInMs?: number;
+    /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
+    resumeFrom?: string;
+}
+
+/** Contains response data for the send operation. */
+export declare type EmailSendResponse = EmailSendHeaders & EmailSendResult;
+
+/** Status of the long running operation */
+export declare interface EmailSendResult {
+    /** The unique id of the operation. Use a UUID. */
+    id: string;
+    /** Status of operation. */
+    status: EmailSendStatus;
+    /** Error details when status is a non-success terminal state. */
+    error?: ErrorDetail;
 }
 
 /**
- * Defines values for SendStatus. \
- * {@link KnownSendStatus} can be used interchangeably with SendStatus,
+ * Defines values for EmailSendStatus. \
+ * {@link KnownEmailSendStatus} can be used interchangeably with EmailSendStatus,
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
- * **queued**: The message has passed basic validations and has been queued to be processed further. \
- * **outForDelivery**: The message has been processed and is now out for delivery. \
- * **dropped**: The message could not be processed and was dropped.
+ * **NotStarted** \
+ * **Running** \
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled**
  */
-export declare type SendStatus = string;
-
-/** Status of an email message that was sent previously. */
-export declare interface SendStatusResult {
-    /** System generated id of an email message sent. */
-    messageId: string;
-    /** The type indicating the status of a request. */
-    status: SendStatus;
+export declare type EmailSendStatus = string;
+
+/** The resource management error additional info. */
+export declare interface ErrorAdditionalInfo {
+    /**
+     * The additional info type.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly type?: string;
+    /**
+     * The additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly info?: Record<string, unknown>;
+}
+
+/** The error detail. */
+export declare interface ErrorDetail {
+    /**
+     * The error code.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly code?: string;
+    /**
+     * The error message.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly message?: string;
+    /**
+     * The error target.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * The error details.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: ErrorDetail[];
+    /**
+     * The error additional info.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+}
+
+/** Content of the email with a required html property. */
+export declare interface HtmlEmailContent {
+    /** Subject of the email message */
+    subject: string;
+    /** Plain text version of the email message. */
+    plainText?: string;
+    /** Html version of the email message. */
+    html: string;
+}
+
+/** Known values of {@link EmailSendStatus} that the service accepts. */
+export declare enum KnownEmailSendStatus {
+    /** NotStarted */
+    NotStarted = "NotStarted",
+    /** Running */
+    Running = "Running",
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Canceled */
+    Canceled = "Canceled"
+}
+
+/** Content of the email with a required plainText property. */
+export declare interface PlainTextEmailContent {
+    /** Subject of the email message */
+    subject: string;
+    /** Plain text version of the email message. */
+    plainText: string;
+    /** Html version of the email message. */
+    html?: string;
 }
 
 export { }

package/dist-esm/samples-dev/checkMessageStatus.js

@@ -1,41 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-/**
- * @summary Checks the message status of a sent email
- */
-import { EmailClient } from "@azure/communication-email";
-// Load the .env file (you will need to set these environment variables)
-import * as dotenv from "dotenv";
-dotenv.config();
-const connectionString = process.env["COMMUNICATION_CONNECTION_STRING"] || "";
-const senderAddress = process.env["SENDER_ADDRESS"] || "";
-const recipientAddress = process.env["RECIPIENT_ADDRESS"] || "";
-const getMessageStatusFromEmail = async () => {
-    // Create the Email Client
-    const emailClient = new EmailClient(connectionString);
-    // Create the Email Message to be sent
-    const emailMessage = {
-        sender: senderAddress,
-        content: {
-            subject: "This is the subject",
-            plainText: "This is the body",
-            html: "<html><h1>This is the body</h1></html>",
-        },
-        recipients: {
-            to: [{ email: recipientAddress, displayName: "Customer Name" }],
-        },
-    };
-    try {
-        // Send the email message
-        const sendEmailResponse = await emailClient.send(emailMessage);
-        // Use the message id to get the status of the email
-        const messageId = sendEmailResponse.messageId || "";
-        const getMessageStatusResponse = await emailClient.getSendStatus(messageId);
-        console.log("Message Status: " + getMessageStatusResponse);
-    }
-    catch (error) {
-        console.log(error);
-    }
-};
-void getMessageStatusFromEmail();
-//# sourceMappingURL=checkMessageStatus.js.map

package/dist-esm/samples-dev/checkMessageStatus.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkMessageStatus.js","sourceRoot":"","sources":["../../samples-dev/checkMessageStatus.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAgB,MAAM,4BAA4B,CAAC;AAEvE,wEAAwE;AACxE,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,IAAI,EAAE,CAAC;AAC9E,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC;AAC1D,MAAM,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;AAEhE,MAAM,yBAAyB,GAAG,KAAK,IAAmB,EAAE;IAC1D,0BAA0B;IAC1B,MAAM,WAAW,GAAgB,IAAI,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAEnE,sCAAsC;IACtC,MAAM,YAAY,GAAiB;QACjC,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE;YACP,OAAO,EAAE,qBAAqB;YAC9B,SAAS,EAAE,kBAAkB;YAC7B,IAAI,EAAE,wCAAwC;SAC/C;QACD,UAAU,EAAE;YACV,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;SAChE;KACF,CAAC;IAEF,IAAI;QACF,yBAAyB;QACzB,MAAM,iBAAiB,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAE/D,oDAAoD;QACpD,MAAM,SAAS,GAAG,iBAAiB,CAAC,SAAS,IAAI,EAAE,CAAC;QACpD,MAAM,wBAAwB,GAAG,MAAM,WAAW,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAE5E,OAAO,CAAC,GAAG,CAAC,kBAAkB,GAAG,wBAAwB,CAAC,CAAC;KAC5D;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;KACpB;AACH,CAAC,CAAC;AAEF,KAAK,yBAAyB,EAAE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * @summary Checks the message status of a sent email\n */\n\nimport { EmailClient, EmailMessage } from \"@azure/communication-email\";\n\n// Load the .env file (you will need to set these environment variables)\nimport * as dotenv from \"dotenv\";\ndotenv.config();\n\nconst connectionString = process.env[\"COMMUNICATION_CONNECTION_STRING\"] || \"\";\nconst senderAddress = process.env[\"SENDER_ADDRESS\"] || \"\";\nconst recipientAddress = process.env[\"RECIPIENT_ADDRESS\"] || \"\";\n\nconst getMessageStatusFromEmail = async (): Promise<void> => {\n  // Create the Email Client\n  const emailClient: EmailClient = new EmailClient(connectionString);\n\n  // Create the Email Message to be sent\n  const emailMessage: EmailMessage = {\n    sender: senderAddress,\n    content: {\n      subject: \"This is the subject\",\n      plainText: \"This is the body\",\n      html: \"<html><h1>This is the body</h1></html>\",\n    },\n    recipients: {\n      to: [{ email: recipientAddress, displayName: \"Customer Name\" }],\n    },\n  };\n\n  try {\n    // Send the email message\n    const sendEmailResponse = await emailClient.send(emailMessage);\n\n    // Use the message id to get the status of the email\n    const messageId = sendEmailResponse.messageId || \"\";\n    const getMessageStatusResponse = await emailClient.getSendStatus(messageId);\n\n    console.log(\"Message Status: \" + getMessageStatusResponse);\n  } catch (error) {\n    console.log(error);\n  }\n};\n\nvoid getMessageStatusFromEmail();\n"]}