mirror of
https://github.com/egulias/EmailValidator.git
synced 2026-08-24 14:28:21 +00:00
Eduardo Gulias Davis
118 lines
4.9 KiB
Markdown
118 lines
4.9 KiB
Markdown
# EmailValidator
|
|
|
|
[](https://travis-ci.org/egulias/EmailValidator)
|
|
[](https://scrutinizer-ci.com/g/egulias/EmailValidator/?branch=3.x)
|
|
[](https://scrutinizer-ci.com/g/egulias/EmailValidator/?branch=3.x)
|
|
[](https://insight.symfony.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6)
|
|
|
|
A library for validating emails against several RFC.
|
|
|
|
## Supported RFCs ##
|
|
|
|
This library aims to support RFCs:
|
|
|
|
* [5321](https://tools.ietf.org/html/rfc5321),
|
|
* [5322](https://tools.ietf.org/html/rfc5322),
|
|
* [6530](https://tools.ietf.org/html/rfc6530),
|
|
* [6531](https://tools.ietf.org/html/rfc6531),
|
|
* [6532](https://tools.ietf.org/html/rfc6532),
|
|
* [1035](https://tools.ietf.org/html/rfc1035)
|
|
|
|
## Supported versions
|
|
|
|
**Curent major version with full support is v3**
|
|
|
|
| Version | Released | EOL | Only critical bug fixes | Full |
|
|
| ---- | :----: | :----: | :----: | :----: |
|
|
| v3.x | 2020/12/29 | - | X | X |
|
|
| v2.1.x | 2016/05/16 | 01/2022 | X | |
|
|
| v1.2 | 2013/19/05 | YES | | |
|
|
|
|
|
|
## Requirements ##
|
|
|
|
* PHP 7.2
|
|
* [Composer](https://getcomposer.org) is required for installation
|
|
* [Spoofchecking](/src/Validation/SpoofCheckValidation.php) and [DNSCheckValidation](/src/Validation/DNSCheckValidation.php) validation requires that your PHP system has the [PHP Internationalization Libraries](https://php.net/manual/en/book.intl.php) (also known as PHP Intl)
|
|
|
|
**Note**: `PHP version upgrades will happen to accomodate to the pace of major frameworks. Minor versions bumps will go via minor versions of this library (i.e: PHP7.3 -> v3.x+1). Major versions will go with major versions of the library`
|
|
|
|
## Installation ##
|
|
|
|
Run the command below to install via Composer
|
|
|
|
```shell
|
|
composer require egulias/email-validator
|
|
```
|
|
|
|
## Getting Started ##
|
|
|
|
`EmailValidator`requires you to decide which (or combination of them) validation/s strategy/ies you'd like to follow for each [validation](#available-validations).
|
|
|
|
A basic example with the RFC validation
|
|
```php
|
|
<?php
|
|
|
|
use Egulias\EmailValidator\EmailValidator;
|
|
use Egulias\EmailValidator\Validation\RFCValidation;
|
|
|
|
$validator = new EmailValidator();
|
|
$validator->isValid("example@example.com", new RFCValidation()); //true
|
|
```
|
|
|
|
|
|
### Available validations ###
|
|
|
|
1. [RFCValidation](/src/Validation/RFCValidation.php): Standard RFC-like email validation.
|
|
2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php): RFC-like validation that will fail when warnings* are found.
|
|
3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php): Will check if there are DNS records that signal that the server accepts emails. This does not entails that the email exists.
|
|
5. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php): It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
|
|
6. [Your own validation](#how-to-extend): You can extend the library behaviour by implementing your own validations.
|
|
|
|
*warnings: Warnings are deviations from the RFC that in a broader interpretation are acceptded.
|
|
|
|
```php
|
|
<?php
|
|
|
|
use Egulias\EmailValidator\EmailValidator;
|
|
use Egulias\EmailValidator\Validation\DNSCheckValidation;
|
|
use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
|
|
use Egulias\EmailValidator\Validation\RFCValidation;
|
|
|
|
$validator = new EmailValidator();
|
|
$multipleValidations = new MultipleValidationWithAnd([
|
|
new RFCValidation(),
|
|
new DNSCheckValidation()
|
|
]);
|
|
//ietf.org has MX records signaling a server with email capabilites
|
|
$validator->isValid("example@ietf.org", $multipleValidations); //true
|
|
```
|
|
|
|
#### Additional validations ####
|
|
Validations not present in the RFCs
|
|
|
|
1. [SpoofCheckValidation](/src/Validation/Extra/SpoofCheckValidation.php): Will check for multi-utf-8 chars that can signal an erroneous email name.
|
|
|
|
|
|
### How to extend ###
|
|
|
|
It's easy! You just need to implement [EmailValidation](/src/Validation/EmailValidation.php) and you can use your own validation.
|
|
|
|
## Contributing ##
|
|
|
|
Please follow the [Contribution guide](CONTRIBUTING.md). Is short and simple and will help a lot.
|
|
|
|
## Other Contributors ##
|
|
|
|
(You can find current contributors [here](https://github.com/egulias/EmailValidator/graphs/contributors))
|
|
|
|
As this is a port from another library and work, here are other people related to the previous one:
|
|
|
|
* Ricard Clau [@ricardclau](https://github.com/ricardclau): Performance against PHP built-in filter_var (v2 and earlier)
|
|
* Josepf Bielawski [@stloyd](https://github.com/stloyd): For its first re-work of Dominic's lib
|
|
* Dominic Sayers [@dominicsayers](https://github.com/dominicsayers): The original isemail function
|
|
|
|
## License ##
|
|
|
|
Released under the MIT License attached with this code.
|