X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;ds=sidebyside;f=manpages%2Fnotmuch-insert-1.mdwn;h=46a6aa7a246fac84592663321b9cae689e3e9199;hb=219490b75a85ca18d449168575a0c7538e71612e;hp=8a28938147c95241993f134e7d6b87db2fb5ee71;hpb=0add150ffd941ea7ed64a9116929aaf2daa927a5;p=notmuch-wiki diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 8a28938..46a6aa7 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -13,49 +13,95 @@
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. + the maildir directory given by configuration option database.mail_root, + then incorporates the message into the notmuch database. It is an alâ + ternative to using a separate tool to deliver the message then running + notmuch-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: tags prefixed by '+' are added while those prefixed by '-' are removed. - 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. + If the new message is a duplicate of an existing message in the dataâ + 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- - 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. + The insert command supports hooks. See notmuch-hooks(5) for more deâ + tails on hooks. - --create-folder + Option arguments must appear before any tag operation arguments. Supâ + ported options for insert include - 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. + --folder=<folder> + Deliver the message to the specified folder, relative to the + top-level directory given by the value of database.mail_root. + 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 inâ + dex. + + See also index.decrypt in notmuch-config(1).
- 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. - - If the message could not be written to disk then a non-zero exit status - is returned. + 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.
- 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)@@ -67,7 +113,7 @@
- 2014, Carl Worth and many others + 2009-2022, Carl Worth and many others-