trebuchet

A node.js module for throwing email around using the Postmark API.

Trebuchet

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

npm install trebuchet
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: __dirname + '/path/to/template/fling.html',
    text: __dirname + '/path/to/template/fling.txt',
    data: {
        foo: 'Bar'
    }
}, function (errresponse) {
    // Win! 
});
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: __dirname + '/path/to/template/fling.html',
    css: __dirname + '/path/to/template/fling.css',
    text: __dirname + '/path/to/template/fling.txt',
    data: {
        foo: 'Bar'
    }
}, function (errresponse) {
    // Win! 
});

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

NOTE: You can also pass a css variable to load a stylesheet that will be inlined using juice.

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: __dirname + '/path/to/template/fire.html',
    text: __dirname + '/path/to/template/fire.txt',
    data: {
        foo: 'Bar',
        name: 'Bubba'
    }
}, function (errresponse) {
    // Loaded! 
});
trebuchet.fire(function (errresponse) {
    // Win! 
});

Trebuchet uses Mustache templates to make sending dynamic HTML and plain-text emails super-duper simple.

NEW: We've added support Juice which allows one to pass a css variable and inline the CSS with the HTML template for email-friendly CSS... KA POW!

An example template:

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

With example data:

{
    greeting: 'Hello World!'
}

Result (without CSS argument):

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

Result (with CSS argument, e.g. "some/path/to/template.css"):

<html>
    <body style="color:yellow;background-color:black;">
        <h1>Hello World!</h1>
    </body>
</html>

Trebuchet also accepts pre-rendered strings and buffers. Simply add the prerendered flag and ommit the data in your options.

var trebuchet = require('trebuchet')('yourapikey');
 
trebuchet.load({
    params: {
        from: 'you@domain.com',
        to: 'someone@domain.com',
        subject: 'Sending email using prerendred texts'
    },
    prerendered: true,
    html: '<h2>This email was rendered externally!</h2>', //alternatively, pass in a buffer 
    text: 'This email was rendered externally!',
}, function (errresponse) {
    // Loaded! 
});
npm test