1# Email CLI 📧
2
3A beautiful and functional email client for your terminal, built with Go and the charming Bubble Tea TUI library. Never leave your command line to check your inbox or send an email again!
4
5
6
7## Features ✨
8
9- **View Your Inbox**: Fetches and displays a list of your most recent emails.
10- **Read Emails**: Select an email from your inbox to view its content.
11- **Compose and Send**: A simple and intuitive interface for writing and sending new emails.
12- **Beautiful TUI**: A clean and modern terminal user interface that's a pleasure to use.
13- **Secure**: Uses a local configuration file to store your credentials securely.
14
15## Getting Started 🚀
16
17Follow these instructions to get the email client up and running on your local machine.
18
19### Prerequisites
20
21- **Go**: You need to have Go (version 1.18 or newer) installed on your system. You can download it from the [official Go website](https://golang.org/dl/).
22
23### Installation & Setup
24
251. **Clone the repository:**
26
27 ```bash
28 git clone [https://github.com/andrinoff/email-cli.git](https://github.com/andrinoff/email-cli.git)
29 cd email-cli
30 ```
31
322. Login
33
34 You will have 4 input fields
35
36 1. Provider (currently, `gmail` or `icloud`)
37 2. Email
38 3. App-specific Password (TODO: add a guide)
39 4. Name to sign off (OPTIONAL, but recommended)
40
413. **Run the application:**
42 Once your `config.json` file is set up, you can run the application directly from your terminal:
43 ```bash
44 go run .
45 ```
46
47## Usage ⌨️
48
49The Email CLI is designed to be intuitive and easy to navigate with your keyboard.
50
51- **Main Menu**: Use the `Up`/`Down` arrow keys or `k`/`j` to navigate the main menu choices. Press `Enter` to select an option.
52- **Inbox View**: In the inbox, use the arrow keys to scroll through your emails. Press `Enter` to open and view a selected email.
53- **Composer**:
54 - Use `Tab` or the arrow keys to move between the "To", "Subject", and "Body" fields.
55 - When you are finished composing your email, navigate to the "Body" field and press `Enter` to send it.
56- **Go Back/Quit**:
57 - Press `Esc` from any view to return to the main menu.
58 - Press `Ctrl+C` at any time to quit the application.
59
60## Built With 🛠️
61
62This project is built with some fantastic Go libraries:
63
64- [Bubble Tea](https://github.com/charmbracelet/bubbletea) - A powerful TUI (Text User Interface) framework.
65- [Lipgloss](https://github.com/charmbracelet/lipgloss) - A library for beautiful, style-driven layouts in the terminal.
66- [Bubbles](https://github.com/charmbracelet/bubbles) - A collection of ready-to-use components for Bubble Tea applications.
67
68## License 📄
69
70This project is distributed under the MIT License. See the `LICENSE` file for more information.
71
72---
73
74Made with ❤️ by [@andrinoff](https://andrinoff.com)