README

MailboxValidator Yii 电子邮件验证扩展允许用户轻松验证电子邮件地址是否有效，是否为一次性电子邮件或免费电子邮件。

此扩展在许多类型的项目中都很有用，例如

• 在注册时验证用户的电子邮件
• 在发送电子邮件之前清理您的邮件列表
• 进行欺诈检查
• 等等

安装

使用 Composer 安装此扩展

composer require mailboxvalidator/mailboxvalidator-yii

依赖关系

此模块要正常工作需要 API 密钥。

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

获取 API 密钥后，打开您的 config/params.php 并将以下行添加到数组中

'mbvAPIKey' => 'PASTE_YOUR_API_KEY_HERE',

您也可以在调用库后设置您的 API 密钥。只需这样做

$mbv = new EmailValidation('PASTE_YOUR_API_KEY_HERE');

或这样

['email', MailboxValidator::className(), 'option'=>'YOUR_SELECTED_OPTION','api_key'=>'PASTE_YOUR_API_KEY_HERE',],

函数

EmailValidation (api_key)

使用 API 密钥创建 MailboxValidator 对象的新实例。

validateDisposable (email_address)

检查电子邮件地址是否属于一次性电子邮件服务提供商。返回值：True，False

validateFree (email_address)

检查电子邮件地址是否属于免费电子邮件服务提供商。返回值：True，False

validateEmail (email_address)

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

返回字段

isDisposableEmail (email_address)

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

返回字段

isFreeEmail (email_address)

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

返回字段

用法

表单验证

要在表单验证中使用此库，首先在模型中调用此库，如下所示

use MailboxValidator\MailboxValidator;

之后，在函数 rules 中添加电子邮件的新验证规则

['YOUR_EMAIL_FIELD_NAME', MailboxValidator::className(), 'option'=>'disposable,free',],

在这行中，扩展已被调用，您需要指定要使用的验证器。可用的验证器有 disposable 和 free。之后，刷新您的表单并查看结果。

电子邮件验证

要使用此库获取电子邮件地址的验证结果，首先在控制器中加载库，如下所示

use MailboxValidator\EmailValidation;

之后，您可以得到电子邮件地址的验证结果，如下所示

$mbv = new EmailValidation(Yii::$app->params['mbvAPIKey']);
$results = $mbv->isFreeEmail('example@example.com');

要将结果传递到视图中，只需将 $results 添加到视图加载器中，如下所示

return $this->render('YOUR_VIEW_NAME', ['results' => $results]);

然后在您的视图文件中调用验证结果。例如

echo 'email_address = ' . $results->email_address . "<br>";

您可以在上面找到可用的完整响应参数列表。

错误

版权

版权 (C) 2018-2023 by MailboxValidator.com，support@mailboxvalidator.com