@tryghost/nodemailer 2.0.2 → 2.1.0

package/README.md

@@ -11,11 +11,13 @@ Provides pre-configured transport options for common transport services.
 ### Supported Transport Types
 
 1. `smtp` - send via SMTP server.
-  *  Detects when service: 'sendmail' is used and enables sendmail mode
+
+- Detects when service: 'sendmail' is used and enables sendmail mode
 
 2. `mailgun` - Allows using Mailgun with API key instead of via SMTP.
-  *  `auth: { api_key: 'your-mailgun-api-key' }`
-  * Defaults to 60-second timeout.
+
+- `auth: { api_key: 'your-mailgun-api-key' }`
+- Defaults to 60-second timeout.
 
 3. `sendmail` - use local sendmail binary.
 
@@ -33,26 +35,22 @@ Factory for creating Nodemailer transports across SMTP, SES, Mailgun, Sendmail,
 
 ## Develop
 
-This is a mono repository, managed with [lerna](https://lernajs.io/).
+This is a mono repository, managed with [Nx](https://nx.dev).
 
 Follow the instructions for the top-level repo.
-1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
 
+1. `git clone` this repo & `cd` into it as usual
+2. Run `pnpm install` to install top-level dependencies.
 
 ## Run
 
-- `yarn dev`
-
+- `pnpm dev`
 
 ## Test
 
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
-
-
-
+- `pnpm lint` runs oxlint
+- `pnpm test` runs lint and tests
 
-# Copyright & License 
+# Copyright & License
 
-Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).

package/lib/nodemailer.js

@@ -5,7 +5,7 @@ const nodemailer = require('nodemailer');
 const tpl = require('@tryghost/tpl');
 
 const messages = {
-    unknownTransport: `Unknown mail transport: {transport}`
+    unknownTransport: `Unknown mail transport: {transport}`,
 };
 
 /**
@@ -19,70 +19,71 @@ module.exports = function (transport, options = {}) {
     transport = transport.toLowerCase();
 
     switch (transport) {
-    case 'smtp':
-        transportOptions = options;
-
-        /**
-         * @deprecated `secureConnection` was removed in Nodemailer 1.0.2
-         * in favor of `secure` but Ghost has been recommending `secureConnection`
-         * and it's difficult to get everyone to switch at this point
-         *
-         * Therefore, we have to alias it here to keep things working
-         */
-        if (Object.prototype.hasOwnProperty.call(options, 'secureConnection')) {
-            transportOptions.secure = options.secureConnection;
-        }
-
-        if (options.service && options.service.toLowerCase() === 'sendmail') {
+        case 'smtp':
+            transportOptions = options;
+
+            /**
+             * @deprecated `secureConnection` was removed in Nodemailer 1.0.2
+             * in favor of `secure` but Ghost has been recommending `secureConnection`
+             * and it's difficult to get everyone to switch at this point
+             *
+             * Therefore, we have to alias it here to keep things working
+             */
+            if (Object.prototype.hasOwnProperty.call(options, 'secureConnection')) {
+                transportOptions.secure = options.secureConnection;
+            }
+
+            if (options.service && options.service.toLowerCase() === 'sendmail') {
+                transportOptions.sendmail = true;
+            }
+            break;
+        case 'mailgun':
+            const mailgunTransport = require('nodemailer-mailgun-transport');
+
+            // Default to 60s timeout if not set in `options`
+            if (!Object.prototype.hasOwnProperty.call(options, 'timeout')) {
+                options.timeout = 60000;
+            }
+
+            transportOptions = mailgunTransport(options);
+            break;
+        case 'sendmail':
+            transportOptions = options;
             transportOptions.sendmail = true;
-        }
-        break;
-    case 'mailgun':
-        const mailgunTransport = require('nodemailer-mailgun-transport');
-
-        // Default to 60s timeout if not set in `options`
-        if (!Object.prototype.hasOwnProperty.call(options, 'timeout')) {
-            options.timeout = 60000;
-        }
-
-        transportOptions = mailgunTransport(options);
-        break;
-    case 'sendmail':
-        transportOptions = options;
-        transportOptions.sendmail = true;
-        break;
-    case 'ses':
-        const {SESv2Client, SendRawEmailCommand} = require('@aws-sdk/client-sesv2');
-
-        const pattern = /(.*)email(.*)\.(.*).amazonaws.com/i;
-        const result = pattern.exec(options.ServiceUrl);
-        const region = options.region || (result && result[3]) || 'us-east-1';
-
-        const accessKeyId = options.accessKeyId || options.AWSAccessKeyID;
-        const secretAccessKey = options.secretAccessKey || options.AWSSecretKey;
-        const credentials = (accessKeyId && secretAccessKey) ? {accessKeyId, secretAccessKey} : undefined;
-
-        const sesClient = new SESv2Client({
-            region,
-            credentials
-        });
-
-        transportOptions = {
-            SES: {sesClient, SendRawEmailCommand}
-        };
-
-        break;
-    case 'direct':
-        transportOptions = Object.assign({direct: true}, options);
-        break;
-    case 'stub':
-        const stubTransport = require('nodemailer-stub-transport');
-        transportOptions = stubTransport(options);
-        break;
-    default:
-        throw new errors.EmailError({
-            message: tpl(messages.unknownTransport, {transport})
-        });
+            break;
+        case 'ses':
+            const { SESv2Client, SendRawEmailCommand } = require('@aws-sdk/client-sesv2');
+
+            const pattern = /(.*)email(.*)\.(.*).amazonaws.com/i;
+            const result = pattern.exec(options.ServiceUrl);
+            const region = options.region || (result && result[3]) || 'us-east-1';
+
+            const accessKeyId = options.accessKeyId || options.AWSAccessKeyID;
+            const secretAccessKey = options.secretAccessKey || options.AWSSecretKey;
+            const credentials =
+                accessKeyId && secretAccessKey ? { accessKeyId, secretAccessKey } : undefined;
+
+            const sesClient = new SESv2Client({
+                region,
+                credentials,
+            });
+
+            transportOptions = {
+                SES: { sesClient, SendRawEmailCommand },
+            };
+
+            break;
+        case 'direct':
+            transportOptions = Object.assign({ direct: true }, options);
+            break;
+        case 'stub':
+            const stubTransport = require('nodemailer-stub-transport');
+            transportOptions = stubTransport(options);
+            break;
+        default:
+            throw new errors.EmailError({
+                message: tpl(messages.unknownTransport, { transport }),
+            });
     }
 
     const transporter = nodemailer.createTransport(transportOptions);

