1 <h1>NOTMUCH-SHOW(1)</h1>
5 notmuch-show - show messages matching the given search terms
10 <b>notmuch</b> <b>show</b> [<u>options</u>...] <<u>search-term</u>>...
15 Shows all messages matching the search terms.
17 See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
20 The messages will be grouped and sorted based on the threading (all
21 replies to a particular message will appear immediately after that mes-
22 sage in date order). The output is not indented by default, but depth
23 tags are printed so that proper indentation can be performed by a post-
24 processor (such as the emacs interface to notmuch).
26 Supported options for <b>show</b> include
28 <b>--entire-thread=(true|false)</b>
30 If true, <b>notmuch</b> <b>show</b> outputs all messages in the thread of any
31 message matching the search terms; if false, it outputs only
32 the matching messages. For <b>--format=json</b> this defaults to true.
33 For other formats, this defaults to false.
35 <b>--format=(text|json|mbox|raw)</b>
37 <b>text</b> (default for messages)
39 The default plain-text format has all text-content MIME
40 parts decoded. Various components in the output, (<b>message</b>,
41 <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>), will be delimited
42 by easily-parsed markers. Each marker consists of a Con-
43 trol-L character (ASCII decimal 12), the name of the
44 marker, and then either an opening or closing brace, ('{'
45 or '}'), to either open or close the component. For a mul-
46 tipart MIME message, these parts will be nested.
50 The output is formatted with Javascript Object Notation
51 (JSON). This format is more robust than the text format for
52 automated processing. The nested structure of multipart
53 MIME messages is reflected in nested JSON output. By
54 default JSON output includes all messages in a matching
55 thread; that is, by default, <b>--format=json</b> sets
56 <b>--entire-thread</b> The caller can disable this behaviour by
57 setting <b>--entire-thread=false</b>
61 All matching messages are output in the traditional, Unix
62 mbox format with each message being prefixed by a line
63 beginning with "From " and a blank line separating each
64 message. Lines in the message content beginning with "From
65 " (preceded by zero or more '>' characters) have an
66 additional '>' character added. This reversible escaping is
67 termed "mboxrd" format and described in detail here:
69 http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
71 <b>raw</b> (default for a single part, see --part)
73 For a message or an attached message part, the original,
74 raw content of the email message is output. Consumers of
75 this format should expect to implement MIME decoding and
78 For a single part (--part) the raw part content is output
79 after performing any necessary MIME decoding. Note that
80 messages with a simple body still have two parts: part 0 is
81 the whole message and part 1 is the body.
83 For a multipart part, the part headers and body (including
84 all child parts) is output.
86 The raw format must only be used with search terms matching
91 Output the single decoded MIME part N of a single message. The
92 search terms must match only a single message. Message parts
93 are numbered in a depth-first walk of the message MIME struc-
94 ture, and are identified in the 'json' or 'text' output for-
99 Compute and report the validity of any MIME cryptographic sig-
100 natures found in the selected content (ie. "multipart/signed"
101 parts). Status of the signature will be reported (currently on-
102 ly supported with --format=json), and the multipart/signed part
103 will be replaced by the signed data.
107 Decrypt any MIME encrypted parts found in the selected content
108 (ie. "multipart/encrypted" parts). Status of the decryption
109 will be reported (currently only supported with --format=json)
110 and the multipart/encrypted part will be replaced by the de-
111 crypted content. Implies --verify.
113 <b>--exclude=(true|false)</b>
115 Specify whether to omit threads only matching search.tag_ex-
116 clude from the search results (the default) or not. In either
117 case the excluded message will be marked with the exclude flag
118 (except when output=mbox when there is nowhere to put the
121 If --entire-thread is specified then complete threads are re-
122 turned regardless (with the excluded flag being set when appro-
123 priate) but threads that only match in an excluded message are
124 not returned when <b>--exclude=true.</b>
126 The default is <b>--exclude=true.</b>
128 <b>--body=(true|false)</b>
130 If true (the default) <b>notmuch</b> <b>show</b> includes the bodies of the
131 messages in the output; if false, bodies are omitted.
132 <b>--body=false</b> is only implemented for the json format and it is
133 incompatible with <b>--part</b> ><b>&</b>gt; <b>0.</b>
135 This is useful if the caller only needs the headers as body-
136 less output is much faster and substantially smaller.
138 A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email
139 messages. For this, use a search term of "thread:<thread-id>" as can be
140 seen in the first column of output from the <b>notmuch</b> <b>search</b> command.
145 <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>
146 <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),
147 <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)
150 <h2>Notmuch 0.14</h2>