BGUI

This is a fork of email-verify and it has the following differences from the original project:

It's entirely written in TypeScript
It's Promise-based
It provides the response sent from the SMTP server in case of errors
It adds the BANNED_BY_SERVER error code, trying to parse the error message sent by the server.

Install

npm install bgui -g if you just want to use the CLI.
npm install bgui to use it in your app.

Usage

Result

The result is an object like the following:

{
  "success": true // boolean
  "info": "voodoo81people@hotmail.com is a valid email" // A description of the result
  "addr": "voodoo81people@hotmail.com" // the address being verified
  "code": 1, // info code saying things on verification status, see infoCodes enum
  "lastResponse": "220 DB8EUR05FT061.mail.protection.outlook.com Microsoft ESMTP MAIL Service ready ...", // last SMTP response
}

Options

The options are:

port: integer, port to connect to. (default: 25)
sender: string, sender's email address. (default: name@example.org).
timeout: integer, socket timeout in milliseconds. (default: 0, that is no timeout).
fqdn: string, used as part of the HELO, defaults to mail.example.org.
dns: string | Array<string>, ip address or array of ip addresses (as strings), used to set the servers of the dns check
ignore: set an ending response code integer to ignore, such as 450 for greylisted emails.

Flow

The basic flow is as follows:

Validate it is a proper email address
Get the domain of the email
Grab the DNS MX records for that domain
Create a TCP connection to the smtp server
Send a EHLO message
Send a MAIL FROM message
Send a RCPT TO message
If they all validate, return an object with success: true. If any stage fails, the callback object will have success: false.

This module has tests with Jest. Run npm test and make sure you have a solid connection.

Use (also see the app.js file):

import { verify } from 'bgui';

verify('support@github.com').then((info) => {
  expect(info.success).toBeTruthy();
  expect(info.code).toBe(infoCodes.FINISHED_VERIFICATION);
  expect(info.lastResponse?.length !== undefined && info.lastResponse.length > 0).toBeTruthy();
  done();
});

For CLI usage:

bgui --help

Why this name?

It takes inspiration from Bernard Gui, an inquisitor. This service declares which emails must be condemned and set on fire.

chrisvoo / bernardo