module-kickbox

Kickbox.io email verification for Magento 2, _(*1)

This module is a wrapper for the Kickbox.io php api library., _(*2)

Based on linusshops/kickbox-magento for Magento 1., _(*3)

Usage

Verify an email

Inject LinusShops\Kickbox\Model\EmailVerifier for access to verification., _(*4)

$email = 'test@example.com';

//'risky' emails are also considered deliverable
$this->emailVerifier->verifyIsDeliverable($email)

Verify an email using the response model

$verifiedEmail = $this->emailVerifier->verify('info@linusshops.com');
$isValid = $verifiedEmail->isDeliverable();

//Access any of the response fields from Kickbox as magic methods.
$result = $verifiedEmail->result();
$didYouMean = $verifiedEmail->did_you_mean();
$sendex = $verifiedEmail->sendex();

Use the ajax endpoint to verify client-side

http://example.com/en/kickbox/deliverable?email=test@example.com, _(*5)

{
    "error": 0,
    "feedback": {
        "message": "Data retrieved successfully!",
        "debug": [],
        "target": ""
    },
    "tpl": [],
    "target": {
        "feedback": "",
        "payload": ""
    },
    "payload": {
        "email": "samuel@dersam.net",
        "deliverable": true
    }
}

For best results, use Common.ajax for automagical parsing. https://github.com/linusshops/module-common, _(*6)