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

pug-mailer

v1.0.1

Published

Send HTML emails with SMTP & Mailgun using PugJS templates.

Downloads

60

Readme

Pug Mailer

Send HTML emails with SMTP & Mailgun using PugJS template files.

Installation

Using npm:

$ npm install pug-mailer --save

Using yarn:

$ yarn add pug-mailer

Usage

// Load the module.
const mailer = require('pug-mailer')

// Initiate the module and create transporter.
// Note: `pug-mailer` is based on `nodemailer` module,
//       for more details about transporters and configuration
//       please visit: https://nodemailer.com/
mailer.init({
  /* transporter SMTP options */
})

// Send an email.
// Note: `pug-mailer` is based on `nodemailer` module,
//       for more details about messages options
//       please visit: https://nodemailer.com/
mailer.send({
  /* mail options */
})

Examples

Using Mailtrap:

const mailer = require('pug-mailer')

mailer.init({
  service: 'Mailtrap',
  auth: {
    user: 'MAILTRAP_SMTP_USERNAME',
    pass: 'MAILTRAP_SMTP_PASSWORD'
  }
})

mailer.send({
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Foo Bar',

  // Name of the PugJS template file.
  // PugJS template files should be located at: process.cwd() + '/mails/templates/'
  template: 'foo' // The `.pug` extension is appended automatically.

  // You may also pass the full path to the PugJS template file.
  template: '/full/path/to/foo.pug' // The `.pug` extension is required here.

  // Data to be sent to PugJS template files.
  data: {
    //
  }
})
.then(response => console.log('Message sent!'))
.catch(err => console.log('Something went wrong!'))

Using Mailgun:

const mailer = require('pug-mailer')

mailer.init({
  service: 'Mailgun',
  auth: {
    user: 'MAILGUN_SMTP_USERNAME',
    pass: 'MAILGUN_SMTP_PASSWORD'
  }
})

mailer.send({
  from: '[email protected]',
  to: '[email protected]',
  subject: 'Foo Bar',
  template: 'foo',
  data: {
    foo: 'bar'
  }
})
.then(response => console.log('Message sent!'))
.catch(err => console.log('Something went wrong!'))

Template Files

You should be already familiar with PugJS previously known as Jade, but if not, read their awesome documentation. PugJS template files are the best and the fastest way to write HTML code.

pug-mailer compiles the PugJS template files with given data and then sends emails using the defined nodemailer transporter.

Template files should be locaded at: process.cwd() + '/mails/templates/' by default, but you may also pass full paths to template files and they will be loaded from your path.

License

The MIT License (MIT)

Copyright (c) 2017 Ion Suman [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.