38 lines
1.3 KiB
ReStructuredText
38 lines
1.3 KiB
ReStructuredText
.. image:: https://travis-ci.org/karolyi/py3-validate-email.svg?branch=master
|
|
:target: https://travis-ci.org/karolyi/py3-validate-email
|
|
|
|
============================
|
|
py3-validate-email
|
|
============================
|
|
|
|
py3-validate-email is a package for Python that check if an email is valid, properly formatted and really exists.
|
|
|
|
This module is for Python 3.6 and above!
|
|
|
|
INSTALLATION
|
|
============================
|
|
|
|
You can install the package with pip:
|
|
|
|
pip install py3-validate-email
|
|
|
|
|
|
USAGE
|
|
============================
|
|
|
|
Basic usage::
|
|
|
|
from validate_email import validate_email
|
|
is_valid = validate_email(email_address='example@example.com', check_regex=True, check_mx=True, from_address='my@from.addr.ess', smtp_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,
|
|
`smtp_timeout`: seconds until SMTP timeout
|
|
`use_blacklist`: use the blacklist of domains downloaded from [https://githubusercontent.com/martenson/disposable-email-domains](https://raw.githubusercontent.com/martenson/disposable-email-domains)
|
|
|
|
|
|
TODOs and BUGS
|
|
============================
|
|
See: https://github.com/karolyi/py3-validate-email/issues
|