ses-template-mailer v2.1.2

AWS Simple Email Service (SES) Template Mailer

Send HTML or plain text templates through Amazon Web Services Simple Email Service (SES) using Handlebars, Pug, EJS or Underscore. This is essentially a wrapper for ses.sendEmail.

Install

npm install --save ses-template-mailer

Usage

Email = require('ses-template-mailer')
email = new Email(options, credentials);
email.send(function(error, result){});

Options

Properties

template (String)

The text email template. Should either be an html template string or a valid url eg: https://mybucket.s3.amazonaws.com/template.handlebars. Using an extension name like "handlebars", "pug", "ejs" or "underscore" will overwrite TemplateType.

templateData (Object)

The data to parse the template with. Refer to your desired templating engine for more details.

templateType (String)

The template engine to use. Must be one of the following: "handlebars", "pug", "ejs", "underscore". Handlebars is the default.

rateLimit (Number=90)

If sending multiple emails with with send delivery will be throttled ensure your don't go over your rate limit. Default: 90.

send (Function)

Dispatch emails

Parameters

Events

COMPLETE_EVENT

Event triggered when all emails have been processed and sent.

Parameters

SEND_EVENT

Event trigged each time an email is sent.

ERROR_EVENT

Event trigger when an email failed to send.

Examples:

Sending One Email (with callbacks)

Email = require('../lib/email')
email = new Email(
	{
		Destination: {
			BccAddresses: ['Jack Sprat <jack-sprat@hotmail.com>'],
			CcAddresses: ['Humpty Dumpty <humpty-dumpty@yahoo.com>'],
			ToAddresses: ['Peter Pumpkineater <peter-pumpkineater@gmail.com>']
		},
		Message: {
			Subject: {
				Data: 'Pumpkin Eater'
			},
			Body: {
					Html: {
						Data: '<div>{{peter}}, {{peter}} pumpkin eater, Had a wife but couldn't keep her; <a href="{{more}}">more</a></div>'
					},
					Text: {
						Data: '{{peter}}, {{peter}} pumpkin eater, Had a wife but couldn't keep her;'
					}
			},
			TemplateData: {name:'Peter', more: 'https://en.wikipedia.org/wiki/Peter_Peter_Pumpkin_Eater'},
			TemplateType: 'handlebars'
		},
		Source: 'admin@example.com',
		ReplyToAddresses: [ 'Nobody <no-reply@example.com>'],
		ReturnPath: 'admin@example.com'
	}, {
		accessKeyId: 'my_aws_access_key',
		secretAccessKey: 'my_aws_secret_key',
		region: 'us-west-2'
	}

);

// Optional setup:
// email.template = '<div>{{peter}}, {{peter}} pumpkin eater, Had a wife but couldn't keep her; <a href="{{more}}">more</a></div>'
// email.templateData = {name:'Peter', more: 'https://en.wikipedia.org/wiki/Peter_Peter_Pumpkin_Eater'}
// email.templateType = 'handlebars'

email.send(function(err, data) {
	if (err)
		console.log(err, err.stack); // error
	else
		console.log(data); // success
}

Sending Multiple Emails (with events)

Email = require('../lib/email')
email = new Email([recipient1, recipient2, recipient3,]);
email.rateLimit = 200
email.on(Email.COMPLETE_EVENT, function(errors, results, data){
	console.log(results.length+" of "+data.length+" emails have been sent.")
});
email.on(Email.SEND_EVENT, function(result){
	console.log('email sent')
});
email.on(Email.ERROR_EVENT, function(error){
	console.log(error.stack)
});
email.send()

Tests

Make a copy of the test/conf.sample.coffee and update if necessary.

cp test/conf.sample.coffee test/conf.coffee // update conf.coffee
mocha test/email.coffee