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

Remove backslashes

This commit is contained in:
László Károlyi 2021-11-16 23:54:19 +01:00
parent 51bd9f459c
commit 996787e472
Signed by: karolyi
GPG Key ID: 2DCAF25E55735BFE
1 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -37,33 +37,33 @@ Basic usage:
### Parameters
email\_address: the email address to check
email_address: the email address to check
check\_format: check whether the email address has a valid structure; defaults to True
check_format: check whether the email address has a valid structure; defaults to True
check\_blacklist: check the email against the blacklist of domains downloaded from <https://github.com/disposable-email-domains/disposable-email-domains>; defaults to True
check_blacklist: check the email against the blacklist of domains downloaded from <https://github.com/disposable-email-domains/disposable-email-domains>; defaults to True
check\_dns: check the DNS mx-records, defaults to True
check_dns: check the DNS mx-records, defaults to True
dns\_timeout: seconds until DNS timeout; defaults to 10 seconds
dns_timeout: seconds until DNS timeout; defaults to 10 seconds
check\_smtp: check whether the email actually exists by initiating an SMTP conversation; defaults to True
check_smtp: check whether the email actually exists by initiating an SMTP conversation; defaults to True
smtp\_timeout: seconds until SMTP timeout; defaults to 10 seconds
smtp_timeout: seconds until SMTP timeout; defaults to 10 seconds
smtp\_helo\_host: the hostname to use in SMTP HELO/EHLO; if set to None (the default), the fully qualified domain name of the local host is used
smtp_helo_host: the hostname to use in SMTP HELO/EHLO; if set to None (the default), the fully qualified domain name of the local host is used
smtp\_from\_address: the email address used for the sender in the SMTP conversation; if set to None (the default), the email\_address parameter is used as the sender as well
smtp_from_address: the email address used for the sender in the SMTP conversation; if set to None (the default), the email_address parameter is used as the sender as well
smtp\_skip\_tls: skip the TLS negotiation with the server, even when available. defaults to False
smtp_skip_tls: skip the TLS negotiation with the server, even when available. defaults to False
smtp\_tls\_context: an SSLContext to use with the TLS negotiation when the server supports it. defaults to None
smtp_tls_context: an SSLContext to use with the TLS negotiation when the server supports it. defaults to None
smtp\_debug: activate smtplib's debug output which always goes to stderr; defaults to False
smtp_debug: activate smtplib's debug output which always goes to stderr; defaults to False
### Result
The function validate\_email() returns the following results:
The function validate_email() returns the following results:
True
All requested checks were successful for the given email address.
@ -76,38 +76,38 @@ None of the requested checks failed, but at least one of them yielded an ambiguo
### Getting more information
The function validate\_email\_or\_fail() works exactly like validate\_email, except that it raises an exception in the case of validation failure and ambiguous result instead of returning False or None, respectively.
The function validate_email_or_fail() works exactly like validate_email, except that it raises an exception in the case of validation failure and ambiguous result instead of returning False or None, respectively.
All these exceptions descend from EmailValidationError. Please see below for the exact exceptions raised by the various checks. Note that all exception classes are defined in the module validate\_email.exceptions.
All these exceptions descend from EmailValidationError. Please see below for the exact exceptions raised by the various checks. Note that all exception classes are defined in the module validate_email.exceptions.
Please note that SMTPTemporaryError indicates an ambiguous check result rather than a check failure, so if you use validate\_email\_or\_fail(), you probably want to catch this exception.
Please note that SMTPTemporaryError indicates an ambiguous check result rather than a check failure, so if you use validate_email_or_fail(), you probably want to catch this exception.
The checks
----------
By default, all checks are enabled, but each of them can be disabled by one of the check\_... parameters. Note that, however, check\_smtp implies check\_dns.
By default, all checks are enabled, but each of them can be disabled by one of the check_... parameters. Note that, however, check_smtp implies check_dns.
### check\_format
### check_format
Check whether the given email address conforms to the general format requirements of valid email addresses.
validate\_email\_or\_fail() raises AddressFormatError on any failure of this test.
validate_email_or_fail() raises AddressFormatError on any failure of this test.
### check\_blacklist
### check_blacklist
Check whether the domain part of the given email address (the part behind the ["@"](mailto:"@")) is known as a disposable and temporary email address domain. These are often used to register dummy users in order to spam or abuse some services.
A list of such domains is maintained at <https://github.com/disposable-email-domains/disposable-email-domains>, and this module uses that list.
validate\_email\_or\_fail() raises DomainBlacklistedError if the email address belongs to a blacklisted domain.
validate_email_or_fail() raises DomainBlacklistedError if the email address belongs to a blacklisted domain.
### check\_dns
### check_dns
Check whether there is a valid list of servers responsible for delivering emails to the given email address.
First, a DNS query is issued for the email address' domain to retrieve a list of all MX records. That list is then stripped of duplicates and malformatted entries. If at the end of this procedure, at least one valid MX record remains, the check is considered successful.
On failure of this check, validate\_email\_or\_fail() raises one of the following exceptions, all of which descend from DNSError:
On failure of this check, validate_email_or_fail() raises one of the following exceptions, all of which descend from DNSError:
DomainNotFoundError
The domain of the email address cannot be found at all.
@ -116,7 +116,7 @@ NoNameserverError
There is no nameserver for the domain.
DNSTimeoutError
A timeout occured when querying the nameserver. Note that the timeout period can be changed with the dns\_timeout parameter.
A timeout occured when querying the nameserver. Note that the timeout period can be changed with the dns_timeout parameter.
DNSConfigurationError
The nameserver is misconfigured.
@ -127,13 +127,13 @@ The nameserver does not list any MX records for the domain.
NoValidMXError
The nameserver lists MX records for the domain, but none of them is valid.
### check\_smtp
### check_smtp
Check whether the given email address exists by simulating an actual email delivery.
A connection to the SMTP server identified through the domain's MX record is established, and an SMTP conversation is initiated up to the point where the server confirms the existence of the email address. After that, instead of actually sending an email, the conversation is cancelled.
Unless you set smtp\_skip\_tls to True, the module will try to negotiate a TLS connection with STARTTLS, and silently fall back to an unencrypted SMTP connection if the server doesn't support it. Additionally, depending on your client configuration, the TLS negotiation might fail which will result in an ambiguous response for the given host as the module will be unable to communicate with the host after the negotiation fails. In trying to succeed, you can pass an SSLContext as an smtp\_tls\_context parameter, but remember that the server might still deny the negotiation based on how you set the SSLContext up, and based on its security settings as well.
Unless you set smtp_skip_tls to True, the module will try to negotiate a TLS connection with STARTTLS, and silently fall back to an unencrypted SMTP connection if the server doesn't support it. Additionally, depending on your client configuration, the TLS negotiation might fail which will result in an ambiguous response for the given host as the module will be unable to communicate with the host after the negotiation fails. In trying to succeed, you can pass an SSLContext as an smtp_tls_context parameter, but remember that the server might still deny the negotiation based on how you set the SSLContext up, and based on its security settings as well.
If the SMTP server replies to the RCPT TO command with a code 250 (success) response, the check is considered successful.
@ -143,7 +143,7 @@ If the SMTP server cannot be connected, unexpectedly closes the connection, or r
If there is more than one valid MX record for the domain, they are tried in order of priority until the first time the check is either successful or failed. Only in case of an ambiguous check result, the next server is tried, and only if the check result is ambiguous for all servers, the overall check is considered ambiguous as well.
On failure of this check or on ambiguous result, validate\_email\_or\_fail() raises one of the following exceptions, all of which descend from SMTPError:
On failure of this check or on ambiguous result, validate_email_or_fail() raises one of the following exceptions, all of which descend from SMTPError:
AddressNotDeliverableError
The SMTP server permanently refused the email address. Technically, this means that the server replied to the RCPT TO command with a code 5xx response.
@ -154,7 +154,7 @@ The SMTP server refused to even let us get to the point where we could ask it ab
SMTPTemporaryError
A temporary error occured during the check for all available MX servers. This is considered an ambiguous check result. For example, greylisting is a frequent cause for this. Make sure you check the contents of the message.
All of the above three exceptions provide further details about the error response(s) in the exception's instance variable error\_messages.
All of the above three exceptions provide further details about the error response(s) in the exception's instance variable error_messages.
Auto-updater
------------