npm - @azure/communication-email - Versions diffs - 1.0.0-beta.1 - Mend

@azure/communication-email 1.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/LICENSE.txt +21 -0
package/README.md +183 -0
package/dist/index.js +668 -0
package/dist/index.js.map +1 -0
package/dist-esm/samples-dev/checkMessageStatus.js +46 -0
package/dist-esm/samples-dev/checkMessageStatus.js.map +1 -0
package/dist-esm/samples-dev/sendEmailMultipleRecipients.js +59 -0
package/dist-esm/samples-dev/sendEmailMultipleRecipients.js.map +1 -0
package/dist-esm/samples-dev/sendEmailSingleRecipient.js +43 -0
package/dist-esm/samples-dev/sendEmailSingleRecipient.js.map +1 -0
package/dist-esm/samples-dev/sendEmailWithAttachments.js +50 -0
package/dist-esm/samples-dev/sendEmailWithAttachments.js.map +1 -0
package/dist-esm/src/constants.js +4 -0
package/dist-esm/src/constants.js.map +1 -0
package/dist-esm/src/emailClient.js +64 -0
package/dist-esm/src/emailClient.js.map +1 -0
package/dist-esm/src/generated/src/emailRestApiClient.js +26 -0
package/dist-esm/src/generated/src/emailRestApiClient.js.map +1 -0
package/dist-esm/src/generated/src/emailRestApiClientContext.js +38 -0
package/dist-esm/src/generated/src/emailRestApiClientContext.js.map +1 -0
package/dist-esm/src/generated/src/models/index.js +9 -0
package/dist-esm/src/generated/src/models/index.js.map +1 -0
package/dist-esm/src/generated/src/models/mappers.js +331 -0
package/dist-esm/src/generated/src/models/mappers.js.map +1 -0
package/dist-esm/src/generated/src/models/parameters.js +76 -0
package/dist-esm/src/generated/src/models/parameters.js.map +1 -0
package/dist-esm/src/generated/src/operations/email.js +96 -0
package/dist-esm/src/generated/src/operations/email.js.map +1 -0
package/dist-esm/src/generated/src/operations/index.js +9 -0
package/dist-esm/src/generated/src/operations/index.js.map +1 -0
package/dist-esm/src/index.js +5 -0
package/dist-esm/src/index.js.map +1 -0
package/dist-esm/src/logger.js +8 -0
package/dist-esm/src/logger.js.map +1 -0
package/dist-esm/src/models.js +4 -0
package/dist-esm/src/models.js.map +1 -0
package/dist-esm/test/public/emailClient.spec.js +137 -0
package/dist-esm/test/public/emailClient.spec.js.map +1 -0
package/dist-esm/test/public/utils/recordedClient.js +46 -0
package/dist-esm/test/public/utils/recordedClient.js.map +1 -0
package/package.json +110 -0
package/types/communication-email.d.ts +200 -0

package/dist-esm/test/public/emailClient.spec.js ADDED Viewed

