Trebuchet

Let's chuck some email!

Trebuchet is a node.js module for super simple email transactions using the Postmark API and Handlebars for templating. Trebuchet was designed with simple email rendering, batching and API operations in mind.

Installation

npm install trebuchet

Basic Use (Fling Pattern)

var trebuchet = require('trebuchet')('yourapikey');

trebuchet.fling({
    params: {
        from: 'you@domain.com',
        to: 'someone@domain.com',
        subject: 'This is only a test of the fling pattern'
    },
    html: 'path/to/template/fling.html',
    text: 'path/to/template/fling.txt',
    data: {
        foo: 'Bar'
    }
}, function (err, response) {
    // Win!
});

Batch Sender (Load --> Fire Pattern)

The batch sender uses the Postmark API's batch method to support sending groups of messages (up to 500 at a time).

var trebuchet = require('trebuchet')('yourapikey');

trebuchet.load({
    params: {
        from: 'you@domain.com',
        to: 'someone@domain.com',
        subject: 'This is only a test of the load/fire pattern'
    },
    html: 'path/to/template/fire.html',
    text: 'path/to/template/fire.txt',
    data: {
        foo: 'Bar',
        name: 'Bubba'
    }
}, function (err, response) {
    // Loaded!
});

trebuchet.fire(function (err, response) {
    // Win!
});

Templating

This fork of Trebuchet uses Handlebars templates to make sending dynamic HTML and plain-text emails super-duper simple.

An example template:

<html>
    <body>
        <h1>{{greeting}}</h1>
    </body>
</html>

With example data:

{
    greeting: 'Hello World!'
}

Result:

<html>
    <body>
        <h1>Hello World!</h1>
    </body>
</html>

Instead of having to pass html and text options every time, you can simply pass a templateName, as long as you have defined a templateDirectory.

var trebuchet = require('trebuchet', { apikey: 'yourapikey', templateDirectory: path.join(__dirname, 'templates') });

trebuchet.fling({
    params: {
        from: 'you@domain.com',
        to: 'someone@domain.com',
        subject: 'This is only a test of template usage'
    },
        // the template property will automatically load and set the following options without you having to manually set them
        // * html: ~/templates/fling-test/index.html
        // * text: ~/templates/fling-test/index.txt
        template: 'fling-test',
        data: {
            foo: 'Bar'
        }
    }, function(err, response) {
        // Template Win!
    });

Testing

node test/index.js --from "you@domain.com" --to "someone@domain.com"

mpa / trebuchet