X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-insert-1.mdwn;h=bf44bdc4b4a1d9ae48eaa07110d6e7a553c186ff;hb=29654905e64093a5275f4a554527231072efccb9;hp=56a2b2a746708b0b8dd69ea94c914bafd17fcd5a;hpb=cf2df983cb6d13042694366be4aba76d4a98048b;p=notmuch-wiki diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 56a2b2a..bf44bdc 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -32,41 +32,70 @@ Option arguments must appear before any tag operation arguments. Sup‐ ported 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. - - --create-folder - Try to create the folder named by the --folder option, if it - 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 indi‐ - cate succesful mail delivery. - - --no-hooks - Prevent hooks from being run. + --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 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 + 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 suc‐ + cessful mail delivery. + + --no-hooks + Prevent hooks from being run. + + --decrypt=(true|nostash|auto|false) + If true and the message is encrypted, try to decrypt the message + while indexing, stashing 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). + + nostash is the same as true except that it will not stash + newly-discovered session keys in the database. + + Be aware that the index is likely sufficient (and a stashed ses‐ + sion key is certainly 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 or + --decrypt=nostash 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, 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
+       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),  not‐
+       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
        much-hooks(5), notmuch-reply(1), notmuch-restore(1), notmuch-search(1),
        notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)
@@ -78,7 +107,7 @@

COPYRIGHT

-       2014, Carl Worth and many others
+       2009-2018, Carl Worth and many others
-

0.19

+

0.26