Co-juice-mailer NPM

About

It is simple mailer for compound.js project. It based on nademailer and swig-email-templates npms.

Features

Uses swig, which supports Django-inspired template inheritance.
Uses juice, which takes an HTML file and inlines all the <link rel="stylesheet">s and the <style>s.
Uses swig-dummy-context which gives you the ability to generate dummy context from a template to aid in an email preview tool.
URL rewrite support - you can provide a urlRewriteFn argument to rewrite your links.

Installation

Put the following dependence to your package.json file

"co-juice-mailer":     "latest"

Add this package to "/config/autoload.js" file

And run:

npm install -l

Place "mailer.yml" to your application "config" folder:

development:
  mailer: smtp
  url: "http://localhost:8888"
  from: "no-reply@example.com"
  host: "smtp.gmail.com"
  port: 587
  use_authentication: true
  user: "no-reply@example.com"
  pass: "password"

production:
  mailer: smtp
  url: "http://example.com"
  from: "no-reply@example.com"
  host: "smtp.gmail.com"
  port: 587
  use_authentication: true
  user: "no-reply@example.com"
  pass: "password"

test:
  mailer: test
  url: "http://localhost:8888"
  from: "no-reply@example.com"

Usage

Put you email views into the app/views/ directory with following naming style:

templatename.html

When you want to send email, just call

mailer = require( 'co-juice-mailer' );
callback = function(err, success){
    if( success ){
        console.log('email was sent')
    } else {
        console.log('Error: ' + err)
    }
};
mailer.sendEmail( 'relative_path/templatename', {name: 'my var for template context'},
    {subject: 'Email subject', email: 'recipient@example.com', from: 'me@home'}, callback)

The following variables will be available in the email template context: