Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 3.47 KB

README.md

File metadata and controls

89 lines (59 loc) · 3.47 KB
Raw

Crates.io docs

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:

[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

use email_validation::{is_free_email, is_disposable_email};

fn main() {
    let email = b"test@gmail.com";
    
    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 or 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 file for details.