is termed "mboxrd" format and described in detail here:
<u>http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html</u>
- <b>raw</b> (default if --part is given)
+ <b>raw</b> (default if <b>--part</b> is given)
Write the raw bytes of the given MIME part of a message
to standard out. For this format, it is an error to spec‐
ify a query that matches more than one message.
<b>--verify</b>
Compute and report the validity of any MIME cryptographic signa‐
- tures found in the selected content (ie. "multipart/signed"
+ tures found in the selected content (e.g., "multipart/signed"
parts). Status of the signature will be reported (currently only
- supported with --format=json and --format=sexp), and the multi‐
+ supported with <b>--format=json</b> and <b>--format=sexp</b>), and the multi‐
part/signed part will be replaced by the signed data.
- <b>--decrypt=(false|auto|true)</b>
+ <b>--decrypt=(false|auto|true|stash)</b>
If <b>true</b>, decrypt any MIME encrypted parts found in the selected
- content (i.e. "multipart/encrypted" parts). Status of the
+ content (e.g., "multipart/encrypted" parts). Status of the
decryption will be reported (currently only supported with
- --format=json and --format=sexp) and on successful decryption
+ <b>--format=json</b> and <b>--format=sexp</b>) and on successful decryption
the multipart/encrypted part will be replaced by the decrypted
content.
- If <b>auto</b>, and a session key is already known for the message,
- then it will be decrypted, but notmuch will not try to access
+ <b>stash</b> behaves like <b>true</b>, but upon successful decryption it will
+ also stash the message's session key in the database, and index
+ the cleartext of the message, enabling automatic decryption in
+ the future.
+
+ If <b>auto</b>, and a session key is already known for the message,
+ then it will be decrypted, but notmuch will not try to access
the user's keys.
Use <b>false</b> to avoid even automatic decryption.
- Non-automatic decryption expects a functioning <b>gpg-agent</b>(1) to
- provide any needed credentials. Without one, the decryption will
+ Non-automatic decryption (<b>stash</b> or <b>true</b>, in the absence of a
+ stashed session key) expects a functioning <b>gpg-agent</b>(1) to pro‐
+ vide any needed credentials. Without one, the decryption will
fail.
- Note: <b>true</b> implies --verify.
+ Note: setting either <b>true</b> or <b>stash</b> here implies <b>--verify</b>.
+
+ Here is a table that summarizes each of these policies:
+
+ ┌──────────────┬───────┬──────┬──────┬───────┐
+ │ │ false │ auto │ true │ stash │
+ ├──────────────┼───────┼──────┼──────┼───────┤
+ │Show cleart‐ │ │ X │ X │ X │
+ │ext if ses‐ │ │ │ │ │
+ │sion key is │ │ │ │ │
+ │already known │ │ │ │ │
+ ├──────────────┼───────┼──────┼──────┼───────┤
+ │Use secret │ │ │ X │ X │
+ │keys to show │ │ │ │ │
+ │cleartext │ │ │ │ │
+ ├──────────────┼───────┼──────┼──────┼───────┤
+ │Stash any │ │ │ │ X │
+ │newly recov‐ │ │ │ │ │
+ │ered session │ │ │ │ │
+ │keys, rein‐ │ │ │ │ │
+ │dexing mes‐ │ │ │ │ │
+ │sage if found │ │ │ │ │
+ └──────────────┴───────┴──────┴──────┴───────┘
+
+ Note: <b>--decrypt=stash</b> requires write access to the database.
+ Otherwise, <b>notmuch</b> <b>show</b> operates entirely in read-only mode.
Default: <b>auto</b>
<b>--exclude=(true|false)</b>
- Specify whether to omit threads only matching search.tag_exclude
- from the search results (the default) or not. In either case the
- excluded message will be marked with the exclude flag (except
- when output=mbox when there is nowhere to put the flag).
+ Specify whether to omit threads only matching
+ search.exclude_tags from the search results (the default) or
+ not. In either case the excluded message will be marked with the
+ exclude flag (except when output=mbox when there is nowhere to
+ put the flag).
- If --entire-thread is specified then complete threads are
+ If <b>--entire-thread</b> is specified then complete threads are
returned regardless (with the excluded flag being set when
appropriate) but threads that only match in an excluded message
are not returned when <b>--exclude=true.</b>
<b>--body=(true|false)</b>
If true (the default) <b>notmuch</b> <b>show</b> includes the bodies of the
messages in the output; if false, bodies are omitted.
- <b>--body=false</b> is only implemented for the json and sexp formats
- and it is incompatible with <b>--part</b> <b>></b> <b>0.</b>
+ <b>--body=false</b> is only implemented for the text, json and sexp
+ formats and it is incompatible with <b>--part</b> <b>></b> <b>0.</b>
This is useful if the caller only needs the headers as body-less
output is much faster and substantially smaller.
<b>--include-html</b>
Include "text/html" parts as part of the output (currently only
- supported with --format=json and --format=sexp). By default,
- unless <b>--part=N</b> is used to select a specific part or
+ supported with <b>--format=text</b>, <b>--format=json</b> and <b>--format=sexp</b>).
+ By default, unless <b>--part=N</b> is used to select a specific part or
<b>--include-html</b> is used to include all "text/html" parts, no part
with content type "text/html" is included in the output.
<h2>COPYRIGHT</h2>
<pre>
- 2009-2018, Carl Worth and many others
+ 2009-2019, Carl Worth and many others
</pre>
-<h2>0.26</h2>
+<h2>0.29</h2>
projects / notmuch-wiki / blobdiff