nodelastic v1.0.2

This is a NodeJS library to allow you to quickly and easily use the Elastic Email Web API V2.

Installation

$ npm install nodelastic

Prerequisites

• An Elastic Email account

Functions

/**
 * Set default configuration that can be used to set common params.
 * @param {Object}         options     Object can be constructed from send parameters
 * Example : 
 *   var options { from : "from@domain.com", fromName : "Sender" }
 *   client.setConfig( options )
 */
function setConfig( options ) { ... }

/**
 * Returns a Promise of http response from Elastic Email
 * @param {Object}         params      Parameters that will override default configuration set in setConfig
 * @param {Array.<Object>} attachments Optional parameter. Please refer to the table below for more details.
 */
function send( params, attachments ) { ... }

params object passed into send function or options object passed into setConfig should have the following format

attachment object passed into the attachments array should have the following format

Example

var ElasticMail = require('nodelastic');
var client = new ElasticMail('your_api_key_here');
var attachments = [ 
  // CSV
  { data: 'id,name\n1,name_1',
    filename: 'attachment1.csv' },
  // PDF
  { data: fs.readFileSync('filepath_here'),
    filename: 'attachment2.pdf',
    contentType: 'application/pdf' } 
];

client.send({
  from : 'from@domain.com',
  fromName : 'Sender',
  subject : 'Subject',
  msgTo: [ 'to@domain.com' ],
  msgCC: [ 'cc_1@domain.com', 'cc_2@domain.com' ],
  bodyHtml: '<h1>Hello World</h1>',
  textHtml: 'Hello World'
}, attachments).then(console.log);

// will print 
// {"success":true,"data":{"transactionid":"190d1b03-8b01-41a1-8003-17181c1719b0","messageid":"ilXf1Nm38mxuxemecfdbvw2"}}

// You can also set default options, for example having the same from and the name of the sender
// the function below is the same as the client.send above
client.setConfig({
  from : 'from@domain.com',
  fromName : 'Sender'
});
client.send({
  subject : 'Subject',
  msgTo: [ 'to@domain.com' ],
  msgCC: [ 'cc_1@domain.com', 'cc_2@domain.com' ],
  bodyHtml: '<h1>Hello World</h1>',
  textHtml: 'Hello World'
}, attachments).then(console.log);