Chris@18: # EmailValidator
Chris@0: [![Build Status](https://travis-ci.org/egulias/EmailValidator.png?branch=master)](https://travis-ci.org/egulias/EmailValidator) [![Coverage Status](https://coveralls.io/repos/egulias/EmailValidator/badge.png?branch=master)](https://coveralls.io/r/egulias/EmailValidator?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/egulias/EmailValidator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/egulias/EmailValidator/?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6/small.png)](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6)
Chris@0: =============================
Chris@18: ## Suported RFCs ##
Chris@18: This library aims to support:
Chris@0: 
Chris@18: RFC 5321, 5322, 6530, 6531, 6532.
Chris@18: 
Chris@18: ## Requirements ##
Chris@18: 
Chris@18:  * [Composer](https://getcomposer.org) is required for installation
Chris@18:  * [Spoofchecking](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/SpoofCheckValidation.php) and [DNSCheckValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/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)
Chris@18: 
Chris@18: ## Installation ##
Chris@0: 
Chris@0: Run the command below to install via Composer
Chris@0: 
Chris@0: ```shell
Chris@18: composer require egulias/email-validator "~2.1"
Chris@0: ```
Chris@0: 
Chris@18: ## Getting Started ##
Chris@18: `EmailValidator`requires you to decide which (or combination of them) validation/s strategy/ies you'd like to follow for each [validation](#available-validations).
Chris@0: 
Chris@18: A basic example with the RFC validation
Chris@18: ```php
Chris@18: <?php
Chris@18: 
Chris@18: use Egulias\EmailValidator\EmailValidator;
Chris@18: use Egulias\EmailValidator\Validation\RFCValidation;
Chris@18: 
Chris@18: $validator = new EmailValidator();
Chris@18: $validator->isValid("example@example.com", new RFCValidation()); //true
Chris@18: ```
Chris@18: 
Chris@18: 
Chris@18: ### Available validations ###
Chris@18: 
Chris@18: 1. [RFCValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/RFCValidation.php)
Chris@18: 2. [NoRFCWarningsValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/NoRFCWarningsValidation.php)
Chris@18: 3. [DNSCheckValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/DNSCheckValidation.php)
Chris@18: 4. [SpoofCheckValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/SpoofCheckValidation.php)
Chris@18: 5. [MultipleValidationWithAnd](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/MultipleValidationWithAnd.php)
Chris@18: 6. [Your own validation](#how-to-extend)
Chris@18: 
Chris@18: `MultipleValidationWithAnd`
Chris@18: 
Chris@18: It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
Chris@0: 
Chris@0: ```php
Chris@0: <?php
Chris@0: 
Chris@0: use Egulias\EmailValidator\EmailValidator;
Chris@18: use Egulias\EmailValidator\Validation\DNSCheckValidation;
Chris@18: use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
Chris@18: use Egulias\EmailValidator\Validation\RFCValidation;
Chris@0: 
Chris@18: $validator = new EmailValidator();
Chris@18: $multipleValidations = new MultipleValidationWithAnd([
Chris@18:     new RFCValidation(),
Chris@18:     new DNSCheckValidation()
Chris@18: ]);
Chris@18: $validator->isValid("example@example.com", $multipleValidations); //true
Chris@0: ```
Chris@0: 
Chris@18: ### How to extend ###
Chris@0: 
Chris@18: It's easy! You just need to implement [EmailValidation](https://github.com/egulias/EmailValidator/blob/master/EmailValidator/Validation/EmailValidation.php) and you can use your own validation.
Chris@0: 
Chris@0: 
Chris@18: ## Other Contributors ##
Chris@18: (You can find current contributors [here](https://github.com/egulias/EmailValidator/graphs/contributors))
Chris@0: 
Chris@18: As this is a port from another library and work, here are other people related to the previous one:
Chris@0: 
Chris@18: * Ricard Clau [@ricardclau](https://github.com/ricardclau):      	Performance against PHP built-in filter_var
Chris@18: * Josepf Bielawski [@stloyd](https://github.com/stloyd):      		For its first re-work of Dominic's lib
Chris@18: * Dominic Sayers [@dominicsayers](https://github.com/dominicsayers):  	The original isemail function
Chris@0: 
Chris@18: ## License ##
Chris@0: Released under the MIT License attached with this code.
Chris@0: