summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKeith Amidon <camalot@picnicpark.org>2016-10-19 03:05:19 -0700
committerDavid Bremner <david@tethera.net>2016-10-22 12:28:13 -0300
commit4bf3bb31dd866245005c0b2079e0ef1cf9c994ac (patch)
tree55ef8370fa35f82a934ca4833ed056054060fe22
parentc008dd13523bb1356653fa8678cfe5d26a6feb82 (diff)
Expand docstrings about fcc using notmuch-insert
This commit expands docstrings for notmuch-fcc-dirs and notmuch-maildir-fcc-with-notmuch-insert to describe how quoted strings are processed and make the ability to configure sent folders containing whitespace more discoverable.
-rw-r--r--emacs/notmuch-maildir-fcc.el13
1 files changed, 10 insertions, 3 deletions
diff --git a/emacs/notmuch-maildir-fcc.el b/emacs/notmuch-maildir-fcc.el
index 95e56503..ea75bb9e 100644
--- a/emacs/notmuch-maildir-fcc.el
+++ b/emacs/notmuch-maildir-fcc.el
@@ -54,7 +54,10 @@ If `notmuch-maildir-use-notmuch-insert' is set (the default) then
the header should be of the form \"folder +tag1 -tag2\" where
folder is the folder (relative to the notmuch mailstore) to store
the message in, and tag1 and tag2 are tag changes to apply to the
-stored message.
+stored message. This string is split using `split-string-and-unquote',
+so a folder name containing spaces can be specified by
+quoting each space with an immediately preceding backslash
+or surrounding the entire folder name in double quotes.
If `notmuch-maildir-use-notmuch-insert' is nil then the Fcc
header should be the directory where the message should be
@@ -230,8 +233,12 @@ should be a list of tag changes to apply to the inserted message."
The fcc-header should be of the form \"folder +tag1 -tag2\" where
folder is the folder (relative to the notmuch mailstore) to store
the message in, and tag1 and tag2 are tag changes to apply to the
-stored message. If CREATE is non-nil then create the folder if
-necessary."
+stored message. This string is split using `split-string-and-unquote',
+so a folder name containing spaces can be specified by
+quoting each space with an immediately preceding backslash
+or surrounding the entire folder name in double quotes.
+
+If CREATE is non-nil then create the folder if necessary."
(let* ((args (split-string-and-unquote fcc-header))
(folder (car args))
(tags (cdr args)))