]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-reply.rst
doc/{reply, show}: match indentation
[notmuch] / doc / man1 / notmuch-reply.rst
index cfbd4ea8dd190cc3d72370b7b01f151bd56a3ca9..c893ba048b9c2b7abc48d926b506cce4d6b7ad60 100644 (file)
@@ -13,8 +13,10 @@ DESCRIPTION
 Constructs a reply template for a set of messages.
 
 To make replying to email easier, **notmuch reply** takes an existing
-set of messages and constructs a suitable mail template. The Reply-to:
-header (if any, otherwise From:) is used for the To: address. Unless
+set of messages and constructs a suitable mail template. Its To:
+address is set according to the original email in this way: if the
+Reply-to: header is present and different from any To:/Cc: address it
+is used, otherwise From: header is used. Unless
 ``--reply-to=sender`` is specified, values from the To: and Cc: headers
 are copied, but not including any of the current user's email addresses
 (as configured in primary\_mail or other\_email in the .notmuch-config
@@ -32,54 +34,62 @@ The resulting message template is output to stdout.
 
 Supported options for **reply** include
 
-    ``--format=``\ (**default**\ \|\ **json**\ \|\ **sexp**\ \|\ **headers-only**)
+``--format=``\ (**default**\ \|\ **json**\ \|\ **sexp**\ \|\ **headers-only**)
+    **default**
+        Includes subject and quoted message body as an RFC 2822
+        message.
 
-        **default**
-            Includes subject and quoted message body as an RFC 2822
-            message.
+    **json**
+        Produces JSON output containing headers for a reply message
+        and the contents of the original message. This output can be
+        used by a client to create a reply message intelligently.
 
-        **json**
-            Produces JSON output containing headers for a reply message
-            and the contents of the original message. This output can be
-            used by a client to create a reply message intelligently.
+    **sexp**
+        Produces S-Expression output containing headers for a reply
+        message and the contents of the original message. This output
+        can be used by a client to create a reply message
+        intelligently.
 
-        **sexp**
-            Produces S-Expression output containing headers for a reply
-            message and the contents of the original message. This
-            output can be used by a client to create a reply message
-            intelligently.
+    **headers-only**
+        Only produces In-Reply-To, References, To, Cc, and Bcc
+        headers.
 
-        **headers-only**
-            Only produces In-Reply-To, References, To, Cc, and Bcc
-            headers.
+``--format-version=N``
+    Use the specified structured output format version. This is
+    intended for programs that invoke **notmuch(1)** internally. If
+    omitted, the latest supported version will be used.
 
-    ``--format-version=N``
-        Use the specified structured output format version. This is
-        intended for programs that invoke **notmuch(1)** internally. If
-        omitted, the latest supported version will be used.
+``--reply-to=``\ (**all**\ \|\ **sender**)
+    **all** (default)
+        Replies to all addresses.
 
-    ``--reply-to=``\ (**all**\ \|\ **sender**)
+    **sender**
+        Replies only to the sender. If replying to user's own message
+        (Reply-to: or From: header is one of the user's configured
+        email addresses), try To:, Cc:, and Bcc: headers in this
+        order, and copy values from the first that contains something
+        other than only the user's addresses.
 
-        **all** (default)
-            Replies to all addresses.
+``--decrypt=(false|auto|true)``
 
-        **sender**
-            Replies only to the sender. If replying to user's own
-            message (Reply-to: or From: header is one of the user's
-            configured email addresses), try To:, Cc:, and Bcc: headers
-            in this order, and copy values from the first that contains
-            something other than only the user's addresses.
+    If ``true``, decrypt any MIME encrypted parts found in the
+    selected content (i.e., "multipart/encrypted" parts). Status
+    of the decryption will be reported (currently only supported
+    with --format=json and --format=sexp), and on successful
+    decryption the multipart/encrypted part will be replaced by
+    the decrypted content.
 
-    ``--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 on successful decryption the
-        multipart/encrypted part will be replaced by the decrypted
-        content.
+    If ``auto``, and a session key is already known for the
+    message, then it will be decrypted, but notmuch will not try
+    to access the user's secret keys.
 
-        Decryption expects a functioning **gpg-agent(1)** to provide any
-        needed credentials. Without one, the decryption will fail.
+    Use ``false`` to avoid even automatic decryption.
+
+    Non-automatic decryption expects a functioning
+    **gpg-agent(1)** to provide any needed credentials. Without
+    one, the decryption will likely fail.
+
+    Default: ``auto``
 
 See **notmuch-search-terms(7)** for details of the supported syntax for
 <search-terms>.
@@ -106,7 +116,15 @@ This command supports the following special exit status codes
 SEE ALSO
 ========
 
-**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
-**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
-**notmuch-new(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
-**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**
+**notmuch(1)**,
+**notmuch-config(1)**,
+**notmuch-count(1)**,
+**notmuch-dump(1)**,
+**notmuch-hooks(5)**,
+**notmuch-insert(1)**,
+**notmuch-new(1)**,
+**notmuch-restore(1)**,
+**notmuch-search(1)**,
+**notmuch-search-terms(7)**,
+**notmuch-show(1)**,
+**notmuch-tag(1)**