py3-validate-email 0.2.4

Email validator with regex, blacklisted domains and SMTP checking.

py3-validate-email

py3-validate-email is a package for Python that check if an email is valid, not blacklisted, properly formatted and really exists.

This module is for Python 3.6 and above!

INSTALLATION

You can install the package with pip:

python -m pip install py3-validate-email

USAGE

Basic usage:

from validate_email import validate_email
is_valid = validate_email(email_address='[e-mail]', check_regex=True, check_mx=True, from_address='[e-mail]', helo_host='my.host.name', smtp_timeout=10, dns_timeout=10, use_blacklist=True)

check_regex will check will the email address has a valid structure and defaults to True

check_mx: check the mx-records and check whether the email actually exists

from_address: the email address the probe will be sent from,

helo_host: the host to use in SMTP HELO when checking for an email,

smtp_timeout: seconds until SMTP timeout

dns_timeout: seconds until DNS timeout

use_blacklist: use the blacklist of domains downloaded from https://github.com/martenson/disposable-email-domains

The function validate_email_or_fail() works exactly like validate_email, except that it raises an exception in the case of validation failure instead of returning False.

Auto-updater

The package contains an auto-updater for downloading and updating the built-in blacklist.txt. It will run on each module load (and installation), but will try to update the content only if the file is older than 5 days, and if the content is not the same that’s already downloaded.

The update can be triggered manually:

from validate_email.updater import update_builtin_blacklist

update_builtin_blacklist(force: bool = False, background: bool = True,
    callback: Callable = None) -> Optional[Thread]

force: forces the update even if the downloaded/installed file is fresh enough.

background: starts the update in a Thread so it won’t make your code hang while it’s updating. If you set this to true, the function will return the Thread used for starting the update so you can join() it if necessary.

callback: An optional Callable (function/method) to be called when the update is done.

TODOs and BUGS

See: https://github.com/karolyi/py3-validate-email/issues