Suggest corrections to user-misspelled email addresses
Project description
Suggest corrections to user-misspelled email addresses.
Python port of mailcheck.js.
Installation
$ pip install pymailcheck
Usage
>>> import pymailcheck
>>> pymailcheck.suggest("test@example.con")
{'domain': 'example.com', 'full': 'test@example.com', 'address': 'test'}
>>> pymailcheck.suggest("test@example.org")
False
You can override or append the built-in list of domains, top-level domains, and/or second-level domains:
Parameter |
Defaults |
Example |
---|---|---|
domains |
pymailcheck.DOMAINS |
yahoo.com |
top_level_domains |
pymailcheck.TOP_LEVEL_DOMAINS |
yahoo |
second_level_domains |
pymailcheck.SECOND_LEVEL_DOMAINS |
com |
>>> pymailcheck.suggest("test@contosl.com")
False
>>> custom_domains = ["example.com", "contoso.com"]
>>> pymailcheck.suggest("test@contosl.com", domains=custom_domains)
{'domain': 'contoso.com', 'full': 'test@contoso.com', 'address': 'test'}
>>> pymailcheck.suggest("test@contosl.com")
False
>>> custom_domains = pymailcheck.DOMAINS.union(("example.com", "contoso.com"))
>>> pymailcheck.suggest("test@contosl.com", domains=custom_domains)
{'domain': 'contoso.com', 'full': 'test@contoso.com', 'address': 'test'}
>>> def my_distance_function(s1, s2): ...
>>> # Have a look at `strsim` PyPI package, for example
>>> pymailcheck.suggest("test@contosl.com", distance_callable=my_distance_function)
{'domain': 'contoso.com', 'full': 'test@contoso.com', 'address': 'test'}
Running Tests
$ python -m unittest discover
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pymailcheck-1.1.0.tar.gz
(4.7 kB
view hashes)
Built Distribution
Close
Hashes for pymailcheck-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5b4bb44fb65061713626f371a9c9313a1cf169bfdacd5e36391509e904a7b6b |
|
MD5 | b0e442435aae2ee51dac9d1d51522d33 |
|
BLAKE2b-256 | 5673f85e65681ff1d019b9f56b51a2cfc05765a464436fbaec4effed2cf52d2c |