This is notmuch-reindex.info, produced by makeinfo version 4.8 from
notmuch-reindex.texi.

Generated by Sphinx 1.4.8.
INFO-DIR-SECTION Miscellaneous
START-INFO-DIR-ENTRY
* notmuch-reindex: (notmuch-reindex.info). re-index matching messages
END-INFO-DIR-ENTRY

     notmuch 0.30, Oct 01, 2020

     Carl Worth and many others

     Copyright (C) 2009-2020, Carl Worth and many others


File: notmuch-reindex.info,  Node: Top,  Next: SYNOPSIS,  Up: (dir)

notmuch-reindex documentation
*****************************

     notmuch 0.30, Oct 01, 2020

     Carl Worth and many others

     Copyright (C) 2009-2020, Carl Worth and many others

* Menu:

* SYNOPSIS::
* DESCRIPTION::
* EXAMPLES::
* SEE ALSO::


File: notmuch-reindex.info,  Node: SYNOPSIS,  Next: DESCRIPTION,  Prev: Top,  Up: Top

1 SYNOPSIS
**********

`notmuch' `reindex' [`option' ...] <`search-term'> ...


File: notmuch-reindex.info,  Node: DESCRIPTION,  Next: EXAMPLES,  Prev: SYNOPSIS,  Up: Top

2 DESCRIPTION
*************

Re-index all messages matching the search terms.

See `notmuch-search-terms(7)' for details of the supported syntax for
<`search-term'>.

The `reindex' command searches for all messages matching the supplied
search terms, and re-creates the full-text index on these messages
using the supplied options.

Supported options for `reindex' include

`--decrypt=(true|nostash|auto|false)'
     If `true', when encountering an encrypted message, try to decrypt
     it while reindexing, stashing any session keys discovered.  If
     `auto', and notmuch already knows about a session key for the
     message, it will try decrypting using that session key but will
     not try to access the user's secret keys.  If decryption is
     successful, index the cleartext itself.

     `nostash' is the same as `true' except that it will not stash
     newly-discovered session keys in the database.

     If `false', notmuch reindex will also delete any stashed session
     keys for all messages matching the search terms.

     Be aware that the index is likely sufficient (and a stashed
     session key is certainly sufficient) to reconstruct the cleartext
     of the message itself, so please ensure that the notmuch message
     index is adequately protected. DO NOT USE `--decrypt=true' or
     `--decrypt=nostash' without considering the security of your index.

     See also `index.decrypt' in `notmuch-config(1)'.


File: notmuch-reindex.info,  Node: EXAMPLES,  Next: SEE ALSO,  Prev: DESCRIPTION,  Up: Top

3 EXAMPLES
**********

A user just received an encrypted message without indexing its
cleartext.  After reading it (via `notmuch show --decrypt=true'), they
decide that they want to index its cleartext so that they can easily
find it later and read it without having to have access to their secret
keys:

    notmuch reindex --decrypt=true id:1234567@example.com

A user wants to change their policy going forward to start indexing
cleartext.  But they also want indexed access to the cleartext of all
previously-received encrypted messages.  Some messages might have
already been indexed in the clear (as in the example above). They can
ask notmuch to just reindex the not-yet-indexed messages:

    notmuch config set index.decrypt true
    notmuch reindex tag:encrypted and not property:index.decryption=success

Later, the user changes their mind, and wants to stop indexing
cleartext (perhaps their threat model has changed, or their trust in
their index store has been shaken).  They also want to clear all of
their old cleartext from the index.  Note that they compact the
database afterward as a workaround for
<https://trac.xapian.org/ticket/742>:

    notmuch config set index.decrypt false
    notmuch reindex property:index.decryption=success
    notmuch compact


File: notmuch-reindex.info,  Node: SEE ALSO,  Prev: EXAMPLES,  Up: Top

4 SEE ALSO
**********

`notmuch(1)', `notmuch-compact(1)', `notmuch-config(1)',
`notmuch-count(1)', `notmuch-dump(1)', `notmuch-hooks(5)',
`notmuch-insert(1)', `notmuch-new(1)', `notmuch-reply(1)',
`notmuch-restore(1)', `notmuch-search(1)', `notmuch-search-terms(7)',
`notmuch-show(1)', `notmuch-tag(1)'



Tag Table:
Node: Top384
Ref: man1/notmuch-reindex doc640
Ref: 0640
Node: SYNOPSIS705
Ref: man1/notmuch-reindex synopsis794
Ref: 1794
Ref: man1/notmuch-reindex notmuch-reindex794
Ref: 2794
Node: DESCRIPTION873
Ref: man1/notmuch-reindex description967
Ref: 3967
Node: EXAMPLES2412
Ref: man1/notmuch-reindex examples2506
Ref: 42506
Node: SEE ALSO3782
Ref: man1/notmuch-reindex see-also3856
Ref: 53856

End Tag Table
