albertcolom/assert-email

PHP library check email (RFC 2822, DNS, Temporal Mail, Allowed Domains)

1.0 2017-12-04 12:01 UTC

Requires

• php: ^5.4 || ^7.0

Requires (Dev)

• phpunit/phpunit: ^4.6

MIT

• Albert Colom

• email
• check
• assert
• validate

README

PHP >= 5.4

PHP library to check email inspired in webmozart/assert

Installation

composer require albertcolom/assert-email

Example usage

use albertcolom\Assert\AssertEmail;

class User
{
    //...
    
    public function setEmail(string $email)
    {
        AssertEmail::valid($email);
    }
}

$user = new User;

$user->setEmail('[e-mail]'); // true
$user->setEmail('foo@domain'); // InvalidArgumentException: Invalid email "foo@domain"

Assertions

Valid

Check email valid RFC 2822

valid($email, $message = '')

AssertEmail::valid('[e-mail]'); // true
AssertEmail::valid('foo@domain'); // InvalidArgumentException: Invalid email "foo@domain"
AssertEmail::valid('foo@domain', 'Custom message %s'); // InvalidArgumentException: Custom message "foo@domain"

Temporal mail

Check temporary emails, it provides a built-in database of 2000+ domains

temporalMail($email, $message = '')`

AssertEmail::temporalMail('[e-mail]'); // true
AssertEmail::temporalMail('[e-mail]'); // InvalidArgumentException: Temporal email is not allowed "[e-mail]"
AssertEmail::temporalMail('[e-mail]', 'Custom message %s'); // InvalidArgumentException: Custom message "[e-mail]"

DNS

Check DNS MX registry

dns($email, $message = '')

AssertEmail::dns('[e-mail]'); // true
AssertEmail::dns('foo@domain.000'); // InvalidArgumentException: Incorrect domain name "domain.000"
AssertEmail::dns('foo@domain.000', 'Custom message %s'); // InvalidArgumentException: Custom message "domain.000"

Domains Allowed

Check if domain allowed list

domainsAllowed($email, array $domains, $message = '')

$allowed = ['mysite.com', 'somedomain.xy', 'test.dev'];

AssertEmail::domainsAllowed('[e-mail]', $allowed); // true
AssertEmail::domainsAllowed('[e-mail]', $allowed); // InvalidArgumentException: Domain is not allowed "[e-mail]"
AssertEmail::domainsAllowed('[e-mail]', $allowed, 'Custom message %s'); // InvalidArgumentException: Custom message "[e-mail]"