README

Inspector is an email validation library built in PHP. It checks for existing domains, proper formatting, a custom email blacklist, and disposable email addresses. Contributions are welcome!

Installation

Install via Composer:

composer require itselijahwood/inspector

Usage

Validate Email Format

Checks whether an email follows the correct format.

$email = "example@gmailcom"; // Missing '.' after 'gmail'
$inspector = new \ItsElijahWood\Inspector\Inspector;

$isValidFormat = $inspector->hasValidFormat($email);

echo $isValidFormat ? "Format is valid" : "Format is not valid";
// Output: "Format is not valid"

Check Domain Validity

Verifies if the email's domain exists.

$email = "example@test.com"; // '@test.com' is not a valid domain
$inspector = new \ItsElijahWood\Inspector\Inspector;

$isValidDomain = $inspector->hasValidDomain($email);

echo $isValidDomain ? "Domain is valid" : "Domain is not valid";
// Output: "Domain is not valid"

Detect Disposable Email Providers

Identifies emails from common temporary/disposable email providers.

$email = "example@temp-mail.org"; // '@temp-mail.org' is a disposable email domain
$inspector = new \ItsElijahWood\Inspector\Inspector;

$isDisposable = $inspector->isDisposable($email);

echo $isDisposable ? "Domain is disposable." : "Domain is not disposable.";
// Output: "Domain is disposable."

Custom Email Blacklist

Allows adding custom email addresses to a blacklist.

$email = "test@gmail.com"; // Listed in the blacklist
$blacklistedEmails = ["test@gmail.com", "test2@gmail.com"];
$inspector = new \ItsElijahWood\Inspector\Inspector;

$isBlacklisted = $inspector->isBlacklisted($email, $blacklistedEmails);

echo $isBlacklisted ? "Email is blacklisted." : "Email is not blacklisted.";
// Output: "Email is blacklisted."