aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Jani Nikula <jani@nikula.org>2014-10-03 23:18:59 +0200
committerGravatar David Bremner <david@tethera.net>2014-10-18 07:54:25 +0200
commitdc20a0eedc80477c0db7b7dea9efef90860ec9fb (patch)
tree380a1e5aa670474d4e574cea36de0cc15abaca1f /doc
parent5df46a3d9efcc201700b02e70b11808fcc40beab (diff)
cli/insert: require succesful message indexing for success status
Add --keep option to keep any remaining stuff in index or file. We could distinguish between failures to index and failures to apply tags or maildir sync, but for simplicity just have one.
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/notmuch-insert.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index 2be1a7b8..e396f6cf 100644
--- a/doc/man1/notmuch-insert.rst
+++ b/doc/man1/notmuch-insert.rst
@@ -38,16 +38,21 @@ Supported options for **insert** include
does not exist. Otherwise the folder must already exist for mail
delivery to succeed.
+ ``--keep``
+ Keep the message file if indexing fails, and keep the message
+ indexed if applying tags or maildir flag synchronization
+ fails. Ignore these errors and return exit status 0 to
+ indicate succesful mail delivery.
+
EXIT STATUS
===========
-This command returns exit status 0 if the message was successfully added
-to the mail directory, even if the message could not be indexed and
-added to the notmuch database. In the latter case, a warning will be
-printed to standard error but the message file will be left on disk.
-
-If the message could not be written to disk then a non-zero exit status
-is returned.
+This command returns exit status 0 on succesful mail delivery,
+non-zero otherwise. The default is to indicate failed mail delivery on
+any errors, including message file delivery to the filesystem, message
+indexing to Notmuch database, changing tags, and synchronizing tags to
+maildir flags. The ``--keep`` option may be used to settle for
+successful message file delivery.
SEE ALSO
========