Nostradamus Prophecy Machine
Miss any of our Open RFC calls?Watch the recordings here! »

@pixul/nodemailer-sparkpost

3.0.3 • Public • Published

SparkPost transport for Nodemailer

This is a fork of nodemailer-sparkpost-transport.

Travis CI Coverage Status npm version

Lead Maintainer: Daniel Cole

Usage

Install

npm install @pixul/nodemailer-sparkpost

Create a Nodemailer transport object

const Nodemailer = require('nodemailer');
const SparkPostTransport = require('@pixul/nodemailer-sparkpos');
const Transporter = Nodemailer.createTransport(SparkPostTransport(options));

where:

  • options defines connection default transmission properties
    • sparkPostApiKey - SparkPost API Key. If not provided, it will use the SPARKPOST_API_KEY env var.
    • endpoint - The endpoint to use for the SparkPost API requests. If you have a SparkPost EU account, set this to https://api.eu.sparkpost.com (optional)
    • campaign_id - Name of the campaign (optional)
    • metadata - Transmission level metadata containing key/value pairs (optional)
    • options - JSON object in which transmission options are defined (optional)
    • substitution_data - Key/value pairs that are provided to the substitution engine (optional)

For more information, see the SparkPost API Documentation for Transmissions

Send a message

transport.sendMail({
  from: 'me@here.com',
  to: 'you@there.com',
  subject: 'Very important stuff',
  text: 'Plain text',
  html: 'Rich taggery'
}, function(err, info) {
 
  if (err) {
    console.log('Error: ' + err);
  } else {
    console.log('Success: ' + info);
  }
});

Read more about Nodemailer's sendMail() method here.

Additional Options

The SparkPost Nodemailer transport also supports a few SparkPost-specific sendMail() options in both the transport constructor and the 'sendMail()` method.

Note: sendMail() options override their constructor counterparts:

  • options
    • campaign_id - Overrides for constructor option
    • metadata - Override for constructor option
    • options - Override for constructor option
    • substitution_data - Override for constructor option

Install

npm i @pixul/nodemailer-sparkpost

DownloadsWeekly Downloads

46

Version

3.0.3

License

Apache-2.0

Unpacked Size

46.5 kB

Total Files

18

Last publish

Collaborators

  • avatar
  • avatar
  • avatar