elpeter / kickbox-cakephp
通过 Kickbox 服务为 CakePHP 提供的电子邮件验证器
dev-master
2015-05-21 09:30 UTC
Requires
This package is not auto-updated.
Last update: 2024-09-28 17:17:53 UTC
README
CakePHP 插件,通过使用 Kickbox 服务进行电子邮件验证。[http://kickbox.io/](http://kickbox.io/)
入门指南
您可以将插件作为子模块添加到项目中,通过 git submodule
$ git submodule add git@github.com:pedroventura/kickbox-cakephp.git app/Plugin/KickboxEmail
否则,您可以使用 git clone 或下载它。将其放置在插件文件夹中。
解决依赖项
要获取 Kickbox 库和其余依赖项,您需要运行 composer。
$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install
在 CakePHP 中设置
要在您的项目中设置插件,请按照以下步骤操作。
获取 API 密钥
在 https://kickbox.io 上注册。 > 前往 API 设置 > 创建新的 API 密钥。
将插件添加到 Bootstrap
将以下行添加到您的 app/Config/bootstrap.php
CakePlugin::load('KickboxEmail', array('bootstrap' => true)); define('KICKBOXAPIKEY', 'KICKBOX API KEY GOES HERE');
使用从 kickbox.io 获取的 API 密钥设置常量 KICKBOXAPIKEY。
添加组件
将插件的主要组件添加到您的应用程序中。
您可以在 app/Controller/AppController.php 或您需要的控制器中添加它。
public $components = array( 'KickboxEmail.Validator' );
如何验证电子邮件
如下使用 validate 方法
$res = $this->Validator->verify('EMAIL GOES HERE');
$res 将返回 true 或 false。因此,如果电子邮件通过了验证或没有通过。
在 app/tmp/logs/kickbox.log 中有一个日志文件,您可以检查所有验证请求和返回数据。默认情况下已启用。您可以通过在 app/Config/bootstrap.php 中添加以下行来禁用它:
Configure::write('KickboxEmail.log', false);