A minimal email TUI where you read with Markdown and write in Neovim.
neomd.ssp.sh/docs
email
markdown
neovim
tui
update flow
+13
-10
+13
-10
README.md
+13
-10
README.md
···
2
2
3
3
A minimal terminal email client for people who write in Markdown and live in Neovim.
4
4
5
-
[Neomd](https://www.ssp.sh/brain/neomd/) is my way of implementing an email TUI based on my experience with Neomutt, focusing on [Neovim](https://www.ssp.sh/brain/neovim) (input) and reading/writing in [Markdown](https://www.ssp.sh/brain/markdown) and navigating with [Vim Motions](https://www.ssp.sh/brain/vim-language-and-motions) with the GTD workflow and [HEY-Screener](https://www.hey.com/features/the-screener/).
6
-
7
-
8
-
> [!WARNING]
9
-
> neomd moves, deletes, and modifies emails directly on your IMAP server. These operations affect your mailbox across all devices. **Back up important emails before first use.** neomd is experimental software and can't take responsibility for lost or misplaced emails. Consider testing with a secondary email account first.
5
+
*Neomd is my way of implementing an email TUI based on my experience with Neomutt, focusing on [Neovim](https://www.ssp.sh/brain/neovim) (input) and reading/writing in [Markdown](https://www.ssp.sh/brain/markdown) and navigating with [Vim Motions](https://www.ssp.sh/brain/vim-language-and-motions) with the GTD workflow and [HEY-Screener](https://www.hey.com/features/the-screener/).*
10
6
11
7
## The philosophy behind Neomd: What's unique?
12
8
···
20
16
21
17
But we have two additional **Feed** and **Papertrail**, two dedicated folders from HEY where you can read newsletters (just hit F) on them automatically in their separate tab, or move all your receipts into the Papertrail. Once you mark them as feed or papertrail, they will moved there automatically going forward. So you decide whether to read emails or news by jumping to different tabs.
22
18
23
-
> [!NOTE]
24
-
> neomd's **speed** depends entirely on your IMAP provider. On Hostpoint (the provider I use), a folder switch takes **~33ms** which feels instant. On Gmail, the same operation takes **~570ms** which is noticeably slow. See [Benchmark](#benchmark) for full details and how to test your provider.
25
19
26
20
### Email Processing Workflow
27
21
···
75
69
*all colored boxes represent neomd folders*
76
70
77
71
**Key principles:**
78
-
- **Screener first**: Unknown senders never clutter your Inbox — they wait in ToScreen for classification [[more](https://ssp-data.github.io/neomd/docs/screener/)]
72
+
- **Screener first**: Unknown senders never clutter your Inbox, but get automatically wait in ToScreen for classification [[more](https://ssp-data.github.io/neomd/docs/screener/)]
79
73
- **One-time decision**: Once you classify a sender (`I/O/F/P`), all future emails from them are automatically routed [[more](https://ssp-data.github.io/neomd/docs/screener/#how-classification-works)]
80
-
- **GTD processing**: Emails in Inbox are processed once — if < 2 min, do it or keep it in inbox as doing *Next* otherwise move to Waiting, Someday, or Scheduled
81
-
- **Minimal filing**: Only Archive when done; no complex folder hierarchies — use search to find old emails
74
+
- **GTD processing**: Emails in Inbox are processed once. Inbox acting as want/need to do *Next*, otherwise move to Waiting, Someday, or Scheduled
75
+
- **Minimal filing**: Only Archive when done; no complex folder hierarchies. Use search to find old emails
82
76
- **Separate contexts**: Feed for newsletters (read when you want), PaperTrail for receipts (search when needed)
83
77
- See full features list below.
84
78
···
163
157
- **Kanagawa theme** — colors from the [kanagawa.nvim](https://github.com/rebelot/kanagawa.nvim) palette
164
158
- **IMAP + SMTP** — direct connection via RFC 6851 MOVE, no local sync daemon required and keeps it in sync if you use it on mobile or different device [[more](https://ssp-data.github.io/neomd/docs/configuration/)]
165
159
160
+
> [!NOTE]
161
+
> neomd's **speed** depends entirely on your IMAP provider. On Hostpoint (the provider I use), a folder switch takes **~33ms** which feels instant. On Gmail, the same operation takes **~570ms** which is noticeably slow. See [Benchmark](#benchmark) for full details and how to test your provider.
162
+
166
163
## Install
167
164
168
165
**Prerequisites:** [Go 1.22+](https://go.dev/doc/install) and `make`.
166
+
167
+
> [!WARNING]
168
+
> neomd moves, deletes, and modifies emails directly on your IMAP server. These operations affect your mailbox across all devices. **Back up important emails before first use.** neomd is experimental software and can't take responsibility for lost or misplaced emails. Consider testing with a secondary email account first.
169
169
170
170
> [!NOTE]
171
171
> **Optional attachment helpers:**
···
305
305
- [goldmark](https://github.com/yuin/goldmark) — Markdown → HTML for sending
306
306
- [BurntSushi/toml](https://github.com/BurntSushi/toml) — config parsing
307
307
308
+
309
+
## FAQ
310
+
You have more questions, check out the [docs](https://ssp-data.github.io/neomd/) with more information, or check [Frequently Asked Questions](https://ssp-data.github.io/neomd/docs/faq/).
308
311
## Changelog
309
312
310
313
See [CHANGELOG.md](CHANGELOG.md) for what's new.