X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-insert-1.mdwn;h=41438ad6e74ab1bf596f0de065c3c6bae962cf99;hb=85fe2a1e7df8ccbb172ebf5f10e3cf574a08944a;hp=56a2b2a746708b0b8dd69ea94c914bafd17fcd5a;hpb=cf2df983cb6d13042694366be4aba76d4a98048b;p=notmuch-wiki diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 56a2b2a..41438ad 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -15,8 +15,8 @@ notmuch insert reads a message from standard input and delivers it into the maildir directory given by configuration option database.path, then incorporates the message into the notmuch database. It is an alterna‐ - tive to using a separate tool to deliver the message then running not- - much new afterwards. + tive to using a separate tool to deliver the message then running not‐ + much-new(1) afterwards. The new message will be tagged with the tags specified by the new.tags configuration option, then by operations specified on the command-line: @@ -26,40 +26,75 @@ base (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. + The insert command supports hooks. See notmuch-hooks(5) for more de‐ + tails on hooks. 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 de‐ + fault 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 in‐ + dex. + + 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

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

0.19

+

0.33