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           <b>--format=</b>(<b>default</b>|<b>json</b>|<b>sexp</b>|<b>headers-only</b>)
  38
  39               <b>default</b>
  40                      Includes  subject  and quoted message body as an RFC 2822
  41                      message.
  42
  43               <b>json</b>   Produces JSON output containing headers for a reply  mes‐
  44                      sage  and the contents of the original message. This out‐
  45                      put can be used by a client to  create  a  reply  message
  46                      intelligently.
  47
  48               <b>sexp</b>   Produces  S-Expression  output  containing  headers for a
  49                      reply message and the contents of the  original  message.
  50                      This  output  can  be  used by a client to create a reply
  51                      message intelligently.
  52
  53               <b>headers-only</b>
  54                      Only produces In-Reply-To, References, To,  Cc,  and  Bcc
  55                      headers.
  56
  57           <b>--format-version=N</b>
  58                  Use  the  specified structured output format version. This is
  59                  intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1)  internally.  If
  60                  omitted, the latest supported version will be used.
  61
  62           <b>--reply-to=</b>(<b>all</b>|<b>sender</b>)
  63
  64               <b>all</b> <b>(default)</b>
  65                      Replies to all addresses.
  66
  67               <b>sender</b> Replies  only  to  the  sender. If replying to user&apos;s own
  68                      message (Reply-to: or From: header is one of  the  user&apos;s
  69                      configured email addresses), try To:, Cc:, and Bcc: head‐
  70                      ers in this order, and copy values from  the  first  that
  71                      contains something other than only the user&apos;s addresses.
  72
  73           <b>--decrypt</b>
  74                  Decrypt  any  MIME encrypted parts found in the selected con‐
  75                  tent (ie. &quot;multipart/encrypted&quot; parts). Status of the decryp‐
  76                  tion  will  be reported (currently only supported with --for‐
  77                  mat=json and --format=sexp) and on successful decryption  the
  78                  multipart/encrypted  part  will  be replaced by the decrypted
  79                  content.
  80
  81                  Decryption expects a functioning <b>gpg-agent</b>(1) to provide  any
  82                  needed credentials. Without one, the decryption will fail.
  83
  84        See  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7)  for  details  of the supported syntax for
  85        &lt;search-terms&gt;.
  86
  87        Note: It is most common to use  <b>notmuch</b>  <b>reply</b>  with  a  search  string
  88        matching  a  single  message,  (such as id:&lt;message-id&gt;), but it can be
  89        useful to reply to several messages at once. For example, when a series
  90        of  patches  are sent in a single thread, replying to the entire thread
  91        allows for the reply to comment on issues found  in  multiple  patches.
  92        The  default format supports replying to multiple messages at once, but
  93        the JSON and S-Expression formats do not.
  94 </pre>
  95
  96 <h2>EXIT STATUS</h2>
  97 <pre>
  98        This command supports the following special exit status codes
  99
 100        <b>20</b>     The requested format version is too old.
 101
 102        <b>21</b>     The requested format version is too new.
 103 </pre>
 104
 105 <h2>SEE ALSO</h2>
 106 <pre>
 107        <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>
 108        <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),
 109        <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>
 110        <a href='../notmuch-tag-1/'>much-tag</a>(1)
 111 </pre>
 112
 113 <h2>AUTHOR</h2>
 114 <pre>
 115        Carl Worth and many others
 116 </pre>
 117
 118 <h2>COPYRIGHT</h2>
 119 <pre>
 120        2009-2016, Carl Worth and many others
 121 </pre>
 122
 123 <h2>0.22</h2>