Chris@0
|
1 #EmailValidator
|
Chris@0
|
2 [](https://travis-ci.org/egulias/EmailValidator) [](https://coveralls.io/r/egulias/EmailValidator?branch=master) [](https://scrutinizer-ci.com/g/egulias/EmailValidator/?branch=master) [](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6)
|
Chris@0
|
3 =============================
|
Chris@0
|
4 With the help of
|
Chris@0
|
5
|
Chris@0
|
6 
|
Chris@0
|
7 ##Installation##
|
Chris@0
|
8
|
Chris@0
|
9 Run the command below to install via Composer
|
Chris@0
|
10
|
Chris@0
|
11 ```shell
|
Chris@0
|
12 composer require egulias/email-validator "~1.2"
|
Chris@0
|
13 ```
|
Chris@0
|
14
|
Chris@0
|
15 ##Usage##
|
Chris@0
|
16
|
Chris@0
|
17 Simple example:
|
Chris@0
|
18
|
Chris@0
|
19 ```php
|
Chris@0
|
20 <?php
|
Chris@0
|
21
|
Chris@0
|
22 use Egulias\EmailValidator\EmailValidator;
|
Chris@0
|
23
|
Chris@0
|
24 $validator = new EmailValidator;
|
Chris@0
|
25 if ($validator->isValid($email)) {
|
Chris@0
|
26 echo $email . ' is a valid email address';
|
Chris@0
|
27 }
|
Chris@0
|
28 ```
|
Chris@0
|
29
|
Chris@0
|
30 More advanced example (returns detailed diagnostic error codes):
|
Chris@0
|
31
|
Chris@0
|
32 ```php
|
Chris@0
|
33 <?php
|
Chris@0
|
34
|
Chris@0
|
35 use Egulias\EmailValidator\EmailValidator;
|
Chris@0
|
36
|
Chris@0
|
37 $validator = new EmailValidator;
|
Chris@0
|
38 $email = 'dominic@sayers.cc';
|
Chris@0
|
39 $result = $validator->isValid($email);
|
Chris@0
|
40
|
Chris@0
|
41 if ($result) {
|
Chris@0
|
42 echo $email . ' is a valid email address';
|
Chris@0
|
43 } else if ($validator->hasWarnings()) {
|
Chris@0
|
44 echo 'Warning! ' . $email . ' has unusual/deprecated features (result code ' . var_export($validator->getWarnings(), true) . ')';
|
Chris@0
|
45 } else {
|
Chris@0
|
46 echo $email . ' is not a valid email address (result code ' . $validator->getError() . ')';
|
Chris@0
|
47 }
|
Chris@0
|
48 ```
|
Chris@0
|
49
|
Chris@0
|
50 ##Contributors##
|
Chris@0
|
51 As this is a port from another library and work, here are other people related to the previous:
|
Chris@0
|
52
|
Chris@0
|
53 * Ricard Clau [@ricardclau](http://github.com/ricardclau): Performance against PHP built-in filter_var
|
Chris@0
|
54 * Josepf Bielawski [@stloyd](http://github.com/stloyd): For its first re-work of Dominic's lib
|
Chris@0
|
55 * Dominic Sayers [@dominicsayers](http://github.com/dominicsayers): The original isemail function
|
Chris@0
|
56
|
Chris@0
|
57 ##License##
|
Chris@0
|
58 Released under the MIT License attached with this code.
|
Chris@0
|
59
|