https://github.com/bennymeg/academicemailverifier
Identifies email addresses or domains names that belong to colleges or universities.
https://github.com/bennymeg/academicemailverifier
academic colleges database email email-verification institution tld-verification universities
Last synced: over 1 year ago
JSON representation
Identifies email addresses or domains names that belong to colleges or universities.
- Host: GitHub
- URL: https://github.com/bennymeg/academicemailverifier
- Owner: bennymeg
- License: apache-2.0
- Created: 2018-10-30T19:00:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T22:36:28.000Z (over 3 years ago)
- Last Synced: 2025-03-11T12:51:59.454Z (over 1 year ago)
- Topics: academic, colleges, database, email, email-verification, institution, tld-verification, universities
- Language: JavaScript
- Homepage:
- Size: 882 KB
- Stars: 41
- Watchers: 1
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Academic Email Verifier
Identifies email addresses or domains names that belong to colleges or universities.
Retrieves institution name and owner role (i.e. faculty, student) if available.
[🌌 Service Demo](https://bennymeg.github.io/AcademicEmailVerifier/).
[](https://github.com/bennymeg/AcademicEmailVerifier/blob/master/LICENSE)
[](https://www.npmjs.com/package/academic-email-verifier)
## Installation
```bash
npm install --save academic-email-verifier
```
## Usage
### Import library:
```javascript
import { Verifier } from 'academic-email-verifier';
```
### Verify academic email address asynchronically:
```javascript
// check if email address is a valid academic email address
let isAcademic = await Verifier.isAcademic('benny@stanford.edu');
```
### Get full institution name asynchronically:
```javascript
// get full institution name
let institutionName = await Verifier.getInstitutionName('megidish@mit.edu');
```
## Supported Environments ##
- 🖥 Node.js
## Documentation ##
- 👨🏼💻 [API](https://github.com/bennymeg/AcademicEmailVerifier/blob/master/API.md),
- 👩🏼🏫 [Examples](https://github.com/bennymeg/AcademicEmailVerifier/blob/masterexamples),
- 📜 [Change log](https://github.com/bennymeg/AcademicEmailVerifier/blob/master/CHANGELOG.md),
- 🖋 [License](https://github.com/bennymeg/AcademicEmailVerifier/blob/master/LICENSE)
## Support ##
If you're having any problem, please [raise an issue](https://github.com/bennymeg/AcademicEmailVerifier/issues/new) on GitHub and we'll be happy to help.
## Contribute ##
- 👾 [Issue Tracker](https://github.com/bennymeg/AcademicEmailVerifier/issues),
- 📦 [Source Code](https://github.com/bennymeg/AcademicEmailVerifier/)
Before submitting a pull request, please make sure that you include tests, and that [jshint](http://jshint.com) runs without any warnings: [Download VSCode extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.jshint).
## Test ##
Run the test suite by executing:
```sh
$ npm test
```
## Attribution ##
The database of this project is based on the ruby gem [swot](https://github.com/leereilly/swot) database. this database constitutes a significant part of this project.
___
**Author:** Benny Megidish.