py3-validate-email/README.rst

35 lines
830 B
ReStructuredText
Raw Normal View History

2019-03-01 23:32:03 +01:00
.. image:: https://travis-ci.org/karolyi/py3-validate-email.svg?branch=master
:target: https://travis-ci.org/karolyi/py3-validate-email
2012-04-07 23:05:57 +02:00
==============
2019-03-01 23:32:03 +01:00
py3-validate-email
2012-04-07 23:05:57 +02:00
==============
2019-03-01 23:32:03 +01:00
py3-validate-email is a package for Python that check if an email is valid, properly formatted and really exists.
2012-04-07 23:05:57 +02:00
INSTALLATION
============
You can install the package with pip:
2012-04-07 23:05:57 +02:00
2019-03-01 23:32:03 +01:00
pip install py3-validate-email
2012-04-07 23:05:57 +02:00
USAGE
=====
Basic usage::
2019-03-01 23:32:03 +01:00
from validate_email import validate_email
2018-06-01 14:41:28 +02:00
is_valid = validate_email('example@example.com', check_regex=True, check_mx=True)
2012-04-07 23:05:57 +02:00
2018-06-01 14:41:28 +02:00
check_regex will check will the email address has a valid structure and defaults to True
check_mx will check the mx-records and check whether the email actually exists
2012-04-07 23:05:57 +02:00
TODOs and BUGS
==============
2019-03-01 23:32:03 +01:00
See: https://github.com/karolyi/py3-validate-email/issues