@payloadcms/email-nodemailer 3.0.0-alpha.62

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018-2022 Payload CMS, LLC <info@payloadcms.com>
+Portions Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# Nodemailer Email Adapter

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import type { Transporter } from 'nodemailer';
+import type SMTPConnection from 'nodemailer/lib/smtp-connection';
+import type { EmailAdapter } from 'payload/config';
+export type NodemailerAdapterArgs = {
+    defaultFromAddress: string;
+    defaultFromName: string;
+    skipVerify?: boolean;
+    transport?: Transporter;
+    transportOptions?: SMTPConnection.Options;
+};
+export type NodemailerAdapter = EmailAdapter<unknown>;
+/**
+ * Creates an email adapter using nodemailer
+ *
+ * If no email configuration is provided, an ethereal email test account is returned
+ */
+export declare const nodemailerAdapter: (args?: NodemailerAdapterArgs) => Promise<NodemailerAdapter>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,cAAc,MAAM,gCAAgC,CAAA;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAKlD,MAAM,MAAM,qBAAqB,GAAG;IAClC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,SAAS,CAAC,EAAE,WAAW,CAAA;IACvB,gBAAgB,CAAC,EAAE,cAAc,CAAC,OAAO,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;AAErD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,UACrB,qBAAqB,KAC3B,QAAQ,iBAAiB,CAc3B,CAAA"}

package/dist/index.js

