]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-insert.rst
doc: make SEE ALSO references one-per-line
[notmuch] / doc / man1 / notmuch-insert.rst
index e396f6cf2279402ea0425ab48dbf6970868093db..f83a7385ccf457a705a28a4e3d92ce35bbbf819e 100644 (file)
@@ -25,6 +25,9 @@ If the new message is a duplicate of an existing message in the database
 (it has same Message-ID), it will be added to the maildir folder and
 notmuch database, but the tags will not be changed.
 
+The **insert** command supports hooks. See **notmuch-hooks(5)** for
+more details on hooks.
+
 Option arguments must appear before any tag operation arguments.
 Supported options for **insert** include
 
@@ -42,22 +45,42 @@ Supported options for **insert** include
         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.
+        indicate successful mail delivery.
+
+    ``--no-hooks``
+        Prevent hooks from being run.
 
 EXIT STATUS
 ===========
 
-This command returns exit status 0 on succesful mail delivery,
+This command returns exit status 0 on successful 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.
 
+This command supports the following special exit status code for
+errors most likely to be temporary in nature, e.g. failure to get a
+database write lock.
+
+``75 (EX_TEMPFAIL)``
+    A temporary failure occurred; the user is invited to retry.
+
+The exit status of the **post-insert** hook does not affect the exit
+status of the **insert** command.
+
 SEE ALSO
 ========
 
-**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
-**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-reply(1)**,
-**notmuch-restore(1)**, **notmuch-search(1)**,
-**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**
+**notmuch(1)**,
+**notmuch-config(1)**,
+**notmuch-count(1)**,
+**notmuch-dump(1)**,
+**notmuch-hooks(5)**,
+**notmuch-reply(1)**,
+**notmuch-restore(1)**,
+**notmuch-search(1)**,
+**notmuch-search-terms(7)**,
+**notmuch-show(1)**,
+**notmuch-tag(1)**