Disposable Email Detector

!workflow

!NPM Downloads
!NPM Version

Overview

The disposable-email-detector is a TypeScript utility designed to identify disposable email addresses, providing developers with a tool to enhance email verification processes.

Features

- Domain Check: Identifies if an email address belongs to a known disposable email domain.
- Error Handling: Offers informative messages for scenarios like missing index.json or invalid JSON format.
- Async File Reading: Utilizes asynchronous file reading for improved performance.

Getting Started

$3

- Node.js
- npm

$3

``javascript
npm i disposable-email-detector
`

`javascript
import disposableEmailDetector from 'disposable-email-detector';

const email = 'test@mailinator.com';

disposableEmailDetector(email)
.then((response) => console.log(response)); // true
`

The disposableEmailDetector function reads a list of disposable email domains from index.json. It checks whether the provided email address belongs to a disposable domain and returns a boolean indicating the result.

$3

- If index.json is not found, the script informs you to create it with disposable domains.
- If index.json has an invalid JSON format, it prompts you to correct the file.
- Unexpected errors are logged to the console.

Contributing

Contributions are welcome! Please refer to the contributing guidelines for more information.

License

This project is licensed under the MIT License - see the LICENSE file for details.
``