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|nostash|auto|false)``
  47     If ``true``, when encountering an encrypted message, try to
  48     decrypt it while indexing, and stash any discovered session keys.
  49     If ``auto``, try to use any session key already known to belong to
  50     this message, but do not attempt to use the user's secret keys.
  51     If decryption is successful, index the cleartext of the message.
  52
  53     Be aware that the index is likely sufficient (and the session key
  54     is certainly sufficient) to reconstruct the cleartext of the
  55     message itself, so please ensure that the notmuch message index is
  56     adequately protected.  DO NOT USE ``--decrypt=true`` or
  57     ``--decrypt=nostash`` without considering the security of your
  58     index.
  59
  60     See also ``index.decrypt`` in **notmuch-config(1)**.
  61
  62 ``--full-scan``
  63     By default notmuch-new uses directory modification times (mtimes)
  64     to optimize the scanning of directories for new mail. This option turns
  65     that optimization off.
  66
  67 EXIT STATUS
  68 ===========
  69
  70 This command supports the following special exit status code
  71
  72 ``75 (EX_TEMPFAIL)``
  73     A temporary failure occurred; the user is invited to retry.
  74
  75 SEE ALSO
  76 ========
  77
  78 **notmuch(1)**,
  79 **notmuch-config(1)**,
  80 **notmuch-count(1)**,
  81 **notmuch-dump(1)**,
  82 **notmuch-hooks(5)**,
  83 **notmuch-insert(1)**,
  84 **notmuch-reply(1)**,
  85 **notmuch-restore(1)**,
  86 **notmuch-search(1)**,
  87 **notmuch-search-terms(7)**,
  88 **notmuch-show(1)**,
  89 **notmuch-tag(1)**