-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
38e94f5
commit ce13055
Showing
1 changed file
with
71 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,85 @@ | ||
| # FLUX-MAIL | ||
| # FLUX-MAIL 🦀 | ||
|
|
||
| A self-hosted Temp Mail service written in Rust 🦀. | ||
| A self-hosted Temporary Email Service written in Rust. Create disposable email addresses instantly for your temporary needs. | ||
|
|
||
| To use the hosted version - [https://flux-mail.shubh.sh](https://flux-mail.shubh.sh) | ||
| <div align="center"> | ||
|
|
||
| :accessibility: SMTP SERVER HOSTED AT -> flux.shubh.sh | ||
| [](https://github.com/shubhexists/flux-mail/stargazers) | ||
| [](https://crates.io/crates/flux-mail) | ||
| [](LICENSE) | ||
|
|
||
| Any mails to "something"@flux.shubh.sh will be handled by the deployed SMTP server. | ||
| [View Demo](https://flux-mail.shubh.sh) • [Report Bug](https://github.com/shubhexists/flux-mail/issues) • [Request Feature](https://github.com/shubhexists/flux-mail/issues) | ||
|
|
||
| ### Steps - | ||
| 1) Go to the website and enter any username. Remember your `username` is public, so "DO NOT" use it for confidential mails. | ||
| 2) You'll get the email of the form `{username}@flux.shubh.sh`. Use it for anything you want :) | ||
| 3) ATTACHMENTS are not shown in the hosted version. | ||
| </div> | ||
|
|
||
| ## 🌟 Features | ||
|
|
||
|  | ||
| - **Instant Setup**: Create temporary email addresses in seconds | ||
| - **No Registration**: Zero signup required | ||
| - **Self-Hostable**: Run your own instance easily | ||
| - **Rust-Powered**: Built with performance and reliability in mind | ||
| - **Simple Interface**: Clean and intuitive user experience | ||
|
|
||
| ## Library Usage | ||
| To run your own version of Flux Mail on localhost, use the library published on [Crates.io](https://crates.io/crates/flux-mail) | ||
| ## 📧 SMTP Server Details | ||
|
|
||
| ``` | ||
| - **Server Address:** `flux.shubh.sh` | ||
| - **Email Format:** `[email protected]` | ||
| - All emails sent to `{username}@flux.shubh.sh` will be automatically handled | ||
|
|
||
| ## 🚀 Quick Start | ||
|
|
||
| 1. Visit [flux-mail.shubh.sh](https://flux-mail.shubh.sh) | ||
| 2. Choose your username | ||
| > ⚠️ **Security Note:** Your username is public. Do not use it for confidential communications. | ||
| 3. Start using your temporary email: `{username}@flux.shubh.sh` | ||
|
|
||
| ## 📸 Screenshot | ||
|
|
||
|  | ||
|
|
||
| ## 💻 Installation | ||
|
|
||
| ### Using as a Library | ||
|
|
||
| Add Flux Mail to your Rust project: | ||
|
|
||
| ```bash | ||
| cargo add flux-mail | ||
| ``` | ||
|
|
||
| Refer to [main.rs](https://github.com/shubhexists/flux-mail/blob/master/src/main.rs) for usage of the library. | ||
| 2. Check [main.rs](https://github.com/shubhexists/flux-mail/blob/master/src/main.rs) for implementation details | ||
|
|
||
| ## ⚠️ Limitations | ||
|
|
||
| - Attachments are not displayed in the hosted version. | ||
| - Email will be removed after 7 days from the database. | ||
|
|
||
| ## 🤝 Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| 1. Fork the Project | ||
| 2. Create your Feature Branch (`git checkout -b feature/feature_name`) | ||
| 3. Commit your Changes (`git commit -m 'feature_name'`) | ||
| 4. Push to the Branch (`git push origin feature/feature_name`) | ||
| 5. Open a Pull Request | ||
|
|
||
| ## 📜 License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE` for more information. | ||
|
|
||
| ## 🌟 Show your support | ||
|
|
||
| Give a ⭐️ if this project helped you! | ||
|
|
||
| ## 📞 Contact | ||
|
|
||
| Shubham - [@shubhexists](https://github.com/shubhexists) | ||
|
|
||
| Project Link: [https://github.com/shubhexists/flux-mail](https://github.com/shubhexists/flux-mail) | ||
|
|
||
| ### Thanks | ||
| --- | ||
|
|
||
| Do star (⭐) the project if you like it. | ||
| <div align="center"> | ||
| Made with ❤️ using Rust | ||
| </div> |