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

   1 <h1>NOTMUCH-NEW(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-new - incorporate new mail into the notmuch database
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> <b>new</b> [options]
  11 </pre>
  12
  13 <h2>DESCRIPTION</h2>
  14 <pre>
  15        Find and import any new messages to the database.
  16
  17        The  <b>new</b>  command scans all sub-directories of the database, performing
  18        full-text indexing on new messages that are  found.  Each  new  message
  19        will automatically be tagged with both the <b>inbox</b> and <b>unread</b> tags.
  20
  21        You should run <b>notmuch</b> <b>new</b> once after first running <b>notmuch-setup</b>(1) to
  22        create the initial database. The first run may take a long time if  you
  23        have a significant amount of mail (several hundred thousand messages or
  24        more). Subsequently, you should run <b>notmuch</b> <b>new</b> whenever  new  mail  is
  25        delivered and you wish to incorporate it into the database.  These sub‐
  26        sequent runs will be much quicker than the initial run.
  27
  28        Invoking <b>notmuch</b>  with  no  command  argument  will  run  <b>new</b>  if  <b>not-</b>
  29        <b>much-setup</b>(1)  has  previously  been completed, but <b>notmuch</b> <b>new</b> has not
  30        previously been run.
  31
  32        <b>notmuch</b> <b>new</b> updates tags according  to  maildir  flag  changes  if  the
  33        <b>maildir.synchronize</b>_<b>flags</b>  configuration  option  is  enabled. See <a href='../notmuch-config-1/'>not‐</a>
  34        <a href='../notmuch-config-1/'>much-config</a>(1) for details.
  35
  36        The <b>new</b> command supports hooks. See <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5) for  more  details
  37        on hooks.
  38
  39        Supported options for <b>new</b> include
  40
  41        <b>--no-hooks</b>
  42               Prevents hooks from being run.
  43
  44        <b>--quiet</b>
  45               Do not print progress or results.
  46
  47        <b>--verbose</b>
  48               Print  file  names  being  processed. Ignored when combined with
  49               <b>--quiet</b>.
  50
  51        <b>--decrypt=(true|nostash|auto|false)</b>
  52               If <b>true</b>, when encountering an encrypted message, try to  decrypt
  53               it  while  indexing,  and stash any discovered session keys.  If
  54               <b>auto</b>, try to use any session key already known to belong to this
  55               message,  but  do not attempt to use the user&apos;s secret keys.  If
  56               decryption is successful, index the cleartext of the message.
  57
  58               Be aware that the index is likely sufficient  (and  the  session
  59               key is certainly sufficient) to reconstruct the cleartext of the
  60               message itself, so please ensure that the notmuch message  index
  61               is  adequately  protected.   DO  NOT USE <b>--decrypt=true</b> or <b>--de-</b>
  62               <b>crypt=nostash</b> without considering the security of your index.
  63
  64               See also <b>index.decrypt</b> in <a href='../notmuch-config-1/'>notmuch-config</a>(1).
  65
  66        <b>--full-scan</b>
  67               By  default  notmuch-new  uses  directory   modification   times
  68               (mtimes)  to  optimize the scanning of directories for new mail.
  69               This option turns that optimization off.
  70 </pre>
  71
  72 <h2>EXIT STATUS</h2>
  73 <pre>
  74        This command supports the following special exit status code
  75
  76        <b>75</b> <b>(EX</b>_<b>TEMPFAIL)</b>
  77               A temporary failure occurred; the user is invited to retry.
  78 </pre>
  79
  80 <h2>SEE ALSO</h2>
  81 <pre>
  82        <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>
  83        <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
  84        <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <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/'>not‐</a>
  85        <a href='../notmuch-tag-1/'>much-tag</a>(1)
  86 </pre>
  87
  88 <h2>AUTHOR</h2>
  89 <pre>
  90        Carl Worth and many others
  91 </pre>
  92
  93 <h2>COPYRIGHT</h2>
  94 <pre>
  95        2009-2022, Carl Worth and many others
  96 </pre>
  97
  98 <h2>0.35</h2>