Nodemailer-otp NPM

nodemailer-otp

Nodemailer-otp is a simple Node.js package that allows developers to easily generate OTPs (One Time Passwords) and send email notifications using Nodemailer. This package provides easy integration into your Node.js projects and supports customizable OTP lengths.

Features

Generate OTPs for use in your application
Send OTPs and custom messages via email using Nodemailer
Simple and customizable integration with your Node.js project
Easy setup and usage

Installation

To get started with nodemon-helper, follow these steps:

npm install nodemailer-otp

Create a .env file in your project's root directory:

EMAIL_USER=your-email@example.com
EMAIL_PASS=your-email-access-key

Setup Instructions

Email Provider Configuration

Gmail Setup:
- Enable "Less Secure Apps" in your Gmail account settings, or
- Generate an App-Specific Password if using 2-factor authentication
- Use the app password in your .env file
Dependencies:
```
npm install nodemailer
```

Usage

Basic Setup

const NodemailerHelper = require('nodemailer-otp');
require('dotenv').config();

// Initialize the helper
const helper = new NodemailerHelper(process.env.EMAIL_USER, process.env.EMAIL_PASS);

For (ESM) Syntax

import NodemailerHelper from 'nodemailer-otp';
import dotenv from 'dotenv';

// Load environment variables from .env file
dotenv.config();

// Initialize the helper
const helper = new NodemailerHelper(process.env.EMAIL_USER, process.env.EMAIL_PASS);

Generate OTP

// Generate a 6-digit OTP
const otp = helper.generateOtp(6);
console.log(`Generated OTP: ${otp}`);

Send OTP via Email

helper.sendEmail('recipient-email@example.com','subject','your message here!', otp)
  .then((response ) => {
    console.log(response );
  })
  .catch((err) => {
    console.error(err);
  });