MailboxValidator CodeIgniter 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 application folder

This package will only work with CodeIgniter 3. For CodeIgniter 4, 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, open your application/config/config.php and add the following line:

$config['mbv_api_key'] = 'PASTE_YOUR_API_KEY_HERE';

You can also set you api key in controller during calling library. Just do like this:

$params = array('mbv_api_key' => 'PASTE_YOUR_API_KEY_HERE');
$this->CI->load->library('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 application/libraries called MY_Form_validation.php.

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

<?php 
if (!defined('BASEPATH')) exit('No direct script access allowed');

class MY_Form_validation extends CI_Form_validation {

	protected $CI;
	public function __construct(){
    
        $this->CI = &get_instance();
		$this->CI->load->library('mailboxvalidator');
	}

    public function disposable($email) {
		if ($this->CI->mailboxvalidator->isDisposableEmail($email) == true) {
			// If is_email_disposable return true, means the email is disposable email
			return false;
		} else {
			return true;
		}
	}

    public function free($email) {
		if ($this->CI->mailboxvalidator->isFreeEmail($email) == true) {
			// If is_email_free return true, means the email is free email
			return false;
		} else {
			return true;
		}
	}

}

?>

Next, in your form controller, add the function name into the set_rules array. For example, if you want to use the disposable function to validate email, just add the disposable into the set_rules array. A sample code is displayed at below:

<?php
class Register extends CI_Controller
{
    public function __construct()
    {
         parent::__construct();
         $this->load->helper('form');
         $this->load->helper('url');
         $this->load->library('form_validation');
    }
    
    public function index()
    {
        $data['username'] = $this->input->post('username');
        $this->form_validation->set_rules('username', 'Username', 'required');
        $this->form_validation->set_rules('password', 'Password', 'required');
        $this->form_validation->set_rules('passconf', 'Password Confirmation', 'required');
        $this->form_validation->set_rules('email', 'Email', 'required|disposable', array('disposable' => 'A disposable email address is detected.'));
        if ($this->form_validation->run() == FALSE)
        {
                $this->load->view('register');
        }
        else
        {
                $this->load->view('sucess',$data);
        }
    }
    
    
}

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:

$this->load->library('mailboxvalidator');

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

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

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

$this->load->view('YOUR_VIEW_NAME',$result);

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

echo $email_address;

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

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