README.md

Mailor

This module glues Maildev and MJML with some Pug and Mustache to enable an easier development workflow for mailings on NodeJS.

Get it globally or within your project:

$ npm i -g mailor # or `npm i mailor --save-dev`

Use mailor init to create a templates/ directory with an example.pug ready play with!

Now, you can start creating templates using pure .pug files:

templates/test1.pug

mjml
  Body: Section
    Column: Text
      h1 It works!

Shortcuts for mj-* tags are provided as <Column /> to produce <mj-column /> respectively — those tags supports the class attribute by default while mj-* requires css-class instead.

Build or watch for changes, e.g.

$ mailor watch templates -d generated --no-open

Once built, try sending it through the local SMTP, e.g.

$ mailor send generated/test1.html

Open http://localhost:1081 and see how it looks!

Templating support

By default, e-mail templates are built using .pug files.

However, you can use Mustache, Handlebars or Liquid templates for further rendering, e.g.

mjml
  Body: Section
    Column: Text
      h1 Hello, {{firstName}}!

The example above generates the required HTML for the MJML post-processing, this lefts the {{...}} mustaches without changes.

Now, when you call sendMail(...) you can pass { data: { firstName: 'John' } } and the mustache will be rendered as expected.

Change the post-renderer with Mustache.setEngine('mustache' | 'handlebars' | 'liquidjs') in your code.

LESS.js support

You can pre-process and embed the resulting stylesheet through LESS, e.g.

mjml
  Head
    Style(src='_your_stylesheets.less')

The src attribute used here is non MJML standard, so mj-style won't work the same way — also, if your file is not .less then it'll be embedded without changes.

Including files

By default all files or directories starting with _ are ignored by the compiler, e.g.

mjml
  Head
    include _/header

Live preview

The included live-preview app allows you to watch your generated templates, input variables are extracted directly from your templates so you can test with real data.

You can leverage on the jsonfile option to setup default variables too — notice that on Mustache some values can be objects, arrays or functions.

API

By default maildev is enabled when watch mode is used.

The send command uses nodemailer for sending messages through.

You can, however, reuse this module too:

const nodemailer = require('nodemailer');

const mailer = require('mailor').getMailer({
  transport: nodemailer.createTransport(...),
  internalErrors: [],
});

mailer.sendMail({
  attachments: [{
    filename: `receipt-${receipt.id}.xml`,
    content: receipt.data,
  }],
  headers: {
    'x-mailgun-variables': JSON.stringify({ t: 42 }),
  },
  callback(options) {
    options.headers['x-mailgun-tag'] = 'test';
  },
  template: 'path/to/tpl.html',
  subject: 'Test',
  email: '[email protected]',
  data: { ... },
});

You MUST provide a working transport and optionally a list of internal error messages to be aware of, if any matches an exception will be thrown.

Using input

Local variables are given as data and they're rendered by Mustache to build the message to be sent.

Locals for pug-templates MUST be provided as values during mailor invocation, e.g.

$ mailor build templates -d generated username="John Doe" token="x-f4c8"