<h2>SYNOPSIS</h2>
<pre>
- <b>notmuch</b> <b>show</b> [<u>options</u>...] <<u>search-term</u>>...
+ <b>notmuch</b> <b>show</b> [<u>option</u> ...] <<u>search-term</u>> ...
</pre>
<h2>DESCRIPTION</h2>
The messages will be grouped and sorted based on the threading (all
replies to a particular message will appear immediately after that mes-
sage in date order). The output is not indented by default, but depth
- tags are printed so that proper indentation can be performed by a post-
- processor (such as the emacs interface to notmuch).
+ tags are printed so that proper indentation can be performed by a
+ post-processor (such as the emacs interface to notmuch).
Supported options for <b>show</b> include
<b>--entire-thread=(true|false)</b>
- If true, <b>notmuch</b> <b>show</b> outputs all messages in the thread of any
- message matching the search terms; if false, it outputs only
- the matching messages. For <b>--format=json</b> this defaults to true.
- For other formats, this defaults to false.
+ If true, <b>notmuch</b> <b>show</b> outputs all messages in the thread of
+ any message matching the search terms; if false, it outputs
+ only the matching messages. For --format=json and --for-
+ mat=sexp this defaults to true. For other formats, this
+ defaults to false.
+
+ --format=(text|json|sexp|mbox|raw)
+
+ <b>text</b> <b>(default</b> <b>for</b> <b>messages)</b>
+
+ The default plain-text format has all text-content MIME
+ parts decoded. Various components in the output, (<b>mes-</b>
+ <b>sage</b>, <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>), will be
+ delimited by easily-parsed markers. Each marker consists
+ of a Control-L character (ASCII decimal 12), the name of
+ the marker, and then either an opening or closing brace,
+ ('{' or '}'), to either open or close the component. For
+ a multipart MIME message, these parts will be nested.
+
+ <b>json</b>
+
+ The output is formatted with Javascript Object Notation
+ (JSON). This format is more robust than the text format
+ for automated processing. The nested structure of multi-
+ part MIME messages is reflected in nested JSON output. By
+ default JSON output includes all messages in a matching
+ thread; that is, by default, --format=json sets
+ --entire-thread. The caller can disable this behaviour by
+ setting --entire-thread=false. The JSON output is always
+ encoded as UTF-8 and any message content included in the
+ output will be charset-converted to UTF-8.
+
+ <b>sexp</b>
+
+ The output is formatted as the Lisp s-expression (sexp)
+ equivalent of the JSON format above. Objects are format-
+ ted as property lists whose keys are keywords (symbols
+ preceded by a colon). True is formatted as t and both
+ false and null are formatted as nil. As for JSON, the
+ s-expression output is always encoded as UTF-8.
+
+ <b>mbox</b>
+
+ All matching messages are output in the traditional, Unix
+ mbox format with each message being prefixed by a line
+ beginning with "From " and a blank line separating each
+ message. Lines in the message content beginning with
+ "From " (preceded by zero or more '>' characters) have an
+ additional '>' character added. This reversible escaping
+ 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> <b>(default</b> <b>if</b> <b>--part</b> <b>is</b> <b>given)</b>
+
+ 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.
+
+ If the specified part is a leaf part, this outputs the
+ body of the part after performing content transfer decod-
+ ing (but no charset conversion). This is suitable for
+ saving attachments, for example.
+
+ For a multipart or message part, the output includes the
+ part headers as well as the body (including all child
+ parts). No decoding is performed because multipart and
+ message parts cannot have non-trivial content transfer
+ encoding. Consumers of this may need to implement MIME
+ decoding and similar functions.
+
+ <b>--format-version=N</b>
+
+ Use the specified structured output format version. This is
+ intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If
+ omitted, the latest supported version will be used.
- <b>--format=(text|json|mbox|raw)</b>
-
- <b>text</b> (default for messages)
+ <b>--part=N</b>
- The default plain-text format has all text-content MIME
- parts decoded. Various components in the output, (<b>message</b>,
- <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>), will be delimited
- by easily-parsed markers. Each marker consists of a Con-
- trol-L character (ASCII decimal 12), the name of the
- marker, and then either an opening or closing brace, ('{'
- or '}'), to either open or close the component. For a mul-
- tipart MIME message, these parts will be nested.
+ Output the single decoded MIME part N of a single message.
+ The search terms must match only a single message. Message
+ parts are numbered in a depth-first walk of the message MIME
+ structure, and are identified in the 'json', 'sexp' or
+ 'text' output formats.
- <b>json</b>
+ Note that even a message with no MIME structure or a single
+ body part still has two MIME parts: part 0 is the whole mes-
+ sage (headers and body) and part 1 is just the body.
- The output is formatted with Javascript Object Notation
- (JSON). This format is more robust than the text format for
- automated processing. The nested structure of multipart
- MIME messages is reflected in nested JSON output. By
- default JSON output includes all messages in a matching
- thread; that is, by default, <b>--format=json</b> sets
- <b>--entire-thread</b> The caller can disable this behaviour by
- setting <b>--entire-thread=false</b>
+ <b>--verify</b>
- <b>mbox</b>
+ Compute and report the validity of any MIME cryptographic
+ signatures found in the selected content (ie. "multi-
+ part/signed" parts). Status of the signature will be
+ reported (currently only supported with --format=json and
+ --format=sexp), and the multipart/signed part will be
+ replaced by the signed data.
- All matching messages are output in the traditional, Unix
- mbox format with each message being prefixed by a line
- beginning with "From " and a blank line separating each
- message. Lines in the message content beginning with "From
- " (preceded by zero or more '>' characters) have an
- additional '>' character added. This reversible escaping is
- termed "mboxrd" format and described in detail here:
+ <b>--decrypt</b>
- http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
+ Decrypt any MIME encrypted parts found in the selected con-
+ tent (ie. "multipart/encrypted" parts). Status of the
+ decryption will be reported (currently only supported with
+ --format=json and --format=sexp) and on successful decryp-
+ tion the multipart/encrypted part will be replaced by the
+ decrypted content.
- <b>raw</b> (default for a single part, see --part)
+ Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
+ needed credentials. Without one, the decryption will fail.
- For a message or an attached message part, the original,
- raw content of the email message is output. Consumers of
- this format should expect to implement MIME decoding and
- similar functions.
+ Implies --verify.
- For a single part (--part) the raw part content is output
- after performing any necessary MIME decoding. Note that
- messages with a simple body still have two parts: part 0 is
- the whole message and part 1 is the body.
+ <b>--exclude=(true|false)</b>
- For a multipart part, the part headers and body (including
- all child parts) is output.
+ 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).
- The raw format must only be used with search terms matching
- single message.
+ If --entire-thread is specified then complete threads are
+ returned regardless (with the excluded flag being set when
+ appropriate) but threads that only match in an excluded mes-
+ sage are not returned when --exclude=true.
- <b>--part=N</b>
+ The default is --exclude=true.
- Output the single decoded MIME part N of a single message. The
- search terms must match only a single message. Message parts
- are numbered in a depth-first walk of the message MIME struc-
- ture, and are identified in the 'json' or 'text' output for-
- mats.
+ <b>--body=(true|false)</b>
- <b>--verify</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.
+ --body=false is only implemented for the json and sexp for-
+ mats and it is incompatible with --part > 0.
- Compute and report the validity of any MIME cryptographic sig-
- natures found in the selected content (ie. "multipart/signed"
- parts). Status of the signature will be reported (currently on-
- ly supported with --format=json), and the multipart/signed part
- will be replaced by the signed data.
+ This is useful if the caller only needs the headers as
+ body-less output is much faster and substantially smaller.
- <b>--decrypt</b>
+ <b>--include-html</b>
- Decrypt any MIME encrypted parts found in the selected content
- (ie. "multipart/encrypted" parts). Status of the decryption
- will be reported (currently only supported with --format=json)
- and the multipart/encrypted part will be replaced by the de-
- crypted content. Implies --verify.
+ Include "text/html" parts as part of the output (currently
+ only supported with --format=json and --format=sexp). By
+ default, unless --part=N is used to select a specific part
+ or --include-html is used to include all "text/html" parts,
+ no part with content type "text/html" is included in the
+ output.
- <b>--exclude=(true|false)</b>
+ A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email
+ messages. For this, use a search term of "thread:<thread-id>" as can be
+ seen in the first column of output from the <b>notmuch</b> <b>search</b> command.
+</pre>
- Specify whether to omit threads only matching search.tag_ex-
- clude 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).
+<h2>EXIT STATUS</h2>
+<pre>
+ This command supports the following special exit status codes
- If --entire-thread is specified then complete threads are re-
- turned regardless (with the excluded flag being set when appro-
- priate) but threads that only match in an excluded message are
- not returned when <b>--exclude=true.</b>
+ <b>20</b>
- The default is <b>--exclude=true.</b>
+ The requested format version is too old.
- <b>--body=(true|false)</b>
+ <b>21</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 format and it is
- incompatible with <b>--part</b> ><b>&</b>gt; <b>0.</b>
+ The requested format version is too new.
+</pre>
- This is useful if the caller only needs the headers as body-
- less output is much faster and substantially smaller.
+<h2>SEE ALSO</h2>
+<pre>
+ <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>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+ <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-tag-1/'>not-</a>
+ <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
- A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email
- messages. For this, use a search term of "thread:<thread-id>" as can be
- seen in the first column of output from the <b>notmuch</b> <b>search</b> command.
+<h2>AUTHOR</h2>
+<pre>
+ Carl Worth and many others
</pre>
-<h2>SEE ALSO</h2>
+<h2>COPYRIGHT</h2>
<pre>
- <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>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
- <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
+ 2014, Carl Worth and many others
</pre>
-<h2>Notmuch 0.14</h2>
+<h2>0.18</h2>
projects / notmuch-wiki / blobdiff