@drop-in/new/packages/beeper/src/beeper.ts

A SvelteKit Svelte 5 PocketBase Starter Kit with a CLI

// This is beeper.
// It's a wrapper around nodemailer that makes it easier to send emails.
// Why a wrapper? Well, we want to use the same config for nodemailer as we do for the rest of the app.
// Also if you don't have the config, it just outputs to the console. Which is nice for getting up and running. Meteor did this and I liked it.

// I'm having to do this import to get the config d.ts file to work so that way we get access to the global.drop_in_config object types. If you know a better way to do this, please let me know.
// I'm sure you could do it, but I spent hours on it and got frustrated.
import '@drop-in/plugin/global';
import nodemailer from 'nodemailer';

// The beeper class could be used if you want, but you are probably better off just using nodemailer directly at that point. Use beeper instance to send emails configured with global.drop_in_config.email
export class Beeper {
	transporter: nodemailer.Transporter | undefined;
	from: string | undefined;
	constructor({
		host,
		port,
		secure,
		auth,
		from,
	}:
		| {
				host?: string;
				port?: number;
				secure?: boolean;
				auth?: { user: string; pass: string };
				from?: string;
		  }
		| undefined = {}) {
		if (host) {
			this.transporter = nodemailer.createTransport({
				host,
				port,
				secure,
				auth,
			});
		} else if (global.drop_in_config.email) {
			this.transporter = nodemailer.createTransport(global.drop_in_config.email);
		}
		this.from = from;
	}
	async send({
		to,
		subject,
		html,
		from = this.from,
	}: {
		to?: string;
		subject?: string;
		html?: string;
		from?: string;
	} = {}) {
		if (this.transporter) {
			await this.transporter.sendMail({
				from,
				to,
				subject,
				html,
			});
		} else {
			console.log('Sending email', to, subject, html, from);
		}
	}
}

// This is the beeper that's configured in the global config file.
export const beeper = new Beeper(global.drop_in_config.email);