X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-insert-1.mdwn;h=91aac93d8e1df94cc39bfd8beaedeae9c41e50a8;hb=0568dc66970180cbda48af10d27c49fb1a36805e;hp=fdaa55a3ce2bcea5ca24b0dbb60b6198b2bf60cc;hpb=6562766d20047abcb3bab0d88a1e5849baaae76d;p=notmuch-wiki diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index fdaa55a..91aac93 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -26,29 +26,77 @@ base (it has same Message-ID), it will be added to the maildir folder and notmuch database, but the tags will not be changed. - Option arguments must appear before any tag operation arguments. Sup‐ + The insert command supports hooks. See notmuch-hooks(5) for more + details 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. + --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. - --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. + --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  if  the  message  was  successfully
-       added  to  the mail directory, even if the message could not be indexed
-       and added to the notmuch database. In the latter case, a  warning  will
-       be printed to standard error but the message file will be left on disk.
+       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.
 
-       If the message could not be written to disk then a non-zero exit status
-       is returned.
+       The exit status of the post-insert hook does not affect the exit status
+       of the insert command.

SEE ALSO

@@ -65,7 +113,7 @@

COPYRIGHT

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

0.18.1

+

0.30