email-inspector/README.md

A Node.js module for email address analysis and validation.

# Email Inspector

Email Inspector is a Node.js package for validating and inspecting email addresses.

## Installation

You can install this package using npm:

```bash
npm install email-inspector
```

## Usage

Here's how you can use Email Inspector in your Node.js application:

```javascript
const emailInspector = require('email-inspector');

const email = 'user@example.com';

if (emailInspector.validate(email)) {
  console.log('Email is valid');
} else {
  console.log('Email is invalid');
}

```

## Validation Against Free Email Providers

Email Inspector is designed to verify email addresses against a curated list of free email providers. This validation ensures that your business communication remains uninterrupted and can operate smoothly.

## Options

You can customize the behavior of Email Inspector using the following options:

1. customFreeProviders (Array): An array of custom free email providers to consider during validation.

2. providersToRemove (Array): An array of email providers to exclude from the list of free providers during validation.


## Examples

```javascript
const emailInspector = require('email-inspector');

// Example 1: Basic validation
const isValid = emailInspector.validate('user@example.com');
console.log(isValid); // true

// Example 2: Custom free providers
const customProviders = ['customprovider.net'];
const isValidCustom = emailInspector.validate('user@customprovider.net', { customFreeProviders: customProviders });
console.log(isValidCustom); // false
```

## Contributing

If you'd like to contribute to this project, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.


## License

MIT

## Author

Weasely