https://github.com/wefixers/mail
Extraterrestrial efficiency in email transmission!
https://github.com/wefixers/mail
aws-ses email mail mailgun nodemailer
Last synced: 3 months ago
JSON representation
Extraterrestrial efficiency in email transmission!
- Host: GitHub
- URL: https://github.com/wefixers/mail
- Owner: wefixers
- License: mit
- Created: 2023-05-30T10:46:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-07T07:32:10.000Z (almost 2 years ago)
- Last Synced: 2025-01-22T22:31:02.652Z (4 months ago)
- Topics: aws-ses, email, mail, mailgun, nodemailer
- Language: TypeScript
- Homepage:
- Size: 154 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Node mailer
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
A tiny wrapper around nodemailer, no dependencies!
_Who am I kiddin, nodemailer is the dependency!_
- [✨ Release Notes](/CHANGELOG.md)
- [Install](#install)
- [Usage](#usage)
- [Configure using nodemailer](#configure-using-nodemailer)
- [With custom mailers](#with-custom-mailers)
- [Caveats](#caveats)
> Starting from v1.3, only Node18 and above are supported
> This package is ESM only!
## Install
```sh
pnpm i @fixers/mail
```
```sh
npm install @fixers/mail
```
## Usage
> Make sure to add any optional dependency!
```sh
pnpm add @aws-sdk/client-ses
pnpm add nodemailer-mailgun-transport
```
```ts
import { createMailer } from '@fixers/mail'
import { mailgun } from '@fixers/mail/mailers/mailgun'
import { ses } from '@fixers/mail/mailers/ses'
const mailer = createMailer({
default: 'mailgun',
mailers: {
mailgun: mailgun({
domain: process.env.MAILGUN_DOMAIN,
secret: process.env.MAILGUN_API_KEY
}),
ses: ses()
}
})
// it uses 'mailgun', the default mailer
await mailer.sendMail({ })
// with 'ses'
await mailer.sendMailWith('ses', { })
```
### Configure using nodemailer
If you prefer to configure nodemailer by yourself:
```ts
import { createMailer } from '@fixers/mail'
import { createTransport } from 'nodemailer'
import mg from 'nodemailer-mailgun-transport'
const mailer = createMailer({
default: 'mailgun',
mailers: {
mailtrap: createTransport({
host: process.env.MAIL_HOST,
port: process.env.MAIL_PORT,
auth: {
user: process.env.MAIL_USERNAME,
pass: process.env.MAIL_PASSWORD,
},
}),
mailgun: createTransport(mg({
auth: {
domain: env.MAILGUN_DOMAIN,
apiKey: env.MAILGUN_SECRET
}
}))
}
})
```
### With custom mailers
You can also use any mailer-compatible type:
```sh
pnpm add @types/nodemailer -D
```
```ts
import { createMailer } from '@fixers/mail'
import type { SendMailOptions } from 'nodemailer'
const mailer = createMailer({
default: 'custom',
mailers: {
custom: {
async sendMail(mailOptions: SendMailOptions) {
// send an email home!
}
},
// it can be a factory also, promise or not is up to you
customFactory: async () => {
return {
async sendMail(mailOptions: SendMailOptions) {
// send an email home!
}
}
}
}
})
```
## Caveats
- The mailer `default` is mandatory even when only a single mailer is defined, this might change in future
- Typings are loose, you might need to install `@types/nodemailer` to get proper `sendMail` typings, this may change in future as this library could provide some minimal typings that matches nodemailer.
- `@aws-sdk/client-ses` and `nodemailer-mailgun-transport` are optional peer dependency, you need to install them separately.
[npm-version-src]: https://img.shields.io/npm/v/@fixers/mail/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@fixers/mail
[npm-downloads-src]: https://img.shields.io/npm/dm/@fixers/mail.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@fixers/mail
[license-src]: https://img.shields.io/npm/l/@fixers/mail.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@fixers/mail