Node Email Verifier

Node Email Verifier is an email validation library for Node.js that checks if an email address has a valid format and optionally verifies the domain's MX (Mail Exchange) records to ensure it can receive emails.

Features

RFC 5322 Format Validation: Validates email addresses against the standard
email formatting rules.
MX Record Checking: Verifies that the domain of the email address has
valid MX records indicating that it can receive emails. This check can be
disabled using a parameter.
Customizable Timeout: Allows setting a custom timeout for MX record
checking.

Installation

Install the package using npm:

npm install node-email-verifier --save

Usage

Here's how to use Node Email Verifier, with and without MX record checking:

import emailValidator from 'node-email-verifier';

// Example with MX record checking
async function validateEmailWithMx(email) {
  try {
    const isValid = await emailValidator(email, { checkMx: true });
    console.log(`Is "${email}" a valid email address with MX checking?`, isValid);
  } catch (error) {
    console.error('Error validating email with MX checking:', error);
  }
}

// Example with MX record checking and custom timeout
async function validateEmailWithMxTimeout(email) {
  try {
    const isValid = await emailValidator(email, { checkMx: true, timeout: '500ms' });
    console.log(`Is "${email}" a valid email address with MX checking and custom timeout?`, isValid);
  } catch (error) {
    if (error.message.match(/timed out/)) {
      console.error('Timeout on DNS MX lookup.');
    } else {
      console.error('Error validating email with MX checking:', error);
    }
  }
}

// Example with custom timeout as a number
async function validateEmailWithMxTimeoutNumber(email) {
  try {
    const isValid = await emailValidator(email, { checkMx: true, timeout: 500 });
    console.log(`Is "${email}" a valid email address with MX checking and custom timeout?`, isValid);
  } catch (error) {
    if (error.message.match(/timed out/)) {
      console.error('Timeout on DNS MX lookup.');
    } else {
      console.error('Error validating email with MX checking:', error);
    }
  }
}

// Example without MX record checking
async function validateEmailWithoutMx(email) {
  try {
    const isValid = await emailValidator(email, { checkMx: false });
    console.log(`Is "${email}" a valid email address without MX checking?`, isValid);
  } catch (error) {
    console.error('Error validating email without MX checking:', error);
  }
}

validateEmailWithMx('[email protected]').then();
validateEmailWithMxTimeout('[email protected]').then();
validateEmailWithMxTimeoutNumber('[email protected]').then();
validateEmailWithoutMx('[email protected]').then();

API

`async emailValidator(email, [opts])`

Validates the given email address, with an option to skip MX record verification and set a custom timeout.

Parameters

email (string): The email address to validate.
opts (object): Optional configuration options.
timeout (string|number): The timeout for the DNS MX lookup, in
milliseconds or ms format (e.g., '2000ms' or '10s'). The default is 10 seconds
('10s').
checkMx (boolean): Whether to check for MX records. This defaults to
true.