nodemailer-sendgrid-transport

v0.2.0
SendGrid transport for Nodemailer
Nodemailer SendGrid

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: ['[email protected]', '[email protected]'],
    from: '[email protected]',
    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.

npm i nodemailer-sendgrid-transport

Metadata

  • MIT
  • Whatever
  • SendGrid
  • released 7/6/2015

Downloads