Installations

npm install feathers-mailer

Pull Requests

Open

1

Total

28

Closed

3

Merged

24

Issues

Open

1

Total

8

Closed

7

Releases

3

v4.1.1

Published on 02 Jun 2023

v4.1.0

Published on 02 Jun 2023

v4.0.0

Published on 29 Mar 2023

View all 3 releases

Developer

feathersjs-ecosystem

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>= 16

Typescript Support

Yes

Node Version

16.13.0

NPM Version

8.2.0 Statistics

83 Stars

60 Commits

16 Forks

6 Watching

1 Branches

16 Contributors

Updated on 25 May 2024

Bundle Size

209.90 kB

Minified

56.89 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (52.43%)

JavaScript (47.57%)

Total Downloads

Cumulative downloads

Total Downloads

1,526,564

Last day

-53.4%

348

Compared to previous day

Last week

-15.3%

3,415

Compared to previous week

Last month

-13.2%

16,900

Compared to previous month

Last year

-47.3%

212,732

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

2

debug nodemailer

Dev Dependencies

17

@types/debug @types/mocha @types/node @types/nodemailer @types/nodemailer-stub-transport @typescript-eslint/eslint-plugin @typescript-eslint/parser address-rfc2822 cross-env eslint mocha nodemailer-stub-transport npm-check-updates nyc shx ts-node typescript

Versions

feathers-mailer

Feathers mailer service using nodemailer

Installation

1npm install feathers-mailer --save

If using a transport plugin, install the respective module.

API

1const mailer = require('feathers-mailer');

`app.use('/emails', mailer(transport, defaults))`

transport can be either SMTP options or a transport plugin 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, accepting body and returning a promise.

See here for possible fields of body.

Example with SMTP (ethereal)

1const mailer = require('feathers-mailer');
2const nodemailer = require('nodemailer');
3
4(async function (app) {
5  const account = await nodemailer.createTestAccount(); // internet required
6
7  const transporter = {
8    host: account.smtp.host,
9    port: account.smtp.port,
10    secure: account.smtp.secure, // 487 only
11    requireTLS: true,
12    auth: {
13      user: account.user, // generated ethereal user
14      pass: account.pass // generated ethereal password
15    }
16  };
17
18  // Register service and setting default From Email
19  app.use('mailer', mailer(transporter, { from: account.user }));
20
21  // Use the service
22  const email = {
23     to: 'president@mars.com',
24     subject: 'SMTP test',
25     html: 'This is the email body'
26  };
27
28  await app.service('mailer').create(email)
29  console.log(`Preview URL: ${nodemailer.getTestMessageUrl(info)}`)
30})(app)

Example with Mandrill

1const mailer = require('feathers-mailer');
2const mandrill = require('nodemailer-mandrill-transport');
3
4// Register the service, see below for an example
5app.use('/mailer', mailer(mandrill({
6  auth: {
7    apiKey: process.env.MANDRILL_API_KEY
8  }
9})));
10
11// Use the service
12const email = {
13   from: 'FROM_EMAIL',
14   to: 'TO_EMAIL',
15   subject: 'Mandrill test',
16   html: 'This is the email body'
17};
18
19app.service('mailer').create(email).then(function (result) {
20  console.log('Sent email', result);
21}).catch(err => {
22  console.log(err);
23});

License

Licensed under the MIT license.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.9

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More