cybercog / Email-Validation-Tool

An easy to use, accurate-ish & extensible email validation library for PHP 7+

An extensible email validation library for PHP 7+

The aim of this library is to offer a more detailed email validation report than simply checking if an email is the valid format, and also to make it possible to easily add custom validations.

Currently this tool checks the following:

Validation	Description
MX records	Checks if the email's domain has valid MX records
Valid format	Validates e-mail addresses against the syntax in RFC 822, with the exceptions that comments and whitespace folding and dotless domain names are not supported (as it uses PHP's filter_var().
Email Host	Checks if the email's host (e.g gmail.com) is reachable
Role/Business Email^	Checks if the email if a role/business based email (e.g [e-mail]).
Disposable email provider^	Checks if the email is a disposable email (e.g [e-mail]).
Free email provider^	Checks if the email is a free email (e.g [e-mail]).
Misspelled Email ^	Checks the email for possible typos and returns a suggested correction (e.g [e-mail] -> [e-mail]).

^ Data used for these checks can be found here

Installation

composer require daveearley/daves-email-validation-tool

Usage

Quick Start

// Include the composer autoloader
require __DIR__ . '/vendor/autoload.php';

$validator = EmailValidation\EmailValidatorFactory::create('[e-mail]');

$jsonResult = $validator->getValidationResults()->asJson();
$arrayResult = $validator->getValidationResults()->asAray();

echo $jsonResult;

Expected output:

{
"valid_format": true,
"valid_mx_records": false,
"possible_email_correction": "[e-mail]",
"free_email_provider": false,
"disposable_email_provider": false,
"role_or_business_email": false,
"valid_host": false
}

Adding Custom Validations

To add a custom validation simply extend the EmailValidation\Validations\Validator class and implement the getResultResponse() and getValidatorName() methods. You then register the validation using the EmailValidation\EmailValidator->registerValidator() method.

Example code

// Validations/GmailValidator.php

<?php

namespace EmailValidation\Validations;

class GmailValidator extends Validator
{
    public function getValidatorName(): string
    {
        return 'is_gmail';
    }

    public function getResultResponse(): bool
    {
        $hostName = $this->getEmailAddress()->getHostPart();
        return strpos($hostName, 'gmail.com') !== false;
    }
}

// file-where-you-doing-your-validation.php

<?php

use EmailValidation\Validations\GmailValidator;

require __DIR__ . '/vendor/autoload.php';

$validator = EmailValidation\EmailValidatorFactory::create('[e-mail]');

$validator->registerValidator(new GmailValidator());

echo $validator->getValidationResults()->asJson();

The expected output will be:

{
"is_gmail": true,
"valid_format": true,
"valid_mx_records": false,
"possible_email_correction": "",
"free_email_provider": true,
"disposable_email_provider": false,
"role_or_business_email": false,
"valid_host": false
}

Running in Docker

You can eaily validate over HTTP using docker. To get docker working run

docker-compose up -d 

in the repository root. You can then validate an email by navigating to http://localhost:8880?email=[e-mail]. The result will be JSON string as per above.

FAQ

Is this validation accurate?

No, none of these tests are 100% accurate. As with any email validation there will always be false positives & negatives. The only way to guarantee an email is valid is to send an email and solicit a response. However, this library is still useful for detecting disposable emails etc., and also acts as a good first line of defence.