Skip to content

Latest commit

 

History

History
67 lines (57 loc) · 1.77 KB

README.md

File metadata and controls

67 lines (57 loc) · 1.77 KB

Does Email Exist

  • Validates SMTP server is running.
  • Validates MX records are present on DNS.
  • Validates email looks like an email i.e. contains an "@" and a "." to the right of it.
  • Validates common typos e.g. example@gmaill.com using mailcheck.
  • Validates email was not generated by disposable email service using disposable-email-domains.
  • Validates mailbox exists on SMTP server.

About us

The #1 AI Website Builder - Describe what you need. AI builds it. Publish in one click.

Getting Started

Compatible with node.js only. Not browser ready.

npm i does-email-exist --save

Usage

import validate from 'does-email-exist'
const main = async () => {
  let res = await validate('example@gmail.com')
  // {
  //   "valid": false,
  //   "reason": "smtp",
  //   "validators": {
  //       "regex": {
  //         "valid": true
  //       },
  //       "typo": {
  //         "valid": true
  //       },
  //       "disposable": {
  //         "valid": true
  //       },
  //       "mx": {
  //         "valid": true
  //       },
  //       "smtp": {
  //         "valid": false,
  //         "reason": "553-mail rejected because your IP is in the PBL.",
  //         "code": 553
  //       }
  //   }
  // }

  // Can also be called with these default options
  await validate({
    email: 'name@example.org', // Recipient
    sender: 'name@example.org', // Your correct email address
    helloName: 'localhost',
    validateRegex: true,
    validateMx: true,
    validateTypo: false,
    validateDisposable: true,
    validateSMTP: true,
  })
}

Based on deep-email-validator

LICENSE: MIT.