diff options
| author | Koni Marti <koni.marti@gmail.com> | 2023-06-21 22:13:06 +0200 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2023-06-22 10:58:05 +0200 |
| commit | f7837edbb203a489fbfdd95f6b427906a58fbbdb (patch) | |
| tree | 288273e31acef8c8778a2925d5f647b6f528576d | |
| parent | dfaab1f1d73e557bbdbcc428f04f701c0c09c136 (diff) | |
| download | aerc-f7837edbb203a489fbfdd95f6b427906a58fbbdb.tar.gz | |
doc: folder-map in aerc-accounts
Document folder-map option in aerc-accounts.
Signed-off-by: Koni Marti <koni.marti@gmail.com>
Tested-by: Bence Ferdinandy <bence@ferdinandy.com>
Signed-off-by: Robin Jarry <robin@jarry.cc>
| -rw-r--r-- | CHANGELOG.md | 1 | ||||
| -rw-r--r-- | doc/aerc-accounts.5.scd | 33 |
2 files changed, 34 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 7c43e89b..479296be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - Completions for `:mkdir` - `carddav-query` utility to use for `address-book-cmd`. - JMAP support. +- Folder name mapping with `folder-map` in `accounts.conf`. ### Fixed diff --git a/doc/aerc-accounts.5.scd b/doc/aerc-accounts.5.scd index 00a575e1..0cf7071b 100644 --- a/doc/aerc-accounts.5.scd +++ b/doc/aerc-accounts.5.scd @@ -78,6 +78,39 @@ Note that many of these configuration options are written for you, such as Specifies a comma separated list of folders to be shown at the top of the list in the provided order. Remaining folders will be sorted alphabetically. +*folder-map* = _<file>_ + The folder map contains a one-to-one mapping of server folders to displayed + folder names. The *folder-map* file expects a + _<display-folder-name>_=_<server-folder-name>_[\*] + mapping per line (similar key=value syntax as for the *query-map* in notmuch). + The mappings are applied as they appear in the *folder-map*. + Supported backends: imap, maildir. + + Note that other account options such as *archive*, *default*, *copy-to*, + *postpone*, *folders*, *folders-exclude*, *folders-sort* need to be + adjusted if one of those folders is affected by a folder mapping. + + To apply the mapping to subfolders or folders with a similar prefix, + append '\*' to the server folder name. + + Examples: + + Remap a single folder: + ``` + Spam = [Gmail]/Spam + ``` + + Remap the folder and all of its subfolders: + ``` + G = [Gmail]\* + ``` + + Remap all subfolders and avoid a folder collision: + ``` + Archive/existing = Archive\* + Archive = OldArchive\* + ``` + *from* = _<address>_ The default value to use for the From header in new emails. This should be an RFC 5322-compatible string, such as _Your Name <you@example.org>_. |