Stacks Email is driver system for sending Emails.
- 📦 Send Email
bun install -d @stacksjs/emailYou may now use it in your project:
import * as email from '@stacksjs/email'
/* Then choose a driver. E.g for sendgrid */
const notification = email.sendgrid
notification.send(EmailOptions)
interface EmailOptions {
to: string | string[]
subject: string
html: string
from?: string
text?: string
attachments?: AttachmentOptions[]
id?: string
}Drivers are configured with the following environment variables:
SENDGRID_API_KEY=SG123
SENDGRID_FROM=from@example.com
SENDGRID_SENDER_NAME=SenderMAILGUN_API_KEY=MG123
MAILGUN_DOMAIN=example.com
MAILGUN_USERNAME=username
MAILGUN_FROM=from@example.comMAILJET_API_KEY=MJ123
MAILJET_API_SECRET=MJTESTSECRET
MAILJET_FROM_EMAIL=from@example.comNETCORE_API_KEY=NC123
NETCORE_FROM=from@example.comNODEMAILER_FROM_EMAIL=from@example.com
NODEMAILER_HOST=example.com
NODEMAILER_USERNAME=username
NODEMAILER_PASSWORD=password
NODEMAILER_PORT=25
NODEMAILER_SECURE=truePOSTMARK_API_KEY=PM123
POSTMARK_FROM=from@example.comSES_REGION=US
SES_ACCESS_KEY_ID=testkey123
SES_SECRET_ACCESS_KEY=testaccesskey123
SES_FROM=from@example.comMANDRILL_API_KEY=Ma123
MANDRILL_EMAIL=from@example.comEMAILJS_FROM_EMAIL=from@example.com
EMAILJS_HOST=example.com
EMAILJS_USERNAME=username
EMAILJS_PASSWORD=password
EMAILJS_PORT=25
EMAILJS_SECURE=trueLearn more in the docs.
bun testPlease see our releases page for more information on what has changed recently.
Please review the Contributing Guide for details.
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
For casual chit-chat with others using this package:
Join the Stacks Discord Server
Many thanks to the following core technologies & people who have contributed to this package:
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