# 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) [!

Latest version **1.0.8** (published 2020-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install edumail
pnpm add edumail
yarn add edumail
bun add edumail
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2020-01-12 |
| First published | 2019-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 516.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Anand Chowdhary |
| Maintainers | anandchowdhary |

## Links

- npm: https://www.npmjs.com/package/edumail
- Repository: https://github.com/AnandChowdhary/edumail
- Homepage: https://github.com/AnandChowdhary/edumail#readme
- Issues: https://github.com/AnandChowdhary/edumail/issues
- npm.io page: https://npm.io/package/edumail

## Dependencies (2)

- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [node-cache](https://npm.io/package/node-cache.md) ^5.1.0

## Recent versions

- 1.0.8 (latest) — 2020-01-12
- 1.0.7 — 2019-12-23
- 1.0.6 — 2019-11-17
- 1.0.5 — 2019-10-07
- 1.0.4 — 2019-08-28
- 1.0.3 — 2019-08-18
- 1.0.2 — 2019-07-27
- 1.0.1 — 2019-06-12
- 1.0.0 — 2019-06-01
- 0.9.2 — 2019-06-01
- 0.9.1 — 2019-06-01
- 0.9.0 — 2019-05-27

## 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("example@america.edu");
// returns false
```

You can also use promises:

```js
isEducational("example@scu.edu").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("example@america.edu"); // true
const educational = await isEducationalDomain("example@america.edu"); // true
```

## 📝 License

MIT

---
_Source: https://npm.io/package/edumail · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
