This Python module enables user to easily validate if an email address is valid, a type of disposable email or free email.
This module 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
To install this module type the following:
pip install MailboxValidator
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.
Creates a new instance of the MailboxValidator object with the API key.
Performs email validation on the supplied email address.
| Field Name | Description |
|---|---|
| email_address | The input email address. |
| domain | The domain of the email address. |
| is_free | Whether the email address is from a free email provider like Gmail or Hotmail. Return values: True, False |
| is_syntax | Whether the email address is syntactically correct. Return values: True, False |
| is_domain | Whether the email address has a valid MX record in its DNS entries. Return values: True, False, - (- means not applicable) |
| is_smtp | Whether the mail servers specified in the MX records are responding to connections. Return values: True, False, - (- means not applicable) |
| is_verified | Whether the mail server confirms that the email address actually exist. Return values: True, False, - (- means not applicable) |
| is_server_down | Whether the mail server is currently down or unresponsive. Return values: True, False, - (- means not applicable) |
| is_greylisted | Whether the mail server employs greylisting where an email has to be sent a second time at a later time. Return values: True, False, - (- means not applicable) |
| is_disposable | Whether the email address is a temporary one from a disposable email provider. Return values: True, False, - (- means not applicable) |
| is_suppressed | Whether the email address is in our blacklist. Return values: True, False, - (- means not applicable) |
| is_role | Whether the email address is a role-based email address like [email protected] or [email protected]. Return values: True, False, - (- means not applicable) |
| is_high_risk | Whether the email address contains high risk keywords. Return values: True, False, - (- means not applicable) |
| is_catchall | Whether the email address is a catch-all address. Return values: True, False, Unknown, - (- means not applicable) |
| mailboxvalidator_score | Email address reputation score. Score > 0.70 means good; score > 0.40 means fair; score <= 0.40 means poor. |
| time_taken | The time taken to get the results in seconds. |
| status | Whether our system think the email address is valid based on all the previous fields. Return values: True, False |
| credits_available | The number of credits left to perform validations. |
| error_code | The error code if there is any error. See error table in the below section. |
| error_message | The error message if there is any error. See error table in the below section. |
Check if the supplied email address is from a disposable email provider.
| Field Name | Description |
|---|---|
| email_address | The input email address. |
| is_disposable | Whether the email address is a temporary one from a disposable email provider. Return values: True, False |
| credits_available | The number of credits left to perform validations. |
| error_code | The error code if there is any error. See error table in the below section. |
| error_message | The error message if there is any error. See error table in the below section. |
Check if the supplied email address is from a free email provider.
| Field Name | Description |
|---|---|
| email_address | The input email address. |
| is_free | Whether the email address is from a free email provider like Gmail or Hotmail. Return values: True, False |
| credits_available | The number of credits left to perform validations. |
| error_code | The error code if there is any error. See error table in the below section. |
| error_message | The error message if there is any error. See error table below. |
import MailboxValidator
mbv = MailboxValidator.EmailValidation('PASTE_API_KEY_HERE')
results = mbv.validate_email('[email protected]')
if results is None:
print("Error connecting to API.\n")
elif 'error' not in results:
print('email_address = ' + results['email_address'] + "\n")
print('domain = ' + results['domain'] + "\n")
print('is_free = ' + str(results['is_free']) + "\n")
print('is_syntax = ' + str(results['is_syntax']) + "\n")
print('is_domain = ' + str(results['is_domain']) + "\n")
print('is_smtp = ' + str(results['is_smtp']) + "\n")
print('is_verified = ' + str(results['is_verified']) + "\n")
print('is_server_down = ' + str(results['is_server_down']) + "\n")
print('is_greylisted = ' + str(results['is_greylisted']) + "\n")
print('is_disposable = ' + str(results['is_disposable']) + "\n")
print('is_suppressed = ' + str(results['is_suppressed']) + "\n")
print('is_role = ' + str(results['is_role']) + "\n")
print('is_high_risk = ' + str(results['is_high_risk']) + "\n")
print('is_catchall = ' + str(results['is_catchall']) + "\n")
print('mailboxvalidator_score = ' + str(results['mailboxvalidator_score']) + "\n")
print('time_taken = ' + str(results['time_taken']) + "\n")
print('status = ' + str(results['status']) + "\n")
print('credits_available = ' + str(results['credits_available']) + "\n")
else:
print('error_code = ' + str(results['error']['error_code']) + "\n")
print('error_message = ' + results['error']['error_message'] + "\n")import MailboxValidator
mbv = MailboxValidator.EmailValidation('PASTE_API_KEY_HERE')
results = mbv.is_disposable_email('[email protected]')
if results is None:
print("Error connecting to API.\n")
elif 'error' not in results:
print('email_address = ' + results['email_address'] + "\n")
print('is_disposable = ' + str(results['is_disposable']) + "\n")
print('credits_available = ' + str(results['credits_available']) + "\n")
else:
print('error_code = ' + results['error']['error_code'] + "\n")
print('error_message = ' + results['error']['error_message'] + "\n")import MailboxValidator
mbv = MailboxValidator.EmailValidation('PASTE_API_KEY_HERE')
results = mbv.is_free_email('[email protected]')
if results is None:
print("Error connecting to API.\n")
elif 'error' not in results:
print('email_address = ' + results['email_address'] + "\n")
print('is_free = ' + str(results['is_free']) + "\n")
print('credits_available = ' + str(results['credits_available']) + "\n")
else:
print('error_code = ' + results['error']['error_code'] + "\n")
print('error_message = ' + results['error']['error_message'] + "\n")| error_code | error_message |
|---|---|
| 100 | Missing parameter. |
| 101 | API key not found. |
| 102 | API key disabled. |
| 103 | API key expired. |
| 104 | Insufficient credits. |
| 105 | Unknown error. |
Copyright (C) 2018-2023 by MailboxValidator.com, [email protected]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent