Email Validator

Small PHP library to valid email addresses using a number of methods.

Features

Validates email address
Checks for example domains (e.g. example.com)
Checks for disposable email domains (e.g. mailinator.com)
Checks for role-based addresses (e.g. abuse@)
Checks for MX records (i.e. can receive email)

Install (using Composer)

composer require nojacko/email-validator:~1.0

Usage

Generalised Functions

isValid($email) Runs all the tests within this library. Returns true or false.
isSendable($email) Checks isEmail, isExample and hasMx. Returns true or false.

Specific Functions

If you want more control, use these functions seperately.

isEmail($email) Note: returns true or false only.
isExample($email)
isDisposable($email)
isRole($email)
hasMx($email)

These functions take a single argument (an email address) and return:

true, when function name is satisfied.
false, when function name is not satisfied.
null, when check is not possible, i.e. an invalid email is given.

Examples

$validator = new \EmailValidator\Validator();

$validator->isValid('[email protected]');              // true
$validator->isValid('[email protected]');                // false
$validator->isValid('[email protected]');             // false

$validator->isSendable('[email protected]');           // true
$validator->isSendable('[email protected]');             // true
$validator->isSendable('[email protected]');          // false

$validator->isEmail('[email protected]');             // true
$validator->isEmail('example@example');                 // false

$validator->isExample('[email protected]');           // true
$validator->isExample('[email protected]');            // false
$validator->isExample('example.com');                   // null

$validator->isDisposable('[email protected]');        // false
$validator->isDisposable('[email protected]');     // true
$validator->isDisposable('example.com');                // null

$validator->isRole('[email protected]');              // false
$validator->isRole('[email protected]');                // true
$validator->isRole('example.com');                      // null

$validator->hasMx('[email protected]');               // false
$validator->hasMx('[email protected]');                // true
$validator->hasMx('example.com');                       // null

Contribute

Contributions welcome!

Requirements

Test-driven development
Follow PSR-2 Coding Style Guide
One change per pull request

Add/Remove Disposable Domain

See the email-data-disposable project.

New Feature

If you're planning a new feature, please raise an issue first to ensure it's in scope. The aim is to keep this library small and with one specific purpose.

Other Contributions

For anything that isn't a new feature (bug fix, tests, etc) just create a pull request.

Testing

Test are all located in tests folder.

Run tests with phpunit. In root folder, execute phpunit in a CLI.

Versioning

Semantic Versioning 2.0.0

License

The MIT License (MIT). See LICENCE file.

Comments

Merged martenson/disposable-email-domains blacklist

Just asked the Martenson if I could merge the blacklist, because his one is a bit better ;) https://github.com/martenson/disposable-email-domains/issues/15

opened by mipapo 4
Checks for MX, A, and AAAA DNS records

Changed hasMx to hasDNS to reflect the semantic check for A and AAAA records in Validator.php. Updated README.md with hasDNS instead of hasMx.

This is to reflect the fact that some email domains have no MX records but have an A or AAAA record. I borrowed this idea from egulias/EmailValidator source.

opened by Ema4rl 3
Keeping PHP implementation apart from the domain list

Consider adding my disposable domain repo (https://github.com/martenson/disposable-email-domains) as a git submodule so we can work together on one list that is domain agnostic and you can continue here on your PHP validator implementation without the hassle of keeping the list up to date.

opened by martenson 1
Email with name

Hello! This is really tiny validator, but it will be great to pass validation for emails with names like Sender Name <[email protected]>

opened by SilverFire 1
Invalid email addresses with space then underscore not being detected

I have found that having a space then underscore, the regex doesn't see it as invalid. For example frank [email protected] is valid according to this library. I note that frank_ [email protected] is not valid so it's more than just looking for a space. Pull request #8 fixes this issue. Please merge and release a new version, thanks!

opened by joshbmarshall 0