node-gmailer

Sending of emails from your nodejs app using your gmail account.

How to Use

Installation

npm install node-gmailer

Config Setup

Pass in the following environment variables using a .env file

EMAIL_SENDER_NAME = <Your name or Business name>
GMAIL_ADDRESS = <Your gmail address>
GMAIL_APP_PASSWORD = <Your Gmail App password>

Example .env file content

EMAIL_SENDER_NAME = Smith Joe
GMAIL_ADDRESS = [email protected]
GMAIL_APP_PASSWORD = jdcsscscs3wn

Sending Emails

Import the package into your app

Using ES5

var gmail = require('node-gmailer');

With ES Modules

import gmail from 'node-gmailer';

Sending example [Single Recipient]

const recipient = '[email protected]';
const messageData = {
  subject: 'Olawale from node-gmailer',
  text: 'Hello, this is a single recipient message from node-gmailer',
  html: '<strong> Hello </strong>, this is a single recipient message from <em>node-gmailer</em>'
}

gmail.send(recipient, messageData)
  .then(response => {
    // Email was sent, take a look at 'response'
  })
  .catch(error => {
    // Could not send email, something went wrong, check 'error'
  });

Sending example [Multiple Recipients] with HTML support

const recipients = ['[email protected]', '[email protected]'];
const messageData = {
  subject: 'Olawale from node-gmailer',
  text: 'Hello, this is a single recipient message from node-gmailer',
  html: '<strong> Hello </strong>, this is a single recipient message from <em>node-gmailer</em>'
}

gmail.send(recipients, messageData)
  .then(response => {
    // Email was sent, take a look at 'response'
  })
  .catch(error => {
    // Could not send email, something went wrong, check 'error'
  });

Coming soon

• Email Template Support: Generate HTML emails with support for custom values
• Queue messages to be sent at a particular time or date
• Suggest a feature or improvements

Get Involved

• Report a bug
• Star the repo, fork and contribute.

Note

Remember to securely save your app password and ignore your .env file to avoid accidental pushing to your public repository.

Find instructions on how to generate a gmail app password here.