@@ -0,0 +1,137 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import { env } from "@azure-tools/test-recorder";
+import { createRecordedEmailClientWithConnectionString, createRecordedEmailClientWithKeyCredential, } from "./utils/recordedClient";
+import { assert } from "chai";
+import { matrix } from "@azure/test-utils";
+matrix([[true, false]], async function (useKeyCredential) {
+    describe(`EmailClient [Playback/Live]${useKeyCredential ? " [KeyCredential]" : " [ConnectionString]"}`, () => {
+        let recorder;
+        let client;
+        beforeEach(function () {
+            if (useKeyCredential) {
+                ({ client, recorder } = createRecordedEmailClientWithKeyCredential(this));
+            }
+            else {
+                ({ client, recorder } = createRecordedEmailClientWithConnectionString(this));
+            }
+        });
+        afterEach(async function () {
+            var _a;
+            if (!((_a = this.currentTest) === null || _a === void 0 ? void 0 : _a.isPending())) {
+                await recorder.stop();
+            }
+        });
+        it("successfully sends an email to a single recipient", async function () {
+            const emailMessage = {
+                sender: env.SENDER_ADDRESS,
+                recipients: {
+                    to: [
+                        {
+                            email: env.RECIPIENT_ADDRESS,
+                            displayName: "someRecipient",
+                        },
+                    ],
+                },
+                content: {
+                    subject: "someSubject",
+                    plainText: "somePlainTextBody",
+                    html: "<html><h1>someHtmlBody</html>",
+                },
+            };
+            const response = await client.send(emailMessage);
+            assert.isNotNull(response.messageId);
+        }).timeout(5000);
+        it("successfully sends an email to multiple types of recipients", async function () {
+            const emailMessage = {
+                sender: env.SENDER_ADDRESS,
+                recipients: {
+                    to: [
+                        {
+                            email: env.RECIPIENT_ADDRESS,
+                            displayName: "someRecipient",
+                        },
+                        {
+                            email: env.RECIPIENT_ADDRESS,
+                            displayName: "someRecipient",
+                        },
+                    ],
+                    cC: [
+                        {
+                            email: env.RECIPIENT_ADDRESS,
+                            displayName: "someRecipient",
+                        },
+                    ],
+                    bCC: [
+                        {
+                            email: env.RECIPIENT_ADDRESS,
+                            displayName: "someRecipient",
+                        },
+                    ],
+                },
+                content: {
+                    subject: "someSubject",
+                    plainText: "somePlainTextBody",
+                    html: "<html><h1>someHtmlBody</html>",
+                },
+            };
+            const response = await client.send(emailMessage);
+            assert.isNotNull(response.messageId);
+        }).timeout(5000);
+        it("successfully sends an email with an attachment", async function () {
+            const emailMessage = {
+                sender: env.SENDER_ADDRESS,
+                recipients: {
+                    to: [
+                        {
+                            email: env.RECIPIENT_ADDRESS,
+                            displayName: "someRecipient",
+                        },
+                    ],
+                },
+                content: {
+                    subject: "someSubject",
+                    plainText: "somePlainTextBody",
+                    html: "<html><h1>someHtmlBody</html>",
+                },
+                attachments: [
+                    {
+                        name: "readme.txt",
+                        attachmentType: "txt",
+                        contentBytesBase64: "ZW1haWwgdGVzdCBhdHRhY2htZW50",
+                    },
+                ],
+            };
+            const response = await client.send(emailMessage);
+            assert.isNotNull(response.messageId);
+        }).timeout(5000);
+        it("successfully retrieves the email status with the returned message id", async function () {
+            const emailMessage = {
+                sender: env.SENDER_ADDRESS,
+                recipients: {
+                    to: [
+                        {
+                            email: env.RECIPIENT_ADDRESS,
+                            displayName: "someRecipient",
+                        },
+                    ],
+                },
+                content: {
+                    subject: "someSubject",
+                    plainText: "somePlainTextBody",
+                    html: "<html><h1>someHtmlBody</html>",
+                },
+            };
+            const response = await client.send(emailMessage);
+            const messageId = response.messageId;
+            if (messageId) {
+                const messageStatusResponse = await client.getSendStatus(messageId);
+                assert.isNotNull(messageStatusResponse.status);
+            }
+            else {
+                assert.fail();
+            }
+        }).timeout(5000);
+    });
+});
+//# sourceMappingURL=emailClient.spec.js.map

