Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omid/email_provider_validator
A library to find if emails are from free or disposal/temporary providers
https://github.com/omid/email_provider_validator
disposable-email email email-provider email-validation temporary-email validation validator
Last synced: 2 months ago
JSON representation
A library to find if emails are from free or disposal/temporary providers
- Host: GitHub
- URL: https://github.com/omid/email_provider_validator
- Owner: omid
- License: mit
- Created: 2024-03-13T12:20:59.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-09-15T00:08:46.000Z (3 months ago)
- Last Synced: 2024-09-15T07:03:27.553Z (3 months ago)
- Topics: disposable-email, email, email-provider, email-validation, temporary-email, validation, validator
- Language: Rust
- Homepage:
- Size: 2.03 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://crates.io/crates/email_provider_validator)
[](https://docs.rs/email_provider_validator)
# Email Validation Library
This Rust library provides functionality for validating email addresses based on different criteria,
such as whether they belong to free or disposable/temporary email domains.
The library offers features that can be toggled using Rust Cargo features.
## Features
The library provides the following functions:
- `is_work_domain`: Checks if the given domain is a work email domain.
- `is_work_email`: Checks if the given email address belongs to a work email domain.
These two functions will check depending on the features you enabled,
if you enabled the `free` feature, it will check if the email is not free,
if you enabled the `disposable` feature, it will check if the email is not disposable.
And if you enable both, it will check if the email is not free and not disposable.
### Free Email Validation
Enable the `free` feature to include functionality related to free email validation, e.g.: `gmail.com`.
The module includes a pre-generated list of free email domains and the following functions are provided:
- `is_free_domain`: Checks if the given domain is a free email domain.
- `is_free_email`: Checks if the given email address belongs to a free email domain.
### Disposable Email Validation
Enable the `disposable` feature to include functionality related to disposable/temporary email validation, e.g.: `temp-mail.org`.
The module includes a pre-generated list of disposable email domains and the following functions are provided:
- `is_disposable_domain`: Checks if the given domain is a disposable email domain.
- `is_disposable_email`: Checks if the given email address belongs to a disposable email domain.
This feature is disabled by default because the list of disposable email domains is large and may not be necessary for all use cases.
## Usage
To use this library, add it as a dependency in your `Cargo.toml` file:
```toml
[dependencies]
email_provider_validator = "0.1"
```
The default feature is set to `free`, meaning the free email validation functions are included by default.
You can customize the features by specifying them in the `Cargo.toml` file.
### Example Usage
```rust
use email_validation::{is_free_email, is_disposable_email};
fn main() {
let email = b"[email protected]";
if is_free_email(email) {
println!("This is a free email address.");
} else {
println!("This is not a free email address.");
}
if is_disposable_email(email) {
println!("This is a disposable email address.");
} else {
println!("This is not a disposable email address.");
}
}
```
## Disclaimer
This library is not a complete solution for email validation, and it is not guaranteed to be 100% accurate.
It is intended to be used as a tool to help filter out free email and disposable email address providers.
If you need to validate an email address format, you should use other libraries,
like [email_address](https://crates.io/crates/email_address) or [fast_chemail](https://crates.io/crates/fast_chemail/).
## Contributing
Feel free to contribute to the project by opening issues or submitting pull requests. Ensure that any new features or changes are thoroughly tested.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.