git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-show-1.mdwn

   1 <h1>NOTMUCH-SHOW(1)</h1>
   2
   3 <h2>NAME</h2>
   4
   5 <pre>
   6        notmuch-show - Show messages matching the given search terms.
   7 </pre>
   8
   9 <h2>SYNOPSIS</h2>
  10
  11 <pre>
  12        <b>notmuch</b> <b>show</b> [<u>options</u>...] <<u>search-term</u>>...
  13 </pre>
  14
  15 <h2>DESCRIPTION</h2>
  16
  17 <pre>
  18        Shows all messages matching the search terms.
  19 </pre>
  20
  21 <pre>
  22        See  <b>notmuch-search-terms</b>(7)  for  details  of the supported syntax for
  23        <search-terms>.
  24 </pre>
  25
  26 <pre>
  27        The messages will be grouped and sorted based  on  the  threading  (all
  28        replies to a particular message will appear immediately after that mes-
  29        sage in date order). The output is not indented by default,  but  depth
  30        tags are printed so that proper indentation can be performed by a post-
  31        processor (such as the emacs interface to notmuch).
  32 </pre>
  33
  34 <pre>
  35        Supported options for <b>show</b> include
  36 </pre>
  37
  38 <pre>
  39            <b>--entire-thread</b>
  40 </pre>
  41
  42 <pre>
  43                By default only those messages that match the search terms will
  44                be displayed. With this option, all messages in the same thread
  45                as any matched message will be displayed.
  46 </pre>
  47
  48 <pre>
  49            <b>--format=(text|json|mbox|raw)</b>
  50 </pre>
  51
  52 <pre>
  53                <b>text</b> (default for messages)
  54 </pre>
  55
  56 <pre>
  57                    The default plain-text format  has  all  text-content  MIME
  58                    parts  decoded. Various components in the output, (<b>message</b>,
  59                    <b>header</b>, <b>body</b>, <b>attachment</b>, and MIME <b>part</b>), will be delimited
  60                    by  easily-parsed  markers.  Each marker consists of a Con-
  61                    trol-L character  (ASCII  decimal  12),  the  name  of  the
  62                    marker,  and  then either an opening or closing brace, ('{'
  63                    or '}'), to either open or close the component. For a  mul-
  64                    tipart MIME message, these parts will be nested.
  65 </pre>
  66
  67 <pre>
  68                <b>json</b>
  69 </pre>
  70
  71 <pre>
  72                    The  output  is  formatted  with Javascript Object Notation
  73                    (JSON). This format is more robust than the text format for
  74                    automated  processing.  The  nested  structure of multipart
  75                    MIME messages is reflected in nested JSON output. JSON out-
  76                    put  always  includes all messages in a matching thread; in
  77                    effect <b>--format=json</b> implies <b>--entire-thread</b>
  78 </pre>
  79
  80 <pre>
  81                <b>mbox</b>
  82 </pre>
  83
  84 <pre>
  85                    All matching messages are output in the  traditional,  Unix
  86                    mbox  format  with  each  message  being prefixed by a line
  87                    beginning with "From " and a  blank  line  separating  each
  88                    message.  Lines in the message content beginning with "From
  89                    " (preceded by zero or more '>' characters) have  an  addi-
  90                    tional  '>'  character  added.  This reversible escaping is
  91                    termed "mboxrd" format and described in detail here:
  92 </pre>
  93
  94 <pre>
  95                    http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
  96 </pre>
  97
  98 <pre>
  99                <b>raw</b> (default for a single part, see --part)
 100 </pre>
 101
 102 <pre>
 103                    For a message or an attached message  part,  the  original,
 104                    raw  content  of  the email message is output. Consumers of
 105                    this format should expect to implement  MIME  decoding  and
 106                    similar functions.
 107 </pre>
 108
 109 <pre>
 110                    For  a  single part (--part) the raw part content is output
 111                    after performing any necessary MIME  decoding.   Note  that
 112                    messages with a simple body still have two parts: part 0 is
 113                    the whole message and part 1 is the body.
 114 </pre>
 115
 116 <pre>
 117                    For a multipart part, the part headers and body  (including
 118                    all child parts) is output.
 119 </pre>
 120
 121 <pre>
 122                    The raw format must only be used with search terms matching
 123                    single message.
 124 </pre>
 125
 126 <pre>
 127            <b>--part=N</b>
 128 </pre>
 129
 130 <pre>
 131                Output the single decoded MIME part N of a single message.  The
 132                search  terms  must match only a single message.  Message parts
 133                are numbered in a depth-first walk of the message  MIME  struc-
 134                ture,  and  are  identified in the 'json' or 'text' output for-
 135                mats.
 136 </pre>
 137
 138 <pre>
 139            <b>--verify</b>
 140 </pre>
 141
 142 <pre>
 143                Compute and report the validity of any MIME cryptographic  sig-
 144                natures  found  in the selected content (ie. "multipart/signed"
 145                parts). Status of the signature will be reported (currently on-
 146                ly supported with --format=json), and the multipart/signed part
 147                will be replaced by the signed data.
 148 </pre>
 149
 150 <pre>
 151            <b>--decrypt</b>
 152 </pre>
 153
 154 <pre>
 155                Decrypt any MIME encrypted parts found in the selected  content
 156                (ie.  "multipart/encrypted"  parts).  Status  of the decryption
 157                will be reported (currently only supported with  --format=json)
 158                and  the  multipart/encrypted  part will be replaced by the de-
 159                crypted content.  Implies --verify.
 160 </pre>
 161
 162 <pre>
 163            <b>--exclude=(true|false)</b>
 164 </pre>
 165
 166 <pre>
 167                Specify whether to omit threads  only  matching  search.tag_ex-
 168                clude  from  the search results (the default) or not. In either
 169                case the excluded message will be marked with the exclude  flag
 170                (except  when  output=mbox  when  there  is  nowhere to put the
 171                flag).
 172 </pre>
 173
 174 <pre>
 175                If --entire-thread is specified then complete threads  are  re-
 176                turned regardless (with the excluded flag being set when appro-
 177                priate) but threads that only match in an excluded message  are
 178                not returned when <b>--exclude=true.</b>
 179 </pre>
 180
 181 <pre>
 182                The default is <b>--exclude=true.</b>
 183 </pre>
 184
 185 <pre>
 186        A  common  use  of  <b>notmuch</b> <b>show</b> is to display a single thread of email
 187        messages. For this, use a search term of "thread:<thread-id>" as can be
 188        seen in the first column of output from the <b>notmuch</b> <b>search</b> command.
 189 </pre>
 190
 191 <h2>SEE ALSO</h2>
 192
 193 <pre>
 194        <b>notmuch</b>(1),  <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>not-</b>
 195        <b>much-hooks</b>(5),  <b>notmuch-new</b>(1),  <b>notmuch-reply</b>(1),  <b>notmuch-restore</b>(1),
 196        <b>notmuch-search</b>(1), <b>notmuch-search-terms</b>(7), <b>notmuch-tag</b>(1)
 197 </pre>
 198
 199 <h2>Notmuch 0.13.2</h2>