README

方便的Laravel邮件黑名单管理。

安装

您可以通过composer使用以下命令安装此包：

composer require hivokas/laravel-email-blacklist

包将自动注册自己。

您可以使用以下命令发布迁移：

php artisan vendor:publish --provider="Hivokas\EmailBlacklist\Providers\EmailBlacklistServiceProvider" --tag="migrations"

迁移发布后，您可以通过运行迁移来创建黑名单邮件的表：

php artisan migrate

您可以使用以下命令发布配置文件：

php artisan vendor:publish --provider="Hivokas\EmailBlacklist\Providers\EmailBlacklistServiceProvider" --tag="config"

这是已发布配置文件的内容

return [

    /*
    |--------------------------------------------------------------------------
    | Table Name For Email Blacklist Storing
    |--------------------------------------------------------------------------
    */
    'table_name' => 'blacklisted_emails',

    /*
    |--------------------------------------------------------------------------
    | BlacklistedEmail Model
    |--------------------------------------------------------------------------
    */
    'model' => \Hivokas\EmailBlacklist\Models\BlacklistedEmail::class,

];

使用示例

use Hivokas\EmailBlacklist\Facades\EmailBlacklist;

EmailBlacklist::add('me@hivokas.com');

EmailBlacklist::count(); // 1

EmailBlacklist::all(); // ['me@hivokas.com']

EmailBlacklist::exists('me@hivokas.com'); // true

EmailBlacklist::remove('me@hivokas.com');

EmailBlacklist::exists('me@hivokas.com'); // false

EmailBlacklist::count(); // 0

方法

all()

返回所有被黑名单的电子邮件。

count()

返回被黑名单的电子邮件数量。

exists(string $email)

如果电子邮件被黑名单，则返回true，反之亦然。

add(string $email)

将电子邮件添加到黑名单。

remove(string $email)

从黑名单中删除电子邮件。

validate(string $email)

如果电子邮件无效，则抛出InvalidArgumentException。

测试

您可以使用以下命令运行测试：

composer test