git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-insert-1.mdwn

   1 <h1>NOTMUCH-INSERT(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-insert - add a message to the maildir and notmuch database
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> <b>insert</b> [option ...] [+&lt;<u>tag</u>&gt;|-&lt;<u>tag</u>&gt; ...]
  11 </pre>
  12
  13 <h2>DESCRIPTION</h2>
  14 <pre>
  15        <b>notmuch</b> <b>insert</b> reads a message from standard input and delivers it into
  16        the maildir directory given by configuration option <b>database.path</b>, then
  17        incorporates  the  message into the notmuch database. It is an alterna‐
  18        tive to using a separate tool to deliver the message then running  <b>not-</b>
  19        <b>much</b> <b>new</b> afterwards.
  20
  21        The  new message will be tagged with the tags specified by the <b>new.tags</b>
  22        configuration option, then by operations specified on the command-line:
  23        tags prefixed by &apos;+&apos; are added while those prefixed by &apos;-&apos; are removed.
  24
  25        If  the  new message is a duplicate of an existing message in the data‐
  26        base (it has same Message-ID), it will be added to the  maildir  folder
  27        and notmuch database, but the tags will not be changed.
  28
  29        Option  arguments must appear before any tag operation arguments.  Sup‐
  30        ported options for <b>insert</b> include
  31
  32           <b>--folder=&lt;folder&gt;</b>
  33                  Deliver the message to the specified folder, relative to  the
  34                  top-level  directory given by the value of <b>database.path</b>. The
  35                  default is to deliver to the top-level directory.
  36
  37           <b>--create-folder</b>
  38                  Try to create the folder named by the <b>--folder</b> option, if  it
  39                  does  not  exist. Otherwise the folder must already exist for
  40                  mail delivery to succeed.
  41 </pre>
  42
  43 <h2>EXIT STATUS</h2>
  44 <pre>
  45        This command returns exit status 0  if  the  message  was  successfully
  46        added  to  the mail directory, even if the message could not be indexed
  47        and added to the notmuch database. In the latter case, a  warning  will
  48        be printed to standard error but the message file will be left on disk.
  49
  50        If the message could not be written to disk then a non-zero exit status
  51        is returned.
  52 </pre>
  53
  54 <h2>SEE ALSO</h2>
  55 <pre>
  56        <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>not‐</a>
  57        <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1),
  58        <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
  59 </pre>
  60
  61 <h2>AUTHOR</h2>
  62 <pre>
  63        Carl Worth and many others
  64 </pre>
  65
  66 <h2>COPYRIGHT</h2>
  67 <pre>
  68        2014, Carl Worth and many others
  69 </pre>
  70
  71 <h2>0.18.1</h2>