USAGE.md

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_APIKEY'
  }
}

// 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);
});

Deploying

• Confirm tests pass
• Bump the version in README.md, package.json, test/sendgrid-transport-test.js
• Update CHANGELOG.md
• Confirm tests pass
• Commit Version bump vX.X.X
• npm publish
• Push changes to GitHub
• Release tag on GitHub vX.X.X