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 🙏

© 2024 – Pkg Stats / Ryan Hefner

nodemailer-stub

v1.2.2

Published

Stub transport for Nodemailer. Testing your mails in Node.js is now easy.

Downloads

1,753

Readme

nodemailer-stub

Build Status Coverage Status npm GitHub release

Nodemailer-stub comes with a stub transport for Nodemailer. The Stub stores the messages in memory but mimics real mail behaviour. It also contains a smart testing class called InteractsWithMail, which allows users to access, read, count and flush the messages in memory in their testing environment.

Installation

$ yarn add nodemailer-stub -D
#... or via npm
$ npm install nodemailer-stub --save-dev

Usage

This is an example use case for the Stub.

import { stubTransport } from 'nodemailer-stub'
import nodeMailer from 'nodemailer'

let transport = nodeMailer.createTransport(stubTransport)

let mail = await transport.sendMail({
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Nodemailer stub works!',
  text: 'Wohoo'
})

For testing purposes, there is also a transport called errorTransport, where the transport throws an error during execution, to help with testing the robustness of your mail service logic.

We've also included a testing utility class, called interactsWithMail. You can use it in your tests like this:

import { interactsWithMail as iwm } from 'nodemailer-stub'

const exampleMail = {
  to: '[email protected]',
  from: '[email protected]',
  subject: 'testing',
  content: 'foo',
  contents: ['foo'],
  contentType: 'text/plain'
}

test('it retrieves the last message', () => {
  iwm.newMail(exampleMail)

  let lastMail = iwm.lastMail()

  lastMail.to.should.eq('[email protected]')
  lastMail.from.should.eq('[email protected]')
  lastMail.subject.should.eq('testing')
  lastMail.content.should.eq(['foo'])
  lastMail.contents.should.eq(['foo'])
  lastMail.contentType.should.eq('text/plain')
})

Available methods for interactsWithMail:

lastMail()

Retrieves last mail. Accessible properties:

  • from
  • to
  • subject
  • content
  • contents
  • contentType

newMail (Object)

Adds a new mail to the list of all mails.

Available properties:

  • from (required)
  • to (required)
  • subject
  • text (required)

flushMails ()

Flushes all messages. Useful when testing multiple occurrences of mailer, and should be used in afterAll or afterEach hooks in your tests.

sentMailsCount ()

Retrieves a count of how many emails were sent in the last mailer call.

Testing

All tests can be executed with the following command:

$ yarn test

License

See LICENSE file.