alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mu4e: centralize docstring for mu4e-bookmarks

Browse Source 
Refer to it in mu4e-maildir-shortcut, so we only have one place to
document the format.
This commit is contained in:
Dirk-Jan C. Binnema
2025-03-16 16:29:40 +02:00
parent a6c41f6262
commit e534f8ae79
2 changed files with 13 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
mu4e/mu4e-bookmarks.el
View File

@ -48,14 +48,16 @@
( :name "Messages with images" ( :name "Messages with images"
:query "mime:image/*" :query "mime:image/*"
:key ?p)) :key ?p))
"List of pre-defined queries that are shown on the main screen. "List of predefined queries that are shown on the main screen.
Each of the list elements is a plist with at least: Each of the list elements is a plist with at least:
`:name' - the name of the query `:name' - the name of the query
`:query' - the query expression string or function `:query' - the query expression string or function
Likely, you also want to assign a shortcut key;
`:key' - the shortcut key (single character) `:key' - the shortcut key (single character)
Optionally, you can add the following: Furthermore, you can add the following:
- `:favorite' - if t, monitor the results of this query, and make - `:favorite' - if t, monitor the results of this query, and make
it eligible for showing its status in the modeline. At most it eligible for showing its status in the modeline. At most

25
mu4e/mu4e-folders.el
View File

@ -98,25 +98,18 @@ This makes it possible to quickly go to a particular
maildir (folder), or quickly moving messages to them (e.g., for maildir (folder), or quickly moving messages to them (e.g., for
archiving or refiling). archiving or refiling).
Each of the list elements is a plist with at least: The format is the same as for `mu4e-bookmarks', with a few
`:maildir' - the maildir for the shortcut (e.g. \"/archive\") difference, so see its doc-strings for further details.
`:key' - the shortcut key.
Optionally, you can add the following: The only field specific for `mu4e-maildir-shortcuts' is
`:name' - name of the maildir to be displayed in main-view. - `:maildir' - the maildir for the shortcut (e.g., \"/archive\")
`:hide' - if t, the shortcut is hidden from the main-view.
`:hide-if-no-unread' - if it t, the shortcut is hidden from
the main-view if it contains no unread messages.
You can also use: Example:
`:hide-unread' - do not show the counts of unread/total number
of matches for the maildir in the main-view, and is implied
from `:hide'.
For backward compatibility, an older form is recognized as well: \\(setq mu4e-maildir-shortcuts
\\'( (:maildir \"/inbox\" :key ?i :hide-if-no-unread t)
(maildir . key), where MAILDIR is a maildir (such as (:maildir \"/drafts\" :key ?d :hide t)
\"/archive/\"), and key is a single character. (:maildir \"/sent\" :key ?s :hide-unread t)))
You can use these shortcuts in the headers and view buffers, for You can use these shortcuts in the headers and view buffers, for
example with `mu4e-mark-for-move-quick' (or \"m\", by default) or example with `mu4e-mark-for-move-quick' (or \"m\", by default) or