README.md

NOTICE:

Wildbit (operators of postmarkapp.com) currently maintains the Postmark.js module. Please head over there for the most up to date version.

Postmark.js

Send emails with the greatest of ease! Now your node.js application can send emails through Postmark.

Install

Installing postmark is super simple:

npm install postmark

Sending an Email:

To send your first email, all you need to do is:

var postmark = require("postmark");
var client = new postmark.Client("<server key>");

client.sendEmail({
    "From": "[email protected]", 
    "To": "[email protected]", 
    "Subject": "Test", 
    "TextBody": "Test Message"
});

Replace with the server key provided by Postmark and you are good to go!

Your message must be provided in the format specified in the Postmark API and will be verified. The member names of message payloads are case-sensitive, and messages not matching the documented format will not be accepted by the API.

All client methods accept a callback as the their last parameter, following the normal node.js callback convention:

callback(error, result){...} 

To send attachments with the email, use the following format may be used:

var postmark = require("postmark");
var client = new postmark.Client("<server key>");

client.sendEmail({
    "From": "[email protected]", 
    "To": "[email protected]", 
    "Subject": "Test", 
    "TextBody": "Test Message",
    "Attachments": [{
      "Content": File.readFileSync("./unicorns.jpg").toString('base64'),
      "Name": "PrettyUnicorn.jpg",
      "ContentType": "image/jpeg"
    }]
}, function(error, success) {
    if(error) {
        console.error("Unable to send via postmark: " + error.message);
        return;
    }
    console.info("Sent to postmark for delivery")
});

Sending a Batch of Messages

The Postmark API provides functionality for sending batches of emails with a single command, rather than issuing separate API calls for each message. You may access this feature by calling Client.sendEmailBatch(...), which behaves similarly to postmark.sendEmail(...) except that the first parameter is an array of messages formatted in the same manner as outlined above:

For example:

var postmark = require("postmark");
var client = new postmark.Client("<server key>");

var messages = [
    {
        "From": "[email protected]",
        "To": "[email protected]",
        "Subject": "Message #1",
        "TextBody": "This is email number 1."
    },
    {
        "From": "[email protected]",
        "To": "[email protected]",
        "Subject": "Message #2",
        "TextBody": "This is email number 2."
    }
];

postmark.sendEmailBatch(messages, function (error, batchResults) {
    if (error) {
        console.error("Unable to send via postmark: " + error.message);
        return;
    }
    console.info("Messages sent to postmark");
});

The Postmark API will return an array of statuses, one for each message sent. You may iterate over the batchResults for information about each sent message. For further details, please see the Postmark Batch API.