@@ -0,0 +1,95 @@
+/* eslint-disable no-console */ import nodemailer from 'nodemailer';
+import { InvalidConfiguration } from 'payload/errors';
+/**
+ * Creates an email adapter using nodemailer
+ *
+ * If no email configuration is provided, an ethereal email test account is returned
+ */ export const nodemailerAdapter = async (args)=>{
+    const { defaultFromAddress, defaultFromName, transport } = await buildEmail(args);
+    const adapter = ()=>({
+            defaultFromAddress,
+            defaultFromName,
+            sendEmail: async (message)=>{
+                return await transport.sendMail({
+                    from: `${defaultFromName} <${defaultFromAddress}>`,
+                    ...message
+                });
+            }
+        });
+    return adapter;
+};
+async function buildEmail(emailConfig) {
+    if (!emailConfig) {
+        const transport = await createMockAccount(emailConfig);
+        if (!transport) throw new InvalidConfiguration('Unable to create Nodemailer test account.');
+        return {
+            defaultFromAddress: 'info@payloadcms.com',
+            defaultFromName: 'Payload',
+            transport
+        };
+    }
+    // Create or extract transport
+    let transport;
+    if ('transport' in emailConfig && emailConfig.transport) {
+        ({ transport } = emailConfig);
+    } else if ('transportOptions' in emailConfig && emailConfig.transportOptions) {
+        transport = nodemailer.createTransport(emailConfig.transportOptions);
+    } else {
+        transport = await createMockAccount(emailConfig);
+    }
+    if (emailConfig.skipVerify !== false) {
+        await verifyTransport(transport);
+    }
+    return {
+        defaultFromAddress: emailConfig.defaultFromAddress,
+        defaultFromName: emailConfig.defaultFromName,
+        transport
+    };
+}
+async function verifyTransport(transport) {
+    try {
+        await transport.verify();
+    } catch (err) {
+        console.error({
+            err,
+            msg: 'Error verifying Nodemailer transport.'
+        });
+    }
+}
+/**
+ * Use ethereal.email to create a mock email account
+ */ async function createMockAccount(emailConfig) {
+    try {
+        const etherealAccount = await nodemailer.createTestAccount();
+        const smtpOptions = {
+            ...emailConfig || {},
+            auth: {
+                pass: etherealAccount.pass,
+                user: etherealAccount.user
+            },
+            fromAddress: emailConfig?.defaultFromAddress,
+            fromName: emailConfig?.defaultFromName,
+            host: 'smtp.ethereal.email',
+            port: 587,
+            secure: false
+        };
+        const transport = nodemailer.createTransport(smtpOptions);
+        const { pass, user, web } = etherealAccount;
+        console.info('E-mail configured with ethereal.email test account. ');
+        console.info(`Log into mock email provider at ${web}`);
+        console.info(`Mock email account username: ${user}`);
+        console.info(`Mock email account password: ${pass}`);
+        return transport;
+    } catch (err) {
+        if (err instanceof Error) {
+            console.error({
+                err,
+                msg: 'There was a problem setting up the mock email handler'
+            });
+            throw new InvalidConfiguration(`Unable to create Nodemailer test account. Error: ${err.message}`);
+        }
+        throw new InvalidConfiguration('Unable to create Nodemailer test account.');
+    }
+}
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/* eslint-disable no-console */\nimport type { Transporter } from 'nodemailer'\nimport type SMTPConnection from 'nodemailer/lib/smtp-connection'\nimport type { EmailAdapter } from 'payload/config'\n\nimport nodemailer from 'nodemailer'\nimport { InvalidConfiguration } from 'payload/errors'\n\nexport type NodemailerAdapterArgs = {\n  defaultFromAddress: string\n  defaultFromName: string\n  skipVerify?: boolean\n  transport?: Transporter\n  transportOptions?: SMTPConnection.Options\n}\n\nexport type NodemailerAdapter = EmailAdapter<unknown>\n\n/**\n * Creates an email adapter using nodemailer\n *\n * If no email configuration is provided, an ethereal email test account is returned\n */\nexport const nodemailerAdapter = async (\n  args?: NodemailerAdapterArgs,\n): Promise<NodemailerAdapter> => {\n  const { defaultFromAddress, defaultFromName, transport } = await buildEmail(args)\n\n  const adapter: NodemailerAdapter = () => ({\n    defaultFromAddress,\n    defaultFromName,\n    sendEmail: async (message) => {\n      return await transport.sendMail({\n        from: `${defaultFromName} <${defaultFromAddress}>`,\n        ...message,\n      })\n    },\n  })\n  return adapter\n}\n\nasync function buildEmail(emailConfig?: NodemailerAdapterArgs): Promise<{\n  defaultFromAddress: string\n  defaultFromName: string\n  transport: Transporter\n}> {\n  if (!emailConfig) {\n    const transport = await createMockAccount(emailConfig)\n    if (!transport) throw new InvalidConfiguration('Unable to create Nodemailer test account.')\n\n    return {\n      defaultFromAddress: 'info@payloadcms.com',\n      defaultFromName: 'Payload',\n      transport,\n    }\n  }\n\n  // Create or extract transport\n  let transport: Transporter\n  if ('transport' in emailConfig && emailConfig.transport) {\n    ;({ transport } = emailConfig)\n  } else if ('transportOptions' in emailConfig && emailConfig.transportOptions) {\n    transport = nodemailer.createTransport(emailConfig.transportOptions)\n  } else {\n    transport = await createMockAccount(emailConfig)\n  }\n\n  if (emailConfig.skipVerify !== false) {\n    await verifyTransport(transport)\n  }\n\n  return {\n    defaultFromAddress: emailConfig.defaultFromAddress,\n    defaultFromName: emailConfig.defaultFromName,\n    transport,\n  }\n}\n\nasync function verifyTransport(transport: Transporter) {\n  try {\n    await transport.verify()\n  } catch (err: unknown) {\n    console.error({ err, msg: 'Error verifying Nodemailer transport.' })\n  }\n}\n\n/**\n * Use ethereal.email to create a mock email account\n */\nasync function createMockAccount(emailConfig?: NodemailerAdapterArgs) {\n  try {\n    const etherealAccount = await nodemailer.createTestAccount()\n\n    const smtpOptions = {\n      ...(emailConfig || {}),\n      auth: {\n        pass: etherealAccount.pass,\n        user: etherealAccount.user,\n      },\n      fromAddress: emailConfig?.defaultFromAddress,\n      fromName: emailConfig?.defaultFromName,\n      host: 'smtp.ethereal.email',\n      port: 587,\n      secure: false,\n    }\n    const transport = nodemailer.createTransport(smtpOptions)\n    const { pass, user, web } = etherealAccount\n\n    console.info('E-mail configured with ethereal.email test account. ')\n    console.info(`Log into mock email provider at ${web}`)\n    console.info(`Mock email account username: ${user}`)\n    console.info(`Mock email account password: ${pass}`)\n    return transport\n  } catch (err: unknown) {\n    if (err instanceof Error) {\n      console.error({ err, msg: 'There was a problem setting up the mock email handler' })\n      throw new InvalidConfiguration(\n        `Unable to create Nodemailer test account. Error: ${err.message}`,\n      )\n    }\n    throw new InvalidConfiguration('Unable to create Nodemailer test account.')\n  }\n}\n"],"names":["nodemailer","InvalidConfiguration","nodemailerAdapter","args","defaultFromAddress","defaultFromName","transport","buildEmail","adapter","sendEmail","message","sendMail","from","emailConfig","createMockAccount","transportOptions","createTransport","skipVerify","verifyTransport","verify","err","console","error","msg","etherealAccount","createTestAccount","smtpOptions","auth","pass","user","fromAddress","fromName","host","port","secure","web","info","Error"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,6BAA6B,GAK7B,OAAOA,gBAAgB,aAAY;AACnC,SAASC,oBAAoB,QAAQ,iBAAgB;AAYrD;;;;CAIC,GACD,OAAO,MAAMC,oBAAoB,OAC/BC;IAEA,MAAM,EAAEC,kBAAkB,EAAEC,eAAe,EAAEC,SAAS,EAAE,GAAG,MAAMC,WAAWJ;IAE5E,MAAMK,UAA6B,IAAO,CAAA;YACxCJ;YACAC;YACAI,WAAW,OAAOC;gBAChB,OAAO,MAAMJ,UAAUK,QAAQ,CAAC;oBAC9BC,MAAM,CAAC,EAAEP,gBAAgB,EAAE,EAAED,mBAAmB,CAAC,CAAC;oBAClD,GAAGM,OAAO;gBACZ;YACF;QACF,CAAA;IACA,OAAOF;AACT,EAAC;AAED,eAAeD,WAAWM,WAAmC;IAK3D,IAAI,CAACA,aAAa;QAChB,MAAMP,YAAY,MAAMQ,kBAAkBD;QAC1C,IAAI,CAACP,WAAW,MAAM,IAAIL,qBAAqB;QAE/C,OAAO;YACLG,oBAAoB;YACpBC,iBAAiB;YACjBC;QACF;IACF;IAEA,8BAA8B;IAC9B,IAAIA;IACJ,IAAI,eAAeO,eAAeA,YAAYP,SAAS,EAAE;QACrD,CAAA,EAAEA,SAAS,EAAE,GAAGO,WAAU;IAC9B,OAAO,IAAI,sBAAsBA,eAAeA,YAAYE,gBAAgB,EAAE;QAC5ET,YAAYN,WAAWgB,eAAe,CAACH,YAAYE,gBAAgB;IACrE,OAAO;QACLT,YAAY,MAAMQ,kBAAkBD;IACtC;IAEA,IAAIA,YAAYI,UAAU,KAAK,OAAO;QACpC,MAAMC,gBAAgBZ;IACxB;IAEA,OAAO;QACLF,oBAAoBS,YAAYT,kBAAkB;QAClDC,iBAAiBQ,YAAYR,eAAe;QAC5CC;IACF;AACF;AAEA,eAAeY,gBAAgBZ,SAAsB;IACnD,IAAI;QACF,MAAMA,UAAUa,MAAM;IACxB,EAAE,OAAOC,KAAc;QACrBC,QAAQC,KAAK,CAAC;YAAEF;YAAKG,KAAK;QAAwC;IACpE;AACF;AAEA;;CAEC,GACD,eAAeT,kBAAkBD,WAAmC;IAClE,IAAI;QACF,MAAMW,kBAAkB,MAAMxB,WAAWyB,iBAAiB;QAE1D,MAAMC,cAAc;YAClB,GAAIb,eAAe,CAAC,CAAC;YACrBc,MAAM;gBACJC,MAAMJ,gBAAgBI,IAAI;gBAC1BC,MAAML,gBAAgBK,IAAI;YAC5B;YACAC,aAAajB,aAAaT;YAC1B2B,UAAUlB,aAAaR;YACvB2B,MAAM;YACNC,MAAM;YACNC,QAAQ;QACV;QACA,MAAM5B,YAAYN,WAAWgB,eAAe,CAACU;QAC7C,MAAM,EAAEE,IAAI,EAAEC,IAAI,EAAEM,GAAG,EAAE,GAAGX;QAE5BH,QAAQe,IAAI,CAAC;QACbf,QAAQe,IAAI,CAAC,CAAC,gCAAgC,EAAED,IAAI,CAAC;QACrDd,QAAQe,IAAI,CAAC,CAAC,6BAA6B,EAAEP,KAAK,CAAC;QACnDR,QAAQe,IAAI,CAAC,CAAC,6BAA6B,EAAER,KAAK,CAAC;QACnD,OAAOtB;IACT,EAAE,OAAOc,KAAc;QACrB,IAAIA,eAAeiB,OAAO;YACxBhB,QAAQC,KAAK,CAAC;gBAAEF;gBAAKG,KAAK;YAAwD;YAClF,MAAM,IAAItB,qBACR,CAAC,iDAAiD,EAAEmB,IAAIV,OAAO,CAAC,CAAC;QAErE;QACA,MAAM,IAAIT,qBAAqB;IACjC;AACF"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@payloadcms/email-nodemailer",
+  "version": "3.0.0-alpha.62",
+  "description": "Payload Nodemailer Email Adapter",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/payloadcms/payload.git",
+    "directory": "packages/email-nodemailer"
+  },
+  "license": "MIT",
+  "homepage": "https://payloadcms.com",
+  "author": "Payload CMS, Inc.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "dependencies": {
+    "nodemailer": "6.9.10"
+  },
+  "peerDependencies": {
+    "payload": "3.0.0-alpha.62"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=18.20.2"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/nodemailer": "6.4.14",
+    "payload": "3.0.0-alpha.62"
+  },
+  "scripts": {
+    "build": "pnpm build:swc && pnpm build:types",
+    "build:swc": "swc ./src -d ./dist --config-file .swcrc",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "build:clean": "find . \\( -type d \\( -name build -o -name dist -o -name .cache \\) -o -type f -name tsconfig.tsbuildinfo \\) -exec rm -rf {} + && pnpm build",
+    "clean": "rimraf {dist,*.tsbuildinfo}"
+  }
+}

