MailboxValidator CodeIgniter 4 Email Validation Package enables user to easily validate if an email address is valid, a type of disposable email or free email.

This package can be useful in many types of projects, for example

• to validate an user's email during sign up
• to clean your mailing list prior to email sending
• to perform fraud check
• and so on

Upload the Libraries folder to your CodeIgniter app folder

This package will only work with CodeIgniter 4. For CodeIgniter 3, you can get it from here.

An API key is required for this module to function.

Go to https://www.mailboxvalidator.com/plans#api to sign up for FREE API plan and you'll be given an API key.

After you get your API key, you can set you API key in controller during calling library. For example:

use App\Libraries\Mailboxvalidator;
$params = array('mbv_api_key' => 'PASTE_YOUR_API_KEY_HERE');
$mbv = new Mailboxvalidator($params);

Performs email validation on the supplied email address.

Check whether the email address is belongs to a disposable email provider or not. Return Values: True, False

Check whether the email address is belongs to a free email provider or not. Return Values: True, False

To use this library in form validation, first create a new file under app/Libraries called FormValidation.php.

After that, copy the following sample code into FormValidation.php:

<?php namespace App\Libraries;

use App\Libraries\Mailboxvalidator;

class FormValidation
{
    public function disposable($email, string &$error = null): bool
    {
        $params = array('mbv_api_key' => 'PASTE_YOUR_API_KEY_HERE');
        $$mbv = new Mailboxvalidator($params);
        if ($$mbv->isDisposableEmail($email) === true) {
            // If is_email_disposable return true, means the email is disposable email
            $error = 'A disposable email address is detected.';
            return false;
        } else {
            return true;
        }
    }

    public function free($email, string &$error = null): bool
    {
        $params = array('mbv_api_key' => 'PASTE_YOUR_API_KEY_HERE');
        $$mbv = new Mailboxvalidator($params);
        if ($$mbv->isFreeEmail($email) === true) {
            // If is_email_free return true, means the email is free email
            $error = 'A free email address is detected.';
            return false;
        } else {
            return true;
        }
    }
}

After that, open your app\Config\Validation.php file, and add the below line into the $ruleSets array:

        \App\Libraries\FormValidation::class,

Next, in your form controller, you can use the function from FormValidation.php to validate email. For example, if you want to use the disposable function to validate email, you can follow sample code as shown in below:

<?php namespace App\Controllers;

use CodeIgniter\Controller;

class Form extends Controller
{
    public function index()
    {
        helper(['form', 'url']);
        $validation =  \Config\Services::validation();
        echo view('Signup');
    }
    public function submit()
    {
        helper(['form', 'url']);

        if (! $this->validate([
            'username' => 'required',
            'email' => 'disposable',
        ]))
        {
            echo view('Signup-error', [
                'validation' => $this->validator
            ]);
        }
        else
        {
            echo view('Success');
        }
    }
}

Noted that you will be required to add a custom error message for it. Now you can open your form and try to enter a disposable email address to see the outcome. The form should return the error message for the disposable email.

To use this library to get validation result for an email address, firstly load the library in your controller like this:

use App\Libraries\Mailboxvalidator;

Next, in your controller function, load your MailboxValidator API key like this:

$params = array('mbv_api_key' => 'PASTE_YOUR_API_KEY_HERE');
$mbv = new Mailboxvalidator($params);

After that, you can get the validation result for the email address like this:

$result = $mbv->getSingleResult('test@example.com');

To pass the result to the view, just simply add the $result to your view loader like this:

echo view('result', $result);

And then in your view file, call the validation results. For example:

<?= esc($email_address); ?>
<?= esc($status); ?>

You can refer the full list of response parameters at above table.

Copyright (C) 2024 by MailboxValidator.com, support@mailboxvalidator.com