X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-insert.rst;h=f79600d6571f02f44951eff7eb20cf74fc2b7173;hp=2c9c0d02c25190fa891f4cd417fb58d06128cb82;hb=87bdfbc91f65cb1031ef0ac8a804759f2061ac10;hpb=19c09d870f18f549df3d9f5a3a30a20f7279b07a diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index 2c9c0d02..f79600d6 100644 --- a/doc/man1/notmuch-insert.rst +++ b/doc/man1/notmuch-insert.rst @@ -45,7 +45,7 @@ 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. @@ -53,13 +53,20 @@ Supported options for **insert** include 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.