nodemailer-sendgrid-transport

SendGrid transport for Nodemailer

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
nodemailer-sendgrid-transport
116250.2.08 years ago9 years agoMinified + gzip package size for nodemailer-sendgrid-transport in KB

Readme

nodemailer-sendgrid-transport
This module is a transport plugin for Nodemailer that makes it possible to send through SendGrid's Web API!
BuildStatus NPM version

Usage

Install via npm.
npm install nodemailer-sendgrid-transport
Require the module and initialize it with your SendGrid credentials.
var nodemailer = require('nodemailer');
var sgTransport = require('nodemailer-sendgrid-transport');

// api key https://sendgrid.com/docs/Classroom/Send/api_keys.html
var options = {
	auth: {
		api_key: 'SENDGRID_PASSWORD'
	}
}

// or

// username + password
var options = {
	auth: {
		api_user: 'SENDGRID_USERNAME',
		api_key: 'SENDGRID_PASSWORD'
	}
}
	
var mailer = nodemailer.createTransport(sgTransport(options));

Note: We suggest storing your SendGrid username and password as enviroment variables.
Create an email and send it off!
var email = {
	to: ['joe@foo.com', 'mike@bar.com'],
	from: 'roger@tacos.com',
	subject: 'Hi there',
	text: 'Awesome sauce',
	html: '<b>Awesome sauce</b>'
};

mailer.sendMail(email, function(err, res) {
	if (err) { 
		console.log(err) 
	}
	console.log(res);
});

License

Licensed under the MIT License.