karolyi
/
py3-validate-email
3
3
Fork 4
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Fix documentation

This commit is contained in:
László Károlyi 2019-03-02 03:26:58 +01:00
parent 9a8da38b47
commit 452434a81a
Signed by: karolyi
GPG Key ID: 2DCAF25E55735BFE
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.rst
View File

@ -1,16 +1,16 @@
.. 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:
@ -18,17 +18,20 @@ You can install the package with pip:
USAGE
=====
============================
Basic usage::
from validate_email import validate_email
is_valid = validate_email('example@example.com', check_regex=True, check_mx=True)
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 will check the mx-records and check whether the email actually exists
`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

1
setup.py
View File

@ -33,6 +33,7 @@ setup(
author_email='laszlo@karolyi.hu',
description='Email validator with regex and SMTP checking.',
long_description=open('README.rst').read(),
long_description_content_type='text/x-rst',
keywords='email validation verification mx verify',
url='http://github.com/karolyi/py3-validate-email',
cmdclass=dict(build_py=PostBuildPyCommand),