Add support for SendGrid API (sahat#1127)

Author: YasharF

.env.example

@@ -7,8 +7,10 @@ SESSION_SECRET=Your Session Secret goes here
 MAILGUN_USER=postmaster@sandbox697fcddc09814c6b83718b9fd5d4e5dc.mailgun.org
 MAILGUN_PASSWORD=29eldds1uri6
 
-SENDGRID_USER=hslogin
-SENDGRID_PASSWORD=hspassword00
+SMTP_USER=none
+SMTP_PASSWORD=none
+
+SENDGRID_API_KEY=hdgfadsfahg---apikey---hdgfadsfahg
 
 NYT_KEY=9548be6f3a64163d23e1539f067fcabd:5:68537648
 

README.md

@@ -163,7 +163,7 @@ credentials.
 
 - Visit <a href="https://www.google.com/recaptcha/admin" target="_blank">Google reCAPTCHA Admin Console</a>
 - Enter your application's name as the **Label**
-- Chose **reCAPTCHA v2**, **"I'm not a robot" Checkbox**
+- Choose **reCAPTCHA v2**, **"I'm not a robot" Checkbox**
 - Enter *localhost* as the domain.  You can have other domains added in addition to *localhost*
 - Accept the terms and submit the form
 - Copy the *Site Key* and the *Secret key* into `.env`.  These keys will be accessible under Settings, reCAPTCHA keys drop down if you need them again later.
@@ -353,9 +353,13 @@ The same goes for other providers.
 
 <img src="https://sendgrid.com/brand/sg-logo-300.png" width="200">
 
+You can use SendGrid for sending emails.  The developer tier allows you to send 100 free emails per day.  As an Alternative to SendGrid, you may also choose to use an SMTP service provider.  If using SendGrid:
 - Go to <a href="https://sendgrid.com/user/signup" target="_blank">https://sendgrid.com/user/signup</a>
 - Sign up and **confirm** your account via the *activation email*
-- Then enter your SendGrid *Username* and *Password* into `.env` file
+- Then enter your SendGrid *API Key* into `.env` file as SENDGRID_API_KEY
+
+If using an SMTP service provider instead of SendGrid:
+- Set SMTP_USER and SMTP_PASSWORD in `.env`, and remove SENDGRID_API_KEY
 
 <hr>
 

controllers/contact.js

@@ -1,6 +1,7 @@
 const axios = require('axios');
 const validator = require('validator');
 const nodemailer = require('nodemailer');
+const nodemailerSendgrid = require('nodemailer-sendgrid');
 
 /**
  * GET /contact
@@ -57,13 +58,22 @@ exports.postContact = async (req, res) => {
       fromEmail = req.user.email;
     }
 
-    let transporter = nodemailer.createTransport({
-      service: 'SendGrid',
-      auth: {
-        user: process.env.SENDGRID_USER,
-        pass: process.env.SENDGRID_PASSWORD
-      }
-    });
+    let transportConfig;
+    if (process.env.SENDGRID_API_KEY) {
+      transportConfig = nodemailerSendgrid({
+        apiKey: process.env.SENDGRID_API_KEY
+      });
+    } else {
+      transportConfig = {
+        auth: {
+          user: process.env.SMTP_USER,
+          pass: process.env.SMTP_PASSWORD
+        }
+      };
+    }
+
+    let transporter = nodemailer.createTransport(transportConfig);
+
     const mailOptions = {
       to: process.env.SITE_CONTACT_EMAIL,
       from: `${fromName} <${fromEmail}>`,
@@ -79,16 +89,9 @@ exports.postContact = async (req, res) => {
       .catch((err) => {
         if (err.message === 'self signed certificate in certificate chain') {
           console.log('WARNING: Self signed certificate in certificate chain. Retrying with the self signed certificate. Use a valid certificate if in production.');
-          transporter = nodemailer.createTransport({
-            service: 'SendGrid',
-            auth: {
-              user: process.env.SENDGRID_USER,
-              pass: process.env.SENDGRID_PASSWORD
-            },
-            tls: {
-              rejectUnauthorized: false
-            }
-          });
+          transportConfig.tls = transportConfig.tls || {};
+          transportConfig.tls.rejectUnauthorized = false;
+          transporter = nodemailer.createTransport(transportConfig);
           return transporter.sendMail(mailOptions);
         }
         console.log('ERROR: Could not send contact email after security downgrade.\n', err);

controllers/user.js

@@ -1,6 +1,7 @@
 const { promisify } = require('util');
 const crypto = require('crypto');
 const nodemailer = require('nodemailer');
+const nodemailerSendgrid = require('nodemailer-sendgrid');
 const passport = require('passport');
 const _ = require('lodash');
 const validator = require('validator');
@@ -13,14 +14,20 @@ const randomBytesAsync = promisify(crypto.randomBytes);
  * Helper Function to Send Mail.
  */
 const sendMail = (settings) => {
-  const transporterSettings = {
-    service: 'SendGrid',
-    auth: {
-      user: process.env.SENDGRID_USER,
-      pass: process.env.SENDGRID_PASSWORD
-    }
-  };
-  let transporter = nodemailer.createTransport(transporterSettings);
+  let transportConfig;
+  if (process.env.SENDGRID_API_KEY) {
+    transportConfig = nodemailerSendgrid({
+      apiKey: process.env.SENDGRID_API_KEY
+    });
+  } else {
+    transportConfig = {
+      auth: {
+        user: process.env.SMTP_USER,
+        pass: process.env.SMTP_PASSWORD
+      }
+    };
+  }
+  let transporter = nodemailer.createTransport(transportConfig);
 
   return transporter.sendMail(settings.mailOptions)
     .then(() => {
@@ -29,12 +36,9 @@ const sendMail = (settings) => {
     .catch((err) => {
       if (err.message === 'self signed certificate in certificate chain') {
         console.log('WARNING: Self signed certificate in certificate chain. Retrying with the self signed certificate. Use a valid certificate if in production.');
-        transporter = nodemailer.createTransport({
-          ...transporterSettings,
-          tls: {
-            rejectUnauthorized: false
-          }
-        });
+        transportConfig.tls = transportConfig.tls || {};
+        transportConfig.tls.rejectUnauthorized = false;
+        transporter = nodemailer.createTransport(transportConfig);
         return transporter.sendMail(settings.mailOptions)
           .then(() => {
             settings.req.flash(settings.successfulType, { msg: settings.successfulMsg });
@@ -519,7 +523,7 @@ exports.postForgot = (req, res, next) => {
     };
     const mailSettings = {
       successfulType: 'info',
-      successfulMsg: `An e-mail has been sent to ${req.user.email} with further instructions.`,
+      successfulMsg: `An e-mail has been sent to ${user.email} with further instructions.`,
       loggingError: 'ERROR: Could not send forgot password email after security downgrade.\n',
       errorType: 'errors',
       errorMsg: 'Error sending the password reset message. Please try again shortly.',