X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-insert-1.mdwn;h=243f416f84fd53893eb35f0cfb07640d0be18eb7;hb=887679e40c165171f4f9687932439d1b9fe7d338;hp=f238e433d75891bacb6230554e85f505ce477f25;hpb=59c3b4d66ce19a9dde85e65d5fc5c150e23de209;p=notmuch-wiki diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index f238e43..243f416 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -7,14 +7,14 @@

SYNOPSIS

-       notmuch insert [options] [ +<tag>|-<tag> ... ]
+       notmuch insert [option ...] [+<tag>|-<tag> ...]

DESCRIPTION

        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-
+       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.
 
@@ -22,42 +22,70 @@
        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-
+       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=<&lt;folder>&gt;
+          --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.
 
-               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.
 
-           --create-folder
+          --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 successful mail delivery.
 
-               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.
+          --no-hooks
+                 Prevent hooks from being run.

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 occured; 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

-       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)
-

Notmuch 0.17

+

AUTHOR

+
+       Carl Worth and many others
+
+ +

COPYRIGHT

+
+       2009-2016, Carl Worth and many others
+
+ +

0.23.4