py3-validate-email/README.rst

53 lines
1.0 KiB
ReStructuredText

==============
validate_email
==============
validate_email is a package for Python that check if an email is valid, properly formatted and really exists (connecting to the server and "asking")
INSTALLATION
============
First, you must do::
pip install validate_email
Extra
------
For check the domain mx and verify email exits you must have the `pyDNS` package installed::
pip install pyDNS
USAGE
=====
Basic usage::
from validate_email import validate_email
is_valid = validate_email('example@example.com')
Checking domain has SMTP Server
-------------------------------
For check if the host has SMPT Server
from validate_email import validate_email
is_valid = validate_email('example@example.com',mx=True)
Verify email exists
-------------------
Check if the host has SMPT Server and the email exists in the server.
from validate_email import validate_email
is_valid = validate_email('example@example.com',verify=True)
TODOs and BUGS
==============
See: http://github.com/syrusakbary/validate_email/issues