package/dist-esm/test/public/emailClient.spec.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"emailClient.spec.js","sourceRoot":"","sources":["../../../test/public/emailClient.spec.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAY,GAAG,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EACL,6CAA6C,EAC7C,0CAA0C,GAC3C,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,KAAK,WAAW,gBAAgB;IACtD,QAAQ,CAAC,8BACP,gBAAgB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,qBAC1C,EAAE,EAAE,GAAG,EAAE;QACP,IAAI,QAAkB,CAAC;QACvB,IAAI,MAAmB,CAAC;QAExB,UAAU,CAAC;YACT,IAAI,gBAAgB,EAAE;gBACpB,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,0CAA0C,CAAC,IAAI,CAAC,CAAC,CAAC;aAC3E;iBAAM;gBACL,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,6CAA6C,CAAC,IAAI,CAAC,CAAC,CAAC;aAC9E;QACH,CAAC,CAAC,CAAC;QAEH,SAAS,CAAC,KAAK;;YACb,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,WAAW,0CAAE,SAAS,EAAE,CAAA,EAAE;gBAClC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;aACvB;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK;YAC3D,MAAM,YAAY,GAAiB;gBACjC,MAAM,EAAE,GAAG,CAAC,cAAc;gBAC1B,UAAU,EAAE;oBACV,EAAE,EAAE;wBACF;4BACE,KAAK,EAAE,GAAG,CAAC,iBAAiB;4BAC5B,WAAW,EAAE,eAAe;yBAC7B;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,aAAa;oBACtB,SAAS,EAAE,mBAAmB;oBAC9B,IAAI,EAAE,+BAA+B;iBACtC;aACF,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjD,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEjB,EAAE,CAAC,6DAA6D,EAAE,KAAK;YACrE,MAAM,YAAY,GAAiB;gBACjC,MAAM,EAAE,GAAG,CAAC,cAAc;gBAC1B,UAAU,EAAE;oBACV,EAAE,EAAE;wBACF;4BACE,KAAK,EAAE,GAAG,CAAC,iBAAiB;4BAC5B,WAAW,EAAE,eAAe;yBAC7B;wBACD;4BACE,KAAK,EAAE,GAAG,CAAC,iBAAiB;4BAC5B,WAAW,EAAE,eAAe;yBAC7B;qBACF;oBACD,EAAE,EAAE;wBACF;4BACE,KAAK,EAAE,GAAG,CAAC,iBAAiB;4BAC5B,WAAW,EAAE,eAAe;yBAC7B;qBACF;oBACD,GAAG,EAAE;wBACH;4BACE,KAAK,EAAE,GAAG,CAAC,iBAAiB;4BAC5B,WAAW,EAAE,eAAe;yBAC7B;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,aAAa;oBACtB,SAAS,EAAE,mBAAmB;oBAC9B,IAAI,EAAE,+BAA+B;iBACtC;aACF,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjD,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEjB,EAAE,CAAC,gDAAgD,EAAE,KAAK;YACxD,MAAM,YAAY,GAAiB;gBACjC,MAAM,EAAE,GAAG,CAAC,cAAc;gBAC1B,UAAU,EAAE;oBACV,EAAE,EAAE;wBACF;4BACE,KAAK,EAAE,GAAG,CAAC,iBAAiB;4BAC5B,WAAW,EAAE,eAAe;yBAC7B;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,aAAa;oBACtB,SAAS,EAAE,mBAAmB;oBAC9B,IAAI,EAAE,+BAA+B;iBACtC;gBACD,WAAW,EAAE;oBACX;wBACE,IAAI,EAAE,YAAY;wBAClB,cAAc,EAAE,KAAK;wBACrB,kBAAkB,EAAE,8BAA8B;qBACnD;iBACF;aACF,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjD,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAEjB,EAAE,CAAC,sEAAsE,EAAE,KAAK;YAC9E,MAAM,YAAY,GAAiB;gBACjC,MAAM,EAAE,GAAG,CAAC,cAAc;gBAC1B,UAAU,EAAE;oBACV,EAAE,EAAE;wBACF;4BACE,KAAK,EAAE,GAAG,CAAC,iBAAiB;4BAC5B,WAAW,EAAE,eAAe;yBAC7B;qBACF;iBACF;gBACD,OAAO,EAAE;oBACP,OAAO,EAAE,aAAa;oBACtB,SAAS,EAAE,mBAAmB;oBAC9B,IAAI,EAAE,+BAA+B;iBACtC;aACF,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACjD,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC;YACrC,IAAI,SAAS,EAAE;gBACb,MAAM,qBAAqB,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;gBACpE,MAAM,CAAC,SAAS,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;aAChD;iBAAM;gBACL,MAAM,CAAC,IAAI,EAAE,CAAC;aACf;QACH,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { EmailClient, EmailMessage } from \"../../src\";\nimport { Recorder, env } from \"@azure-tools/test-recorder\";\nimport {\n createRecordedEmailClientWithConnectionString,\n createRecordedEmailClientWithKeyCredential,\n} from \"./utils/recordedClient\";\nimport { Context } from \"mocha\";\nimport { assert } from \"chai\";\nimport { matrix } from \"@azure/test-utils\";\n\nmatrix([[true, false]], async function (useKeyCredential) {\n describe(`EmailClient [Playback/Live]${\n useKeyCredential ? \" [KeyCredential]\" : \" [ConnectionString]\"\n }`, () => {\n let recorder: Recorder;\n let client: EmailClient;\n\n beforeEach(function (this: Context) {\n if (useKeyCredential) {\n ({ client, recorder } = createRecordedEmailClientWithKeyCredential(this));\n } else {\n ({ client, recorder } = createRecordedEmailClientWithConnectionString(this));\n }\n });\n\n afterEach(async function (this: Context) {\n if (!this.currentTest?.isPending()) {\n await recorder.stop();\n }\n });\n\n it(\"successfully sends an email to a single recipient\", async function () {\n const emailMessage: EmailMessage = {\n sender: env.SENDER_ADDRESS,\n recipients: {\n to: [\n {\n email: env.RECIPIENT_ADDRESS,\n displayName: \"someRecipient\",\n },\n ],\n },\n content: {\n subject: \"someSubject\",\n plainText: \"somePlainTextBody\",\n html: \"<html><h1>someHtmlBody</html>\",\n },\n };\n\n const response = await client.send(emailMessage);\n assert.isNotNull(response.messageId);\n }).timeout(5000);\n\n it(\"successfully sends an email to multiple types of recipients\", async function () {\n const emailMessage: EmailMessage = {\n sender: env.SENDER_ADDRESS,\n recipients: {\n to: [\n {\n email: env.RECIPIENT_ADDRESS,\n displayName: \"someRecipient\",\n },\n {\n email: env.RECIPIENT_ADDRESS,\n displayName: \"someRecipient\",\n },\n ],\n cC: [\n {\n email: env.RECIPIENT_ADDRESS,\n displayName: \"someRecipient\",\n },\n ],\n bCC: [\n {\n email: env.RECIPIENT_ADDRESS,\n displayName: \"someRecipient\",\n },\n ],\n },\n content: {\n subject: \"someSubject\",\n plainText: \"somePlainTextBody\",\n html: \"<html><h1>someHtmlBody</html>\",\n },\n };\n\n const response = await client.send(emailMessage);\n assert.isNotNull(response.messageId);\n }).timeout(5000);\n\n it(\"successfully sends an email with an attachment\", async function () {\n const emailMessage: EmailMessage = {\n sender: env.SENDER_ADDRESS,\n recipients: {\n to: [\n {\n email: env.RECIPIENT_ADDRESS,\n displayName: \"someRecipient\",\n },\n ],\n },\n content: {\n subject: \"someSubject\",\n plainText: \"somePlainTextBody\",\n html: \"<html><h1>someHtmlBody</html>\",\n },\n attachments: [\n {\n name: \"readme.txt\",\n attachmentType: \"txt\",\n contentBytesBase64: \"ZW1haWwgdGVzdCBhdHRhY2htZW50\",\n },\n ],\n };\n\n const response = await client.send(emailMessage);\n assert.isNotNull(response.messageId);\n }).timeout(5000);\n\n it(\"successfully retrieves the email status with the returned message id\", async function () {\n const emailMessage: EmailMessage = {\n sender: env.SENDER_ADDRESS,\n recipients: {\n to: [\n {\n email: env.RECIPIENT_ADDRESS,\n displayName: \"someRecipient\",\n },\n ],\n },\n content: {\n subject: \"someSubject\",\n plainText: \"somePlainTextBody\",\n html: \"<html><h1>someHtmlBody</html>\",\n },\n };\n\n const response = await client.send(emailMessage);\n const messageId = response.messageId;\n if (messageId) {\n const messageStatusResponse = await client.getSendStatus(messageId);\n assert.isNotNull(messageStatusResponse.status);\n } else {\n assert.fail();\n }\n }).timeout(5000);\n });\n});\n"]}

