Expand docstrings about fcc using notmuch-insert
authorKeith Amidon <camalot@picnicpark.org>
Wed, 19 Oct 2016 10:05:19 +0000 (03:05 -0700)
committerDavid Bremner <david@tethera.net>
Sat, 22 Oct 2016 15:28:13 +0000 (12:28 -0300)
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.

emacs/notmuch-maildir-fcc.el

index 95e565033c050d9e436cbcaaf3cccb6038506219..ea75bb9ee8acb722a12b6495d21e333db3f16cbc 100644 (file)
@@ -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)))