Skip to content

API to check if an email is from a disposable email service, quick and easy

Notifications You must be signed in to change notification settings

V3RITAS-UTD/email-ok

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

email-ok

API to check if an email is from a disposable email service

Install

yarn install or npm install

This will also download the latest domain list

Run

yarn start or npm run start

Endpoint will be available on localhost:3000/check/:email

Quick use: curl http://localhost:3000/check/test@fast-mail.one will return {"disposable": true}


To re-fetch the domain list run yarn postinstall or npm run postinstall - this can be done via a cronjob every 2 days to keep the domain list updated


To enable authentication with header X-API-Key you need to clone the .env.example to .env, change API_KEY_LIST and uncomment src/app.js L15-L23

cp .env.example .env

Test

yarn test or npm run test

Tests can be found in test/test.js, using Tape + Supertest

Credits

Domain list is loaded from yzyjim/disposable-email-domain-list

MIT License

About

API to check if an email is from a disposable email service, quick and easy

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published