X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-insert.rst;h=214f261ba6b00f95a3eb036f535c9ca992978708;hp=e396f6cf2279402ea0425ab48dbf6970868093db;hb=29648a137c5807135ab168917b4a51d5e19e51c2;hpb=dc20a0eedc80477c0db7b7dea9efef90860ec9fb diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst index e396f6cf..214f261b 100644 --- a/doc/man1/notmuch-insert.rst +++ b/doc/man1/notmuch-insert.rst @@ -25,13 +25,17 @@ 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 ``--folder=<``\ folder\ **>** Deliver the message to the specified folder, relative to the top-level directory given by the value of **database.path**. The - default is to deliver to the top-level directory. + default is the empty string, which means delivering to the + top-level directory. ``--create-folder`` Try to create the folder named by the ``--folder`` option, if it @@ -42,22 +46,61 @@ 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. + + ``--decrypt=(true|auto|false)`` + + If ``true`` and the message is encrypted, try to decrypt the + message while indexing, storing any session keys discovered. + If ``auto``, and notmuch already knows about a session key for + the message, it will try decrypting using that session key but + will not try to access the user's secret keys. If decryption + is successful, index the cleartext itself. Either way, the + message is always stored to disk in its original form + (ciphertext). + + Be aware that the index is likely sufficient to reconstruct + the cleartext of the message itself, so please ensure that the + notmuch message index is adequately protected. DO NOT USE + ``--decrypt=true`` without considering the security of + your index. + + See also ``index.decrypt`` in **notmuch-config(1)**. 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)**