MailboxValidator Flask Python Module

This Flask 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

Installation

To install this module type the following:

pip install flask_MailboxValidator

Dependencies

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.

In order to use this module to validate email from form, WTForms and Flask-WTF need to be installed. Also, nose2 need to be installed in order to run the test file.

Functions

SingleValidation (api_key)

Creates a new instance of the MailboxValidator object with the API key.

ValidateEmail (email_address)

Performs email validation on the supplied email address.

Return Fields

DisposableEmail (email_address)

Check if the supplied email address is from a disposable email provider.

Return Fields

FreeEmail (email_address)

Check if the supplied email address is from a free email provider.

Return Fields

Usage for validate email from form

Note: WTForms and Flask-WTF must be installed before using this features.

This Flask Python module had three different validator for different uses: EmailValidation for validating email address by all parameters, DisposableEmailValidation for validating disposable email address, and FreeEmailValidation for validating free email address.

1. Import the validator class from the package. For example: from flask_MailboxValidator.SingleValidation import EmailValidation
2. Call the validator in validator array along with your API key. For example: email = StringField('Email:', validators=[validators.InputRequired(), EmailValidation(apikey='Your_API_Key')])

Sample Codes

Validate email

import flask_MailboxValidator
from flask import Flask
from flask import jsonify

app = Flask(__name__)

mbv = flask_MailboxValidator.SingleValidation('PASTE_API_KEY_HERE')
results = mbv.ValidateEmail('example@example.com')

@app.route('/')
def display_result():
	if results is None:
		return("Error connecting to API.\n")
	elif 'error' not in results:
		return (jsonify(results))
	else:
		return('error_message = ' + results['error']['error_message'] + "\n")

Check if an email is from a disposable email provider

import flask_MailboxValidator
from flask import Flask
from flask import jsonify

app = Flask(__name__)

mbv = flask_MailboxValidator.SingleValidation('PASTE_API_KEY_HERE')
results = mbv.DisposableEmail('example@example.com')

@app.route('/')
def display_result():
	if results is None:
		return("Error connecting to API.\n")
	elif 'error' not in results:
		return (jsonify(results))
	else:
		return('error_message = ' + results['error']['error_message'] + "\n")

Check if an email is from a free email provider

import flask_MailboxValidator
from flask import Flask
from flask import jsonify

app = Flask(__name__)

mbv = flask_MailboxValidator.SingleValidation('PASTE_API_KEY_HERE')
results = mbv.FreeEmail('example@example.com')

@app.route('/')
def display_result():
	if results is None:
		return("Error connecting to API.\n")
	elif 'error' not in results:
		return (jsonify(results))
	else:
		return('error_message = ' + results['error']['error_message'] + "\n")

Test

To run the test file, you will first need to replace the 'PASTE_API_KEY_HERE' with your API key in the test file(Located at test directory). After that, run this command in terminal: python setup.py test

Errors

Copyright

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