The best way to check a misspelled email address in JavaScript
🔐 Reduce failed authentication ⬆️ Increase email delivery ⚡️ Built for speed
## @zootools/email-spell-checker [![npm package][npm-img]][npm-url] [![npm package][bundlephobia-img]][bundlephobia-url] [![Issues][issues-img]][issues-url] [![Commitizen Friendly][commitizen-img]][commitizen-url] EmailSpellChecker is a lightweight JavaScript module written in TypeScript that suggests the right domain when your users misspell it in an email address. At [ZooTools, an email marketing and referral tool](https://zootools.co?ref=email-spell-checker-github), we validate thousands of misspelled emails daily with _EmailSpellChecker_ and it helped us to reduce bounced emails by 30%. It's by far the easiest way to reduce misspelled email addresses in your web apps and server. ## The features you deserve We rewrote and improved [mailcheck.js](https://github.com/mailcheck/mailcheck), a great module that is no longer maintained (7+ years since the last update) and we fixed critical bugs like [this](https://github.com/ZooTools/email-spell-checker/pull/3), or [this](https://github.com/ZooTools/email-spell-checker/pull/4). - ⚡️ Lightning fast: Highly performant email checking using `Sift3` - a fast and accurate string distance algorithm. - 🔋 Updated: 39+ popular domains, and 66+ modern TLDs out-of-the-box. Frequently updated. - 🚀 Ridiculously small: 1.8KB (minzip) and 0 external dependencies. We agree, big bundles suck! - 💙 TypeScript: Fully written in TypeScript, cause we know you love it and we too. - ⚙️ Extensible: Allows you 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 never use a library without tests :). ## Why should you validate email spelling? Typos in the email will harm your business. Especially email deliverability. Common user misspellings such as “gnail” instead of “gmail” or “yaho” instead of “yahoo” can be used as [spam traps](https://sendgrid.com/blog/spam-traps-what-they-are-and-why-you-should-pay-attention-to-them/) by ISPs, and as a result, your emails will be blocked or marked as spam. Common use cases: - User authentication (login, signup, email recovery). - Backend email validation. - Newsletter subscriptions. ## Tutorials Here are some highly-requested tutorials. - [🟨 JavaScript: Getting started in 5 minutes](./demos/javascript/) - 🟦 React: Validating email spell in React (coming soon) - [🟩 Node with Express.js: Validating email spell in Node](./demos/node-express/) If you want to write a tutorial [send a PR](https://github.com/zootools/email-spell-checker/pulls) or [create an issue](https://github.com/zootools/email-spell-checker/issues) if you want to ask for one. ## Getting Started in 5 minutes Adding EmailSpellChecker to your project takes less than 5 minutes. It works on any JavaScript framework (Vue, React, Next.JS, Angular, Svelte, etc) as well as your backend server. ### Installation _Install with npm:_ ```bash npm i @zootools/email-spell-checker --save ``` _Install with yarn:_ ```bash yarn add @zootools/email-spell-checker ``` ### Basic Example Using the library is easy. Import it, call the `run` function with the email you want to validate, and get a suggestion. ```js import emailSpellChecker from '@zootools/email-spell-checker'; const suggestion = emailSpellChecker.run({ email: 'jorge@gmaik.co' }) if (suggestion) { // dev: user made a typo -- handle the suggestion. // for example: show a message to fix the email. console.log(suggestion.address); // jorge console.log(suggestion.domain); // gmail.com console.log(suggestion.full); // jorge@gmail.com } ``` ## 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`: ```js emailSpellChecker.run({ email: 'jorge@gmaik.co', 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](https://jestjs.io/), 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 us [@ZooToolsHQ](https://twitter.com/ZooToolsHQ) and [@JGFerreiro](https://twitter.com/JGFerreiro) if you are interested to appear. ## Customer support & updates Updates - 🎯 [Join our mailing lists to get useful information](https://form.waitlistpanda.com/go/8H98mVOzZhwGMalf8nfb) about this and other useful open source libraries: https://form.waitlistpanda.com/go/8H98mVOzZhwGMalf8nfb - 📆 Click "Watch repo" on GitHub and ⭐️ the repo to be notified of useful information. Customer support - 🤝 Do you have bugs or issues? Email [github@zootools.co](github@zootools.co) or [create an issue](https://github.com/zootools/email-spell-checker/issues) Socials - [@ZooToolsHQ](https://twitter.com/ZooToolsHQ) - [@JGFerreiro](https://twitter.com/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. ## We're hiring! Badass developer looking for a job? [Join the grind](https://www.notion.so/zootools/Careers-at-ZooTools-2e2815794b14415daca297506c54cb69)!
