Mercurial > hg > mlmmj

comparison README.listtexts @ 741:b72bcb7e08a2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Arbitrary headers in listtexts, fix default Content-Transfer-Encoding: header, and document \uNNNN substitution Also, the interface to prepstdreply() has changed; there is no longer a customheaders argument, which was never used anyway, and is now essentially redundant due to this patch.
author Ben Schmidt
date Mon, 20 Sep 2010 01:44:58 +1000
parents c910b56dc039
children b00eb39643c1
comparison
equal deleted inserted replaced
740:5db75af2d0db 741:b72bcb7e08a2
104 List text format 104 List text format
105 ---------------- 105 ----------------
106 106
107 They have the following format: 107 They have the following format:
108 108
109 - Subject line 109 - Headers
110 - Blank line 110 - Blank line
111 - Body 111 - Body
112 112
113 They are expected to be in UTF-8 encoding and have Unix line endings. 113 They are expected to be in UTF-8 encoding and have Unix line endings.
114 114
115 The subject line is the text 'Subject: ' (Mlmmj expects the space, even though 115 The headers should be formatted as they should appear in the mail message. They
116 this is not ordinarily required in mail messages) followed by the subject line 116 will begin the mail message. Header continuation via lines beginning with
117 to be used for the mail. The subject line may include UTF-8 characters, which 117 linear whitespace is supported.
118 will automatically be escaped using the =?utf-8?q?...?= quoting mechanism. 118
119 Following the headers found in the list text, Mlmmj will output the following
120 default headers, unless the same header is already provided in the list text.
121
122 - From:
123 - To:
124 - Message-ID:
125 - Date:
126 - Subject: mlmmj administrivia
127 - MIME-Version: 1.0
128 - Content-Type: text/plain; charset=utf-8
129 - Content-Transfer-Encoding: 8bit
130
131 The Subject: header is treated specially: it may include UTF-8 characters,
132 which will automatically be escaped using the =?utf-8?q?...?= quoting
133 mechanism.
119 134
120 List text substitutions 135 List text substitutions
121 ----------------------- 136 -----------------------
122 137
123 Both subject and body may include the following, which are substituted prior to 138 Both headers and body may include the following, which are substituted prior to
124 sending the message: 139 sending the message (though note that some of these substitutions are
140 multi-line substitutions and would not work in a header):
125 141
126 - $bouncenumbers$ 142 - $bouncenumbers$
127 (available only in bounceprobe) 143 (available only in bounceprobe)
128 the formatted list of indexes of messages which may not have been received as 144 the formatted list of indexes of messages which may not have been received as
129 they bounced 145 they bounced
220 236
221 - $subaddr$ 237 - $subaddr$
222 (available only in submod-moderator and [un]sub-confirm[-digest|-nomail]) 238 (available only in submod-moderator and [un]sub-confirm[-digest|-nomail])
223 the address requested to be (un-)subscribed 239 the address requested to be (un-)subscribed
224 240
225 241 - \uNNNN
226 242 (NNNN are hex digits)
243 a Unicode character
244 (this is not really appropriate for use in a header, except perhaps the
245 Subject: header as Mlmmj does automatic quoting for that header as described
246 above)
247
248
249