From 3f2e896bdf7a418d5c0dfdb9df1a32481ac08e18 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Mon, 20 Oct 2025 18:58:13 +0300 Subject: mu4e-folders: improve mu4e-maildir-shortcuts docstring ... and :type --- mu4e/mu4e-folders.el | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/mu4e/mu4e-folders.el b/mu4e/mu4e-folders.el index 36b3cb8..42c62c9 100644 --- a/mu4e/mu4e-folders.el +++ b/mu4e/mu4e-folders.el @@ -101,12 +101,12 @@ nil otherwise." (defcustom mu4e-maildir-shortcuts nil "A list of maildir shortcuts. -Creating a shortcut makes it possible to quickly go to a -particular maildir (folder), or quickly moving messages to +Adding a shortcut to this list makes it possible to quickly go to +a particular maildir (folder), or quickly moving messages to them (e.g., for archiving or refiling). The format is mostly the same as for `mu4e-bookmarks', with a few -difference, so see its doc-string for further details. +differences; see its doc-string for further details. The only field specific to `mu4e-maildir-shortcuts' is `:maildir', which is the property specifying the maildir for the @@ -114,15 +114,15 @@ shortcut (e.g., \"/archive\"). Example: - (setq mu4e-maildir-shortcuts + (setq mu4e-maildir-shortcuts \='((:maildir \"/inbox\" :key ?i :hide-if-no-unread t) - (:maildir \"/drafts\" :key ?d :hide t) - (:maildir \"/sent\" :key ?s :hide-unread t))) + (:maildir \"/drafts\" :key ?d :hide t) + (:maildir \"/sent\" :key ?s :hide-unread t))) You can use these shortcuts in the headers and view buffers, for -example with `mu4e-mark-for-move-quick' (or \"m\", by default) or -`mu4e-jump-to-maildir' (or \"j\", by default), followed by the -designated shortcut character for the maildir. +example with +`mu4e-search-maildir' (\\\\[mu4e-search-maildir]). +followed by the designated shortcut character for the maildir. Unlike in search queries, folder names with spaces in them must NOT be quoted, since mu4e does this for you." @@ -131,13 +131,15 @@ NOT be quoted, since mu4e does this for you." :value-type character :tag "Alist (old format)") (repeat (plist - :key-type (choice (const :tag "Maildir" :maildir) - (const :tag "Shortcut" :key) - (const :tag "Name of maildir" :name) - (const :tag "Hide from main view" :hide) - (const :tag "Do not count" :hide-unread)) + :key-type (choice + (const :tag "Maildir" :maildir) + (const :tag "Shortcut" :key) + (const :tag "Name of maildir" :name) + (const :tag "Hide from main view" :hide) + (const :tag "Do not show unread counts" :hide-unread) + (const :tag "Hide if no unread" :hide-if-no-unread)) :tag "Plist (new format)"))) - :version "1.3.9" + :package-version "1.3.9" :group 'mu4e-folders) (defcustom mu4e-maildir-initial-input "/" @@ -318,7 +320,7 @@ Offer to create it if it does not exist yet." This is based on the variable `mu4e-attachment-dir', which is either: - if is a string, used it as-is -- a function taking two string parameters, both of which can be nil: +- a function taking two string parameters, both of which can be nil: (1) FNAME, a filename or a URL (2) MIMETYPE, a mime-type (such as \"text/plain\"." (let ((dir -- cgit v1.0