@zootools/email-spell-checker
Advanced tools
Readme
🔐 Reduce failed authentication ⬆️ Increase emails delivery ⚡️ Built for speed
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 - web3 Mailchimp alternative, 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.
We rewrote and improved mailcheck.js, a great module that is no longer maintained (7+ years since the last update) and we fixed critical bugs like this, or this.
Sift3 - a fast and accurate string distance algorithm.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 by ISPs, and as a result, your emails will be blocked or marked as spam.
Common use cases:
Here are 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.
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.
Install with npm:
npm i @zootools/email-spell-checker --save
Install with yarn:
yarn add @zootools/email-spell-checker
Using the library is easy. Import it, call run function with the email you want to validate, and get a suggestion.
import emailSpellChecker from '@zootools/email-spell-checker';
const suggestedEmail = emailSpellChecker.run({
email: 'jorge@gmaik.co',
});
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"
// full: "jorge@gmail.com"
// }
}
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 :).
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
});
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.
We're putting together a list of happy users of EmailSpellChecker.
Tweet us @ZooToolsHQ and @JGFerreiro if you are interested to appear.
Updates
Customer support
Socials
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
Badass developer looking for a job? Join the grind!
FAQs
mailSpellChecker.js (mail spell checker) is a lightweight module that suggests a right domain when your users misspell it in an email address
The npm package @zootools/email-spell-checker receives a total of 21,496 weekly downloads. As such, @zootools/email-spell-checker popularity was classified as popular.
We found that @zootools/email-spell-checker demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.