Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daveearley/email-validation-tool
An easy to use, accurate-ish & extensible email validation library for PHP 7+ 📧
https://github.com/daveearley/email-validation-tool
email email-validation email-verification php php-7 php-email-validation
Last synced: 22 days ago
JSON representation
An easy to use, accurate-ish & extensible email validation library for PHP 7+ 📧
- Host: GitHub
- URL: https://github.com/daveearley/email-validation-tool
- Owner: daveearley
- License: mit
- Created: 2017-07-15T18:52:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-24T13:12:34.000Z (over 2 years ago)
- Last Synced: 2024-10-12T12:21:34.303Z (about 1 month ago)
- Topics: email, email-validation, email-verification, php, php-7, php-email-validation
- Language: PHP
- Homepage:
- Size: 5.11 MB
- Stars: 276
- Watchers: 19
- Forks: 44
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://codecov.io/gh/daveearley/Email-Validation-Tool/) [](https://travis-ci.org/daveearley/Email-Validation-Tool) [](https://codeclimate.com/github/daveearley/Email-Validation-Tool/)
**An extensible email validation library for PHP 7+**
The aim of this library is to offer a more detailed email validation report than simply checking if an email is the valid format, and also to make it possible to easily add custom validations.
Currently this tool checks the following:
| Validation | Description |
| ------------- | ------------- |
| MX records | Checks if the email's domain has valid MX records |
| Valid format | Validates e-mail addresses against the syntax in RFC 822, with the exceptions that comments and whitespace folding and dotless domain names are not supported (as it uses PHP's [filter_var()](http://php.net/manual/en/function.filter-var.php)). |
| Email Host | Checks if the email's host (e.g gmail.com) is reachable |
| Role/Business Email^ | Checks if the email is a role/business based email (e.g [email protected]). |
| Disposable email provider^ | Checks if the email is a [disposable email](https://en.wikipedia.org/wiki/Disposable_email_address) (e.g [email protected]). |
| Free email provider^ | Checks if the email is a free email (e.g [email protected]). |
| Misspelled Email ^ | Checks the email for possible typos and returns a suggested correction (e.g [email protected] -> [email protected]). |
^ **Data used for these checks can be found [here](https://github.com/daveearley/Email-Validation-Tool/tree/master/src/data)**
# Installation
```bash
composer require daveearley/daves-email-validation-tool
```
# Usage
## Quick Start
```php
// Include the composer autoloader
require __DIR__ . '/vendor/autoload.php';
$validator = EmailValidation\EmailValidatorFactory::create('[email protected]');
$jsonResult = $validator->getValidationResults()->asJson();
$arrayResult = $validator->getValidationResults()->asArray();
echo $jsonResult;
```
Expected output:
```json
{
"valid_format": true,
"valid_mx_records": false,
"possible_email_correction": "[email protected]",
"free_email_provider": false,
"disposable_email_provider": false,
"role_or_business_email": false,
"valid_host": false
}
```
## Adding Custom Validations
To add a custom validation simply extend the [EmailValidation\Validations\Validator](https://github.com/daveearley/Email-Validation-Tool/blob/master/src/Validations/Validator.php) class and implement the **getResultResponse()** and **getValidatorName()** methods. You then register the validation using the **EmailValidation\EmailValidator->registerValidator()** method.
### Example code
// Validations/GmailValidator.php
```php
getEmailAddress()->getHostPart();
return strpos($hostName, 'gmail.com') !== false;
}
}
```
// file-where-you-are-doing-your-validation.php
```php
registerValidator(new GmailValidator());
echo $validator->getValidationResults()->asJson();
```
The expected output will be:
```json
{
"is_gmail": true,
"valid_format": true,
"valid_mx_records": false,
"possible_email_correction": "",
"free_email_provider": true,
"disposable_email_provider": false,
"role_or_business_email": false,
"valid_host": false
}
```
## Running in Docker
```bash
docker-compose up -d
```
You can then validate an email by navigating to http://localhost:[email protected]. The result will be JSON string as per above.
## Adding a custom data source
You can create your own data provider by creating a data provider class which implements the [EmailValidation\EmailDataProviderInterface](https://github.com/daveearley/Email-Validation-Tool/blob/master/src/EmailDataProviderInterface.php).
Example Code:
```php