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

   1 ===========
   2 notmuch-new
   3 ===========
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **new** [options]
   9
  10 DESCRIPTION
  11 ===========
  12
  13 Find and import any new messages to the database.
  14
  15 The **new** command scans all sub-directories of the database,
  16 performing full-text indexing on new messages that are found. Each new
  17 message will automatically be tagged with both the **inbox** and
  18 **unread** tags.
  19
  20 You should run **notmuch new** once after first running **notmuch
  21 setup** to create the initial database. The first run may take a long
  22 time if you have a significant amount of mail (several hundred thousand
  23 messages or more). Subsequently, you should run **notmuch new** whenever
  24 new mail is delivered and you wish to incorporate it into the database.
  25 These subsequent runs will be much quicker than the initial run.
  26
  27 Invoking ``notmuch`` with no command argument will run **new** if
  28 **notmuch setup** has previously been completed, but **notmuch new** has
  29 not previously been run.
  30
  31 **notmuch new** updates tags according to maildir flag changes if the
  32 **maildir.synchronize\_flags** configuration option is enabled. See
  33 **notmuch-config(1)** for details.
  34
  35 The **new** command supports hooks. See **notmuch-hooks(5)** for more
  36 details on hooks.
  37
  38 Supported options for **new** include
  39
  40     ``--no-hooks``
  41         Prevents hooks from being run.
  42
  43     ``--quiet``
  44         Do not print progress or results.
  45
  46     ``--decrypt=(true|auto|false)``
  47
  48         If ``true``, when encountering an encrypted message, try to
  49         decrypt it while indexing.  If decryption is successful, index
  50         the cleartext itself.  If ``auto``, try to use any session key
  51         already known to belong to this message, but do not attempt to
  52         use the user's secret keys.
  53
  54         Be aware that the index is likely
  55         sufficient to reconstruct the cleartext of the message itself,
  56         so please ensure that the notmuch message index is adequately
  57         protected.  DO NOT USE ``--decrypt=true`` without
  58         considering the security of your index.
  59
  60         See also ``index.decrypt`` in **notmuch-config(1)**.
  61
  62 EXIT STATUS
  63 ===========
  64
  65 This command supports the following special exit status code
  66
  67 ``75 (EX_TEMPFAIL)``
  68     A temporary failure occurred; the user is invited to retry.
  69
  70 SEE ALSO
  71 ========
  72
  73 **notmuch(1)**,
  74 **notmuch-config(1)**,
  75 **notmuch-count(1)**,
  76 **notmuch-dump(1)**,
  77 **notmuch-hooks(5)**,
  78 **notmuch-insert(1)**,
  79 **notmuch-reply(1)**,
  80 **notmuch-restore(1)**,
  81 **notmuch-search(1)**,
  82 **notmuch-search-terms(7)**,
  83 **notmuch-show(1)**,
  84 **notmuch-tag(1)**