feat: support MAIL_SMTP_URL (#12296)

Signed-off-by: Matt Krick <matt.krick@gmail.com>

Author: mattkrick

.env.example

@@ -163,13 +163,21 @@ MAIL_PROVIDER='debug'
 # MAILGUN_DOMAIN='key_MAILGUN_DOMAIN'
 # MAIL_GOOGLE_USER='key_MAIL_GOOGLE_USER'
 # MAIL_GOOGLE_PASS='key_MAIL_GOOGLE_PASS'
+
+# For SMTP, MAIL_SMTP_URL is mutually exclusive to the other env vars with the MAIL_SMTP_ prefix
+# Use it when custom configs are required
+# MAIL_SMTP_URL='smtps://username:password@smtp.example.com/?pool=true&tls.rejectUnauthorized=false'
+
 # MAIL_SMTP_HOST='key_MAIL_SMTP_HOST'
 # MAIL_SMTP_PORT=587
 # MAIL_SMTP_USER='key_MAIL_SMTP_USER'
 # MAIL_SMTP_PASSWORD='key_MAIL_SMTP_PASSWORD'
 # MAIL_SMTP_USE_TLS='1' # set to '0' for false
 # MAIL_SMTP_CIPHERS='HIGH:MEDIUM:!aNULL:!eNULL:@STRENGTH:!DH:!kEDH'
 
+# When true, verifies DNS resolution, TCP handshake, and authentication on server startup
+# MAIL_SMTP_DEBUG=false
+
 # GLOBAL BANNER
 # GLOBAL_BANNER_ENABLED='true'
 # GLOBAL_BANNER_TEXT='UNCLASSIFIED CUI (IL4)'

packages/server/email/MailManagerSMTP.ts

@@ -1,9 +1,36 @@
 import nodemailer from 'nodemailer'
+import {isNotNull} from '../../client/utils/predicates'
 import logError from '../utils/logError'
 import MailManager, {type MailManagerOptions} from './MailManager'
 
-export default class MailManagerSMTP extends MailManager {
-  transport = nodemailer.createTransport({
+const composeConfig = () => {
+  const {
+    MAIL_SMTP_URL,
+    MAIL_SMTP_HOST,
+    MAIL_SMTP_PORT,
+    MAIL_SMTP_USER,
+    MAIL_SMTP_PASSWORD,
+    MAIL_SMTP_USE_TLS,
+    MAIL_SMTP_CIPHERS
+  } = process.env
+  if (MAIL_SMTP_URL) {
+    const oldVars = [
+      MAIL_SMTP_HOST,
+      MAIL_SMTP_PORT,
+      MAIL_SMTP_USER,
+      MAIL_SMTP_PASSWORD,
+      MAIL_SMTP_USE_TLS,
+      MAIL_SMTP_CIPHERS
+    ]
+    const usedOldVars = oldVars.filter(isNotNull)
+    if (usedOldVars.length > 0) {
+      console.warn(
+        `Using MAIL_SMTP_URL. The following ENV Vars are ignored and can be removed: ${usedOldVars.join(', ')}`
+      )
+    }
+    return MAIL_SMTP_URL
+  }
+  return {
     host: process.env.MAIL_SMTP_HOST,
     port: Number(process.env.MAIL_SMTP_PORT) || 0,
     auth: process.env.MAIL_SMTP_USER
@@ -23,7 +50,24 @@ export default class MailManagerSMTP extends MailManager {
             ciphers: process.env.MAIL_SMTP_CIPHERS
           }
         : undefined
-  })
+  }
+}
+
+if (process.env.MAIL_SMTP_DEBUG === 'true') {
+  const verifyTransport = async () => {
+    const manager = new MailManagerSMTP()
+    try {
+      await manager.transport.verify()
+      console.log('SMTP Verification Complete. You may safely remove ENV Var MAIL_SMTP_DEBUG')
+    } catch (err) {
+      console.error('SMTP Verification Failed', err)
+    }
+  }
+  verifyTransport()
+}
+
+export default class MailManagerSMTP extends MailManager {
+  transport = nodemailer.createTransport(composeConfig())
 
   async sendEmail(options: MailManagerOptions) {
     const {subject, body, to, attachments, html} = options

packages/server/package.json

@@ -96,7 +96,6 @@
     "jsdom": "^20.0.0",
     "jsonwebtoken": "^9.0.0",
     "lib0": "^0.2.114",
-    "mailcomposer": "^4.0.1",
     "mailgun.js": "^9.3.0",
     "md-to-adf": "^0.6.4",
     "mime-types": "^2.1.16",
@@ -105,7 +104,7 @@
     "node-env-flag": "0.1.0",
     "node-html-markdown-cloudflare": "^1.3.0",
     "node-html-parser": "^7.0.1",
-    "nodemailer": "^7.0.9",
+    "nodemailer": "^7.0.10",
     "oauth-1.0a": "^2.2.6",
     "object-hash": "^3.0.0",
     "oy-vey": "^0.12.1",