email-checkup
v1.0.1
Published
A email verification package. Disposable email filter and verifies that the email exists.
Downloads
5
Maintainers
pioupiaReadme
email-checkup
A email verification package. Disposable email filter and verifies that the email exists.
Installation
Use the package manager npm to install email-checkup.
npm i email-checkupUsage
const emailcheckup = require("email-checkup");
emailcheckup({
mail: "[email protected]", //email to check
blacklist: false, //by default is true.
whitelist: ["com", "be", "ch", "fr"], //By default is ["com", "be", "ch", "fr"]
exists: true //by default is false.
}).then(result => {
console.log(result) // Return "true" if the email is real. And return "false" if the email is not real Warning, the package does not check if the email exists (for now)!
})Options
email-checkup supports 3 options :
- blacklist - true / false (Defaults to true). This option is optional. It enables a blacklist of more than 360 disposable email sites.
- whitelist - array (Defaults : ["com", "be", "ch", "fr"]). This option is optional. It enables a whitelist of all domains accepted in the email.
- mail - email (This option is not optional !). Put the email to check.
- exists - true / false (Defaults to false). This option allows you to check if the email exists !
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.