email-templates

email-templates

Create, preview, and send custom email templates for Node.js. Highly configurable and supports automatic inline CSS, stylesheets, embedded images and fonts, and much more! Made for sending beautiful emails with Lad.

NEW: v3.0.0 is released! See the 2.x branch documentation if you're using an older version

Table of Contents

• Install
• Preview
• Usage
  • Basic
  • Cache Pug Templates
  • Localization
  • Custom Text Template
  • Custom Template Engine (e.g. EJS)
  • Custom Default Message Options
  • Custom Rendering (e.g. from a MongoDB database)
• Options
• Plugins
• Tip
• Contributors
• License

Install

By default we recommend pug for your template engine, but you can use any template engine.

npm:

npm install email-templates pug

yarn:

yarn add email-templates pug

Preview

We've added preview-email by default to this package!

This means that (by default) in the development environment (e.g. NODE_ENV=development) your emails will be rendered to the tmp directory for you and automatically opened in the browser.

View the demo

Usage

Basic

You can swap the transport option with a Nodemailer transport configuration object or transport instance. We highly recommend using Postmark for your transport (it's the default in Lad).

const Email = require('email-templates');

const email = new Email({
  message: {
    from: '[e-mail]'
  },
  transport: {
    jsonTransport: true
  }
});

email.send({
  template: 'mars',
  message: {
    to: '[e-mail]'
  },
  locals: {
    name: 'Elon'
  }
}).then(console.log).catch(console.error);

The example above assumes you have the following directory structure:

.
├── app.js
└── emails
    └── mars
        ├── html.pug
        └── subject.pug

And the contents of the pug files are:

html.pug:

p Hi #{name},
p Welcome to Mars, the red planet.

subject.pug:

= `Hi ${name}, welcome to Mars`

Cache Pug Templates

We strongly suggest to follow this example and pre-cache your templates with cache-pug-templates (if you're using the default Pug template engine).

If you do not do this, then your Pug templates will re-compile and re-cache every time you deploy new code and restart your app.

• Ensure you have Redis (v4.x+) installed:

  • Mac: brew install redis && brew services start redis

  • Ubuntu:

    sudo add-apt-repository -y ppa:chris-lea/redis-server
    sudo apt-get update
    sudo apt-get -y install redis-server
    

• Install the packages:

  npm:

  npm install cache-pug-templates redis
  

  yarn:

  yarn add cache-pug-templates redis
  

• Configure it to read and cache your entire email templates directory:

  const path = require('path');
  const cachePugTemplates = require('cache-pug-templates');
  const redis = require('redis');
  const Email = require('email-templates');
  
  const redisClient = redis.createClient();
  const email = new Email({
    message: {
      from: '[e-mail]'
    },
    transport: {
      jsonTransport: true
    }
  });
  
  cachePugTemplates(redisClient, email.config.views.root);
  
  // ...
  

• For more configuration options see cache-pug-templates.

Localization

All you need to do is simply pass an i18n configuration object as config.i18n (or an empty one as this example shows to use defaults).

const Email = require('email-templates');

const email = new Email({
  message: {
    from: '[e-mail]'
  },
  transport: {
    jsonTransport: true
  },
  i18n: {} // <------ HERE
});

email.send({
  template: 'mars',
  message: {
    to: '[e-mail]'
  },
  locals: {
    name: 'Elon'
  }
}).then(console.log).catch(console.error);

Then slightly modify your templates to use localization functions.

html.pug:

p= t(`Hi ${name},`)
p= t('Welcome to Mars, the red planet.')

subject.pug:

= t(`Hi ${name}, welcome to Mars`)

Note that if you use Lad, you have a built-in filter called translate:

p: :translate(locale) Hi #{name}
p: :translate(locale) Welcome to Mars, the red planet.

Custom Text Template

By default we use html-to-text to generate a plaintext version and attach it as message.text.

If you'd like to customize the text body, you can pass message.text or set config.htmlToText: false (doing so will automatically lookup a text template file just like it normally would for html and subject).

const Email = require('email-templates');

const email = new Email({
  message: {
    from: '[e-mail]'
  },
  transport: {
    jsonTransport: true
  },
  htmlToText: false // <----- HERE
});

email.send({
  template: 'mars',
  message: {
    to: '[e-mail]'
  },
  locals: {
    name: 'Elon'
  }
}).then(console.log).catch(console.error);

text.pug:

| Hi #{name},
| Welcome to Mars, the red planet.

Custom Template Engine (e.g. EJS)

• Install your desired template engine (e.g. EJS)

  npm:

  npm install ejs
  

  yarn:

  yarn add ejs
  

• Set the extension in options and send an email

  const Email = require('email-templates');
  
  const email = new Email({
    message: {
      from: '[e-mail]'
    },
    transport: {
      jsonTransport: true
    },
    views: {
      options: {
        extension: 'ejs' // <---- HERE
      }
    }
  });
  

Custom Default Message Options

You can configure your Email instance to have default message options, such as a default "From", an unsubscribe header, etc.

For a list of all available message options and fields see the Nodemailer mesage reference.

Here's an example showing how to set a default custom header and a list unsubscribe header:

const Email = require('email-templates');

const email = new Email({
  message: {
    from: '[e-mail]',
    headers: {
      'X-Some-Custom-Thing': 'Some-Value'
    },
    list: {
      unsubscribe: 'https://niftylettuce.com/unsubscribe'
    }
  },
  transport: {
    jsonTransport: true
  }
});

Custom Rendering (e.g. from a MongoDB database)

You can pass a custom config.render function which accepts two arguments view and locals and must return a Promise.

If you wanted to read a stored EJS template from MongoDB, you could do something like:

const ejs = require('ejs');

const email = new Email({
  // ...
  render: (view, locals) => {
    return new Promise((resolve, reject) => {
      // this example assumes that `template` returned
      // is an ejs-based template string
      db.templates.findOne({ view }, (err, template) => {
        if (err) return reject(err);
        if (!template) return reject(new Error('Template not found'));
        resolve(ejs.render(template, locals));
      });
    });
  }
});

Options

For a list of all available options and defaults view the configuration object.

Plugins

You can use any nodemailer plugin. Simply pass an existing transport instance as config.transport.

You should add the nodemailer-base64-to-s3 plugin to convert base64 inline images to actual images stored on Amazon S3 and Cloudfront.

We also highly recommend to add to your default config.locals the following:

• custom-fonts-in-emails - render any font in emails as an image w/retina support (no more Photoshop or Sketch exports!)
• font-awesome-assets - render any Font Awesome icon as an image in an email w/retina support (no more Photoshop or Sketch exports!)

Tip

Instead of having to configure this for yourself, you could just use Lad instead.

Contributors

Name	Website
Nick Baugh	http://niftylettuce.com

License

MIT © Nick Baugh