mlmmj

changeset c910b56dc039

Documented listtexts
author Ben Schmidt
date Mon, 20 Sep 2010 01:18:30 +1000
parents f317a8fe2ba7
children ada79809aac0
files ChangeLog README.listtexts
diffstat 2 files changed, 227 insertions(+), 0 deletions(-) [+]
line diff
     1.1 --- a/ChangeLog	Tue Aug 24 21:58:59 2010 +1000
     1.2 +++ b/ChangeLog	Mon Sep 20 01:18:30 2010 +1000
     1.3 @@ -1,3 +1,4 @@
     1.4 + o Documented listtexts
     1.5   o Makes the random strings produced always the same length rather the
     1.6     smaller random numbers producing shorter strings which could be
     1.7     problematic
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/README.listtexts	Mon Sep 20 01:18:30 2010 +1000
     2.3 @@ -0,0 +1,226 @@
     2.4 +README.listtexts
     2.5 +
     2.6 +List texts in mlmmj
     2.7 +===================
     2.8 +
     2.9 +List texts are stored in listdir/text. They specify the content of various
    2.10 +automatic emails that Mlmmj sends. They are provided in a number of different
    2.11 +languages. The language to use for a list is chosen when you run the
    2.12 +mlmmj-make-ml.sh script and the appropriate files are copied into your
    2.13 +listdir/text directory.
    2.14 +
    2.15 +This file documents
    2.16 +
    2.17 +- Supported list texts
    2.18 +- List text format
    2.19 +- List text substitutions
    2.20 +
    2.21 +Supported list texts
    2.22 +--------------------
    2.23 +
    2.24 +The following list texts are supported by mlmmj:
    2.25 +
    2.26 +- access
    2.27 +  sent to a poster when their post is denied because of an access rule
    2.28 +
    2.29 +- bounce-probe
    2.30 +  sent to a subscriber after an email to them bounced to inform them of the
    2.31 +  bounce and probe when the address is no longer bouncing
    2.32 +
    2.33 +- digest
    2.34 +  sent at the start of a digest
    2.35 +
    2.36 +- listfaq
    2.37 +  sent in response to an email to listname+faq@domain.tld
    2.38 +
    2.39 +- listhelp
    2.40 +  sent in response to an email to listname+help@domain.tld
    2.41 +
    2.42 +- listsubs
    2.43 +  sent in response to an email to listname+list@domain.tld from the list owner
    2.44 +  (the formatted list of subscribers is automatically appended to the listtext)
    2.45 +
    2.46 +- maxmailsize
    2.47 +  sent to the poster when a mail exceeds the maximum allowed size
    2.48 +
    2.49 +- moderation
    2.50 +- moderation-poster
    2.51 +  sent when a message is to be moderated (to the appropriate moderators or to
    2.52 +  the poster)
    2.53 +
    2.54 +- notifysub
    2.55 +- notifysub-digest
    2.56 +- notifysub-nomail
    2.57 +- notifyunsub
    2.58 +- notifyunsub-digest
    2.59 +- notifyunsub-nomail
    2.60 +  sent to the list owner when somebody is (un-)subscribed
    2.61 +
    2.62 +- notintocc
    2.63 +  sent to the poster when the list address is not found in a To: or CC: header
    2.64 +
    2.65 +- sub-confirm
    2.66 +- sub-confirm-digest
    2.67 +- sub-confirm-nomail
    2.68 +  sent to a requester to allow them to confirm a subscription request
    2.69 +
    2.70 +- sub-deny-digest
    2.71 +- sub-deny-nomail
    2.72 +  sent when a subscription request is received for the digest or nomail version
    2.73 +  of a list when that version is disabled
    2.74 +
    2.75 +- sub-ok
    2.76 +- sub-ok-digest
    2.77 +- sub-ok-nomail
    2.78 +  sent to the new subscriber when a subscription succeeds
    2.79 +
    2.80 +- sub-subscribed
    2.81 +  sent to a person sending a subscription request when they are already
    2.82 +  subscribed to the list
    2.83 +
    2.84 +- submod-moderator
    2.85 +- submod-requester
    2.86 +  sent when a subscription is to be moderated (to the appropriate moderators
    2.87 +  or to the requester)
    2.88 +
    2.89 +- subonlypost
    2.90 +  sent to the poster when they attempt to post to a subonlypost list without
    2.91 +  being subscribed
    2.92 +
    2.93 +- unsub-confirm
    2.94 +- unsub-confirm-digest
    2.95 +- unsub-confirm-nomail
    2.96 +  sent to a subscriber to allow them to confirm an unsubscription request
    2.97 +
    2.98 +- unsub-notsubscribed
    2.99 +  sent to a person sending an unsubscription request when they are not actually
   2.100 +  subscribed to the list
   2.101 +
   2.102 +- unsub-ok
   2.103 +- unsub-ok-digest
   2.104 +- unsub-ok-nomail
   2.105 +  sent to the old subscriber when an unsubscription succeeds
   2.106 +
   2.107 +List text format
   2.108 +----------------
   2.109 +
   2.110 +They have the following format:
   2.111 +
   2.112 +- Subject line
   2.113 +- Blank line
   2.114 +- Body
   2.115 +
   2.116 +They are expected to be in UTF-8 encoding and have Unix line endings.
   2.117 +
   2.118 +The subject line is the text 'Subject: ' (Mlmmj expects the space, even though
   2.119 +this is not ordinarily required in mail messages) followed by the subject line
   2.120 +to be used for the mail. The subject line may include UTF-8 characters, which
   2.121 +will automatically be escaped using the =?utf-8?q?...?= quoting mechanism.
   2.122 +
   2.123 +List text substitutions
   2.124 +-----------------------
   2.125 +
   2.126 +Both subject and body may include the following, which are substituted prior to
   2.127 +sending the message:
   2.128 +
   2.129 +- $bouncenumbers$
   2.130 +  (available only in bounceprobe)
   2.131 +  the formatted list of indexes of messages which may not have been received as
   2.132 +  they bounced
   2.133 +
   2.134 +- $confaddr$
   2.135 +  (available only in [un]sub-confirm[-digest|-nomail])
   2.136 +  the address to which to send mail to confirm the (un-)subscription in
   2.137 +  question
   2.138 +
   2.139 +- $digestfirst$
   2.140 +  (available only in digest)
   2.141 +  index of the first message included in a digest
   2.142 +
   2.143 +- $digestinterval$
   2.144 +  (available only in digest)
   2.145 +  indexes of the first and last messages included in a digest (e.g. 1-5), or
   2.146 +  just the index if only a single message is included
   2.147 +
   2.148 +- $digestissue$
   2.149 +  (available only in digest)
   2.150 +  the issue number of the digest
   2.151 +
   2.152 +- $digestlast$
   2.153 +  (available only in digest)
   2.154 +  index of the last message included in a digest
   2.155 +
   2.156 +- $digestsubaddr$
   2.157 +  listname+subscribe-digest@domain.tld
   2.158 +
   2.159 +- $digestthreads$
   2.160 +  (available only in digest)
   2.161 +  the list of threads included in the digest
   2.162 +
   2.163 +- $digestunsubaddr$
   2.164 +  listname+unsubscribe-digest@domain.tld
   2.165 +
   2.166 +- $faqaddr$
   2.167 +  listname+faq@domain.tld
   2.168 +
   2.169 +- $helpaddr$
   2.170 +  listname+help@domain.tld
   2.171 +
   2.172 +- $listaddr$
   2.173 +  listname@domain.tld
   2.174 +
   2.175 +- $listgetN$
   2.176 +  listname+get-N@domain.tld
   2.177 +  (the N here is nothing special, so this won't actually work, but is used to
   2.178 +  explain to users how to use the +get functionality)
   2.179 +
   2.180 +- $listowner$
   2.181 +  listname+owner@domain.tld
   2.182 +
   2.183 +- $listsubaddr$
   2.184 +  listname+subscribe@domain.tld
   2.185 +
   2.186 +- $listunsubaddr$
   2.187 +  listname+unsubscribe@domain.tld
   2.188 +
   2.189 +- $maxmailsize$
   2.190 +  (available only in maxmailsize)
   2.191 +  the maximum size of mail that Mlmmj will accept
   2.192 +
   2.193 +- $moderateaddr$
   2.194 +  (available only in moderation and submod-moderator)
   2.195 +  the address to which to send mail to approve the post or subscription in
   2.196 +  question
   2.197 +
   2.198 +- $moderators$
   2.199 +  (available only in moderation, moderation-poster and submod)
   2.200 +  the formatted list of moderators to whom the moderation request has been sent
   2.201 +
   2.202 +- $newsub$
   2.203 +  (available only in notifysub, notifysub-digest and notifysub-nomail)
   2.204 +  the address that has been subscribed
   2.205 +
   2.206 +- $nomailsubaddr$
   2.207 +  listname+subscribe-nomail@domain.tld
   2.208 +
   2.209 +- $nomailunsubaddr$
   2.210 +  listname+unsubscribe-nomail@domain.tld
   2.211 +
   2.212 +- $oldsub$
   2.213 +  (available only in notifyunsub, notifyunsub-digest and notifyunsub-nomail)
   2.214 +  the address that has been unsubscribed
   2.215 +
   2.216 +- $originalmail$
   2.217 +  the first 100 lines (including headers)
   2.218 +  of the email message being processed (usually a mail being moderated)
   2.219 +
   2.220 +- $posteraddr$
   2.221 +  (available only in subonlypost)
   2.222 +  the from address of the message that was received as determined by Mlmmj
   2.223 +
   2.224 +- $subaddr$
   2.225 +  (available only in submod-moderator and [un]sub-confirm[-digest|-nomail])
   2.226 +  the address requested to be (un-)subscribed
   2.227 +
   2.228 +
   2.229 +