Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

email-validator-node

bsonmez95MIT2.0.2TypeScript support: included

High-performance TypeScript email validator with format validation, MX record validation, and disposable email detection. Zero runtime dependencies.

email, validation, validator, domains, disposable, typescript, mx-record, dns, batch-validation, blacklist, performance, zero-dependencies

readme

email-validator-node

A simple package to validate format and MX for an e-mail address.

Installation

Install via Yarn:

yarn add email-validator-node

Usage

Node

var {
  checkEmail,
  isEmailFormatValid,
  isMXRecordValid,
  isBlacklisted,
} = require("email-validator-node");

(async () => {
  // checkEmail includes all other validation methods inside. If you run it, no need to run others.
  await checkEmail("test@google.com"); // { isValid:true }
  await checkEmail("asd@asd.asd"); // { isValid:false, message:"not-found" }
  await checkEmail("test@0-00.usa.cc"); // { isValid:false, message:"blacklist" }

  // checks only email format
  await isEmailFormatValid("test@email.com"); // true
  await isEmailFormatValid("test@.com"); // false

  // checks only MX records for the email
  await isMXRecordValid("test@test.com"); // false
  await isMXRecordValid("test@google.com"); // { isValid:true ,mxRecords:[] }

  // checks if the domain disposable or not
  await isBlacklisted("test@0-00.usa.cc"); // true
  await isBlacklisted("john@gmail.com"); // false
})();

Contribute

Contributions welcome! Check the LICENSE file for more info.

License

Distributed under the unlicense public domain. See LICENSE for more information.