package/dist-esm/test/public/utils/recordedClient.js ADDED Viewed

@@ -0,0 +1,46 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+import * as dotenv from "dotenv";
+import { env, record } from "@azure-tools/test-recorder";
+import { EmailClient } from "../../../src";
+import { isNode } from "@azure/core-http";
+import { parseConnectionString } from "@azure/communication-common";
+if (isNode) {
+    dotenv.config();
+}
+const replaceableVariables = {
+    COMMUNICATION_CONNECTION_STRING: "endpoint=https://someEndpoint/;accesskey=someAccessKeyw==",
+    SENDER_ADDRESS: "someSender@contoso.com",
+    RECIPIENT_ADDRESS: "someRecipient@domain.com",
+};
+export const environmentSetup = {
+    replaceableVariables: replaceableVariables,
+    customizationsOnRecordings: [
+        (recording) => recording.replace(/(https:\/\/)([^/',]*)/, "$1someEndpoint"),
+        (recording) => recording.replace(/("sender":)("(.*?)")/, "$1" + '"someSender@contoso.com"'),
+        (recording) => recording.replace(/("email":)("(.*?)")/g, "$1" + '"someRecipient@domain.com"'),
+        (recording) => recording.replace(/('Operation-Location',[\r\n] {2})'(.*?)'/, "$1" + '"someOperationLocation"'),
+        (recording) => recording.replace(/"operation-location"\s?:\s?"[^"]*"/g, '"operation-location": "someOperationLocation"'),
+        (recording) => recording.replace(/('x-ms-request-id',[\r\n] {2})'(.*?)'/, "$1" + '"someRequestId"'),
+        (recording) => recording.replace(/"x-ms-request-id"\s?:\s?"[^"]*"/g, '"x-ms-request-id": "someRequestId"'),
+        (recording) => recording.replace(/("messageId":)("(.*?)")/g, "$1" + '"someRequestId"'),
+        (recording) => recording.replace(/emails\/[^"']*/g, "emails/someRequestId/status"),
+    ],
+    queryParametersToSkip: [],
+};
+export function createRecordedEmailClientWithConnectionString(context) {
+    const recorder = record(context, environmentSetup);
+    return {
+        client: new EmailClient(env.COMMUNICATION_CONNECTION_STRING),
+        recorder,
+    };
+}
+export function createRecordedEmailClientWithKeyCredential(context) {
+    const recorder = record(context, environmentSetup);
+    const { endpoint, credential } = parseConnectionString(env.COMMUNICATION_CONNECTION_STRING);
+    return {
+        client: new EmailClient(endpoint, credential),
+        recorder,
+    };
+}
+//# sourceMappingURL=recordedClient.js.map

package/dist-esm/test/public/utils/recordedClient.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"recordedClient.js","sourceRoot":"","sources":["../../../../test/public/utils/recordedClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAsC,GAAG,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAE7F,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,IAAI,MAAM,EAAE;IACV,MAAM,CAAC,MAAM,EAAE,CAAC;CACjB;AAOD,MAAM,oBAAoB,GAA4B;IACpD,+BAA+B,EAAE,2DAA2D;IAC5F,cAAc,EAAE,wBAAwB;IACxC,iBAAiB,EAAE,0BAA0B;CAC9C,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAA6B;IACxD,oBAAoB,EAAE,oBAAoB;IAC1C,0BAA0B,EAAE;QAC1B,CAAC,SAAiB,EAAU,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,uBAAuB,EAAE,gBAAgB,CAAC;QAC3F,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CAAC,sBAAsB,EAAE,IAAI,GAAG,0BAA0B,CAAC;QAC9E,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CAAC,sBAAsB,EAAE,IAAI,GAAG,4BAA4B,CAAC;QAChF,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CACf,0CAA0C,EAC1C,IAAI,GAAG,yBAAyB,CACjC;QACH,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CACf,qCAAqC,EACrC,+CAA+C,CAChD;QACH,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CAAC,uCAAuC,EAAE,IAAI,GAAG,iBAAiB,CAAC;QACtF,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CAAC,kCAAkC,EAAE,oCAAoC,CAAC;QAC7F,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CAAC,0BAA0B,EAAE,IAAI,GAAG,iBAAiB,CAAC;QACzE,CAAC,SAAiB,EAAU,EAAE,CAC5B,SAAS,CAAC,OAAO,CAAC,iBAAiB,EAAE,6BAA6B,CAAC;KACtE;IACD,qBAAqB,EAAE,EAAE;CAC1B,CAAC;AAEF,MAAM,UAAU,6CAA6C,CAC3D,OAAgB;IAEhB,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAEnD,OAAO;QACL,MAAM,EAAE,IAAI,WAAW,CAAC,GAAG,CAAC,+BAA+B,CAAC;QAC5D,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0CAA0C,CAAC,OAAgB;IACzE,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAEnD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,qBAAqB,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;IAE5F,OAAO;QACL,MAAM,EAAE,IAAI,WAAW,CAAC,QAAQ,EAAE,UAAU,CAAC;QAC7C,QAAQ;KACT,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as dotenv from \"dotenv\";\nimport { Recorder, RecorderEnvironmentSetup, env, record } from \"@azure-tools/test-recorder\";\nimport { Context } from \"mocha\";\nimport { EmailClient } from \"../../../src\";\nimport { isNode } from \"@azure/core-http\";\nimport { parseConnectionString } from \"@azure/communication-common\";\n\nif (isNode) {\n dotenv.config();\n}\n\nexport interface RecordedEmailClient {\n client: EmailClient;\n recorder: Recorder;\n}\n\nconst replaceableVariables: { [k: string]: string } = {\n COMMUNICATION_CONNECTION_STRING: \"endpoint=https://someEndpoint/;accesskey=someAccessKeyw==\",\n SENDER_ADDRESS: \"someSender@contoso.com\",\n RECIPIENT_ADDRESS: \"someRecipient@domain.com\",\n};\n\nexport const environmentSetup: RecorderEnvironmentSetup = {\n replaceableVariables: replaceableVariables,\n customizationsOnRecordings: [\n (recording: string): string => recording.replace(/(https:\\/\\/)([^/',]*)/, \"$1someEndpoint\"),\n (recording: string): string =>\n recording.replace(/(\"sender\":)(\"(.*?)\")/, \"$1\" + '\"someSender@contoso.com\"'),\n (recording: string): string =>\n recording.replace(/(\"email\":)(\"(.*?)\")/g, \"$1\" + '\"someRecipient@domain.com\"'),\n (recording: string): string =>\n recording.replace(\n /('Operation-Location',[\\r\\n] {2})'(.*?)'/,\n \"$1\" + '\"someOperationLocation\"'\n ),\n (recording: string): string =>\n recording.replace(\n /\"operation-location\"\\s?:\\s?\"[^\"]*\"/g,\n '\"operation-location\": \"someOperationLocation\"'\n ),\n (recording: string): string =>\n recording.replace(/('x-ms-request-id',[\\r\\n] {2})'(.*?)'/, \"$1\" + '\"someRequestId\"'),\n (recording: string): string =>\n recording.replace(/\"x-ms-request-id\"\\s?:\\s?\"[^\"]*\"/g, '\"x-ms-request-id\": \"someRequestId\"'),\n (recording: string): string =>\n recording.replace(/(\"messageId\":)(\"(.*?)\")/g, \"$1\" + '\"someRequestId\"'),\n (recording: string): string =>\n recording.replace(/emails\\/[^\"']*/g, \"emails/someRequestId/status\"),\n ],\n queryParametersToSkip: [],\n};\n\nexport function createRecordedEmailClientWithConnectionString(\n context: Context\n): RecordedEmailClient {\n const recorder = record(context, environmentSetup);\n\n return {\n client: new EmailClient(env.COMMUNICATION_CONNECTION_STRING),\n recorder,\n };\n}\n\nexport function createRecordedEmailClientWithKeyCredential(context: Context): RecordedEmailClient {\n const recorder = record(context, environmentSetup);\n\n const { endpoint, credential } = parseConnectionString(env.COMMUNICATION_CONNECTION_STRING);\n\n return {\n client: new EmailClient(endpoint, credential),\n recorder,\n };\n}\n"]}

package/package.json ADDED Viewed

@@ -0,0 +1,110 @@
+{
+  "name": "@azure/communication-email",
+  "version": "1.0.0-beta.1",
+  "description": "The is the JS Client SDK for email. This SDK enables users to send emails and get the status of sent email message.",
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "sdk-type": "client",
+  "main": "dist/index.js",
+  "module": "dist-esm/src/index.js",
+  "types": "types/communication-email.d.ts",
+  "scripts": {
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build": "npm run clean && tsc -p . && dev-tool run bundle --browser-test=false && api-extractor run --local",
+    "build:samples": "dev-tool samples publish -f",
+    "build:test": "tsc -p . && dev-tool run bundle",
+    "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-* temp types *.tgz *.log",
+    "execute:samples": "dev-tool samples run samples-dev",
+    "extract-api": "tsc -p . && api-extractor run --local",
+    "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "karma start --single-run",
+    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 300000  dist-esm/test/public/*.spec.js dist-esm/test/public/node/*.spec.js",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
+    "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json src test --ext .ts",
+    "pack": "npm pack 2>&1",
+    "test": "npm run build:test && npm run unit-test && npm run integration-test",
+    "test:browser": "npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
+    "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
+    "unit-test:browser": "karma start --single-run",
+    "unit-test:node": "mocha -r esm -r ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace --exclude \"test/**/browser/*.spec.ts\" \"test/**/*.spec.ts\"",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+  },
+  "files": [
+    "dist/",
+    "dist-esm/",
+    "types/communication-email.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": "github:Azure/azure-sdk-for-js",
+  "keywords": [
+    "azure",
+    "cloud",
+    "communication",
+    "email"
+  ],
+  "dependencies": {
+    "@azure/core-auth": "^1.3.0",
+    "@azure/core-http": "^2.0.0",
+    "@azure/communication-common": "^1.1.0",
+    "@azure/logger": "^1.0.0",
+    "tslib": "^1.9.3",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@azure/dev-tool": "^1.0.0",
+    "@azure/eslint-plugin-azure-sdk": "^3.0.0",
+    "@azure/test-utils": "^1.0.0",
+    "@azure-tools/test-recorder": "^1.0.0",
+    "@microsoft/api-extractor": "7.18.11",
+    "@types/node": "^12.0.0",
+    "@types/uuid": "^8.3.2",
+    "@types/chai": "^4.1.6",
+    "@types/mocha": "^7.0.2",
+    "chai": "^4.2.0",
+    "dotenv": "^8.2.0",
+    "eslint": "^7.15.0",
+    "karma": "^6.2.0",
+    "karma-chrome-launcher": "^3.0.0",
+    "karma-coverage": "^2.0.0",
+    "karma-edge-launcher": "^0.4.2",
+    "karma-env-preprocessor": "^0.1.1",
+    "karma-firefox-launcher": "^1.1.0",
+    "karma-ie-launcher": "^1.0.0",
+    "karma-json-preprocessor": "^0.3.3",
+    "karma-json-to-file-reporter": "^1.0.1",
+    "karma-junit-reporter": "^2.0.1",
+    "karma-mocha": "^2.0.1",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-sourcemap-loader": "^0.3.8",
+    "mocha": "^7.1.1",
+    "mocha-junit-reporter": "^2.0.0",
+    "nyc": "^15.0.0",
+    "typescript": "~4.2.0",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.0"
+  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/communication/communication-email/",
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "sideEffects": false,
+  "autoPublish": true,
+  "//sampleConfiguration": {
+    "productName": "Azure Communication Services - Email",
+    "productSlugs": [
+      "azure",
+      "azure-communication-services"
+    ],
+    "disableDocsMs": true,
+    "requiredResources": {
+      "Azure Communication Services Resource": "https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource",
+      "Email Communication Services Resource": "https://aka.ms/acsemail/createemailresource"
+    }
+  }
+}

package/types/communication-email.d.ts ADDED Viewed

@@ -0,0 +1,200 @@
+import { KeyCredential } from '@azure/core-auth';
+import { PipelineOptions } from '@azure/core-http';
+/**
+ * An object representing the email address and its display name
+ */
+export declare interface EmailAddress {
+    /**
+     * Email address.
+     */
+    email: string;
+    /**
+     * Email display name.
+     */
+    displayName?: string;
+}
+/**
+ * Attachment to the email.
+ */
+export declare interface EmailAttachment {
+    /**
+     * Name of the attachment
+     */
+    name: string;
+    /**
+     * The type of attachment file.
+     */
+    attachmentType: EmailAttachmentType;
+    /**
+     * Base64 encoded contents of the attachment
+     */
+    contentBytesBase64: string;
+}
+/**
+ * Defines values for EmailAttachmentType.
+ */
+export declare type EmailAttachmentType = "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";
+/**
+ *  The Email service client.
+ */
+export declare class EmailClient {
+    private readonly api;
+    /**
+     * Initializes a new instance of the EmailClient class.
+     * @param connectionString - Connection string to connect to an Azure Communication Service resource.
+     *                         Example: "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";
+     * @param options - Optional. Options to configure the HTTP pipeline.
+     */
+    constructor(connectionString: string, options?: EmailClientOptions);
+    /**
+     * Initializes a new instance of the EmailClient class using an Azure KeyCredential.
+     * @param endpoint - The endpoint of the service (ex: https://contoso.eastus.communications.azure.net).
+     * @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);
+    /**
+     * Queues an email message to be sent to one or more recipients
+     * @param emailMessage - Message payload for sending an email
+     */
+    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>;
+}
+/**
+ * Client options used to configure SMS Client API requests.
+ */
+export declare interface EmailClientOptions extends PipelineOptions {
+}
+/**
+ * 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.
+ */
+export declare type EmailImportance = "high" | "normal" | "low";
+/**
+ * Message payload for sending an email
+ */
+export declare interface EmailMessage {
+    /**
+     * Custom email headers to be passed.
+     */
+    customHeaders?: EmailCustomHeader[];
+    /**
+     * Sender email address from a verified domain.
+     */
+    sender: 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
+     */
+    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;
+}
+/**
+ * Recipients of the email
+ */
+export declare interface EmailRecipients {
+    /**
+     * Email to recipients
+     */
+    to: EmailAddress[];
+    /**
+     * Email cc recipients
+     */
+    cC?: EmailAddress[];
+    /**
+     * Email bcc recipients
+     */
+    bCC?: EmailAddress[];
+}
+/**
+ * Results of a sent email.
+ */
+export declare interface SendEmailResult {
+    /**
+     * MessageId of the sent email.
+     */
+    messageId: string;
+}
+/**
+ * Defines values for SendStatus.
+ */
+export declare type SendStatus = "queued" | "outForDelivery" | "dropped";
+/**
+ * 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 { }