email_provider_validator 0.1.3

A Rust library to validate email provider
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

[![Crates.io](https://img.shields.io/crates/v/email_provider_validator.svg?style=flat)](https://crates.io/crates/email_provider_validator)
[![docs](https://docs.rs/email_provider_validator/badge.svg)](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"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](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.