Skip to content

A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.

TypeScript fluxerfluxerapp

feat(email): send html, attachments, unsubscribe and bulk smtp

Hampusabdf0886292f
diff --git a/fluxer_api/pkgs/email/src/EmailProviderTypes.ts b/fluxer_api/pkgs/email/src/EmailProviderTypes.ts
index fe8e1079a..e9c9bc5e8 100644
--- a/fluxer_api/pkgs/email/src/EmailProviderTypes.ts
+++ b/fluxer_api/pkgs/email/src/EmailProviderTypes.ts
@@ -6,10 +6,16 @@ export interface EmailConfig {
fromName: string;
replyTo?: string | null;
appBaseUrl: string;
+ apiBaseUrl: string;
appealsEmail: string | null;
+ privacyEmail: string | null;
safetyEmail: string | null;
supportEmail: string | null;
productName: string;
+ marketingBaseUrl: string;
+ staticCdnBaseUrl: string;
+ legalAddress: string | null;
+ brandLogo: boolean;
}
export interface EmailMessage {
@@ -21,10 +27,30 @@ export interface EmailMessage {
replyTo?: string;
subject: string;
text: string;
+ html?: string;
+ headers?: Record<string, string>;
+ listUnsubscribe?: EmailListUnsubscribe;
+ attachments?: ReadonlyArray<EmailAttachment>;
+}
+
+export interface EmailAttachment {
+ filename: string;
+ content: Uint8Array;
+ contentType: string;
+}
+
+export interface EmailListUnsubscribe {
+ url: string;
+ post: boolean;
}
export interface IEmailProvider {
sendEmail(message: EmailMessage): Promise<boolean>;
+ openBulk?(): IBulkEmailProvider;
+}
+
+export interface IBulkEmailProvider extends IEmailProvider {
+ close(): Promise<void>;
}
export interface UserBouncedEmailChecker {
diff --git a/fluxer_api/pkgs/email/src/SmtpEmailProvider.test.ts b/fluxer_api/pkgs/email/src/SmtpEmailProvider.test.ts
index fe84c47bc..d37d8f014 100644
--- a/fluxer_api/pkgs/email/src/SmtpEmailProvider.test.ts
+++ b/fluxer_api/pkgs/email/src/SmtpEmailProvider.test.ts
@@ -3,14 +3,26 @@
import {SmtpEmailProvider} from '@pkgs/email/src/SmtpEmailProvider';
import {beforeEach, describe, expect, it, vi} from 'vitest';
-const {createTransport} = vi.hoisted(() => ({createTransport: vi.fn()}));
+const {sendMail, close, createTransport} = vi.hoisted(() => {
+ const sendMail = vi.fn();
+ const close = vi.fn();
+ return {
+ sendMail,
+ close,
+ createTransport: vi.fn((_options: Record<string, unknown>) => ({sendMail, close, verify: vi.fn()})),
+ };
+});
-vi.mock('nodemailer', () => ({default: {createTransport}}));
+vi.mock('nodemailer', () => ({
+ default: {createTransport},
+}));
describe('SmtpEmailProvider', () => {
beforeEach(() => {
- createTransport.mockReset();
- createTransport.mockReturnValue({sendMail: vi.fn(), verify: vi.fn()});
+ createTransport.mockClear();
+ close.mockReset();
+ sendMail.mockReset();
+ sendMail.mockResolvedValue({});
});
it.each([
@@ -26,32 +38,49 @@ describe('SmtpEmailProvider', () => {
expect(createTransport).toHaveBeenCalledWith(expect.objectContaining(expected));
});
- const message = {
- from: {email: '[email protected]', name: 'Example'},
- subject: 'Hi',
- text: 'Body',
- };
+ it('passes the html part, custom headers and a one-click unsubscribe link', async () => {
+ await createProvider().sendEmail({
+ ...MESSAGE,
+ html: '<p>Body</p>',
+ headers: {'X-Entity-Ref-ID': 'ref'},
+ listUnsubscribe: {url: 'https://api.example.com/unsubscribe?token=abc', post: true},
+ });
+ expect(sendMail).toHaveBeenCalledWith({
+ from: 'Fluxer <[email protected]>',
+ subject: 'Subject',
+ text: 'Body',
+ html: '<p>Body</p>',
+ list: {unsubscribe: {url: 'https://api.example.com/unsubscribe?token=abc'}},
+ headers: {'X-Entity-Ref-ID': 'ref', 'List-Unsubscribe-Post': 'List-Unsubscribe=One-Click'},
+ });
+ });
- it('sends the configured headers verbatim', async () => {
- const provider = new SmtpEmailProvider({
- host: 'smtp.example.com',
- port: 587,
- username: 'user',
- password: 'pass',
- headers: {'X-Tracking': '{"enable":0}'},
+ it('leaves out the one-click header when the unsubscribe link does not accept a POST', async () => {
+ await createProvider().sendEmail({
+ ...MESSAGE,
+ listUnsubscribe: {url: 'https://example.com/unsubscribe', post: false},
+ });
+ expect(sendMail.mock.calls[0][0]).toEqual({
+ ...MESSAGE,
+ from: 'Fluxer <[email protected]>',
+ list: {unsubscribe: {url: 'https://example.com/unsubscribe'}},
});
- await provider.sendEmail(message);
- const {sendMail} = createTransport.mock.results[0].value;
- expect(sendMail).toHaveBeenCalledWith(
- expect.objectContaining({headers: {'X-Tracking': {prepared: true, value: '{"enable":0}'}}}),
- );
});
- it('sends no extra headers when none are configured', async () => {
- const provider = new SmtpEmailProvider({host: 'smtp.example.com', port: 587, username: 'user', password: 'pass'});
- await provider.sendEmail(message);
- const {sendMail} = createTransport.mock.results[0].value;
- expect(sendMail.mock.calls[0][0]).not.toHaveProperty('headers');
+ it('opens a pooled transport for bulk sends and closes it', async () => {
+ const bulk = createProvider().openBulk();
+ expect(createTransport).toHaveBeenCalledTimes(2);
+ expect(createTransport.mock.calls[1][0]).toMatchObject({
+ host: 'smtp.example.com',
+ port: 587,
+ auth: {user: 'user', pass: 'pass'},
+ pool: true,
+ maxConnections: 4,
+ maxMessages: 100,
+ });
+ await expect(bulk.sendEmail(MESSAGE)).resolves.toBe(true);
+ await bulk.close();
+ expect(close).toHaveBeenCalledTimes(1);
});
});
diff --git a/fluxer_api/pkgs/email/src/SmtpEmailProvider.ts b/fluxer_api/pkgs/email/src/SmtpEmailProvider.ts
index 8ca32a15f..06d36b99f 100644
--- a/fluxer_api/pkgs/email/src/SmtpEmailProvider.ts
+++ b/fluxer_api/pkgs/email/src/SmtpEmailProvider.ts
@@ -2,7 +2,7 @@
import {resolveSmtpTlsMode, type SmtpTlsMode, SmtpTlsModes} from '@fluxer/constants/src/SmtpConstants';
import {createLogger} from '@fluxer/logger/src/Logger';
-import type {EmailMessage, IEmailProvider} from '@pkgs/email/src/EmailProviderTypes';
+import type {EmailMessage, IBulkEmailProvider} from '@pkgs/email/src/EmailProviderTypes';
import nodemailer, {type Transporter} from 'nodemailer';
const logger = createLogger('@pkgs/email/src/SmtpEmailProvider');
@@ -19,14 +19,19 @@ interface SmtpEmailConfig {
socketTimeoutMs?: number;
}
-export class SmtpEmailProvider implements IEmailProvider {
+const BULK_POOL = {pool: true, maxConnections: 4, maxMessages: 100} as const;
+
+export class SmtpEmailProvider implements IBulkEmailProvider {
private readonly transporter: Transporter;
private readonly host: string;
private readonly port: number;
private readonly tlsMode: SmtpTlsMode;
private readonly headers: Record<string, {prepared: true; value: string}> | undefined;
- constructor(config: SmtpEmailConfig) {
+ constructor(
+ private readonly config: SmtpEmailConfig,
+ pooled = false,
+ ) {
this.host = config.host;
this.port = config.port;
this.tlsMode = resolveSmtpTlsMode(config.tlsMode, config.port);
@@ -41,16 +46,22 @@ export class SmtpEmailProvider implements IEmailProvider {
secure: this.tlsMode === SmtpTlsModes.IMPLICIT,
requireTLS: this.tlsMode === SmtpTlsModes.STARTTLS,
ignoreTLS: this.tlsMode === SmtpTlsModes.NONE,
- auth: {
- user: config.username,
- pass: config.password,
- },
+ ...(config.username || config.password ? {auth: {user: config.username, pass: config.password}} : {}),
connectionTimeout: config.connectionTimeoutMs,
greetingTimeout: config.greetingTimeoutMs,
socketTimeout: config.socketTimeoutMs,
+ ...(pooled ? BULK_POOL : {}),
});
}
+ openBulk(): IBulkEmailProvider {
+ return new SmtpEmailProvider(this.config, true);
+ }
+
+ async close(): Promise<void> {
+ this.transporter.close();
+ }
+
async verify(): Promise<boolean> {
await this.transporter.verify();
return true;
@@ -58,14 +69,7 @@ export class SmtpEmailProvider implements IEmailProvider {
async sendEmail(message: EmailMessage): Promise<boolean> {
try {
- await this.transporter.sendMail({
- to: message.to,
- from: `${message.from.name} <${message.from.email}>`,
- ...(message.replyTo ? {replyTo: message.replyTo} : {}),
- ...(this.headers ? {headers: this.headers} : {}),
- subject: message.subject,
- text: message.text,
- });
+ await this.deliver(message);
logger.debug({to: message.to}, 'Email sent via SMTP');
return true;
} catch (error) {
@@ -73,4 +77,36 @@ export class SmtpEmailProvider implements IEmailProvider {
return false;
}
}
+
+ async sendTestEmail(message: EmailMessage): Promise<string> {
+ return await this.deliver(message);
+ }
+
+ private async deliver(message: EmailMessage): Promise<string> {
+ const headers = {
+ ...this.headers,
+ ...message.headers,
+ ...(message.listUnsubscribe?.post ? {'List-Unsubscribe-Post': 'List-Unsubscribe=One-Click'} : {}),
+ };
+ const info: {response?: unknown} = await this.transporter.sendMail({
+ to: message.to,
+ from: `${message.from.name} <${message.from.email}>`,
+ ...(message.replyTo ? {replyTo: message.replyTo} : {}),
+ subject: message.subject,
+ text: message.text,
+ ...(message.html ? {html: message.html} : {}),
+ ...(message.listUnsubscribe ? {list: {unsubscribe: {url: message.listUnsubscribe.url}}} : {}),
+ ...(Object.keys(headers).length > 0 ? {headers} : {}),
+ ...(message.attachments?.length
+ ? {
+ attachments: message.attachments.map((attachment) => ({
+ filename: attachment.filename,
+ content: Buffer.from(attachment.content),
+ contentType: attachment.contentType,
+ })),
+ }
+ : {}),
+ });
+ return typeof info?.response === 'string' ? info.response : '';
+ }
}