Skip to content

Commit dd13053

Browse files
committed
Some README tweaks
1 parent a666481 commit dd13053

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This library is tested with Python 3.6+ but should work in earlier versions:
3131

3232
[![Build Status](https://app.travis-ci.com/JoshData/python-email-validator.svg?branch=main)](https://app.travis-ci.com/JoshData/python-email-validator)
3333

34-
[CHANGELOG / Release Notes](CHANGELOG.md)
34+
View the [CHANGELOG / Release Notes](CHANGELOG.md) for the version history of changes in the library. Occasionally this README is ahead of the latest published package --- see the CHANGELOG for details.
3535

3636
---
3737

@@ -111,7 +111,6 @@ The validator checks that the domain name in the email address has a
111111
DNS MX record (except a NULL MX record) indicating that it can receive
112112
email and that it does not have a reject-all SPF record (`v=spf1 -all`)
113113
which would indicate that it cannot send email.
114-
(A/AAAA-record MX fallback is also checked.)
115114
There is nothing to be gained by trying to actually contact an SMTP
116115
server, so that's not done here. For privacy, security, and practicality
117116
reasons servers are good at not giving away whether an address is
@@ -129,7 +128,7 @@ The `validate_email` function also accepts the following keyword arguments
129128
require the
130129
[SMTPUTF8](https://tools.ietf.org/html/rfc6531) extension. You can also set `email_validator.ALLOW_SMTPUTF8` to `False` to turn it off for all calls by default.
131130

132-
`check_deliverability=True`: Set to `False` to skip DNS record checks for the domain. It is recommended to pass `False` when performing validation for login pages since re-validation of the domain by querying DNS at every login is probably undesirable. You can also set `email_validator.CHECK_DELIVERABILITY` to `False` to turn this off for all calls by default.
131+
`check_deliverability=True`: If true, DNS queries check that a non-null MX (or A/AAAA record as an MX fallback) is present for the domain-part of the email address and that a reject-all SPF record is not present. Set to `False` to skip these DNS checks. DNS is slow and sometimes unavailable, so consider whether these checks are useful for your use case. It is recommended to pass `False` when performing validation for login pages (but not account creation pages) since re-validation of the domain by querying DNS at every login is probably undesirable. You can also set `email_validator.CHECK_DELIVERABILITY` to `False` to turn this off for all calls by default.
133132

134133
`allow_empty_local=False`: Set to `True` to allow an empty local part (i.e.
135134
`@example.com`), e.g. for validating Postfix aliases.

0 commit comments

Comments
 (0)