elpeter/kickbox-cakephp

Email validator via Kickbox Service for CakePHP

Kickbox CakePHP

CakePHP Plugin for Email Verification by using Kickbox Service. http://kickbox.io/, _(*1)

Getting Started

You can add the plugin as submodule in your project, via git submodule:, _(*2)

$ git submodule add git@github.com:pedroventura/kickbox-cakephp.git app/Plugin/KickboxEmail

Otherwise, you can use git clone or download it. Place it in the Plugin folder., _(*3)

Resolve the dependencies

To get the Kickbox Library and the rest of the dependencies you will need to run composer., _(*4)

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install

Setup in CakePHP

To setup the plugin in your project follow the next steps., _(*5)

Get the API KEY

Register at https://kickbox.io. > Go to API Settings > Create new API KEY., _(*6)

Add the plugin to Bootstrap

Add the followind lines to your app/Config/bootstrap.php, _(*7)

CakePlugin::load('KickboxEmail', array('bootstrap' => true));
define('KICKBOXAPIKEY', 'KICKBOX API KEY GOES HERE');

Set the constant KICKBOXAPIKEY with your API KEY from kickbox.io., _(*8)

Add the Component

Add the main component of the Plugin in your application., _(*9)

You can add it for the whole project in app/Controller/AppController.php or the Controller you need it., _(*10)

public $components = array(
        'KickboxEmail.Validator'
    );

How to validate an email

Use the validate method as follows:, _(*11)

$res = $this->Validator->verify('EMAIL GOES HERE');

$res will return true or false. So, if the email passed the validation or not., _(*12)

There is a log file in app/tmp/logs/kickbox.log where you can check all the validation request and returned data. By default is enabled. You can disable it by adding the following line in the app/Config/bootstrap.php, _(*13)

Configure::write('KickboxEmail.log', false);