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

README.rst readability improvements

This commit is contained in:
László Károlyi 2021-09-13 18:34:16 +02:00
parent 853bfc15e7
commit 077e91d0bd
Signed by: karolyi
GPG Key ID: 2DCAF25E55735BFE
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.rst
View File

@ -25,7 +25,17 @@ USAGE
Basic usage::
from validate_email import validate_email
is_valid = validate_email(email_address='example@example.com', check_format=True, check_blacklist=True, check_dns=True, dns_timeout=10, check_smtp=True, smtp_timeout=10, smtp_helo_host='my.host.name', smtp_from_address='my@from.addr.ess', smtp_debug=False)
is_valid = validate_email(
email_address='example@example.com',
check_format=True,
check_blacklist=True,
check_dns=True,
dns_timeout=10,
check_smtp=True,
smtp_timeout=10,
smtp_helo_host='my.host.name',
smtp_from_address='my@from.addr.ess',
smtp_debug=False)
Parameters
----------------------------
@ -160,8 +170,11 @@ 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]
update_builtin_blacklist(
force: bool = False,
background: bool = True,
callback: Callable = None
) -> Optional[Thread]
:code:`force`: forces the update even if the downloaded/installed file is fresh enough.