Download the PHP package citco/email-validator without Composer
On this page you can find all versions of the php package citco/email-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download citco/email-validator
More information about citco/email-validator
Files in citco/email-validator
Package email-validator
Short Description An easy to use, accurate-ish & extensible email validation library for PHP 7+
License MIT
Informations about the package email-validator
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()). |
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 (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
Installation
Usage
Quick Start
Expected output:
Adding Custom Validations
To add a custom validation simply extend the EmailValidation\Validations\Validator class and implement the getResultResponse() and getValidatorName() methods. You then register the validation using the EmailValidation\EmailValidator->registerValidator() method.
Example code
// Validations/GmailValidator.php
// file-where-you-are-doing-your-validation.php
The expected output will be:
Running in Docker
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.
Example Code:
FAQ
Is this validation accurate?
No, none of these tests are 100% accurate. As with any email validation there will always be false positives & negatives. The only way to guarantee an email is valid is to send an email and solicit a response. However, this library is still useful for detecting disposable emails etc., and also acts as a good first line of defence.
Can I manually update the disposable email provider data?
Yes, this project relies on this great repository for its list of disposable email providers. To fetch the latest list from that repo you can run
from the command line. This will fetch the data and save it to ./src/data/disposable-email-providers.php
All versions of email-validator with dependencies
ext-json Version *