X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-reply.rst;h=5c64c4a63b106ca5ec60c099de5ca013c0be22fd;hp=cfbd4ea8dd190cc3d72370b7b01f151bd56a3ca9;hb=HEAD;hpb=d736260385a689b5c77d8121f48e29440e3adfa4 diff --git a/doc/man1/notmuch-reply.rst b/doc/man1/notmuch-reply.rst index cfbd4ea8..4f39a959 100644 --- a/doc/man1/notmuch-reply.rst +++ b/doc/man1/notmuch-reply.rst @@ -1,3 +1,5 @@ +.. _notmuch-reply(1): + ============= notmuch-reply ============= @@ -13,8 +15,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,56 +36,75 @@ The resulting message template is output to stdout. Supported options for **reply** include - ``--format=``\ (**default**\ \|\ **json**\ \|\ **sexp**\ \|\ **headers-only**) +.. program:: reply + +.. option:: --duplicate=N + + Reply to duplicate number N. The numbering starts from 1, and + matches the order used by :option:`show --duplicate` and + :option:`search --output=files `. + +.. option:: --format=(default|json|sexp|headers-only) + + 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. + + 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. + +.. option:: --format-version=N - **default** - Includes subject and quoted message body as an RFC 2822 - message. + Use the specified structured output format version. This is + intended for programs that invoke :any:`notmuch(1)` internally. If + omitted, the latest supported version will be used. - **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. +.. option:: --reply-to=(all|sender) - **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. + all (default) + Replies to all addresses. - **headers-only** - Only produces In-Reply-To, References, To, Cc, and Bcc - headers. + 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. - ``--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. +.. option:: --decrypt=(false|auto|true) - ``--reply-to=``\ (**all**\ \|\ **sender**) + 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. - **all** (default) - Replies to all addresses. + 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. - **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. + Use ``false`` to avoid even automatic decryption. - ``--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. + Non-automatic decryption expects a functioning + :manpage:`gpg-agent(1)` to provide any needed credentials. Without + one, the decryption will likely fail. - Decryption expects a functioning **gpg-agent(1)** to provide any - needed credentials. Without one, the decryption will fail. + Default: ``auto`` -See **notmuch-search-terms(7)** for details of the supported syntax for +See :any:`notmuch-search-terms(7)` for details of the supported syntax for . Note: It is most common to use **notmuch reply** with a search string @@ -106,7 +129,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)** +:any:`notmuch(1)`, +:any:`notmuch-config(1)`, +:any:`notmuch-count(1)`, +:any:`notmuch-dump(1)`, +:any:`notmuch-hooks(5)`, +:any:`notmuch-insert(1)`, +:any:`notmuch-new(1)`, +:any:`notmuch-restore(1)`, +:any:`notmuch-search(1)`, +:any:`notmuch-search-terms(7)`, +:any:`notmuch-show(1)`, +:any:`notmuch-tag(1)`