Package Exports

postmark

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (postmark) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Postmark.js -- Simple Email Sending

Note: This was recently updated to run directly on node.js 0.4.0 so there are no other dependencies. If you were using this before, it should upgrade perfectly fine without any change.

Send emails with the greatest of ease! Now your node.js application can send emails through Postmark using their HTTP API. To send any email, including attachments, all you need to do is this:

    var postmark = require("postmark")("YOURAPIKEY");
    postmark.send({
        "From": "donotreply@example.com", 
        "To": "target@example.us", 
        "Subject": "Test", 
        "TextBody": "Test Message"
    });

Replace YOURAPIKEY with the API key provided by Postmark and you are good to go! Your message must be provided in the format specified in the (Postmark API)[http://developer.postmarkapp.com/developer-build.html#message-format] and will be verified. If you provide the object in a manner not as specified (including case sensitivity), an exception will be thrown. Send takes a callback as the second parameter that indicates success or failure, following the normal node.js callback pattern callback(error, result), if there is an issue with the submission an error object will be returned as the first argument.

To send attachments with the email, use the following format:

    var postmark = require("postmark")("YOURAPIKEY");
    postmark.send({
        "From": "donotreply@example.com", 
        "To": "target@example.us", 
        "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")
    });

Enjoy sending.

Install

  npm install postmark

Special Thanks

Postmark