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.
This commit is contained in:
Keith Amidon 2016-10-19 03:05:19 -07:00 committed by David Bremner
parent c008dd1352
commit 4bf3bb31dd

View 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 the header should be of the form \"folder +tag1 -tag2\" where
folder is the folder (relative to the notmuch mailstore) to store 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 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 If `notmuch-maildir-use-notmuch-insert' is nil then the Fcc
header should be the directory where the message should be 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 The fcc-header should be of the form \"folder +tag1 -tag2\" where
folder is the folder (relative to the notmuch mailstore) to store 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 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 stored message. This string is split using `split-string-and-unquote',
necessary." 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)) (let* ((args (split-string-and-unquote fcc-header))
(folder (car args)) (folder (car args))
(tags (cdr args))) (tags (cdr args)))