northrook/email-validator

An email validator.

dev-main 2024-06-22 06:22 UTC

This package is auto-updated.

Last update: 2024-12-22 07:28:37 UTC


README

A wrapper for the Egulias Email Validator.

Caution

This package is still in development.

Do not use it in production.

Slated features:

Filters allow for partial or exact matching against a white or black list of domains and/or IP addresses.

The blacklist can be fed from a centralized source, such as a database or a file.

Installation

composer require northrook/email-validator

Usage

use Northrook\EmailValidator;

$validator = new EmailValidator();

$validator->isValid( 'test@example.com' ); // true

$validator->isValid( 'test@example!com' ); // false

When the isValid method returns false, the following properties are available for the failed validation:

$validator->isValid;  // bool 
$validator->warnings; // array of warnings encountered during validation.
$validator->error;    // ?InvalidEmail object if invalid, else `null`.
$validator->reason;   // ?Reason object if invalid, else `null`.

License

MIT