2751e96be5871f8a57596a7448951a8e6740bd7a
[notmuch] / man / man1 / notmuch-reply.1
1 .TH NOTMUCH-REPLY 1 2013-01-24 "Notmuch 0.15.1"
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 | sexp | 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 sexp
52 Produces S-Expression output containing headers for a reply message and
53 the contents of the original message. This output can be used by a client
54 to create a reply message intelligently.
55 .TP
56 .BR headers\-only
57 Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
58 .RE
59 .RE
60
61 .RS
62 .TP 4
63 .BR \-\-format-version=N
64
65 Use the specified structured output format version.  This is intended
66 for programs that invoke \fBnotmuch\fR(1) internally.  If omitted, the
67 latest supported version will be used.
68 .RE
69
70 .RS
71 .TP 4
72 .BR \-\-reply\-to= ( all | sender )
73 .RS
74 .TP 4
75 .BR all " (default)"
76 Replies to all addresses.
77 .TP 4
78 .BR sender
79 Replies only to the sender. If replying to user's own message
80 (Reply-to: or From: header is one of the user's configured email
81 addresses), try To:, Cc:, and Bcc: headers in this order, and copy
82 values from the first that contains something other than only the
83 user's addresses.
84 .RE
85 .RE
86 .RS
87 .TP 4
88 .B \-\-decrypt
89
90 Decrypt any MIME encrypted parts found in the selected content
91 (ie. "multipart/encrypted" parts). Status of the decryption will be
92 reported (currently only supported with --format=json and --format=sexp)
93 and the multipart/encrypted part will be replaced by the decrypted
94 content.
95 .RE
96
97 See \fBnotmuch-search-terms\fR(7)
98 for details of the supported syntax for <search-terms>.
99
100 Note: It is most common to use
101 .B "notmuch reply"
102 with a search string matching a single message, (such as
103 id:<message-id>), but it can be useful to reply to several messages at
104 once. For example, when a series of patches are sent in a single
105 thread, replying to the entire thread allows for the reply to comment
106 on issues found in multiple patches. The default format supports
107 replying to multiple messages at once, but the JSON and S-Expression
108 formats do not.
109 .RE
110 .RE
111
112 .SH EXIT STATUS
113
114 This command supports the following special exit status codes
115
116 .TP
117 .B 20
118 The requested format version is too old.
119 .TP
120 .B 21
121 The requested format version is too new.
122
123 .SH SEE ALSO
124
125 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
126 \fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1),
127 \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
128 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
129 \fBnotmuch-tag\fR(1)