npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2025 – Pkg Stats / Ryan Hefner

feathers-mailer

v4.2.0

Published

Feathers mailer service

Downloads

17,353

Readme

feathers-mailer

Node.js CI Libraries.io dependency status for GitHub repo Download Status

Feathers mailer service using nodemailer

Installation

npm install feathers-mailer --save

If using a transport plugin, install the respective module.

API

import { Service } = from 'feathers-mailer';

app.use('/emails', new Service(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)

import { Service } from "feathers-mailer";
import nodemailer from "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", new Service(transporter, { from: account.user }));

  // Use the service
  const email = {
    to: "president@mars.com",
    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

import { Service } from "feathers-mailer";
import mandrill from "nodemailer-mandrill-transport";

// Register the service, see below for an example
app.use(
  "/mailer",
  new Service(
    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);
  });

Prevent mail to be treated as spam

DKIM to prevent mail to be treated as spam

A more and more appearing 'issue' these days, is that mail sent can be seen as spam. Especially if the 'from address' is not linked to the IP of the sending host. To prevent this, you can use a DKIM record. It does require a DNS mutation on the domain reflecting the 'from address', but it will prevent this. Following these steps you can implement this in node-mailer

  1. Go to https://easydmarc.com/tools/DKIM-record-generator to generate a DKIM record. In the form, enter the domain name (equal to the from address domain), and something to use as a selector e.g. feathersMailer.
  2. Ask a network administrator to publish the record which is generated in the domain.
  3. Ensure the record is active using https://easydmarc.com/tools/dkim-lookup. Once the test passes, continue (it might need time to replicate across the web)
  4. Add the following information to the email constance defined in the example above, so it becomes like this
  const email = {
     to: 'president@mars.com',
     subject: 'SMTP test',
     html: 'This is the email body',
     domainName: 'THE DOMAIN ENTERED FOR THE RECORD (FROM ADDRESS DOMAIN)',
     keySelector: 'THE SELECTOR YOU ENTERED TO GENERATE THE RECORD',
     privateKey: 'THE CONTENT FROM THE `PRIVATE KEY` BUT REPLACE `linebreaks` WITH `\n`'
  };

Important: You must replace the linebreaks of the private key with \n or it won't work.

A use case for this, could be a multitenancy application. There the reply domains would be different, but you might want to send from the local SMTP server of the ISP. You would then make it possible for each tenant to configure the three values in their tenant settings within the application, and dynamically collect it prior to sending the mail.

License

Copyright (c) 2025

Licensed under the MIT license.