nodemailer-sparkpost-transport

nodemailer-sparkpost-transport

SparkPost transport for Nodemailer

Usage

Install with npm

npm install nodemailer-sparkpost-transport

Require to your script

var nodemailer = require('nodemailer');
var sparkPostTransport = require('nodemailer-sparkpost-transport');

Create a Nodemailer transport object

var transporter = nodemailer.createTransport(sparkPostTransport(options))

Where

• options defines connection and message data
  • sparkPostApiKey - SparkPost API Key. If not provided, it will use the SPARKPOST_API_KEY env var.
  • campaign_id - Name of the campaign
  • content - Content that will be used to construct a message
  • metadata - Transmission level metadata containing key/value pairs
  • options - JSON object in which transmission options are defined
  • substitution_data - Key/value pairs that are provided to the substitution engine

For more information, see the SparkPost API Documentation for Transmissions

Send a message

transport.sendMail(options, function(err, info) {});

Where

• options defines connection and message data
  • recipients - Inline recipient objects or object containing stored recipient list ID. See SparkPost API Documentation for Recipient Lists for more information.
  • campaign_id - Override for option above
  • content - Override for option above
  • metadata - Override for option above
  • options - Override for option above
  • substitution_data - Override for option above

Example

'use strict';

var nodemailer = require('nodemailer');
var sparkPostTransport = require('nodemailer-sparkpost-transport');

var transporter = nodemailer.createTransport(sparkPostTransport({
  "sparkPostApiKey": "<YOUR_API_KEY>",
  "options": {
    "open_tracking": true,
    "click_tracking": true,
    "transactional": true
  },
  "campaign_id": "Nodemailer Default",
  "metadata": {
    "some_useful_metadata": "testing_sparkpost"
  },
  "substitution_data": {
    "sender": "YOUR NAME",
    "fullName": "YOUR NAME",
    "productName": "The coolest product ever",
    "sparkpostSupportEmail": "[e-mail]",
    "sparkpostSupportPhone": "123-456-7890"
  },
  "content": {
    "template_id": "ADD YOUR TEMPLATE ID HERE"
  }
}));


transporter.sendMail({
  "recipients": [
    {
      "address": {
        "email": "CHANGE TO YOUR TARGET TEST EMAIL",
        "name": "CHANGE TO YOUR RECIPIENT NAME"
      }
    }
  ]
}, function(err, info) {
  if (err) {
    console.error(err);
  } else {
    console.log(info);
  }
});

Changelog

[0.1.2] - 2016/05/17

• #4 Removed dotenv, updated README, and general cleanup. Closes #3 (@aydrian)
• #2 Sort available options lists (@simison)
• #1 fixed typo in readme file (@OogieBoogieInJSON)