NAME

MailboxValidator::SingleValidation - Email verification module for Perl using MailboxValidator API. It validates if the email is valid, from a free provider, contains high-risk keywords, whether it's a catch-all address and so much more.

SYNOPSIS

        use MailboxValidator::SingleValidation;
        
        my $mbv = MailboxValidator::SingleValidation->Init('PASTE_YOUR_API_KEY_HERE');
        
        my $results = $mbv->ValidateEmail('example@example.com');
        
        if (!defined($results))
        {
                print "Error connecting to API.\n";
        }
        elsif ($results->{error_code} eq '')
        {
                print 'email_address = ' . $results->{email_address} . "\n";
                print 'domain = ' . $results->{domain} . "\n";
                print 'is_free = ' . $results->{is_free} . "\n";
                print 'is_syntax = ' . $results->{is_syntax} . "\n";
                print 'is_domain = ' . $results->{is_domain} . "\n";
                print 'is_smtp = ' . $results->{is_smtp} . "\n";
                print 'is_verified = ' . $results->{is_verified} . "\n";
                print 'is_server_down = ' . $results->{is_server_down} . "\n";
                print 'is_greylisted = ' . $results->{is_greylisted} . "\n";
                print 'is_disposable = ' . $results->{is_disposable} . "\n";
                print 'is_suppressed = ' . $results->{is_suppressed} . "\n";
                print 'is_role = ' . $results->{is_role} . "\n";
                print 'is_high_risk = ' . $results->{is_high_risk} . "\n";
                print 'is_catchall = ' . $results->{is_catchall} . "\n";
                print 'mailboxvalidator_score = ' . $results->{mailboxvalidator_score} . "\n";
                print 'time_taken = ' . $results->{time_taken} . "\n";
                print 'status = ' . $results->{status} . "\n";
                print 'credits_available = ' . $results->{credits_available} . "\n";
        }
        else
        {
                print 'error_code = ' . $results->{error_code} . "\n";
                print 'error_message = ' . $results->{error_message} . "\n";
        }
        

DESCRIPTION

This Perl module provides an easy way to call the MailboxValidator API which validates if an email address is a valid one.

This module can be used in many types of projects such as:

 - validating a user's email during sign up
 - cleaning your mailing list prior to an email marketing campaign
 - a form of fraud check

Go to MailboxValidator API documentation page for more info.

DEPENDENCIES

An API key is required for this module to function.

Go to MailboxValidator API plans page to sign up for FREE API plan and you'll be given an API key.

CLASS METHODS

$mbv = MailboxValidator::SingleValidation->Init('PASTE_YOUR_API_KEY_HERE');

Constructs a new MailboxValidator::SingleValidation object with the specified API key.

OBJECT METHODS

$results = $mbv->ValidateEmail('example@example.com');

Returns the MailboxValidator API validation results. See MailboxValidator API documentation for more details.

SEE ALSO

MailboxValidator Website

VERSION

1.03

AUTHOR

Copyright (c) 2017 MailboxValidator.com

All rights reserved. This package is free software; It is licensed under the GPL.