X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-insert.rst;h=f79600d6571f02f44951eff7eb20cf74fc2b7173;hp=e396f6cf2279402ea0425ab48dbf6970868093db;hb=87bdfbc91f65cb1031ef0ac8a804759f2061ac10;hpb=f5db7ad7d243785c274a99734c681e69d13313d0 diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index e396f6cf..f79600d6 100644 --- a/doc/man1/notmuch-insert.rst +++ b/doc/man1/notmuch-insert.rst @@ -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,18 +45,31 @@ 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 ========