package/package.json

@@ -1,35 +1,35 @@
 {
   "name": "@tryghost/nodemailer",
-  "version": "2.0.2",
+  "version": "2.1.0",
+  "license": "MIT",
+  "author": "Ghost Foundation",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/framework.git",
     "directory": "packages/nodemailer"
   },
-  "author": "Ghost Foundation",
-  "license": "MIT",
-  "main": "index.js",
-  "scripts": {
-    "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing vitest run --coverage --config ../../vitest.config.ts",
-    "lint": "eslint . --ext .js --cache",
-    "posttest": "yarn lint"
-  },
   "files": [
     "index.js",
     "lib"
   ],
+  "main": "index.js",
   "publishConfig": {
     "access": "public"
   },
-  "devDependencies": {
-    "sinon": "21.0.2"
-  },
   "dependencies": {
-    "@aws-sdk/client-sesv2": "3.1004.0",
-    "@tryghost/errors": "^3.0.2",
-    "nodemailer": "8.0.1",
+    "@aws-sdk/client-sesv2": "3.1032.0",
+    "nodemailer": "8.0.5",
     "nodemailer-mailgun-transport": "2.1.5",
-    "nodemailer-stub-transport": "1.1.0"
+    "nodemailer-stub-transport": "1.1.0",
+    "@tryghost/errors": "3.1.0"
+  },
+  "devDependencies": {
+    "sinon": "21.1.2"
+  },
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing vitest run --coverage --config ../../vitest.config.ts",
+    "lint": "oxlint -c ../../.oxlintrc.json .",
+    "posttest": "pnpm run lint"
   }
-}
+}