Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.
TypeScript i18nextnext-authnextjspostgresqlprismareact-emailt3-stacktailwindcsstrpcturborepotypescriptzod
✨ Add SMTP_DEBUG option for verbose SMTP logging (#2634)
Luke Vella3cefceb716dc
diff --git a/apps/docs/self-hosting/configuration.mdx b/apps/docs/self-hosting/configuration.mdxindex e6252fc8e..5ff787270 100644--- a/apps/docs/self-hosting/configuration.mdx+++ b/apps/docs/self-hosting/configuration.mdx@@ -74,6 +74,14 @@ An SMTP server is required to send magic-link sign-in emails and notifications.<Note>Available from v4.8.0 and later.</Note></ParamField>+<ParamField path="SMTP_DEBUG" default="false">+ Set to `true` to log the full SMTP conversation. Useful for troubleshooting email delivery issues.++ <Warning>Debug output includes the authentication exchange, where credentials are only base64 encoded. Enable this only while troubleshooting and redact your logs before sharing them.</Warning>++ <Note>Available from v4.12.0 and later.</Note>+</ParamField>+## Auth<ParamField path="EMAIL_LOGIN_ENABLED" default="true">diff --git a/apps/web/src/env.ts b/apps/web/src/env.tsindex c539449b3..61114d6bc 100644--- a/apps/web/src/env.ts+++ b/apps/web/src/env.ts@@ -45,6 +45,7 @@ export const env = createEnv({SMTP_SECURE: z.enum(["true", "false"]).optional(),SMTP_PORT: z.string().optional(),SMTP_REJECT_UNAUTHORIZED: z.enum(["true", "false"]).optional(),+ SMTP_DEBUG: z.enum(["true", "false"]).optional(),/** @deprecated Use SMTP_REJECT_UNAUTHORIZED instead */SMTP_TLS_ENABLED: z.enum(["true", "false"]).optional(),/**@@ -237,6 +238,7 @@ export const env = createEnv({SMTP_SECURE: process.env.SMTP_SECURE,SMTP_PORT: process.env.SMTP_PORT,SMTP_REJECT_UNAUTHORIZED: process.env.SMTP_REJECT_UNAUTHORIZED,+ SMTP_DEBUG: process.env.SMTP_DEBUG,SMTP_TLS_ENABLED: process.env.SMTP_TLS_ENABLED,ALLOWED_EMAILS: process.env.ALLOWED_EMAILS,EMAIL_LOGIN_ENABLED: process.env.EMAIL_LOGIN_ENABLED,diff --git a/packages/emails/src/transport.ts b/packages/emails/src/transport.tsindex 9520bbb9f..5b7afe0f9 100644--- a/packages/emails/src/transport.ts+++ b/packages/emails/src/transport.ts@@ -1,10 +1,28 @@import * as aws from "@aws-sdk/client-ses";import { defaultProvider } from "@aws-sdk/credential-provider-node";+import { logger } from "@rallly/logger";import type { Transporter } from "nodemailer";import { createTransport } from "nodemailer";+import type { Logger as NodemailerLogger } from "nodemailer/lib/shared";type EmailProvider = "ses" | "smtp";+// Adapts pino to nodemailer's bunyan-style logger interface. Pino exposes+// `level` as a property while nodemailer's type expects a method (it never+// calls it).+function createSmtpDebugLogger(): NodemailerLogger {+ const smtpLogger = logger.child({ name: "smtp" }, { level: "trace" });+ return {+ level: () => {},+ trace: smtpLogger.trace.bind(smtpLogger),+ debug: smtpLogger.debug.bind(smtpLogger),+ info: smtpLogger.info.bind(smtpLogger),+ warn: smtpLogger.warn.bind(smtpLogger),+ error: smtpLogger.error.bind(smtpLogger),+ fatal: smtpLogger.fatal.bind(smtpLogger),+ };+}+export type SupportedEmailProviders = EmailProvider;let cachedTransport: Transporter | undefined;@@ -40,6 +58,11 @@ function createTransportForProvider(provider: EmailProvider): Transporter {const rejectUnauthorized =process.env.SMTP_REJECT_UNAUTHORIZED !== "false";+ // Logs the full SMTP conversation including the auth exchange, where+ // credentials are only base64 encoded. Never enable outside of+ // troubleshooting.+ const debug = process.env.SMTP_DEBUG === "true";+// Warn about security change if no explicit settingif (process.env.SMTP_REJECT_UNAUTHORIZED === undefined &&@@ -64,6 +87,8 @@ function createTransportForProvider(provider: EmailProvider): Transporter {rejectUnauthorized,servername: process.env.SMTP_TLS_SERVERNAME,},+ debug,+ logger: debug ? createSmtpDebugLogger() : undefined,});}}