|
738
|
1 README.listtexts
|
|
|
2
|
|
|
3 List texts in mlmmj
|
|
|
4 ===================
|
|
|
5
|
|
|
6 List texts are stored in listdir/text. They specify the content of various
|
|
|
7 automatic emails that Mlmmj sends. They are provided in a number of different
|
|
|
8 languages. The language to use for a list is chosen when you run the
|
|
|
9 mlmmj-make-ml.sh script and the appropriate files are copied into your
|
|
|
10 listdir/text directory.
|
|
|
11
|
|
|
12 This file documents
|
|
|
13
|
|
|
14 - Supported list texts
|
|
|
15 - List text format
|
|
|
16 - List text substitutions
|
|
|
17
|
|
|
18 Supported list texts
|
|
|
19 --------------------
|
|
|
20
|
|
|
21 The following list texts are supported by mlmmj:
|
|
|
22
|
|
|
23 - access
|
|
|
24 sent to a poster when their post is denied because of an access rule
|
|
|
25
|
|
|
26 - bounce-probe
|
|
|
27 sent to a subscriber after an email to them bounced to inform them of the
|
|
|
28 bounce and probe when the address is no longer bouncing
|
|
|
29
|
|
|
30 - digest
|
|
|
31 sent at the start of a digest
|
|
|
32
|
|
|
33 - listfaq
|
|
|
34 sent in response to an email to listname+faq@domain.tld
|
|
|
35
|
|
|
36 - listhelp
|
|
|
37 sent in response to an email to listname+help@domain.tld
|
|
|
38
|
|
|
39 - listsubs
|
|
|
40 sent in response to an email to listname+list@domain.tld from the list owner
|
|
|
41 (the formatted list of subscribers is automatically appended to the listtext)
|
|
|
42
|
|
|
43 - maxmailsize
|
|
|
44 sent to the poster when a mail exceeds the maximum allowed size
|
|
|
45
|
|
|
46 - moderation
|
|
|
47 - moderation-poster
|
|
|
48 sent when a message is to be moderated (to the appropriate moderators or to
|
|
|
49 the poster)
|
|
|
50
|
|
|
51 - notifysub
|
|
|
52 - notifysub-digest
|
|
|
53 - notifysub-nomail
|
|
|
54 - notifyunsub
|
|
|
55 - notifyunsub-digest
|
|
|
56 - notifyunsub-nomail
|
|
|
57 sent to the list owner when somebody is (un-)subscribed
|
|
|
58
|
|
|
59 - notintocc
|
|
|
60 sent to the poster when the list address is not found in a To: or CC: header
|
|
|
61
|
|
|
62 - sub-confirm
|
|
|
63 - sub-confirm-digest
|
|
|
64 - sub-confirm-nomail
|
|
|
65 sent to a requester to allow them to confirm a subscription request
|
|
|
66
|
|
|
67 - sub-deny-digest
|
|
|
68 - sub-deny-nomail
|
|
|
69 sent when a subscription request is received for the digest or nomail version
|
|
|
70 of a list when that version is disabled
|
|
|
71
|
|
|
72 - sub-ok
|
|
|
73 - sub-ok-digest
|
|
|
74 - sub-ok-nomail
|
|
|
75 sent to the new subscriber when a subscription succeeds
|
|
|
76
|
|
|
77 - sub-subscribed
|
|
|
78 sent to a person sending a subscription request when they are already
|
|
|
79 subscribed to the list
|
|
|
80
|
|
|
81 - submod-moderator
|
|
|
82 - submod-requester
|
|
|
83 sent when a subscription is to be moderated (to the appropriate moderators
|
|
|
84 or to the requester)
|
|
|
85
|
|
|
86 - subonlypost
|
|
|
87 sent to the poster when they attempt to post to a subonlypost list without
|
|
|
88 being subscribed
|
|
|
89
|
|
|
90 - unsub-confirm
|
|
|
91 - unsub-confirm-digest
|
|
|
92 - unsub-confirm-nomail
|
|
|
93 sent to a subscriber to allow them to confirm an unsubscription request
|
|
|
94
|
|
|
95 - unsub-notsubscribed
|
|
|
96 sent to a person sending an unsubscription request when they are not actually
|
|
|
97 subscribed to the list
|
|
|
98
|
|
|
99 - unsub-ok
|
|
|
100 - unsub-ok-digest
|
|
|
101 - unsub-ok-nomail
|
|
|
102 sent to the old subscriber when an unsubscription succeeds
|
|
|
103
|
|
|
104 List text format
|
|
|
105 ----------------
|
|
|
106
|
|
|
107 They have the following format:
|
|
|
108
|
|
|
109 - Subject line
|
|
|
110 - Blank line
|
|
|
111 - Body
|
|
|
112
|
|
|
113 They are expected to be in UTF-8 encoding and have Unix line endings.
|
|
|
114
|
|
|
115 The subject line is the text 'Subject: ' (Mlmmj expects the space, even though
|
|
|
116 this is not ordinarily required in mail messages) followed by the subject line
|
|
|
117 to be used for the mail. The subject line may include UTF-8 characters, which
|
|
|
118 will automatically be escaped using the =?utf-8?q?...?= quoting mechanism.
|
|
|
119
|
|
|
120 List text substitutions
|
|
|
121 -----------------------
|
|
|
122
|
|
|
123 Both subject and body may include the following, which are substituted prior to
|
|
|
124 sending the message:
|
|
|
125
|
|
|
126 - $bouncenumbers$
|
|
|
127 (available only in bounceprobe)
|
|
|
128 the formatted list of indexes of messages which may not have been received as
|
|
|
129 they bounced
|
|
|
130
|
|
|
131 - $confaddr$
|
|
|
132 (available only in [un]sub-confirm[-digest|-nomail])
|
|
|
133 the address to which to send mail to confirm the (un-)subscription in
|
|
|
134 question
|
|
|
135
|
|
|
136 - $digestfirst$
|
|
|
137 (available only in digest)
|
|
|
138 index of the first message included in a digest
|
|
|
139
|
|
|
140 - $digestinterval$
|
|
|
141 (available only in digest)
|
|
|
142 indexes of the first and last messages included in a digest (e.g. 1-5), or
|
|
|
143 just the index if only a single message is included
|
|
|
144
|
|
|
145 - $digestissue$
|
|
|
146 (available only in digest)
|
|
|
147 the issue number of the digest
|
|
|
148
|
|
|
149 - $digestlast$
|
|
|
150 (available only in digest)
|
|
|
151 index of the last message included in a digest
|
|
|
152
|
|
|
153 - $digestsubaddr$
|
|
|
154 listname+subscribe-digest@domain.tld
|
|
|
155
|
|
|
156 - $digestthreads$
|
|
|
157 (available only in digest)
|
|
|
158 the list of threads included in the digest
|
|
|
159
|
|
|
160 - $digestunsubaddr$
|
|
|
161 listname+unsubscribe-digest@domain.tld
|
|
|
162
|
|
|
163 - $faqaddr$
|
|
|
164 listname+faq@domain.tld
|
|
|
165
|
|
|
166 - $helpaddr$
|
|
|
167 listname+help@domain.tld
|
|
|
168
|
|
|
169 - $listaddr$
|
|
|
170 listname@domain.tld
|
|
|
171
|
|
|
172 - $listgetN$
|
|
|
173 listname+get-N@domain.tld
|
|
|
174 (the N here is nothing special, so this won't actually work, but is used to
|
|
|
175 explain to users how to use the +get functionality)
|
|
|
176
|
|
|
177 - $listowner$
|
|
|
178 listname+owner@domain.tld
|
|
|
179
|
|
|
180 - $listsubaddr$
|
|
|
181 listname+subscribe@domain.tld
|
|
|
182
|
|
|
183 - $listunsubaddr$
|
|
|
184 listname+unsubscribe@domain.tld
|
|
|
185
|
|
|
186 - $maxmailsize$
|
|
|
187 (available only in maxmailsize)
|
|
|
188 the maximum size of mail that Mlmmj will accept
|
|
|
189
|
|
|
190 - $moderateaddr$
|
|
|
191 (available only in moderation and submod-moderator)
|
|
|
192 the address to which to send mail to approve the post or subscription in
|
|
|
193 question
|
|
|
194
|
|
|
195 - $moderators$
|
|
|
196 (available only in moderation, moderation-poster and submod)
|
|
|
197 the formatted list of moderators to whom the moderation request has been sent
|
|
|
198
|
|
|
199 - $newsub$
|
|
|
200 (available only in notifysub, notifysub-digest and notifysub-nomail)
|
|
|
201 the address that has been subscribed
|
|
|
202
|
|
|
203 - $nomailsubaddr$
|
|
|
204 listname+subscribe-nomail@domain.tld
|
|
|
205
|
|
|
206 - $nomailunsubaddr$
|
|
|
207 listname+unsubscribe-nomail@domain.tld
|
|
|
208
|
|
|
209 - $oldsub$
|
|
|
210 (available only in notifyunsub, notifyunsub-digest and notifyunsub-nomail)
|
|
|
211 the address that has been unsubscribed
|
|
|
212
|
|
|
213 - $originalmail$
|
|
|
214 the first 100 lines (including headers)
|
|
|
215 of the email message being processed (usually a mail being moderated)
|
|
|
216
|
|
|
217 - $posteraddr$
|
|
|
218 (available only in subonlypost)
|
|
|
219 the from address of the message that was received as determined by Mlmmj
|
|
|
220
|
|
|
221 - $subaddr$
|
|
|
222 (available only in submod-moderator and [un]sub-confirm[-digest|-nomail])
|
|
|
223 the address requested to be (un-)subscribed
|
|
|
224
|
|
|
225
|
|
|
226
|
