Skip to content

isBizMail tells you whether a given email address belongs to a free email account provider (gmail.com, yahoo.es, yandex.ru etc) or not.

License

Notifications You must be signed in to change notification settings

salaros/is-biz-mail-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Business Email Checker

Build Status Coverage Status Inline docs Known Vulnerabilities Code Climate maintainability

License js type npm npm npm npm bundle size (minified + gzip)

Donate Patreon Donate Paypal Donate Liberapay

isBizMail tells you whether a given email address is free (gmail.com, yahoo.es, yandex.ru etc) or not. Detects around 4-5k domains and sub-domains.

Under the hood isBizMail mostly relies on 3-rd party domain lists created by people and organizations mentioned in Credits section.

Looking for PHP, .NET etc?

🟊🟊🟊 Support this project 🟊🟊🟊

You can support us in a small way, please consider starring and sharing this repo! It helps us getting known and grow the community.

star us

Installation

You can install isBizMail for JavaScript via your prefered dependency manager, e.g. Yarn

yarn add is-biz-mail

or via NPM

npm i is-biz-mail

Vanilla

One of examples of vanilla JavaScript usage might be a simple HTML page:

<script src="https://cdn.jsdelivr.net/npm/is-biz-mail/dist/is-biz-mail.js"></script>
<script>
    var result = isBizMail.isValid('foo@nodejs.onmicrosoft.com"');
    console.log([email, result]);   // (2)Β ["foo@nodejs.onmicrosoft.com", false]
</script>

ES5 / ES6 module

import isBizMail from 'is-biz-mail';

let result = isBizMail.isFreeMailAddress('es6@gmail.com');
console.log([email, result]);   // (2)Β ["es6@gmail.com", true]
// ...

CommonJS, Node.js etc

const isBizMail = require('is-biz-mail');

let result = isBizMail.isFreeMailAddress('cjs@yahoo.com');
console.log([email, result]);   // (2)Β ["cjs@yahoo.com", true]
// ...

Testing: Mocha + Should.js

yarn
yarn test

or via NPM

npm install
npm test    # or ./node_modules/.bin/mocha

Credits