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

templated-mail

v1.0.0

Published

Tool for sending templated mail

Downloads

3

Readme

##Templated email Easy development/support and using email templates.

##Supports for other template engines ###Base usage

var Mailer = require('templated-mail');
var TemplateProvider = require('templated-mail/providers/template/handlebars');

var mailer = new Mailer(new TemplateProvider(), {
  host: 'smtp.example.com',
  secure: true,
  port: 465,
  auth: {
    user: 'login',
    pass: 'AwesomePassword'
  }
});

mailer
  .send({
    from: '[email protected]',
    to: '[email protected]',
    subject: 'Very important'
  }, 'template_name', {foo: 'bar'})
  .then(function(out) {
    // action on success
    // `out` = response of server on your request
    // maybe `out` contains info by error or description some troubles which block sending or receiving message for receiver
  })
  .catch(function(err) {
    // ...
  });

###Setting helpers

var options = {
  helpers: [Math.round] // helper with name `round`
};

var mailer = new Mailer(new TemplateProvider(options), {
  host: 'smtp.example.com',
  secure: true,
  port: 465,
  auth: {
    user: 'login',
    pass: 'AwesomePassword'
  }
});

Function name is name of helper. You can define by named function. If you use ECMAScript 5 or older version you can use some polyfill (or hook) for Function.name property or upgrade nodejs version :)

###Setting templates You can redefine function (setHTMLTemplateGetter and setTextTemplateGetter) for determine location requested template. If function for text template is not defined it will be taken stringified html template (without tags).

By default template path is relative by project "template".

Usage example:

/*
Structure of your paths for templates:
 /
 └─ home
  └─ user
   └─ templates
    └─ ${name}
     └─ ${lang}.html.hbs
 */

var templatePath = '/home/user/templates';
var options = {
  getHTMLtemplate(template) {
    return `${templatePath}/${template.name}/${template.lang}.html.hbs`;
  }
};

var mailer = new Mailer(new TemplateProvider(options), {
  host: 'smtp.example.com',
  secure: true,
  port: 465,
  auth: {
    user: 'login',
    pass: 'AwesomePassword'
  }
});

##Command for test

node index.test.js --host=smtp.example.com [email protected] --password=AwesomePassword [email protected] [email protected]
# or short version
node index.test.js -H smtp.example.com -L [email protected] -P AwesomePassword -T [email protected] -F [email protected]