dustmail.js

npm install dustmail

Dustmail is a simple email module designed to leverage dust templates for sending emails out. This module allows you to create templates like many developers have grown to expect with an express server, complete with layouts and partials.

Dustmail is also designed to allow you to use whatever email sending server you are most comfortable with by providing a simple and easy to use driver system. We've included two drivers for popular mail services Postmark and Mandrill. Both drivers are separate from Dustmail and can be installed via npm.

Code Examples

var	dustmail = require('dustmail')({
		layouts_dir: './example_templates/layouts/',
		partials_dir: './example_templates/partials/',
		templates_dir: './example_templates/templates/',
		driver: require('dustmail-postmark')('key') // you can also specify your driver when initialising dustmail
	}),
	fs = require('fs'); // only necessary for reading file for attachment example

var data = {
	template: 'layout_example',
	vars: {
       name: 'Mr. Example'
   },
   to: 'example@example.com',
   from: 'example@example.com',
   subject: 'Dustmail is awesome!',
	attachments: [ // array of objects
		{
			name: 'readme.txt',
			content: fs.readFileSync('./README.md'), // full content of the file
			contentType: 'text/plain'
		}
	]
}

// This example demos use of rendering template first, and passing that directly to send.
// This could allow you to use the generated HTML/Plaintext to save or manipulate further as you choose.
dustmail.render(data.template, data.vars, function(err, renderData) {
	if(err) {
		res.fail(err);
	}else{
		dustmail.send({
			to: data.to,
			from: data.from,
			subject: data.subject,
			attachments: data.attachments,
			render: renderData,
			sendType: 'html',
		}, function(err, data) {
			if(err) {
				console.log(err);
			}else{
				console.log(data);
			}
		});
	}
});

// This example simply sends an email using the template and variables specified.
// Rendering the template HTML/Plaintext is handled internally.
dustmail.send({
	to: data.to,
	from: data.from,
	subject: data.subject,
	attachments: data.attachments,
	template: data.template,
	vars: data.vars,
	sendType: 'text',
}, function(err, data) {
	if(err) {
		console.log(err);
	}else{
		console.log(data);
	}
});

Errors

Errors are returned in the following format. 'raw' is not included where not applicable.

{
	message: 'simple message',
	raw: 'raw, technical message'
}

Drivers

Writing an email driver for dustmail.js is extremely simple. The driver is just a basic function to handle the email being sent. See our documentation for more information on writing your own.