Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feathersjs-ecosystem/feathers-mailer
Feathers mailer service using nodemailer
https://github.com/feathersjs-ecosystem/feathers-mailer
feathersjs mailgun sendgrid smtp
Last synced: 3 months ago
JSON representation
Feathers mailer service using nodemailer
- Host: GitHub
- URL: https://github.com/feathersjs-ecosystem/feathers-mailer
- Owner: feathersjs-ecosystem
- License: mit
- Created: 2016-02-28T21:56:08.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-20T19:39:50.000Z (about 1 year ago)
- Last Synced: 2024-07-12T05:32:42.983Z (4 months ago)
- Topics: feathersjs, mailgun, sendgrid, smtp
- Language: TypeScript
- Homepage:
- Size: 894 KB
- Stars: 83
- Watchers: 6
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - feathers-mailer - Feathers mailer service using nodemailer (service) (Plugins / Email and SMS)
README
# feathers-mailer
[](https://github.com/feathersjs-ecosystem/feathers-mailer/actions/workflows/node.js.yml)
[](https://david-dm.org/feathersjs-ecosystem/feathers-mailer)
[](https://www.npmjs.com/package/feathers-mailer)
> Feathers mailer service using [`nodemailer`](https://github.com/nodemailer/nodemailer)
## Installation
```shell
npm install feathers-mailer --save
```
If using a [transport plugin](https://nodemailer.com/transports/), install the respective module.
## API
```js
const mailer = require('feathers-mailer');
```
### `app.use('/emails', mailer(transport, defaults))`
- `transport` can be either [SMTP options](https://nodemailer.com/smtp/#general-options) or a [transport plugin](https://nodemailer.com/transports/) with associated options.
- `defaults` is an object that defines default values for mail options.
### `service.create(body, params)`
`service.create` is a thin wrapper for [`transporter.sendMail`](https://nodemailer.com/usage/#sending-mail), accepting `body` and returning a promise.
See [here](https://nodemailer.com/message/#commmon-fields) for possible fields of `body`.
## Example with SMTP (ethereal)
```js
const mailer = require('feathers-mailer');
const nodemailer = require('nodemailer');
(async function (app) {
const account = await nodemailer.createTestAccount(); // internet required
const transporter = {
host: account.smtp.host,
port: account.smtp.port,
secure: account.smtp.secure, // 487 only
requireTLS: true,
auth: {
user: account.user, // generated ethereal user
pass: account.pass // generated ethereal password
}
};
// Register service and setting default From Email
app.use('mailer', mailer(transporter, { from: account.user }));
// Use the service
const email = {
to: '[email protected]',
subject: 'SMTP test',
html: 'This is the email body'
};
await app.service('mailer').create(email)
console.log(`Preview URL: ${nodemailer.getTestMessageUrl(info)}`)
})(app)
```
## Example with Mandrill
```js
const mailer = require('feathers-mailer');
const mandrill = require('nodemailer-mandrill-transport');
// Register the service, see below for an example
app.use('/mailer', mailer(mandrill({
auth: {
apiKey: process.env.MANDRILL_API_KEY
}
})));
// Use the service
const email = {
from: 'FROM_EMAIL',
to: 'TO_EMAIL',
subject: 'Mandrill test',
html: 'This is the email body'
};
app.service('mailer').create(email).then(function (result) {
console.log('Sent email', result);
}).catch(err => {
console.log(err);
});
```
## License
Copyright (c) 2018
Licensed under the [MIT license](LICENSE).