package/src/index.ts

@@ -0,0 +1,123 @@
+/* eslint-disable no-console */
+import type { Transporter } from 'nodemailer'
+import type SMTPConnection from 'nodemailer/lib/smtp-connection'
+import type { EmailAdapter } from 'payload/config'
+
+import nodemailer from 'nodemailer'
+import { InvalidConfiguration } from 'payload/errors'
+
+export type NodemailerAdapterArgs = {
+  defaultFromAddress: string
+  defaultFromName: string
+  skipVerify?: boolean
+  transport?: Transporter
+  transportOptions?: SMTPConnection.Options
+}
+
+export type NodemailerAdapter = EmailAdapter<unknown>
+
+/**
+ * Creates an email adapter using nodemailer
+ *
+ * If no email configuration is provided, an ethereal email test account is returned
+ */
+export const nodemailerAdapter = async (
+  args?: NodemailerAdapterArgs,
+): Promise<NodemailerAdapter> => {
+  const { defaultFromAddress, defaultFromName, transport } = await buildEmail(args)
+
+  const adapter: NodemailerAdapter = () => ({
+    defaultFromAddress,
+    defaultFromName,
+    sendEmail: async (message) => {
+      return await transport.sendMail({
+        from: `${defaultFromName} <${defaultFromAddress}>`,
+        ...message,
+      })
+    },
+  })
+  return adapter
+}
+
+async function buildEmail(emailConfig?: NodemailerAdapterArgs): Promise<{
+  defaultFromAddress: string
+  defaultFromName: string
+  transport: Transporter
+}> {
+  if (!emailConfig) {
+    const transport = await createMockAccount(emailConfig)
+    if (!transport) throw new InvalidConfiguration('Unable to create Nodemailer test account.')
+
+    return {
+      defaultFromAddress: 'info@payloadcms.com',
+      defaultFromName: 'Payload',
+      transport,
+    }
+  }
+
+  // Create or extract transport
+  let transport: Transporter
+  if ('transport' in emailConfig && emailConfig.transport) {
+    ;({ transport } = emailConfig)
+  } else if ('transportOptions' in emailConfig && emailConfig.transportOptions) {
+    transport = nodemailer.createTransport(emailConfig.transportOptions)
+  } else {
+    transport = await createMockAccount(emailConfig)
+  }
+
+  if (emailConfig.skipVerify !== false) {
+    await verifyTransport(transport)
+  }
+
+  return {
+    defaultFromAddress: emailConfig.defaultFromAddress,
+    defaultFromName: emailConfig.defaultFromName,
+    transport,
+  }
+}
+
+async function verifyTransport(transport: Transporter) {
+  try {
+    await transport.verify()
+  } catch (err: unknown) {
+    console.error({ err, msg: 'Error verifying Nodemailer transport.' })
+  }
+}
+
+/**
+ * Use ethereal.email to create a mock email account
+ */
+async function createMockAccount(emailConfig?: NodemailerAdapterArgs) {
+  try {
+    const etherealAccount = await nodemailer.createTestAccount()
+
+    const smtpOptions = {
+      ...(emailConfig || {}),
+      auth: {
+        pass: etherealAccount.pass,
+        user: etherealAccount.user,
+      },
+      fromAddress: emailConfig?.defaultFromAddress,
+      fromName: emailConfig?.defaultFromName,
+      host: 'smtp.ethereal.email',
+      port: 587,
+      secure: false,
+    }
+    const transport = nodemailer.createTransport(smtpOptions)
+    const { pass, user, web } = etherealAccount
+
+    console.info('E-mail configured with ethereal.email test account. ')
+    console.info(`Log into mock email provider at ${web}`)
+    console.info(`Mock email account username: ${user}`)
+    console.info(`Mock email account password: ${pass}`)
+    return transport
+  } catch (err: unknown) {
+    if (err instanceof Error) {
+      console.error({ err, msg: 'There was a problem setting up the mock email handler' })
+      throw new InvalidConfiguration(
+        `Unable to create Nodemailer test account. Error: ${err.message}`,
+      )
+    }
+    throw new InvalidConfiguration('Unable to create Nodemailer test account.')
+  }
+}