PHP Email Validation Library Pro: Validate email addresses using multiple rules

Recommend this page to a friend!
  Info   View files Example   View files View files (34)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2020-08-02 (1 month ago) RSS 2.0 feedNot yet rated by the usersTotal: 112 This week: 3All time: 9,266 This week: 91Up
Version License PHP version Categories
email-validator-pro 1.0.0The PHP License7Email, PHP 5, Validation
Description Author

This package can validate email addresses using multiple rules.

It implements several types of checks for a given email address and it returns a result telling if it passed all the checks. Currently it implements the following checks:

- Validate the email address format
- Validate existence of valid DNS MX records for the email domain
- Check if the email domain is of disposable email addresses
- Check if the email domain is of a free email address provider
- Check if the email domain is in a list of banned domains

Picture of John Conde
  Performance   Level  
Name: John Conde <contact>
Classes: 5 packages by
Country: United States United States
Age: 47
All time rank: 3288413 in United States United States
Week rank: 38 Up3 in United States United States Up
Innovation award
Innovation award
Nominee: 1x

Details

PHP Email Validator (email-validator)

The PHP Email Validator will validate an email address for all or some of the following conditions:

  • is in a valid format
  • has configured MX records (optional)
  • is not a disposable email address (optional)
  • is not a free email account (optional)
  • is not a banned email domain (optional)

The Email Validator is configurable, so you have full control over how much validation will occur.

Requirements

  • PHP 7.2 or newer

Installation

Simply add a dependency on stymiee/email-validator to your project's composer.json file if you use Composer to manage the dependencies of your project.

Here is a minimal example of a composer.json file that just defines a dependency on PHP Simple Encryption:

{
    "require": {
        "stymiee/email-validator": "^1"
    }
}

Functional Description

The Email Validator library builds upon PHP's built in filter_var($emailAddress, FILTER_VALIDATE_EMAIL); by adding a default MX record check. It also offers additional validation against disposable email addresses, free email address providers, and a custom banned domain list.

Validate MX

If checkMxRecords is set to true in the configuration (see below) the domain name will be validated to ensure it exists and has MX records configured. If the domain does not exist or no MX records exist the odds are the email address is not in use.

Restrict Disposable Email Addresses

Many users who are abusing a system, or not using that system as intended, can use a disposable email service who provides a short-lived (approximately 10 minutes) email address to be used for registrations or user confirmations. If checkDisposableEmail is set to true in the configuration (see below) the domain name will be validated to ensure it is not associated with a disposable email address provider.

You can add you own domains to this list if you find the public list providers do not have one you have identified in their lists. Examples are provided in the examples directory which demonstrate how to do this.

Restrict Free Email Address Providers

Many users who are abusing a system, or not using that system as intended, can use a free email service who provides a free email address which is immediately available to be used for registrations or user confirmations. If checkFreeEmail is set to true in the configuration (see below) the domain name will be validated to ensure it is not associated with a free email address provider.

You can add you own domains to this list if you find the public list providers do not have one you have identified in their lists. Examples are provided in the examples directory which demonstrate how to do this.

Restrict Banned Domains

If you have users from a domain abusing your system, or you have business rules that require the blocking of certain domains (i.e. public email providers like Gmail or Yahoo mail), you can block then by setting checkBannedListedEmail to true in the configuration (see below) and providing an array of banned domains. Examples are provided in the examples directory which demonstrate how to do this.

Configuration

To configure the Email Validator you can pass an array with the follow parameters/values:

checkMxRecords

A boolean value that enables/disables MX record validation. Enabled by default.

checkBannedListedEmail

A boolean value that enables/disables banned domain validation. Disabled by default.

checkDisposableEmail

A boolean value that enables/disables disposable email address validation. Disabled by default.

checkFreeEmail

A boolean value that enables/disables free email address provider validation. Disabled by default.

localDisposableOnly

A boolean value that when set to true will not retrieve third party disposable email provider lists. Use this if you cache the list of providers locally which is useful when performance matters. Disabled by default.

LocalFreeOnly

A boolean value that when set to true will not retrieve third party free email provider lists. Use this if you cache the list of providers locally which is useful when performance matters. Disabled by default.

bannedList

An array of domains that are not allowed to be used for email addresses.

disposableList

An array of domains that are suspected disposable email address providers.

freeList

An array of domains that are free email address providers.

Example

$config = [
    'checkMxRecords' => true,
    'checkBannedListedEmail' => true,
    'checkDisposableEmail' => true,
    'checkFreeEmail' => true,
    'bannedList' => $bannedDomainList,
    'disposableList' => $customDisposableEmailList,
    'freeList' => $customFreeEmailList,
];
$emailValidator = new EmailValidator($config);

Example

