Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bnkc/emval
emval is a blazingly fast python email validator written in rust.
https://github.com/bnkc/emval
email-validator python rust
Last synced: 9 days ago
JSON representation
emval is a blazingly fast python email validator written in rust.
- Host: GitHub
- URL: https://github.com/bnkc/emval
- Owner: bnkc
- License: mit
- Created: 2024-07-14T04:11:01.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-11-26T02:35:00.000Z (16 days ago)
- Last Synced: 2024-11-26T03:26:52.739Z (16 days ago)
- Topics: email-validator, python, rust
- Language: Python
- Homepage:
- Size: 146 KB
- Stars: 179
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - bnkc/emval - emval is a blazingly fast python email validator written in rust. (Python)
README
# 📬 emval
`emval` is a blazingly fast Python email validator written in Rust, offering performance improvements of 100-1000x over traditional validators.
## Features
- Drop-in replacement for popular email validators like `python-email-validator`, `verify-email`, and `pyIsEmail`.
- 100-1000x faster than [python-email-validator](https://github.com/JoshData/python-email-validator).
- Validates email address syntax according to [RFC 5322](https://www.rfc-editor.org/rfc/rfc5322.html) and [RFC 6531](https://www.rfc-editor.org/rfc/rfc6531.html).
- Checks domain deliverability (coming soon).
- Supports internationalized domain names (IDN) and local parts.
- Provides user-friendly syntax errors.
- Normalizes addresses.
- Rejects invalid and unsafe Unicode characters.
## Getting Started
Install `emval` from PyPI:
```sh
pip install emval
```
## Usage
### Quick Start
To validate an email address:
```python
from emval import validate_email, EmailValidator
email = "[email protected]"
try:
# Check if the email is valid.
val_email = validate_email(email)
# Utilize the normalized form for storage.
normalized_email = val_email.normalized
except Exception as e:
# Example: "Invalid Local Part: Quoting the local part before the '@' sign is not permitted in this context."
print(str(e))
```
### Configurations
Customize email validation behavior using the `EmailValidator` class:
```python
from emval import EmailValidator
emval = EmailValidator(
allow_smtputf8=False,
allow_empty_local=True,
allow_quoted_local=True,
allow_domain_literal=True,
deliverable_address=False,
)
email = "user@[192.168.1.1]"
try:
validated_email = emval.validate_email(email)
print(validated_email)
except Exception as e:
print(str(e))
```
### Options
- `allow_smtputf8`: Allows internationalized email addresses.
- `allow_empty_local`: Allows an empty local part (e.g., `@domain.com`).
- `allow_quoted_local`: Allows quoted local parts (e.g., `"user name"@domain.com`).
- `allow_domain_literal`: Allows domain literals (e.g., `[192.168.0.1]`).
- `deliverable_address`: Checks if the email address is deliverable by verifying the domain's MX records.
## Technical Details
### Email Address Syntax
emval adheres to the syntax rules defined in [RFC 5322](https://www.rfc-editor.org/rfc/rfc5322.html) and [RFC 6531](https://www.rfc-editor.org/rfc/rfc6531.html). It supports both ASCII and internationalized characters.
### Internationalized Email Addresses
#### Domain Names
emval converts non-ASCII domain names into their ASCII "Punycode" form according to [IDNA 2008](https://www.rfc-editor.org/rfc/rfc5891.html). This ensures compatibility with systems that do not support Unicode.
#### Local Parts
emval allows international characters in the local part of email addresses, following [RFC 6531](https://www.rfc-editor.org/rfc/rfc6531.html). It offers options to handle environments without SMTPUTF8 support.
### Unsafe Unicode Characters
emval rejects unsafe Unicode characters to enhance security, preventing display and interpretation issues.
### Normalization
emval normalizes email addresses to ensure consistency:
- **Lowercasing domains:** Domain names are standardized to lowercase.
- **Unicode NFC normalization:** Characters are transformed into their precomposed forms.
- **Removing unnecessary characters:** Quotes and backslashes in the local part are removed.
## Acknowledgements
This project draws inspiration from [python-email-validator](https://github.com/JoshData/python-email-validator). While `python-email-validator` is more comprehensive, `emval` aims to provide a faster solution.
## Getting Help
For questions and issues, please open an issue in the [GitHub issue tracker](https://github.com/bnkc/emval/issues).
## License
emval is licensed under the [MIT License](https://opensource.org/licenses/MIT). See the [LICENSE](https://github.com/bnkc/emval/blob/main/LICENSE) file for more details.