diff options
| author | Danilo M. <danix@danix.xyz> | 2026-10-17 11:08:49 +0200 |
|---|---|---|
| committer | Danilo M. <danix@danix.xyz> | 2026-10-17 11:08:49 +0200 |
| commit | c6fc5bbef45bcfa4f8d5e50ca7401aa1f5b6bc7d (patch) | |
| tree | 775fa89b284c68d30205c58d83fae55336676f60 /desktop/modules/qtmaildir/README.md | |
| parent | 8e9d8b9ac1b593032dea9eca312fa1495c0c8858 (diff) | |
| download | quickshell-c6fc5bbef45bcfa4f8d5e50ca7401aa1f5b6bc7d.tar.gz quickshell-c6fc5bbef45bcfa4f8d5e50ca7401aa1f5b6bc7d.zip | |
settings: qtmaildir's config, in four Mail pages
qtmaildir is configured through qtmaildir.conf alone, which it reads at
startup and never writes. Four settings pages under a new Mail group
edit it: Mail ([general], [sync], [completion]), Compose, Accounts (a
card per account, add and remove) and Tags & shortcuts ([tagcolors] and
[keys]). Fields save on Enter and unset when emptied, with qtmaildir's
defaults as placeholders and numbers range-checked; the pages say when
qtmaildir is running and a change waits for its restart.
Ini.js edits the file line by line so its comments survive. Headers are
only whole [name] lines: a section is never cut at the next "[", since
values such as [Gmail]/Bozze hold brackets, the trap AGENTS.md records.
The shortcut actions are copied from qtmaildir's KeyMap::knownActions()
rather than exported by it, since a CLI flag there would have meant
translations and a changelog entry; the field also takes free text, and
the copy is marked as a ponytail ceiling.
The settings sidebar now clips, which a list long enough to scroll
showed it did not: entries drew over the search box.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'desktop/modules/qtmaildir/README.md')
| -rw-r--r-- | desktop/modules/qtmaildir/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/desktop/modules/qtmaildir/README.md b/desktop/modules/qtmaildir/README.md new file mode 100644 index 0000000..4bbcbfd --- /dev/null +++ b/desktop/modules/qtmaildir/README.md @@ -0,0 +1,38 @@ +# qtmaildir + +Four settings pages, under Mail, for qtmaildir's +`~/.config/qtmaildir/qtmaildir.conf`: + +- **Mail**: `[general]`, `[sync]` and `[completion]`: startup query and + account, language, toolbar size, message zoom, date format, forward + prefixes, mark-read and auto-sync delays, sync on quit, the sync command + and log, contacts, calendars and their sync command, the notmuch config. +- **Compose**: `[compose]`. +- **Accounts**: one card per `[account.<key>]` with every key qtmaildir + reads; Add appends a section with `trash = Trash` and `spam = Spam`, + Remove asks once and deletes the section. The key is the account's + identity and is not renamed here. +- **Tags & shortcuts**: `[tagcolors]` and `[keys]`, a row each, removable, + with an add row. + +qtmaildir reads the file at startup and never writes it, so editing it +under a running qtmaildir is safe; the pages say when it is running and a +change waits for its restart. A field saves on Enter, and emptied it unsets +the key, so qtmaildir's default applies; the placeholders name those +defaults, from qtmaildir's README. Numbers are range-checked before writing. + +`Ini.js` edits the file a line at a time so its comments and order survive: +a key unset is commented out with `;`, a commented key set again is +activated, and a tag or shortcut row removed is deleted outright. Section +headers are only lines that are nothing but `[name]`, never "everything up +to the next `[`": values hold brackets (`[Gmail]/Bozze`), which is the trap +AGENTS.md records. Values follow QSettings' reading: an unquoted `;` starts a +comment, and a value holding `;` or `"` is written quoted. + +The shortcut actions offered are copied from qtmaildir's +`KeyMap::knownActions()`, a `ponytail:` ceiling in `TagsKeysPage.qml`: a +new action there needs adding here, and meanwhile can be typed, since the +field takes free text. + +`Qtm.qml` is the singleton the four pages share. Check: +`node desktop/modules/qtmaildir/test_ini.js`. |
