ephemeral_email 0.2.0

A Rust library for generating temporary email addresses.
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
90
91
92
93
94
95
96
97
98
99
100

//! `ephemeral_email` is a Rust library for creating and managing temporary email addresses effortlessly.
//! It allows developers to generate disposable email addresses, fetch messages from temporary inboxes,
//! and supports multiple email providers. This is particularly useful for testing, avoiding spam, or
//! any scenario where a temporary email address is needed. With support for 42 domains and a straightforward
//! API, `ephemeral_email` simplifies handling temporary emails in your Rust applications.
//!
//! # Features
//!
//! - Create temporary email addresses
//! - Fetch messages from temporary inboxes
//! - Support for multiple email providers
//! - Over 40 domains
//!
//! # Email Providers
//!
//! You can use the following email providers for temporary email addresses:
//!
//! - [Mail.tm](https://mail.tm)
//! - [Muellmail.com](https://muellmail.com)
//! - [TempMail.lol](https://tempmail.lol)
//! - [FakeMail.net](https://fakemail.net)
//!
//! # Disclaimer
//!
//! This library is not affiliated with, endorsed by, or associated with the email providers listed above.
//! Use this library at your own risk. Users are responsible for ensuring their use of the email providers'
//! services complies with the respective terms of service and any applicable laws and regulations. The author
//! assumes no responsibility for any misuse or legal issues that may arise from using this library.
//!
//! # Usage
//!
//! Add the following to your `Cargo.toml`:
//!
//! ```toml
//! [dependencies]
//! ephemeral_email = "0.2"
//! ```
//!
//! Example usage:
//!
//! ```no_run
//! use ephemeral_email::{ProviderType, TempMail};
//!
//! #[tokio::main]
//! async fn main() {
//!     let inbox = TempMail::new()
//!         .provider_type(ProviderType::FakeMailNet)
//!         .name("test")
//!         .create_inbox()
//!         .await
//!         .unwrap();
//!     println!("Created inbox with email: {}", inbox.get_email_address());
//!     let messages = inbox.get_messages().await.unwrap();
//!     println!("Got {} messages:", messages.len());
//!     for message in messages {
//!         println!("From: {}", message.from);
//!     }
//! }
//! ```
//!
//! # Rquest
//!
//! By default, `ephemeral_email` uses [reqwest] for making web requests. However, providers that use Cloudflare
//! cannot be accessed this way. To support these providers, `ephemeral_email` can use [rquest] to emulate browsers
//! like Chrome or Firefox. This feature is gated behind a feature flag. Note that [rquest] is incompatible with
//! crates that depend on `openssl-sys`, such as [reqwest]. To use [rquest], enable the `use-rquest` feature flag
//! and disable the default `use-reqwest` feature. For build issues, refer to the [rquest documentation](https://github.com/0x676e67/rquest#building).
//!
//! ```toml
//! [dependencies]
//! ephemeral_email = { version = "0.2", default-features = false, features = ["use-rquest"] }
//! ```
//!
//! [rquest]: https://github.com/0x676e67/rquest
//! [reqwest]: https://github.com/seanmonstar/reqwest
//!
//! # Related Crates
//!
//! Check out these related crates:
//!
//! - [tempmail-lol](https://github.com/Morb0/tempmail-lol)
//! - [tmail](https://github.com/atifyushri/tmail)
//!
//! # Contact
//!
//! If you are a representative of an email provider listed in this library and would like to request removal or
//! have any concerns, please contact us at [ephemeral_email@hwiller.com](mailto:ephemeral_email@hwiller.com).

mod client;
mod domain;
mod email;
mod error;
mod provider;
mod temp_mail;

pub use domain::Domain;
pub use email::{EmailAddress, Message};
pub use error::{EmailAddressError, InboxCreationError, MessageFetcherError};
pub use provider::{Inbox, ProviderType};
pub use temp_mail::TempMail;