Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-13 00:03:33 +10:00
Code Issues Packages Projects Releases Wiki Activity

feat(email): support configurable SMTP service (#1447)

Browse Source
This commit is contained in:
Jordan Labrosse
2024-11-06 11:00:59 +01:00
committed by GitHub
parent 5158584955
commit dcc2ac8a71
4 changed files with 54 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
packages/email/mailer.ts
View File

@ -1,10 +1,56 @@
import type { Transporter } from 'nodemailer';
import { createTransport } from 'nodemailer';
import { ResendTransport } from '@documenso/nodemailer-resend';
import { MailChannelsTransport } from './transports/mailchannels';
const getTransport = () => {
/**
* Creates a Nodemailer transport object for sending emails.
*
* This function uses various environment variables to configure the appropriate
* email transport mechanism. It supports multiple types of email transports,
* including MailChannels, Resend, and different SMTP configurations.
*
* @returns {Transporter} A configured Nodemailer transporter instance.
*
* Supported Transports:
* - **mailchannels**: Uses MailChannelsTransport, requiring:
* - `NEXT_PRIVATE_MAILCHANNELS_API_KEY`: API key for MailChannels
* - `NEXT_PRIVATE_MAILCHANNELS_ENDPOINT`: Endpoint for MailChannels (optional)
* - **resend**: Uses ResendTransport, requiring:
* - `NEXT_PRIVATE_RESEND_API_KEY`: API key for Resend
* - **smtp-api**: Uses a custom SMTP API configuration, requiring:
* - `NEXT_PRIVATE_SMTP_HOST`: The SMTP server host
* - `NEXT_PRIVATE_SMTP_APIKEY`: The API key for SMTP authentication
* - `NEXT_PRIVATE_SMTP_APIKEY_USER`: The username for SMTP authentication (default: 'apikey')
* - **smtp-auth** (default): Uses a standard SMTP configuration, requiring:
* - `NEXT_PRIVATE_SMTP_HOST`: The SMTP server host (default: 'localhost:2500')
* - `NEXT_PRIVATE_SMTP_PORT`: The port to connect to (default: 587)
* - `NEXT_PRIVATE_SMTP_SECURE`: Whether to use SSL/TLS (default: false)
* - `NEXT_PRIVATE_SMTP_UNSAFE_IGNORE_TLS`: Whether to ignore TLS (default: false)
* - `NEXT_PRIVATE_SMTP_USERNAME`: The username for SMTP authentication
* - `NEXT_PRIVATE_SMTP_PASSWORD`: The password for SMTP authentication
* - `NEXT_PRIVATE_SMTP_SERVICE`: The SMTP service provider (e.g., "gmail"). This option is used
* when integrating with well-known services (like Gmail), enabling simplified configuration.
*
* Example Usage:
* ```env
* NEXT_PRIVATE_SMTP_TRANSPORT='smtp-auth';
* NEXT_PRIVATE_SMTP_HOST='smtp.example.com';
* NEXT_PRIVATE_SMTP_PORT=587;
* NEXT_PRIVATE_SMTP_SERVICE='gmail';
* NEXT_PRIVATE_SMTP_SECURE='true';
* NEXT_PRIVATE_SMTP_USERNAME='your-email@gmail.com';
* NEXT_PRIVATE_SMTP_PASSWORD='your-password';
* ```
*
* Notes:
* - Ensure that the required environment variables for each transport type are set.
* - If `NEXT_PRIVATE_SMTP_TRANSPORT` is not specified, the default is `smtp-auth`.
* - `NEXT_PRIVATE_SMTP_SERVICE` is optional and used specifically for well-known services like Gmail.
*/
const getTransport = (): Transporter => {
const transport = process.env.NEXT_PRIVATE_SMTP_TRANSPORT ?? 'smtp-auth';
if (transport === 'mailchannels') {
@ -53,6 +99,9 @@ const getTransport = () => {
pass: process.env.NEXT_PRIVATE_SMTP_PASSWORD ?? '',
}
: undefined,
...(process.env.NEXT_PRIVATE_SMTP_SERVICE
? { service: process.env.NEXT_PRIVATE_SMTP_SERVICE }
: {}),
});
};