@stacksjs/email
v0.59.11
Published
The Stacks Email integration. Painlessly create & manage your inboxes, templates, and send emails.
Downloads
205
Maintainers
Readme
Stacks SMS
Stacks Email is driver system for sending Emails.
☘️ Features
- 📦 Send Email
🤖 Usage
bun install -d @stacksjs/email
You 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
Drivers are configured with the following environment variables:
Sendgrid
SENDGRID_API_KEY=SG123
[email protected]
SENDGRID_SENDER_NAME=Sender
Mailgun
MAILGUN_API_KEY=MG123
MAILGUN_DOMAIN=example.com
MAILGUN_USERNAME=username
[email protected]
Mailjet
MAILJET_API_KEY=MJ123
MAILJET_API_SECRET=MJTESTSECRET
[email protected]
Netcore
NETCORE_API_KEY=NC123
[email protected]
Nodemailer
[email protected]
NODEMAILER_HOST=example.com
NODEMAILER_USERNAME=username
NODEMAILER_PASSWORD=password
NODEMAILER_PORT=25
NODEMAILER_SECURE=true
Postmark
POSTMARK_API_KEY=PM123
[email protected]
AWS SES
SES_REGION=US
SES_ACCESS_KEY_ID=testkey123
SES_SECRET_ACCESS_KEY=testaccesskey123
[email protected]
Mandrill
MANDRILL_API_KEY=Ma123
[email protected]
EmailJS
[email protected]
EMAILJS_HOST=example.com
EMAILJS_USERNAME=username
EMAILJS_PASSWORD=password
EMAILJS_PORT=25
EMAILJS_SECURE=true
Learn more in the docs.
🧪 Testing
bun test
📈 Changelog
Please see our releases page for more information on what has changed recently.
🚜 Contributing
Please review the Contributing Guide for details.
🏝 Community
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
🙏🏼 Credits
Many thanks to the following core technologies & people who have contributed to this package:
📄 License
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