@zootools/email-spell-checker

🔐 Reduce failed authentication ⬆️ Increase emails delivery ⚡️ Built for speed

The best way to check a misspelled email address in JavaScript

Email Spell Checker is the easiest way to reduce misspelled email addresses in your web apps and server. Used in production by companies to validate thousands of mispelled emails daily.

@zootools/email-spell-checker

![npm package][bundlephobia-img]

Email Spell Checker is a lightweight JavaScript module written in TypeScript that suggests a right domain when your users misspell it in an email address.

At ZooTools, we validate thousands of emails daily with mailSpellChecker and it helped up to reduce by 30% bounced emails.

The features your deserve

We rewrote and improve mailcheck.js, a great module that is not longer maintained (7+ years old).

• 🔋 Updated: 39+ popular domains, and 66+ modern TLDs out-of-the-box and continuously updated.
• 💙 TypeScript: Fully written in TypeScript, cause we know you love it and we too.
• ⚡️ Lighting fast: Highly performance email checking using js-levenshtein, one of the fastest string distance JS modules.
• ⚙️ Extensible: Allows to pass your custom rules and domains. Tweak it as you need.
• 🔨 5 minutes migration: Same API and functions as mailcheck to migrate in <5 minutes.

Some good use cases

• User authentication (login, signup, email recovery).
• Backend email validation.
• Newsletter subscriptions.

Getting started

Installation

Install with npm:

npm i @zootools/email-spell-checker --save

Install with yarn:

yarn add @zootools/email-spell-checker

Usage

import emailSpellChecker from '@zootools/email-spell-checker';

const suggestedEmail = emailSpellChecker.run({
  email: '[e-mail]',
});

if (suggestedEmail) {
  // Found bad spelled email...
  // ...Tell your user to fix the email

  console.log('address', suggestedEmail.address); // jorge
  console.log('domain', suggestedEmail.domain); // gmail.com
  console.log('full', suggestedEmail.full); // [e-mail]
}

Usage with custom configuration (advanced)

The out-of-the box configuration is the best for every mainstream project. However, we know sometimes you want to pass extra configuration.

Bare in mind that the more domains, TLDs options you add, the slower the validation will take. That's why we recommend to avoid passing your custom configuration.

You can easily extend EmailSpellChecker as you need:

import emailSpellChecker from '@zootools/email-spell-checker';

const suggestedEmail = emailSpellChecker.run({
  email: '[e-mail]',
  domains: DOMAINS,
  topLevelDomains: [
    ...emailSpellChecker.POPULAR_DOMAINS,
    'supercooldomain.com',
  ],
});

if (suggestedEmail) {
  // Found bad spelled email...
  // ...Tell your user to fix the email

  console.log('address', suggestedEmail.address); // jorge
  console.log('domain', suggestedEmail.domain); // gmail.com
  console.log('full', suggestedEmail.full); // [e-mail]
}

How does it work?

TODO: Put screenshot of it in action

Other ports

Want to help contribute launching this email spell checker in other languages? Reach out to us and we'll provide the resources and help to make it happen and help distribute your package.

API

myPackage(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string Default: rainbows

Lorem ipsum.