nikeshashar / free-email-domains-list Goto Github PK

View Code? Open in Web Editor NEW

Fresh list of all free email domain providers. Can be used to check if an email address belongs to a company. Updated weekly.

License: MIT License

Shell 0.01% JavaScript 0.10% TypeScript 99.89%

free-email-domains-list's Introduction

Fresh list of all free email domain providers. Can be used to check if an email address belongs to a company. Updated weekly

Sometimes you need to know if an email address belongs to a company or is registered with a free email provider. This easy script can tell you. Just call isCompanyEmail or isFreeEmail.

All available domains can be found in src folder. They are downloaded from the community maintaned list and updated weekly.

Usage

Function	Return value	Example usage
`isFreeEmail(email: string, emailValidation: IsEmailOptions = {})`	`boolean`	`isFreeEmail('[email protected]')` => `true`
`isCompanyEmail(email: string, emailValidation: IsEmailOptions = {})`	`boolean`	`isCompanyEmail('[email protected]')` => `false`

IsEmailOptions are available options for email validation from validator library. You can check test folder for usage.

If the the email provided is not valid, false is always returned.

Tests

There are jest tests which tests basic functionality. Feel free to extend them.

More packages from me

all-iso-language-codes - List of ISO 639-1, 639-2T, 639-2B and 639-3 codes with translations in all available languages
expo-video-player - Customizable Video Player controls for Expo
free-email-domains-list - Fresh list of all free email domain providers. Can be used to check if an email address belongs to a company. Updated weekly

Recommend Projects