EmailValidator README

The project's README from github.com/egulias/EmailValidator. As one markdown file: README.md.

EmailValidator

Build Status Quality Badge Test Coverage Latest Release

A library for validating emails against several RFC.

Supported RFCs

This library aims to support RFCs:

Supported versions

Version Released EOL Only critical bug fixes Full
v4.x 2023/01/07 - X X
v3.x 2020/12/29 YES
v2.1.x 2016/05/16 YES
v1.2 2013/19/05 YES

Requirements

Note: PHP version upgrades will happen to accomodate to the pace of major frameworks. Minor versions bumps will go via minor versions of this library (i.e: PHP7.3 -> v3.x+1). Major versions will go with major versions of the library

Installation

Run the command below to install via Composer

composer require egulias/email-validator

Getting Started

EmailValidator requires you to decide which (or combination of them) validation/s strategy/ies you'd like to follow for each validation.

A basic example with the RFC validation

<?php

use Egulias\EmailValidator\EmailValidator;
use Egulias\EmailValidator\Validation\RFCValidation;

$validator = new EmailValidator();
$validator->isValid("[email protected]", new RFCValidation()); //true

Available validations

  1. RFCValidation: Standard RFC-like email validation.
  2. NoRFCWarningsValidation: RFC-like validation that will fail when warnings* are found.
  3. DNSCheckValidation: Will check if there are DNS records that signal that the server accepts emails. This does not entail that the email exists.
  4. MultipleValidationWithAnd: It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
  5. MessageIDValidation: Follows RFC2822 for message-id to validate that field, that has some differences in the domain part.
  6. Your own validation: You can extend the library behaviour by implementing your own validations.

*warnings: Warnings are deviations from the RFC that in a broader interpretation are accepted.

<?php

use Egulias\EmailValidator\EmailValidator;
use Egulias\EmailValidator\Validation\DNSCheckValidation;
use Egulias\EmailValidator\Validation\MultipleValidationWithAnd;
use Egulias\EmailValidator\Validation\RFCValidation;

$validator = new EmailValidator();
$multipleValidations = new MultipleValidationWithAnd([
    new RFCValidation(),
    new DNSCheckValidation()
]);
//ietf.org has MX records signaling a server with email capabilities
$validator->isValid("[email protected]", $multipleValidations); //true

Additional validations

Validations not present in the RFCs

  1. SpoofCheckValidation: Will check for multi-utf-8 chars that can signal an erroneous email name.

How to extend

It's easy! You just need to implement EmailValidation and you can use your own validation.

Contributing

Please follow the Contribution guide. Is short and simple and will help a lot.

Other Contributors

(You can find current contributors here)

As this is a port from another library and work, here are other people related to the previous one:

License

Released under the MIT License attached with this code.

EmailValidator (egulias/EmailValidator)

Searching Database…

11.6K ·GitHub
EmailValidator
Что это такое?PHP-библиотека, которая проверяет адреса электронной почты на соответствие нескольким RFC — 5321, 5322, 6530, 6531, 6532 и 1035.
Это отдельное приложение или код, который я подключаю в свой проект?Это библиотека, а не приложение: вы подключаете её в своём PHP-проекте и вызываете её классы для проверки из собственного кода.
Как добавить её в свой PHP-проект?Установите её через Composer (в README приведена команда require), затем выберите, какая стратегия проверки — или их комбинация — будет использоваться для каждой проверки.
Что нужно в моём окружении, чтобы работали все виды проверок?PHP 8.1 или новее плюс Composer. Для проверки подмены (spoof checking) и DNSCheckValidation дополнительно нужно расширение PHP Internationalization Libraries (PHP Intl).
Если проверка DNS прошла, можно ли быть уверенным, что ящик действительно существует?Нет — DNSCheckValidation лишь ищет DNS-записи, которые сигнализируют, что сервер принимает почту; успешная проверка не означает, что адрес существует.
Какие стратегии проверки в неё встроены?Встроенные варианты: RFCValidation (стандартные проверки по RFC), NoRFCWarningsValidation (выдаёт ошибку при обнаружении предупреждений), DNSCheckValidation, MessageIDValidation (поля message-id по RFC2822), SpoofCheckValidation (помечает подозрительные многобайтовые UTF-8 символы) и MultipleValidationWithAnd, которая объединяет другие проверки логическим «И».
Можно ли комбинировать проверки или написать свою?Да. MultipleValidationWithAnd оборачивает другие проверки и проходит только если все они прошли, а библиотеку можно расширять, реализовав интерфейс EmailValidation со своими правилами.
Она работает с интернационализированными адресами, содержащими не-ASCII символы?Да — библиотека специально нацелена на RFC 6530, 6531 и 6532, которые описывают интернационализированные адреса, а SpoofCheckValidation может помечать многобайтовые UTF-8 имена, указывающие на ошибочное имя почты.
Какую версию использовать, и поддерживается ли проект до сих пор?Используйте v4.x, выпущенную в январе 2023 года — эта ветка полностью поддерживается. v3.x, v2.1.x и v1.2 уже не поддерживаются, а требования к версии PHP будут расти вместе с версиями библиотеки.
What are similar projects?php-fts, validator.js, PHPMailer, laravel-ide-helper, flysystem, sqlx, vee-validate, ajv
Which topics is it in?validator, php-library, unicode, internationalization, mit-license, dns, email, php, utility, backend, free, library
Creator
egulias
Size
0.7 MB
Stars
11.6K
Updated
CommitMar 06Release4.0.4Mar 20
Age
13y
Commits · 90 Days