https://github.com/anandchowdhary/edumail

🎓 Identify educational emails for academic discounts
https://github.com/anandchowdhary/edumail

domain education email typescript utility

Last synced: 3 months ago
JSON representation

🎓 Identify educational emails for academic discounts

• Host: GitHub
• URL: https://github.com/anandchowdhary/edumail
• Owner: AnandChowdhary
• License: mit
• Created: 2019-05-26T20:04:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-17T19:25:22.000Z (7 months ago)
• Last Synced: 2024-10-23T17:14:48.427Z (3 months ago)
• Topics: domain, education, email, typescript, utility
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/edumail
• Size: 1.59 MB
• Stars: 10
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🎓 Edumail

[![Travis CI](https://img.shields.io/travis/AnandChowdhary/edumail.svg)](https://travis-ci.org/AnandChowdhary/edumail)

[![Coverage](https://img.shields.io/coveralls/github/AnandChowdhary/edumail.svg)](https://coveralls.io/github/AnandChowdhary/edumail)

[![GitHub](https://img.shields.io/github/license/anandchowdhary/edumail.svg)](https://github.com/AnandChowdhary/edumail/blob/master/LICENSE)

![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/AnandChowdhary/edumail.svg)

[![Minzipped size](https://img.shields.io/bundlephobia/minzip/edumail.svg)](https://www.npmjs.com/package/edumail)

[![NPM version](https://img.shields.io/npm/v/edumail.svg)](https://www.npmjs.com/package/edumail)

[![Types](https://img.shields.io/npm/types/edumail.svg)](https://www.npmjs.com/package/edumail)

Edumail helps you identify educational emails for academic discounts.

It relies upon [JetBrains/swot](https://github.com/JetBrains/swot) to get educational email information.

## ⭐ Getting started

Install Edumail as a dependency:

```bash

npm install edumail

```

Then import and use the functions you need:

```js

import { isEducational } from "edumail";

const isEducationalEmail = await isEducational("[email protected]");

// returns false

```

You can also use promises:

```js

isEducational("[email protected]").then(info => {

  console.log(info); // returns true

}).catch(error => {})

```

There are also functions to identify domains:

```js

import { isBlacklisted, isEducationalDomain } from "edumail";

const blacklisted = await isBlacklisted("[email protected]"); // true

const educational = await isEducationalDomain("[email protected]"); // true

```

## 📝 License

MIT