X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-insert-1.mdwn;h=85695d78f47e14f3278814af35f29db32b0c066c;hb=f74f269a84d927c226418ff74d25daa779b5b854;hp=00d27c48a36cc1a5caeadf592fc6e2289f1fa104;hpb=971fc82cc6d07e9b058d4ade139d9d2145cb5a3f;p=notmuch-wiki diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 00d27c4..85695d7 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -32,34 +32,69 @@ 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. + + --world-readable + When writing mail to the mailbox, allow it to be read by users + other than the current user. Note that this does not override + umask. By default, delivered mail is only readable by the cur‐ + rent user. + + --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
+       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.
 
@@ -78,7 +113,7 @@

COPYRIGHT

-       2015, Carl Worth and many others
+       2009-2019, Carl Worth and many others
 
-

0.20.2

+

0.29