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

mailgun-mailer

v2.2.0

Published

NodeJS module for use with Mailgun API

Downloads

23

Readme

mailer

Node scripts for using Mailgun.

mailer.js exports as a module with functions to send each type of e-mail.

Messages can be formatted as HTML within in the html parameter of each form.

Installation

npm install mailgun-mailer

Functions

setApiKey: Set the API key

setDomain: Set the domain (ie. fusiform.co)

setAddress: Set the from address (ie. [email protected])

sendMail: Send an email based on a specified HTML template (for newsletters, password reset notifications, etc.)

Parameters:

  • name - string - name of recipient
  • toAddress - string - recipient's email address
  • subject - string - subject of email
  • templateFile - string - path to HTML template of file

sendLink: Send an email with a custom link (for email verification, password reset, etc.)

Parameters:

  • name - string - name of recipient
  • toAddress - string - recipient's email address
  • subject - string - subject of email
  • templateFile - string - path to HTML template of file
  • link - string - link to insert into email template

sendReplace: Send an email and specify parameters to replace (for email verification, password reset, etc.)

Parameters:

  • name - string - name of recipient
  • toAddress - string - recipient's email address
  • subject - string - subject of email
  • templateFile - string - path to HTML template of file
  • toReplace - JSON - key-value pairs for strings to replace

Other functions

setAddress: Set the from address (ie. [email protected])

welcome: Send "Welcome" email

verifyEmail: Send verification email for new account

passReset: Send password reset link and instructions

passChanged: Send notification that password was changed

tfaReset: Send link and instructions to reset TFA settings

Example

var cred = {
  'key': 'key-00001234',
  'domain': 'sandbox1234.mailgun.org',
  'address': '[email protected]'
};

//Whether or not to print debug messages
var debug = false;

var mailer = require('mailgun-mailer')(cred, debug);

mailer.sendLink('Pranav', '[email protected]', 'Welcome to FusiformCAST!', 'path/to/template/', 'www.verification_link.com/00001234');