snailmail

Render mustache html templates into SES emails

Usage

/**
./templates/default.html

<p>Hello {{name}}</p>
**/

const Mailer = require('snailmail');

// configure mailer instance
const mailer = Mailer({
  templateDir: __dirname + '/emails',
  from: '[email protected]',
  key: 'AKIAXXXXXXXXXXXXXXXX',
  secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxx',
  region: 'eu-west-1'
});

// send an email
mail.send({
  template: 'default'
  to: '[email protected]',
  subject: 'Test email',
  data: {
    name: 'Alice'
  }
}).then(() => console.log(`Message sent!`));

Mailer options

• templateDir - a path to the directory where email templates are found
• from - the sender/reply address for your emails
• key - AWS accessKeyId for your SES account
• secret - AWS secretAccessKey for your SES account
• region - AWS region for your SES account
• replyTo - (optional) - the value of the reply-to header of your email if distinct to the from address - Default undefined
• ext - (optional) - the file extension of your email templates - Default .html
• layout - (optional) - the path to a standard layout file to use for your email templates
• attachments - (optional) - a map of files to include as attachments on all emails

Message options

• to - the recipient address
• template - the template used to render the message body. Should match the extensionless filename of one of the templates in your template directory
• subject - the subject line of your message. This will also be passed through mustache.render, so can contain dynamic content
• data - any dynamic data to be rendered into the subject or body of your message
• attachments - (optional) - a map of files to include as attachments for this email

Layouts

By default your message templates will be sent exactly as they are defined in the template file. However, if you want to wrap your messages in a standard header/footer then you can define a layout file for your emailer instance.

Your layout will be passed a partial template message which it should include - as per the following example:

layout.html

<header>
  <h1>My header content</h1>
</header>
{{>message}}
<footer>
  <p>My footer content</p>
</footer>

const mailer = Mailer({
  templateDir: __dirname + '/emails',
  layout: __dirname + '/layout.html',
  // ...
});

Attachments

Attachments should be defined as a map of content ids and filenames.

const mailer = Mailer({
  // ...
  attachments: {
    myfile: '/path/to/my/file.png',
    myotherfile: '/path/to/my/other/file.png'
  }
});

An attachment included on the options passed to send will overwrite a default attachment if it has the same content id.

Embedded images

Images can be embeded in your emails by giving a src attribute of cid:<attachmentId>, where the id corresponds to the content id of one of your attachments.

<img src="cid:header" width="100" height="20" />

mailer.send({
  to: '[email protected]',
  subject: 'Important message',
  attachments: {
    header: '/path/to/my/file.png'
  }
});