Skip to content

larvit/larvitmail

Repository files navigation

Build Status

larvitmail

Mailer wrapper for nodejs

Installation

npm i larvitmail

Usage

Basic usage

Defaults to SMTP localhost without any options.

send() returns SentMessageInfo from nodemailer (https://nodemailer.com/usage/) where messageId, envelope, acceppted, rejected etc. can be found.

const Mail = require('larvitmail');
const mail = new Mail();

await mail.send({
	'from':	'[email protected]',
	'to':	'[email protected]',
	'subject':	'test',
	'text':	'BAM!'
}; // throws on error
console.log('Mail sent');

Custom configuration

const Mail = require('larvitmail');
const mail = new Mail({
	'log': new require('larvitutils').Log('verbose'),
	'transportConf': 'smtps://user%40gmail.com:[email protected]',
	'mailDefaults': {
		'from': '[email protected]'
	}
});

await mail.send({
	'to':	'[email protected]',
	'subject':	'test',
	'text':	'BAM!'
};
console.log('Mail sent');

Templates

Set "isHtml" to true to use templates to send html emails.

const Mail = require('larvitmail');
const mail = new Mail();

await mail.send({
	to:	'[email protected]',
	subject:	'test',
	template:	'<h1>Hello <%= name %>!</h1>',
	templateData:	{ 'name': 'bar' },
	isHtml:	true
};
console.log('Mail sent');

Changelog

3.0.0

  • Replaced callback with promises
  • Upped lib versions

About

Mailer wrapper for nodejs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published