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

   1 <h1>NOTMUCH-REPLY(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-reply - constructs a reply template for a set of messages
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> <b>reply</b> [option ...] &lt;<u>search-term</u>&gt; ...
  11 </pre>
  12
  13 <h2>DESCRIPTION</h2>
  14 <pre>
  15        Constructs a reply template for a set of messages.
  16
  17        To  make  replying to email easier, <b>notmuch</b> <b>reply</b> takes an existing set
  18        of messages and constructs a suitable mail template. Its To: address is
  19        set  according  to  the  original  email  in this way: if the Reply-to:
  20        header is present and different from any To:/Cc: address  it  is  used,
  21        otherwise  From: header is used. Unless <b>--reply-to=sender</b> is specified,
  22        values from the To: and Cc: headers are copied, but not  including  any
  23        of the current user&apos;s email addresses (as configured in primary_mail or
  24        other_email in the .notmuch-config file) in the recipient list.
  25
  26        It also builds a suitable new subject, including Re: at the  front  (if
  27        not  already present), and adding the message IDs of the messages being
  28        replied to to the References list and setting  the  In-Reply-To:  field
  29        correctly.
  30
  31        Finally,  the  original  contents of the emails are quoted by prefixing
  32        each line with &apos;&gt; &apos; and included in the body.
  33
  34        The resulting message template is output to stdout.
  35
  36        Supported options for <b>reply</b> include
  37
  38        <b>--format=(default|json|sexp|headers-only)</b>
  39
  40               <b>default</b>
  41                      Includes subject and quoted message body as an  RFC  2822
  42                      message.
  43
  44               <b>json</b>   Produces  JSON output containing headers for a reply mes‐
  45                      sage and the contents of the original message. This  out‐
  46                      put can be used by a client to create a reply message in‐
  47                      telligently.
  48
  49               <b>sexp</b>   Produces S-Expression output containing headers for a re‐
  50                      ply  message  and  the  contents of the original message.
  51                      This output can be used by a client  to  create  a  reply
  52                      message intelligently.
  53
  54               <b>headers-only</b>
  55                      Only  produces  In-Reply-To,  References, To, Cc, and Bcc
  56                      headers.
  57
  58        <b>--format-version=N</b>
  59               Use the specified structured output format version. This is  in‐
  60               tended  for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If omit‐
  61               ted, the latest supported version will be used.
  62
  63        <b>--reply-to=(all|sender)</b>
  64
  65               <b>all</b> <b>(default)</b>
  66                      Replies to all addresses.
  67
  68               <b>sender</b> Replies only to the sender. If  replying  to  user&apos;s  own
  69                      message  (Reply-to:  or From: header is one of the user&apos;s
  70                      configured email addresses), try To:, Cc:, and Bcc: head‐
  71                      ers  in  this  order, and copy values from the first that
  72                      contains something other than only the user&apos;s addresses.
  73
  74        <b>--decrypt=(false|auto|true)</b>
  75               If <b>true</b>, decrypt any MIME encrypted parts found in the  selected
  76               content  (i.e.,  &quot;multipart/encrypted&quot; parts). Status of the de‐
  77               cryption will be reported (currently only supported with  <b>--for-</b>
  78               <b>mat=json</b>  and  <b>--format=sexp</b>),  and on successful decryption the
  79               multipart/encrypted part will be replaced by the decrypted  con‐
  80               tent.
  81
  82               If  <b>auto</b>,  and  a  session key is already known for the message,
  83               then it will be decrypted, but notmuch will not  try  to  access
  84               the user&apos;s secret keys.
  85
  86               Use <b>false</b> to avoid even automatic decryption.
  87
  88               Non-automatic  decryption  expects a functioning <b>gpg-agent</b>(1) to
  89               provide any needed credentials. Without one, the decryption will
  90               likely fail.
  91
  92               Default: <b>auto</b>
  93
  94        See  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7)  for  details  of the supported syntax for
  95        &lt;search-terms&gt;.
  96
  97        Note: It is most common to use  <b>notmuch</b>  <b>reply</b>  with  a  search  string
  98        matching  a  single  message,  (such as id:&lt;message-id&gt;), but it can be
  99        useful to reply to several messages at once. For example, when a series
 100        of  patches  are sent in a single thread, replying to the entire thread
 101        allows for the reply to comment on issues found  in  multiple  patches.
 102        The  default format supports replying to multiple messages at once, but
 103        the JSON and S-Expression formats do not.
 104 </pre>
 105
 106 <h2>EXIT STATUS</h2>
 107 <pre>
 108        This command supports the following special exit status codes
 109
 110        <b>20</b>     The requested format version is too old.
 111
 112        <b>21</b>     The requested format version is too new.
 113 </pre>
 114
 115 <h2>SEE ALSO</h2>
 116 <pre>
 117        <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>
 118        <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-restore-1/'>notmuch-restore</a>(1),
 119        <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not‐</a>
 120        <a href='../notmuch-tag-1/'>much-tag</a>(1)
 121 </pre>
 122
 123 <h2>AUTHOR</h2>
 124 <pre>
 125        Carl Worth and many others
 126 </pre>
 127
 128 <h2>COPYRIGHT</h2>
 129 <pre>
 130        2009-2022, Carl Worth and many others
 131 </pre>
 132
 133 <h2>0.35</h2>