validate_emails Example¶
Email Validation Example Script¶
This module demonstrates how to validate a list of email addresses using various configurations. It leverages the validate_email_address function from the dsg_lib.common_functions.email_validation module to perform the validation.
The script is designed to: - Validate a predefined list of email addresses. - Use multiple configurations to test different validation scenarios. - Measure and display the time taken to validate all email addresses. - Print the validation results in a sorted order for better readability.
Features¶
- Email Validation: Checks the validity of email addresses based on various configurations.
- Custom Configurations: Supports multiple validation options such as deliverability checks, allowing quoted local parts, and more.
- Performance Measurement: Tracks the time taken to validate all email addresses.
- Result Sorting: Outputs the validation results in a sorted format for easier analysis.
Usage¶
Run the script as a standalone module:
$ python validate_emails.py
Attributes¶
Email Addresses¶
A predefined list of email addresses to validate. The list includes: - Valid email addresses. - Invalid email addresses. - Edge cases such as emails with non-ASCII characters, quoted local parts, and domain literals.
Configurations¶
A list of dictionaries, where each dictionary represents a validation configuration. Configuration options include:
- check_deliverability (bool): Whether to check if the email address is deliverable.
- test_environment (bool): Whether the function is being run in a test environment.
- allow_smtputf8 (bool): Whether to allow non-ASCII characters in the email address.
- allow_empty_local (bool): Whether to allow email addresses with an empty local part.
- allow_quoted_local (bool): Whether to allow email addresses with a quoted local part.
- allow_display_name (bool): Whether to allow email addresses with a display name.
- allow_domain_literal (bool): Whether to allow email addresses with a domain literal.
- globally_deliverable (bool): Whether the email address should be globally deliverable.
- timeout (int): The timeout for the validation in seconds.
- dns_type (str): The type of DNS to use for the validation. Can be 'dns' or 'timeout'.
Functions¶
validate_email_address(email: str, **kwargs: dict) -> dict¶
Validates an email address using the provided configuration and returns a dictionary with the results.
Example Output¶
The script outputs the validation results in a sorted order, along with the time taken for the validation process. Each result includes: - The email address. - The validation status. - Additional metadata based on the configuration used.
License¶
This module is licensed under the MIT License.
import pprint
import time
from typing import List, Dict, Any
from dsg_lib.common_functions.email_validation import validate_email_address
def run_validation(
email_addresses: List[str],
configurations: List[Dict[str, Any]],
) -> List[Dict[str, Any]]:
"""
Validate each email against multiple configurations.
Args:
email_addresses: List of email strings to validate.
configurations: List of parameter dicts for validation.
Returns:
A sorted list of result dicts (sorted by "email" key).
"""
results: List[Dict[str, Any]] = []
# iterate over every email and config combination
for email in email_addresses:
for config in configurations:
# call the core email validator and collect its output
res = validate_email_address(email, **config)
results.append(res)
# sort by email for consistent output
return sorted(results, key=lambda x: x["email"])
def main() -> None:
"""
Entry point for the email validation example.
Defines a list of emails and configurations, measures execution time,
runs validation, and pretty‑prints the results.
"""
# list of example email addresses
email_addresses: List[str] = [
"bob@devsetgo.com",
"bob@devset.go",
"foo@yahoo.com",
"bob@gmail.com",
"very fake@devsetgo.com",
"jane.doe@example.com",
"john_doe@example.co.uk",
"user.name+tag+sorting@example.com",
"x@example.com", # shortest possible email address
"example-indeed@strange-example.com",
"admin@mailserver1", # local domain name with no TLD
"example@s.example", # see the list of Internet top-level domains
'" "@example.org', # space between the quotes
'"john..doe"@example.org', # quoted double dot
"mailhost!username@example.org", # bangified host route used for uucp mailers
"user%example.com@example.org", # percent sign in local part
"user-@example.org", # valid due to the last character being an allowed character
# Invalid email addresses
"Abc.example.com", # no @ character
"A@b@c@example.com", # only one @ is allowed outside quotation marks
'a"b(c)d,e:f;g<h>i[j\\k]l@example.com', # none of the special characters in this local part are allowed outside quotation marks
'just"not"right@example.com', # quoted strings must be dot separated or the only element making up the local-part
'this is"not\\allowed@example.com', # spaces, quotes, and backslashes may only exist when within quoted strings and preceded by a backslash
'this\\ still\\"not\\\\allowed@example.com', # even if escaped (preceded by a backslash), spaces, quotes, and backslashes must still be contained by quotes
"1234567890123456789012345678901234567890123456789012345678901234+x@example.com", # local part is longer than 64 characters
# Emails with empty local part
"@example.com", # only valid if allow_empty_local is True
# Emails with non-ASCII characters
"üñîçøðé@example.com", # only valid if allow_smtputf8 is True
"user@üñîçøðé.com", # only valid if allow_smtputf8 is True
# Emails with quoted local part
'"john.doe"@example.com', # only valid if allow_quoted_local is True
'"john..doe"@example.com', # only valid if allow_quoted_local is True
# Emails with display name
"John Doe <john@example.com>", # only valid if allow_display_name is True
# Emails with domain literal
"user@[192.0.2.1]", # only valid if allow_domain_literal is True
# Emails with long local part
"a" * 65 + "@example.com", # local part is longer than 64 characters
# Emails with invalid characters
"john doe@example.com", # space is not allowed
"john@doe@example.com", # only one @ is allowed
"john.doe@.com", # domain can't start with a dot
"john.doe@example..com", # domain can't have two consecutive dots
"test@google.com",
]
# various validation parameter sets to exercise different rules
configurations: List[Dict[str, Any]] = [
{
"check_deliverability": True,
"test_environment": False,
"allow_smtputf8": False,
"allow_empty_local": False,
"allow_quoted_local": False,
"allow_display_name": False,
"allow_domain_literal": False,
"globally_deliverable": None,
"timeout": 10,
"dns_type": "timeout",
},
{
"check_deliverability": False,
"test_environment": True,
"allow_smtputf8": True,
"allow_empty_local": True,
"allow_quoted_local": True,
"allow_display_name": True,
"allow_domain_literal": True,
"globally_deliverable": None,
"timeout": 5,
"dns_type": "dns",
},
{"check_deliverability": True},
{
"check_deliverability": False,
"test_environment": False,
"allow_smtputf8": True,
"allow_empty_local": False,
"allow_quoted_local": True,
"allow_display_name": False,
"allow_domain_literal": True,
"globally_deliverable": None,
"timeout": 15,
"dns_type": "timeout",
},
{
"check_deliverability": True,
"test_environment": True,
"allow_smtputf8": False,
"allow_empty_local": True,
"allow_quoted_local": False,
"allow_display_name": True,
"allow_domain_literal": False,
"globally_deliverable": None,
"timeout": 20,
"dns_type": "dns",
},
{
"check_deliverability": False,
"test_environment": False,
"allow_smtputf8": True,
"allow_empty_local": True,
"allow_quoted_local": True,
"allow_display_name": True,
"allow_domain_literal": True,
"globally_deliverable": None,
"timeout": 25,
"dns_type": "timeout",
},
{
"check_deliverability": True,
"test_environment": True,
"allow_smtputf8": False,
"allow_empty_local": False,
"allow_quoted_local": False,
"allow_display_name": False,
"allow_domain_literal": False,
"globally_deliverable": None,
"timeout": 30,
"dns_type": "dns",
},
{
"check_deliverability": False,
"test_environment": True,
"allow_smtputf8": True,
"allow_empty_local": False,
"allow_quoted_local": True,
"allow_display_name": True,
"allow_domain_literal": False,
"globally_deliverable": None,
"timeout": 35,
"dns_type": "timeout",
},
{
"check_deliverability": True,
"test_environment": False,
"allow_smtputf8": False,
"allow_empty_local": True,
"allow_quoted_local": True,
"allow_display_name": False,
"allow_domain_literal": True,
"globally_deliverable": None,
"timeout": 40,
"dns_type": "dns",
},
{
"check_deliverability": False,
"test_environment": True,
"allow_smtputf8": True,
"allow_empty_local": False,
"allow_quoted_local": False,
"allow_display_name": True,
"allow_domain_literal": True,
"globally_deliverable": None,
"timeout": 45,
"dns_type": "timeout",
},
]
# measure and run
start_time: float = time.time()
results = run_validation(email_addresses, configurations)
elapsed: float = time.time() - start_time
# output each result
for record in results:
pprint.pprint(record, indent=4)
print(f"Time taken: {elapsed:.2f}s")
if __name__ == "__main__":
main()