Skip to content

AnandChowdhary/edumail

Folders and files

NameName
Last commit message
Last commit date

Latest commit

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

Repository files navigation

πŸŽ“ Edumail

Travis CI Coverage GitHub Vulnerabilities Minzipped size NPM version Types

Edumail helps you identify educational emails for academic discounts.

It relies upon JetBrains/swot to get educational email information.

⭐ Getting started

Install Edumail as a dependency:

npm install edumail

Then import and use the functions you need:

import { isEducational } from "edumail";

const isEducationalEmail = await isEducational("example@america.edu");
// returns false

You can also use promises:

isEducational("example@scu.edu").then(info => {
  console.log(info); // returns true
}).catch(error => {})

There are also functions to identify domains:

import { isBlacklisted, isEducationalDomain } from "edumail";

const blacklisted = await isBlacklisted("example@america.edu"); // true
const educational = await isEducationalDomain("example@america.edu"); // true

πŸ“ License

MIT