Trebuchet
Let's chuck some email!
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.
Installation
npm install trebuchetBasic Use (Fling Pattern)
var trebuchet = require('trebuchet')('yourapikey');
trebuchet.fling({
params: {
from: '[email protected]',
to: '[email protected]',
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 (err, response) {
// Win!
});Basic Use (Fling Pattern with HTML friendly inlined-CSS support)
var trebuchet = require('trebuchet')('yourapikey');
trebuchet.fling({
params: {
from: '[email protected]',
to: '[email protected]',
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 (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).
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: '[email protected]',
to: '[email protected]',
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 (err, response) {
// Loaded!
});trebuchet.fire(function (err, response) {
// Win!
});Templating
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>Pre-rendered content
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: '[email protected]',
to: '[email protected]',
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 (err, response) {
// Loaded!
});Testing
npm test
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent