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> [<u>options</u>...] &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.  The  Reply-to:
  19        header  (if  any,  otherwise From:) is used for the To: address. Unless
  20        <b>--reply-to=sender</b> is specified, values from the To: and Cc: headers are
  21        copied, but not including any of the current user&apos;s email addresses (as
  22        configured in primary_mail or other_email in the .notmuch-config  file)
  23        in the recipient list.
  24
  25        It  also  builds a suitable new subject, including Re: at the front (if
  26        not already present), and adding the message IDs of the messages  being
  27        replied  to  to  the References list and setting the In-Reply-To: field
  28        correctly.
  29
  30        Finally, the original contents of the emails are  quoted  by  prefixing
  31        each line with &apos;&gt; &apos; and included in the body.
  32
  33        The resulting message template is output to stdout.
  34
  35        Supported options for <b>reply</b> include
  36
  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>
  44                       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
  47                       intelligently.
  48
  49                   <b>sexp</b>
  50                       Produces  S-Expression  output  containing headers for a
  51                       reply message and the contents of the original  message.
  52                       This  output  can  be used by a client to create a reply
  53                       message intelligently.
  54
  55                   <b>headers-only</b>
  56                       Only produces In-Reply-To, References, To, Cc,  and  Bcc
  57                       headers.
  58
  59               <b>--format-version=N</b>
  60
  61                   Use the specified structured output format version.  This is
  62                   intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally.  If
  63                   omitted, the latest supported version will be used.
  64
  65               <b>--reply-to=</b>(<b>all</b>|<b>sender</b>)
  66
  67                   <b>all</b> (default)
  68                       Replies to all addresses.
  69
  70                   <b>sender</b>
  71                       Replies  only  to  the sender. If replying to user&apos;s own
  72                       message (Reply-to: or From: header is one of the  user&apos;s
  73                       configured  email  addresses),  try  To:,  Cc:, and Bcc:
  74                       headers in this order, and copy values  from  the  first
  75                       that  contains  something  other  than  only  the user&apos;s
  76                       addresses.
  77
  78               <b>--decrypt</b>
  79
  80                   Decrypt any MIME encrypted parts found in the selected  con-
  81                   tent   (ie.  &quot;multipart/encrypted&quot;  parts).  Status  of  the
  82                   decryption will be reported (currently only  supported  with
  83                   --format=json  and  --format=sexp) and on successful decryp-
  84                   tion the multipart/encrypted part will be  replaced  by  the
  85                   decrypted content.
  86
  87                   Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
  88                   needed credentials. Without one, the decryption will fail.
  89
  90        See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of  the  supported  syntax  for
  91        &lt;search-terms&gt;.
  92
  93        Note:  It  is  most  common  to  use <b>notmuch</b> <b>reply</b> with a search string
  94        matching a single message, (such as id:&lt;message-id&gt;),  but  it  can  be
  95        useful to reply to several messages at once. For example, when a series
  96        of patches are sent in a single thread, replying to the  entire  thread
  97        allows  for  the  reply to comment on issues found in multiple patches.
  98        The default format supports replying to multiple messages at once,  but
  99        the JSON and S-Expression formats do not.
 100 </pre>
 101
 102 <h2>EXIT STATUS</h2>
 103 <pre>
 104        This command supports the following special exit status codes
 105
 106        <b>20</b>     The requested format version is too old.
 107
 108        <b>21</b>     The requested format version is too new.
 109 </pre>
 110
 111 <h2>SEE ALSO</h2>
 112 <pre>
 113        <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>
 114        <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),
 115        <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/'>notmuch-</a>
 116        <a href='../notmuch-tag-1/'>tag</a>(1)
 117 </pre>
 118
 119 <h2>Notmuch 0.17</h2>