mailboxvalidator/mailboxvalidator-cakephp

CakePHP 邮箱验证插件

1.1.0 2023-10-12 05:16 UTC

This package is auto-updated.

Last update: 2024-08-31 00:29:40 UTC


README

MailboxValidator CakePHP 邮箱验证包使用户能够轻松验证邮箱地址是否有效、是否为一次性邮箱或免费邮箱。

此包适用于许多类型的项目,例如

  • 在注册过程中验证用户的邮箱
  • 在发送邮件之前清理邮件列表
  • 进行欺诈检查
  • 等等

安装

打开终端,定位到项目根目录,并运行以下命令

composer require mailboxvalidator/mailboxvalidator-cakephp

如果您想手动安装此插件,首先将插件文件夹克隆到网站项目下的插件文件夹。然后,将以下行添加到您的项目 composer.json 文件中,如下所示

{
    ....
    "autoload": {
        "psr-4": {
            ....
            "MailboxValidatorCakePHP\\": "plugins/mailboxvalidator-cakephp/src/"
        }
    },
}

请记住运行此命令来自动加载我们的插件

composer dumpautoload

依赖项

此模块需要 API 密钥才能运行。

请访问 https://www.mailboxvalidator.com/plans#api 并免费注册 API 计划,您将获得一个 API 密钥。

获取 API 密钥后,打开您的 config/bootstrap.php 文件并添加以下行

Configure::write('MBV_API_KEY','PASTE_YOUR_API_KEY_HERE');

函数

single (email_address)

对提供的电子邮件地址执行验证。

disposable (email_address)

检查提供的电子邮件地址是否来自一次性电子邮件提供商。

free (email_address)

检查提供的电子邮件地址是否来自免费电子邮件提供商。

用法

在处理验证的任何表单控制器中包含此行

use MailboxValidatorCakePHP\Controller\MailboxValidatorController;

在任何表单验证方法中,在声明 $validator 之前,声明此行

$MBV = new MailboxValidatorController();

在 $validator 之后添加以下行

->setProvider('mbv', $MBV)

之后,向您的表单字段添加一个新的规则。例如,如果您想验证一次性电子邮件,则您的规则将如下所示

->add('email', 'disposable', [
        'rule' => 'disposable',
        'provider' => 'mbv',
        'message' => 'Invalid email address. Please enter a non-disposable email address.',
])

可用的验证器有:single、free 和 disposable。每个验证器都使用 MailboxValidator API 验证电子邮件。有关更多信息,请访问 单次验证 API一次性电子邮件 API免费电子邮件 API

错误

版权

版权 (C) 2018-2024 由 MailboxValidator.com 拥有,support@mailboxvalidator.com