Márk Magyar
27be0e7157
* use spread syntax instead of array_merge()
* use type cast instead of function cast
* removed redundant returns
* removed redundant phpdoc - type is already inferred
* removed invalid phpdoc - type is already inferred
The PHPDoc return type hint was incomplete, it should have been `InvalidEmail|null`, however, it can be removed altogether as the return type is already inferred from the code.
* changed warnEscaping()'s return value from bool to void
This is not a breaking change as the method is private, and it's only used at one place, where the return value was not used anyway.
* made private class property local
`private $parser` was used in only one place, hence it can be local, there is no reason to put it into the class' scope.
* removed unnecessary type casting
Concatenation already casts `static::CODE` from `int` to `string`, no reason to do it explicitly.
* removed redundant initializers - constructor overwrites them immediately
* removed redundant else block
* simplified if-else statement
* wrapped if body in brackets to comply with PSR12
* fixed README formatting
- fixed numbering at the `Available validations` section
- fixed overall formatting
* Revert "removed redundant phpdoc - type is already inferred"
This reverts commit 68a9ae20bd.
* don't wrap long lines
* make properties typed
Also using constructor property promotion, see more info about it [here](https://php.watch/versions/8.0/constructor-property-promotion).
5.3 KiB
EmailValidator
A library for validating emails against several RFC.
Supported RFCs
This library aims to support RFCs:
Supported versions
Current major version with full support is v3
| Version | Released | EOL | Only critical bug fixes | Full |
|---|---|---|---|---|
| v4.x | 2023/01/07 | - | X | X |
| v3.x | 2020/12/29 | - | X | |
| v2.1.x | 2016/05/16 | YES | ||
| v1.2 | 2013/19/05 | YES |
Requirements
- PHP 8.1
- Composer is required for installation
- Spoofchecking and DNSCheckValidation validation requires that your PHP system has the PHP Internationalization Libraries (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
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.
A basic example with the RFC validation
<?php
use Egulias\EmailValidator\EmailValidator;
use Egulias\EmailValidator\Validation\RFCValidation;
$validator = new EmailValidator();
$validator->isValid("example@example.com", new RFCValidation()); //true
Available validations
- RFCValidation: Standard RFC-like email validation.
- NoRFCWarningsValidation: RFC-like validation that will fail when warnings* are found.
- DNSCheckValidation: Will check if there are DNS records that signal that the server accepts emails. This does not entail that the email exists.
- MultipleValidationWithAnd: It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
- MessageIDValidation: Follows RFC2822 for message-id to validate that field, that has some differences in the domain part.
- Your own validation: You can extend the library behaviour by implementing your own validations.
*warnings: Warnings are deviations from the RFC that in a broader interpretation are accepted.
<?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 capabilities
$validator->isValid("example@ietf.org", $multipleValidations); //true
Additional validations
Validations not present in the RFCs
- SpoofCheckValidation: 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 and you can use your own validation.
Contributing
Please follow the Contribution guide. Is short and simple and will help a lot.
Other Contributors
(You can find current contributors here)
As this is a port from another library and work, here are other people related to the previous one:
- Ricard Clau @ricardclau: Performance against PHP built-in filter_var (v2 and earlier)
- Josepf Bielawski @stloyd: For its first re-work of Dominic's lib
- Dominic Sayers @dominicsayers: The original isemail function
License
Released under the MIT License attached with this code.