php-tempmailbuster/README.md

2.7 KiB
Raw Blame History

PHP Tempmail Buster

Software License

Расширяемый класс для блокировки E-mail адресов определённых доменов или организации белого списка допустимых доменов. Реализует лоадер для загрузки и валидации по списку из Anti Tempmail Repo.

Установка

Install the latest version with

$ composer require ely/php-tempmailbuster

Использование

Пример использования с применением стандартного лоадера:

use Ely\TempMailBuster\Loader\AntiTempmailRepo;
use Ely\TempMailBuster\Storage;
use Ely\TempMailBuster\Validator;

// Создаём класс лоадера
$loader = new AntiTempmailRepo();
// Загружаем из него данные и передаём их в объект хранилища
$storage = new Storage($loader->load();
// или используем статичный метод для работы с лоадерами
$storage = Storage::fromLoader($loader);
// Создаём класс-валидатор
$validator = new Validator($storage);
$validator->validate('team@ely.by'); // = true
$validator->validate('hy42k@sendspamhere.com'); // = false

// Включаем режим белого списка
$validator->whitelistMode();
$validator->validate('team@ely.by'); // = false
$validator->validate('hy42k@sendspamhere.com'); // = true

Конструктор принимает 2 аргумента: первичное и вторичное хранилище. Первичное хранилище работает в соответствии с выбранным режимом работы библиотеки, а вторичное (если указано) позволяет добавить исключение из правил. Смотрите больше примеров вызова метода validate() в тестах.

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

This package was designed and developed within the Ely.by project team. We also thank all the contributors for their help.

License

The MIT License (MIT). Please see License File for more information.