@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 daily by top companies to validate thousands of mispelled emails.

@zootools/email-spell-checker

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 - web3 mailchimp alternative, we validate thousands of emails daily with email-spell-checker and it helped us to reducing bounced emails by 30%.

The features your deserve

We rewrote and improved mailcheck.js, a great module that is not longer maintained (7+ years since last update) and that contains a bug.

• ⚡️ Lighting fast: Highly performance email checking using Sift3 - a fast and accurate string distance algorithm.
• 🚀 Ridiculously small: 2KB (minzip) and 0 external dependencies. We agree, big bundles suck!
• 🔋 Updated: 39+ popular domains, and 66+ modern TLDs out-of-the-box. Frequent updates.
• 💙 TypeScript: Fully written in TypeScript, cause we know you love it and we too.
• ⚙️ Extensible: Allows to pass your custom rules and domains. Tweak it as you need.
• 🔨 1 minute migration: Same API and functions as mailcheck so you can switch in a sec!
• 🔐 Unit tested: Cause we'd not ever used a library without tests :).

Some good use cases

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

Getting Started in 5 minutes

Adding Email Spell Checker to your project takes you less than 5 minutes.

It works on any JavaScript framework (Vue, React, Next.JS, Angular, Svelte, etc) as well as the your backend server.

Here some highly-requested tutorials. If you want to write a tutorial send a PR or create an issue if you want to ask for one:

• JavaScript (Continue reading this README.md)
• ⚛️ React: Validating email spell in React
• ✅ Node: Validating email spell in Node

Installation

Install with npm:

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

Install with yarn:

yarn add @zootools/email-spell-checker

Basic Example

Using the library is really easy:

• Import it.
• Call run function with the email you want to validate.
• Get the suggested email, and prompt your user to accept suggestion.

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

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

if (suggestedEmail) {
  // DEV: Handle the suggestion.
  // E.g: tell the user their email is wrong and offer to apply your suggestion

  console.log(suggestedEmail);
  // {
  //    address: "jorge"
  //    domain: "gmail.com"
  //    suggestedEmail: "[e-mail]"
  // }
}

Extending Domains

EmailSpellChecker has inbuilt defaults if the domains, secondLevelDomains or topLevelDomains options aren't provided.

The out-of-the-box configuration is the best for 99% of cases. If you are that 1%, here is how you can extend the configuration :).

Adding your own Domains

You can replace EmailSpellChecker's default domain/TLD suggestions by supplying replacements to EmailSpellChecker.run:

emailSpellChecker.run({
  domains: [...emailSpellChecker.POPULAR_DOMAINS, 'customdomain.com'], // replaces existing domains
  secondLevelDomains: ['domain', 'yetanotherdomain'], // replaces existing SLDs
  topLevelDomains: ['com.au', 'ru'] // replaces existing TLDs
});

Tests

EmailSpellChecker is tested with Jest, a popular JavaScript testing framework from Facebook with a focus on simplicity.

Run npm test from the command line to run the test suite.

Who uses EmailSpellChecker?

We're putting together a list of happy users of EmailSpellChecker.

Tweet @ZooToolsHQ and @JGFerreiro if you are interested to appear.

Customer support & updates

• 🎯 Major updates: Join our mailing lists to get useful information about this and other useful open source libraries: https://form.waitlistpanda.com/go/8H98mVOzZhwGMalf8nfb
• 📆 Updates: Click "Watch repo" on Github and ⭐️ the repo to get useful information.
• 🤝 Do you have bugs or issues? Email [e-mail] and create an create an issue

Socials:

• @ZooToolsHQ
• @EmailSpellChecker
• @JGFerreiro

Maintainers

This library is used and maintained by ZooTools: Growth and marketing tools for ambitious teams.

We use this library heavily in ZooTools Panda, a mailchimp alternative for sending viral marketing campaigns.

You can view examples of the use of this library here