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

doc update2

Browse source
This commit is contained in:
Shautvast 2026-03-02 16:51:06 +01:00
parent 696c3bec9f
commit 11941a5bea
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,6 +1,6 @@
# Tuimail # Tuimail
Tuimail is a terminal email client. It allowes you to use your keyboard to navigate, search and send messages. Tuimail is a terminal email client. It allows you to use your keyboard to navigate, search and send messages.
### Safety features ### Safety features
- no html rendering (conversion to plain text) - no html rendering (conversion to plain text)
@ -14,22 +14,25 @@ Tuimail is a terminal email client. It allowes you to use your keyboard to navig
# Configuring # Configuring
Sorry, there is no binary release for now. This setup requires that you have rust cargo installed. Sorry, there is no binary release for now. This setup requires that you have rust cargo installed.
Run the setup wizard: ```bash
cargo run
```
The first time you run it asks you to enter the config settings.
You can reconfigure later using:
```bash ```bash
cargo run -- --configure cargo run -- --configure
``` ```
(the first time --configure is active by default)
When prompted for provider choose `imap/proton`, choose your provider: When prompted for provider choose `imap/proton`, choose your provider:
For Imap: For imap using gmail:
- IMAP host: `imap.gmail.com`, port: `993`, TLS: `true` - IMAP host: `imap.gmail.com`, port: `993`, TLS: `true`
- Username - Username
- Password - Password
- SMTP host: `smtp.gmail.com`, port: `465`, TLS mode: `smtps` - SMTP host: `smtp.gmail.com`, port: `465`, TLS mode: `smtps`
Different mail providers may use other hosts and ports. Different imap providers may have other hosts and ports...
For Proton (Tuimail 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