sander/tuimail
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated docs4

Browse source
This commit is contained in:
Shautvast 2026-03-02 15:35:49 +01:00
parent 56b27e1692
commit b64d1411d2
1 changed files with 27 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -24,7 +24,7 @@ For Imap:
Different mail providers may use other hosts and ports. Different mail providers may use other hosts and ports.
For Proton (does not require the proton-bridge) For Proton (Tuimail does not require the proton-bridge)
- Username: your proton account user name - Username: your proton account user name
- Password: - Password:
@ -54,8 +54,6 @@ App Passwords require 2-Step Verification to be enabled on your Google account.
2. Enter a name (e.g. "Mail TUI") and click **Create** 2. Enter a name (e.g. "Mail TUI") and click **Create**
3. Google will display a 16-character password — copy it 3. Google will display a 16-character password — copy it
## Interface ## Interface
``` ```
@ -67,11 +65,11 @@ App Passwords require 2-Step Verification to be enabled on your Google account.
├─────────────────────────────────────────────────────┤ ├─────────────────────────────────────────────────────┤
│ Message │ ← inactive pane │ Message │ ← inactive pane
│ │ │ │
│ Hi there, │ │ Hi there, │
│ Just checking in… │ │ Just checking in… │
│ │ │ │
├─────────────────────────────────────────────────────┤ ├─────────────────────────────────────────────────────┤
│ c compose | r reply | / search | q quit | … │ ← status bar │ c compose | r reply | / search | q quit | … │ ← status bar
└─────────────────────────────────────────────────────┘ └─────────────────────────────────────────────────────┘
``` ```
@ -84,11 +82,11 @@ between the two panes.
### Navigation ### Navigation
| Key | Action | | Key | Action |
|-----|--------| |-------------|--------|
| `↑` / `k` | Move up in inbox or scroll message up | | `↑` / `k` | Move up in inbox or scroll message up |
| `↓` / `j` | Move down in inbox or scroll message down | | `↓` / `j` | Move down in inbox or scroll message down |
| `Tab` | Switch focus between inbox list and message preview | | `Tab` | Switch focus between inbox list and message preview |
| `q` / `Esc` | Quit (or clear search results) | | `q` / `Esc` | Quit (or clear search results) |
Scrolling past the last loaded message automatically fetches the next batch of Scrolling past the last loaded message automatically fetches the next batch of
@ -96,34 +94,34 @@ Scrolling past the last loaded message automatically fetches the next batch of
### Email Actions ### Email Actions
| Key | Action | | Key | Action |
|-----|--------| |------------|--------|
| `r` | **Reply** to the selected email | | `r` | **Reply** to the selected email |
| `d` | **Delete** the selected email (moves to Trash) | | `d` | **Delete** the selected email (moves to Trash) |
| `u` / `F5` | **Refresh** the inbox manually | | `u` / `F5` | **Refresh** the inbox manually |
### Search ### Search
| Key | Action | | Key | Action |
|-----|--------| |----------------|--------|
| `/` | Open the search bar | | `/` | Open the search bar |
| *(type query)* | Filter by subject or sender | | *(type query)* | Filter by subject or sender |
| `Enter` | Run the search | | `Enter` | Run the search |
| `Esc` | Clear search results and return to inbox | | `Esc` | Clear search results and return to inbox |
Search runs an IMAP `SEARCH OR SUBJECT … FROM …` query on the server so it Search runs an IMAP `SEARCH OR SUBJECT … FROM …` query on the server so it
works across your entire mailbox, not just the loaded batch. works across your entire mailbox, not just the loaded batch.
### Compose ### Compose
| Key | Action | | Key | Action |
|-----|--------| |----------|--------|
| `c` | Open compose window | | `c` | Open compose window |
| `r` | Open compose pre-filled for replying to the selected email | | `r` | Open compose pre-filled for replying to the selected email |
| `Tab` | Cycle focus: To → Subject → Body → To | | `Tab` | Cycle focus: To → Subject → Body → To |
| `Enter` | Move to next field (To / Subject); insert newline in Body | | `Enter` | Move to next field (To / Subject); insert newline in Body |
| `Ctrl+S` | Send the email | | `Ctrl+S` | Send the email |
| `Esc` | Cancel and discard the draft | | `Esc` | Cancel and discard the draft |
--- ---
@ -157,8 +155,8 @@ Press **`r`** to reply. The compose window opens with:
│ Subject: Re: Weekend plans │ │ Subject: Re: Weekend plans │
├─ Body ───────────────────────────┤ ├─ Body ───────────────────────────┤
│ _ │ ← type your reply here │ _ │ ← type your reply here
│ ─────────────────────────────── │ │ ─────────────────────────────── │
│ On 2025-01-14 09:11, Bob wrote: │ │ On 2025-01-14 09:11, Bob wrote: │
│ > Are you free Saturday? │ │ > Are you free Saturday? │
└──────────────────────────────────┘ └──────────────────────────────────┘
``` ```