unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob 3f9584bb84215d650f8bcfdd6226105a885c6cd8 6495 bytes (raw)
name: man/man1/notmuch-show.1 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
.TH NOTMUCH-SHOW 1 2013-01-18 "Notmuch 0.15"
.SH NAME
notmuch-show \- show messages matching the given search terms
.SH SYNOPSIS

.B notmuch show
.RI "[" options "...] <" search-term ">..."

.SH DESCRIPTION

Shows all messages matching the search terms.

See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.

The messages will be grouped and sorted based on the threading (all
replies to a particular message will appear immediately after that
message 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).

Supported options for
.B show
include
.RS 4
.TP 4
.B \-\-entire\-thread=(true|false)

If true,
.B notmuch show
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
and
.B --format=sexp
this defaults to true.  For other formats, this defaults to false.
.RE

.RS 4
.TP 4
.B \-\-format=(text|json|sexp|mbox|raw)

.RS 4
.TP 4
.BR text " (default for messages)"

The default plain-text format has all text-content MIME parts
decoded. Various components in the output,
.RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
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.
.RE
.RS 4
.TP 4
.B json

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
sets
.B "\-\-entire\-thread"
The caller can disable this behaviour by setting
.B \-\-entire\-thread=false
.RE
.RS 4
.TP 4
.B sexp

The output is formatted as an S-Expression (sexp). This
format is more robust than the text format for automated
processing. The nested structure of multipart MIME messages is
reflected in nested S-Expression output. By default,
S-Expression output includes all messages in a matching thread;
that is, by default,

.B \-\-format=sexp
sets
.B "\-\-entire\-thread"
The caller can disable this behaviour by setting
.B \-\-entire\-thread=false

.RE
.RS 4
.TP 4
.B mbox

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:

.nf
.nh
http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
.hy
.fi
.
.RE
.RS 4
.TP 4
.BR raw " (default for a single part, see \-\-part)"

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.

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.

For a multipart part, the part headers and body (including all child
parts) is output.

The raw format must only be used with search terms matching single
message.
.RE
.RE

.RS 4
.TP 4
.BR \-\-format-version=N

Use the specified structured output format version.  This is intended
for programs that invoke \fBnotmuch\fR(1) internally.  If omitted, the
latest supported version will be used.
.RE

.RS 4
.TP 4
.B \-\-part=N

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.
.RE

.RS 4
.TP 4
.B \-\-verify

Compute and report the validity of any MIME cryptographic signatures
found in the selected content (ie. "multipart/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.
.RE

.RS 4
.TP 4
.B \-\-decrypt

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
--format=sexp) and the multipart/encrypted part will be replaced
by the decrypted content.  Implies --verify.
.RE

.RS 4
.TP 4
.BR \-\-exclude=(true|false)

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).

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 message are not returned when
.B --exclude=true.

The default is
.B --exclude=true.

.RE

.RS 4
.TP 4
.B \-\-body=(true|false)

If true (the default)
.B notmuch show
includes the bodies of the messages in the output; if false,
bodies are omitted.
.B --body=false
is only implemented for the json and sexp formats and it is incompatible with
.B --part > 0.

This is useful if the caller only needs the headers as body-less
output is much faster and substantially smaller.
.RE

A common use of
.B notmuch show
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 search
command.

.SH EXIT STATUS

This command supports the following special exit status codes

.TP
.B 20
The requested format version is too old.
.TP
.B 21
The requested format version is too new.

.SH SEE ALSO

\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
\fBnotmuch-tag\fR(1)

debug log:

solving 3f9584b ...
found 3f9584b in https://yhetil.org/notmuch.git/

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).