<?php
use EmailValidator\EmailValidator;

require('../vendor/autoload.php');

$customDisposableEmailList = [
    'example.com',
];
$customFreeEmailList = [
    'example2.com',
];
$bannedDomainList = [
    'domain.com',
];
$testEmailAddresses = [
    'test@johnconde.net',
    'test@gmail.com',
    'test@hotmail.com',
    'test@outlook.com',
    'test@yahoo.com',
    'test@domain.com',
    'test@mxfuel.com',
    'test@example.com',
    'test@example2.com',
    'test@nobugmail.com',
    'test@cellurl.com',
    'test@10minutemail.com',
];

$config = [
    'checkMxRecords' => true,
    'checkBannedListedEmail' => true,
    'checkDisposableEmail' => true,
    'checkFreeEmail' => true,
    'bannedList' => $bannedDomainList,
    'disposableList' => $customDisposableEmailList,
    'freeList' => $customFreeEmailList,
];
$emailValidator = new EmailValidator($config);

foreach($testEmailAddresses as $emailAddress) {
    $emailIsValid = $emailValidator->validate($emailAddress);
    echo  ($emailIsValid) ? 'Email is valid' : $emailValidator->getErrorReason();
    echo PHP_EOL;
}

Output

Email is valid
Domain is used by free email providers
Domain is used by free email providers
Domain is used by free email providers
Domain is used by free email providers
Domain is banned
Domain is used by disposable email providers
Domain is used by free email providers
Domain is used by disposable email providers
Domain does not accept email
Domain is used by disposable email providers
Domain is used by disposable email providers

Notes

The email address is checked against a list of known disposable email address providers which are aggregated from public disposable email address provider lists. This requires making HTTP requests to get the lists when validating the address.

Support

If you require assistance using this library start by viewing the HELP.md file included in this package. It includes common problems and solutions as well hwo to ask for additional assistance.

  Files folder image Files  
File Role Description
Files folder image.github (1 directory)
Files folder imageexamples (4 files)
Files folder imagesrc (1 directory)
Files folder imagetests (1 directory)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file CHANGELOG Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file CONTRIBUTING.md Data Auxiliary data
Accessible without login Plain text file HELP.md Data Auxiliary data
Accessible without login Plain text file license.txt Doc. Documentation
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README.md Doc. Read me
Accessible without login Plain text file SECURITY.md Data Auxiliary data

  Files folder image Files  /  .github  
File Role Description
Files folder imageworkflows (1 file)

  Files folder image Files  /  .github  /  workflows  
File Role Description
  Accessible without login Plain text file php.yml Data Auxiliary data

  Files folder image Files  /  examples  
File Role Description
  Accessible without login Plain text file disposableEmailList.php Example Example script
  Accessible without login Plain text file disposableEmailListWithCustomDomains.php Example Example script
  Accessible without login Plain text file fullValidation.php Example Example script
  Accessible without login Plain text file getDisposableEmailList.php Example Example script

  Files folder image Files  /  src  
File Role Description
Files folder imageEmailValidator (3 files, 1 directory)

  Files folder image Files  /  src  /  EmailValidator  
File Role Description
Files folder imageValidator (8 files)
  Plain text file EmailAddress.php Class Class source
  Plain text file EmailValidator.php Class Class source
  Plain text file Policy.php Class Class source

  Files folder image Files  /  src  /  EmailValidator  /  Validator  
File Role Description
  Plain text file AProviderValidator.php Class Class source
  Plain text file AValidator.php Class Class source
  Plain text file BannedListValidator.php Class Class source
  Plain text file BasicValidator.php Class Class source
  Plain text file DisposableEmailValidator.php Class Class source
  Plain text file FreeEmailValidator.php Class Class source
  Plain text file IValidator.php Class Class source
  Plain text file MxValidator.php Class Class source

  Files folder image Files  /  tests  
File Role Description
Files folder imageEmailValidator (3 files, 1 directory)

  Files folder image Files  /  tests  /  EmailValidator  
File Role Description
Files folder imageValidator (6 files)
  Plain text file EmailAddressTest.php Class Class source
  Plain text file EmailValidatorTest.php Class Class source
  Plain text file PolicyTest.php Class Class source

  Files folder image Files  /  tests  /  EmailValidator  /  Validator  
File Role Description
  Plain text file BannedListValidatorTest.php Class Class source
  Plain text file BasicValidatorTest.php Class Class source
  Plain text file DisposableEmailValidatorTest.php Class Class source
  Plain text file FreeEmailValidatorTest.php Class Class source
  Plain text file MxValidatorTest.php Class Class source
  Plain text file ProviderValidatorTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:112
This week:3
All time:9,266
This week:91Up

For more information send a message to info at phpclasses dot org.