git.notmuchmail.org Git - notmuch/blob - doc/man1/notmuch-insert.rst

   1 ==============
   2 notmuch-insert
   3 ==============
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **insert** [option ...] [+<*tag*>|-<*tag*> ...]
   9
  10 DESCRIPTION
  11 ===========
  12
  13 **notmuch insert** reads a message from standard input and delivers it
  14 into the maildir directory given by configuration option
  15 **database.path**, then incorporates the message into the notmuch
  16 database. It is an alternative to using a separate tool to deliver the
  17 message then running **notmuch new** afterwards.
  18
  19 The new message will be tagged with the tags specified by the
  20 **new.tags** configuration option, then by operations specified on the
  21 command-line: tags prefixed by '+' are added while those prefixed by '-'
  22 are removed.
  23
  24 If the new message is a duplicate of an existing message in the database
  25 (it has same Message-ID), it will be added to the maildir folder and
  26 notmuch database, but the tags will not be changed.
  27
  28 Option arguments must appear before any tag operation arguments.
  29 Supported options for **insert** include
  30
  31     ``--folder=<``\ folder\ **>**
  32         Deliver the message to the specified folder, relative to the
  33         top-level directory given by the value of **database.path**. The
  34         default is to deliver to the top-level directory.
  35
  36     ``--create-folder``
  37         Try to create the folder named by the ``--folder`` option, if it
  38         does not exist. Otherwise the folder must already exist for mail
  39         delivery to succeed.
  40
  41     ``--keep``
  42         Keep the message file if indexing fails, and keep the message
  43         indexed if applying tags or maildir flag synchronization
  44         fails. Ignore these errors and return exit status 0 to
  45         indicate succesful mail delivery.
  46
  47 EXIT STATUS
  48 ===========
  49
  50 This command returns exit status 0 on succesful mail delivery,
  51 non-zero otherwise. The default is to indicate failed mail delivery on
  52 any errors, including message file delivery to the filesystem, message
  53 indexing to Notmuch database, changing tags, and synchronizing tags to
  54 maildir flags. The ``--keep`` option may be used to settle for
  55 successful message file delivery.
  56
  57 SEE ALSO
  58 ========
  59
  60 **notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
  61 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-reply(1)**,
  62 **notmuch-restore(1)**, **notmuch-search(1)**,
  63 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**