bump version to 0.13~rc1
[notmuch] / man / man1 / notmuch-reply.1
1 .TH NOTMUCH-REPLY 1 2012-05-08 "Notmuch 0.13~rc1"
2 .SH NAME
3 notmuch-reply \- Constructs a reply template for a set of messages.
4
5 .SH SYNOPSIS
6
7 .B notmuch reply
8 .RI "[" options "...] <" search-term ">..."
9
10 .SH DESCRIPTION
11
12 Constructs a reply template for a set of messages.
13
14 To make replying to email easier,
15 .B notmuch reply
16 takes an existing set of messages and constructs a suitable mail
17 template. The Reply-to: header (if any, otherwise From:) is used for
18 the To: address. Unless
19 .BR \-\-reply-to=sender
20 is specified, values from the To: and Cc: headers are copied, but not
21 including any of the current user's email addresses (as configured in
22 primary_mail or other_email in the .notmuch\-config file) in the
23 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 '> ' and included in the body.
32
33 The resulting message template is output to stdout.
34
35 Supported options for
36 .B reply
37 include
38 .RS
39 .TP 4
40 .BR \-\-format= ( default | json | headers\-only )
41 .RS
42 .TP 4
43 .BR default
44 Includes subject and quoted message body.
45 .TP
46 .BR json
47 Produces JSON output containing headers for a reply message and the
48 contents of the original message. This output can be used by a client
49 to create a reply message intelligently.
50 .TP
51 .BR headers\-only
52 Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
53 .RE
54 .RE
55 .RS
56 .TP 4
57 .BR \-\-reply\-to= ( all | sender )
58 .RS
59 .TP 4
60 .BR all " (default)"
61 Replies to all addresses.
62 .TP 4
63 .BR sender
64 Replies only to the sender. If replying to user's own message
65 (Reply-to: or From: header is one of the user's configured email
66 addresses), try To:, Cc:, and Bcc: headers in this order, and copy
67 values from the first that contains something other than only the
68 user's addresses.
69 .RE
70 .RE
71 .RS
72 .TP 4
73 .B \-\-decrypt
74
75 Decrypt any MIME encrypted parts found in the selected content
76 (ie. "multipart/encrypted" parts). Status of the decryption will be
77 reported (currently only supported with --format=json) and the
78 multipart/encrypted part will be replaced by the decrypted
79 content.
80 .RE
81
82 See \fBnotmuch-search-terms\fR(7)
83 for details of the supported syntax for <search-terms>.
84
85 Note: It is most common to use
86 .B "notmuch reply"
87 with a search string matching a single message, (such as
88 id:<message-id>), but it can be useful to reply to several messages at
89 once. For example, when a series of patches are sent in a single
90 thread, replying to the entire thread allows for the reply to comment
91 on issues found in multiple patches. The default format supports
92 replying to multiple messages at once, but the JSON format does not.
93 .RE
94 .RE
95
96 .SH SEE ALSO
97
98 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
99 \fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
100 \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
101 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
102 \fBnotmuch-tag\fR(1)