Mercurial > hg > mlmmj
annotate TUNABLES @ 919:e371a935a0cd default tip master
Added tag RELEASE_1_3_0 for changeset 570dd6d4942b
| author | Ben Schmidt |
|---|---|
| date | Thu, 25 May 2017 09:08:47 +1000 |
| parents | 4bcd0168ddf9 |
| children |
| rev | line source |
|---|---|
| 89 | 1 TUNABLES for lists managed with mlmmj: |
| 2 -------------------------------------- | |
| 3 | |
| 4 The following files can be used for changing the behaviour of a list. The | |
| 5 filename is supposed to be below listdir/control. In the case it's a "boolean", | |
| 6 the contents of a file does not matter, the mere presence of it, will set the | |
| 7 variable to "true". If it's a "normal" file, the first line will be used as | |
|
228
fda21d560980
Make it possible to specify several owner emailaddresses, not just one
mmj
parents:
222
diff
changeset
|
8 value, leaving line 2 and forward ready for commentary etc. If it's possible |
| 714 | 9 to specify several entries (one pr. line), it's marked "list". If the file's |
| 10 entire content is used as value, it's marked "text". | |
| 255 | 11 |
| 735 | 12 · listaddress (list) |
| 460 | 13 |
| 14 This file contains all addresses which mlmmj sees as listaddresses (see | |
| 15 tocc below). The first one is the one used as the primary one, when mlmmj | |
| 16 sends out mail. | |
| 17 | |
| 735 | 18 · closedlist (boolean) |
| 89 | 19 |
| 570 | 20 Is the list is open or closed. If it's closed subscription and |
| 514 | 21 unsubscription via mail is disabled. |
| 89 | 22 |
| 735 | 23 · closedlistsub (boolean) |
| 528 | 24 |
| 25 Closed for subscription. Unsubscription is possible. | |
| 26 | |
| 735 | 27 · moderated (boolean) |
| 89 | 28 |
| 281 | 29 If this file is present, the emailaddresses in the file |
| 30 listdir/control/moderators will act as moderators for the list. | |
| 89 | 31 |
| 735 | 32 · submod (list) |
|
560
3258e74426b3
Subscriber moderation finished. Will test it all later tonight, but
mmj
parents:
528
diff
changeset
|
33 |
|
3258e74426b3
Subscriber moderation finished. Will test it all later tonight, but
mmj
parents:
528
diff
changeset
|
34 If this file is present, subscription will be moderated by owner(s). |
| 570 | 35 If there are emailaddresses in this file, then these will be used |
|
560
3258e74426b3
Subscriber moderation finished. Will test it all later tonight, but
mmj
parents:
528
diff
changeset
|
36 instead of owner. |
|
3258e74426b3
Subscriber moderation finished. Will test it all later tonight, but
mmj
parents:
528
diff
changeset
|
37 |
| 735 | 38 · tocc (boolean) |
|
219
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
39 |
|
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
40 If this file is present, the list address does not have to be in the To: |
|
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
41 or Cc: header of the email to the list. |
|
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
42 |
| 735 | 43 · subonlypost (boolean) |
|
219
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
44 |
|
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
45 When this file is present, only people who are subscribed to the list, |
|
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
46 are allowed to post to it. The check is made against the "From:" header. |
|
7dcc23ad4387
Mention control/tocc and control/subonlypost in TUNABLES and ChangeLog
mmj
parents:
90
diff
changeset
|
47 |
| 907 | 48 · modonlypost (boolean) |
| 49 | |
| 50 When this file is present, only people listed in listdir/control/moderators | |
| 51 are allowed to post to it. The check is made against the "From:" header. | |
| 52 | |
| 735 | 53 · modnonsubposts (boolean) |
| 602 | 54 |
| 907 | 55 When this file is present, all postings from people who are not allowed |
| 56 to post to the list will be moderated instead of denied. | |
| 602 | 57 |
| 890 | 58 · modreqlife (normal) |
| 59 | |
| 60 This specifies how long in seconds a mail awaits moderation before it's | |
| 61 discarded. Defaults to 604800 seconds, which is 7 days. | |
| 62 | |
| 735 | 63 · prefix (normal) |
| 89 | 64 |
| 65 The prefix for the Subject: line of mails to the list. This will alter the | |
| 66 Subject: line, and add a prefix if it's not present elsewhere. | |
| 67 | |
| 735 | 68 · owner (list) |
|
228
fda21d560980
Make it possible to specify several owner emailaddresses, not just one
mmj
parents:
222
diff
changeset
|
69 |
|
fda21d560980
Make it possible to specify several owner emailaddresses, not just one
mmj
parents:
222
diff
changeset
|
70 The emailaddresses in this file (1 pr. line) will get mails to |
|
fda21d560980
Make it possible to specify several owner emailaddresses, not just one
mmj
parents:
222
diff
changeset
|
71 listname+owner@listdomain.tld |
|
fda21d560980
Make it possible to specify several owner emailaddresses, not just one
mmj
parents:
222
diff
changeset
|
72 |
| 735 | 73 · customheaders (list) |
|
359
ca217febcfbd
Rerwrite the way listtexts are handled and move Subject: out into the file
mmj
parents:
355
diff
changeset
|
74 |
|
ca217febcfbd
Rerwrite the way listtexts are handled and move Subject: out into the file
mmj
parents:
355
diff
changeset
|
75 These headers are added to every mail coming through. This is the place you |
|
ca217febcfbd
Rerwrite the way listtexts are handled and move Subject: out into the file
mmj
parents:
355
diff
changeset
|
76 want to add Reply-To: header in case you want such. |
|
ca217febcfbd
Rerwrite the way listtexts are handled and move Subject: out into the file
mmj
parents:
355
diff
changeset
|
77 |
| 735 | 78 · delheaders (list) |
| 89 | 79 |
| 231 | 80 In this file is specified *ONE* headertoken to match pr. line. If the file |
| 81 consists of: | |
| 82 Received: | |
| 83 Message-ID: | |
| 84 Then all occurences of these headers in incoming list mail will be deleted. | |
| 234 | 85 "From " and "Return-Path:" are deleted no matter what. |
| 255 | 86 |
| 735 | 87 · access (list) |
| 255 | 88 |
| 89 If this file exists, all headers of a post to the list is matched against | |
| 90 the rules. The first rule to match wins. See README.access for syntax and | |
| 91 examples. | |
|
268
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
92 |
| 735 | 93 · memorymailsize (normal) |
|
268
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
94 |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
95 Here is specified in bytes how big a mail can be and still be prepared for |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
96 sending in memory. It's greatly reducing the amount of write system calls to |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
97 prepare it in memory before sending it, but can also lead to denial of |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
98 service attacks. Default is 16k (16384 bytes). |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
99 |
| 735 | 100 · addtohdr (boolean) |
|
268
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
101 |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
102 When this file is present, a To: header including the recipients |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
103 emailaddress will be added to outgoing mail. Recommended usage is to remove |
|
1dbadf407849
mlmmj-send now prepares headers and mail, and To: header feature added
mmj
parents:
255
diff
changeset
|
104 existing To: headers with delheaders (see above) first. |
| 291 | 105 |
| 735 | 106 · relayhost (normal) |
| 291 | 107 |
| 293 | 108 The host specified (IP address or hostname, both works) in this file will |
| 291 | 109 be used for relaying the mail sent to the list. Defaults to 127.0.0.1. |
| 110 | |
| 735 | 111 · notifysub (boolean) |
| 291 | 112 |
| 113 If this file is present, the owner(s) will get a mail with the address of | |
| 114 someone sub/unsubscribing to a mailinglist. | |
|
320
b2fe9c6cb9fe
Bouncelife and crontab entry fix and a commented out genmsgid() function
mmj
parents:
293
diff
changeset
|
115 |
| 735 | 116 · notifymod (boolean) |
|
729
d78eb18576b0
Added feature to notify users when their posts are moderated
Ben Schmidt
parents:
728
diff
changeset
|
117 |
|
d78eb18576b0
Added feature to notify users when their posts are moderated
Ben Schmidt
parents:
728
diff
changeset
|
118 If this file is present, the poster (based on the envelope from) will |
| 879 | 119 get a mail when their post is being moderated. |
|
729
d78eb18576b0
Added feature to notify users when their posts are moderated
Ben Schmidt
parents:
728
diff
changeset
|
120 |
| 735 | 121 · digestinterval (normal) |
| 338 | 122 |
| 123 This file specifies how many seconds will pass before the next digest is | |
| 124 sent. Defaults to 604800 seconds, which is 7 days. | |
| 125 | |
| 735 | 126 · digestmaxmails (normal) |
| 338 | 127 |
| 128 This file specifies how many mails can accumulate before digest sending is | |
| 129 triggered. Defaults to 50 mails, meaning that if 50 mails arrive to the list | |
| 130 before digestinterval have passed, the digest is delivered. | |
| 131 | |
| 735 | 132 · bouncelife (normal) |
|
320
b2fe9c6cb9fe
Bouncelife and crontab entry fix and a commented out genmsgid() function
mmj
parents:
293
diff
changeset
|
133 |
| 890 | 134 This specifies how long in seconds an address can bounce before it's |
| 135 unsubscribed. Defaults to 432000 seconds, which is 5 days. | |
|
343
6d1f589dee87
This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents:
338
diff
changeset
|
136 |
| 735 | 137 · noarchive (boolean) |
|
343
6d1f589dee87
This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents:
338
diff
changeset
|
138 |
|
6d1f589dee87
This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents:
338
diff
changeset
|
139 If this file exists, the mail won't be saved in the archive but simply |
|
6d1f589dee87
This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents:
338
diff
changeset
|
140 deleted. |
| 355 | 141 |
| 735 | 142 · nosubconfirm (boolean) |
| 355 | 143 |
| 144 If this file exists, no mail confirmation is needed to subscribe to the | |
| 890 | 145 list. This should in principle never ever be used, but there are times |
| 355 | 146 on local lists etc. where this is useful. HANDLE WITH CARE! |
| 426 | 147 |
| 735 | 148 · noget (boolean) |
| 444 | 149 |
| 890 | 150 If this file exists, then retrieving old posts with +get-N is disabled. |
| 444 | 151 |
| 735 | 152 · subonlyget (boolean) |
| 513 | 153 |
| 154 If this file exists, then retrieving old posts with +get-N is only | |
| 155 possible for subscribers. The above mentioned 'noget' have precedence. | |
| 156 | |
| 735 | 157 · verp (normal) |
| 426 | 158 |
| 845 | 159 Control how Mlmmj does VERP (variable envelope return path). If this tunable |
| 160 does not exist, Mlmmj will send a message to the SMTP server for each | |
| 161 recipient, with an appropriate envelope return path, i.e. it will handle | |
| 162 VERP itself. If the tunable does exist, Mlmmj will instead divide the | |
| 163 recipients into groups (the maximum number of recipients in a group can be | |
| 164 controlled by the maxverprecips tunable) and send one message to the SMTP | |
| 165 server per group. The content of this tunable allows VERP to be handled by | |
| 166 the SMTP server. If the tunable contains "postfix", Mlmmj will make Postfix | |
| 167 use VERP by adding XVERP=-= to the MAIL FROM: line. If it contains something | |
| 168 else, that text will be appended to the MAIL FROM: line. If it contains | |
| 169 nothing, VERP will effectively be disabled, as neither Mlmmj nor the SMTP | |
| 170 server will do it. | |
| 426 | 171 |
| 735 | 172 · maxverprecips (normal) |
| 426 | 173 |
| 845 | 174 How many recipients per mail delivered to the SMTP server. Defaults to 100. |
|
439
b75073f25e60
Add switches to control whether or not mlmmj sends out mails explaining
mmj
parents:
426
diff
changeset
|
175 |
| 735 | 176 · notoccdenymails (boolean) |
| 177 · noaccessdenymails (boolean) | |
| 178 · nosubonlydenymails (boolean) | |
| 907 | 179 · nomodonlydenymails (boolean) |
|
439
b75073f25e60
Add switches to control whether or not mlmmj sends out mails explaining
mmj
parents:
426
diff
changeset
|
180 |
|
b75073f25e60
Add switches to control whether or not mlmmj sends out mails explaining
mmj
parents:
426
diff
changeset
|
181 These switches turns off whether mlmmj sends out notification about postings |
|
b75073f25e60
Add switches to control whether or not mlmmj sends out mails explaining
mmj
parents:
426
diff
changeset
|
182 being denied due to the listaddress not being in To: or Cc: (see 'tocc'), |
|
b75073f25e60
Add switches to control whether or not mlmmj sends out mails explaining
mmj
parents:
426
diff
changeset
|
183 when it was rejected due to an access rule (see 'access') or whether it's a |
| 907 | 184 subscribers/moderators only posting list (see 'subonlypost/modonlypost'). |
| 458 | 185 |
| 735 | 186 · nosubmodmails (boolean) |
|
728
e5286b45f9ca
Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents:
727
diff
changeset
|
187 |
|
e5286b45f9ca
Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents:
727
diff
changeset
|
188 This switch turns off whether mlmmj sends out notification about |
|
e5286b45f9ca
Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents:
727
diff
changeset
|
189 subscription being moderated to the person requesting subscription |
|
e5286b45f9ca
Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents:
727
diff
changeset
|
190 (see 'submod'). |
|
e5286b45f9ca
Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents:
727
diff
changeset
|
191 |
| 735 | 192 · smtpport (normal) |
| 458 | 193 |
| 194 In this file a port other than port 25 for connecting to the relayhost | |
| 195 can be specified. | |
| 520 | 196 |
| 735 | 197 · delimiter (normal) |
| 520 | 198 |
| 199 This specifies what to use as recipient delimiter for the list. | |
| 200 Default is "+". | |
|
565
e3a9ca0e9c33
added support for digest text part and digestissue keyword
mortenp
parents:
560
diff
changeset
|
201 |
| 735 | 202 · nodigesttext (boolean) |
|
565
e3a9ca0e9c33
added support for digest text part and digestissue keyword
mortenp
parents:
560
diff
changeset
|
203 |
|
e3a9ca0e9c33
added support for digest text part and digestissue keyword
mortenp
parents:
560
diff
changeset
|
204 If this file exists, digest mails won't have a text part with a thread |
| 570 | 205 summary. |
|
612
ded3bd1059cd
Added 'nodigestsub' tunable which will disable subscription to the digest version of a list (Henne Vogelsang)
mortenp
parents:
603
diff
changeset
|
206 |
| 735 | 207 · nodigestsub (boolean) |
|
612
ded3bd1059cd
Added 'nodigestsub' tunable which will disable subscription to the digest version of a list (Henne Vogelsang)
mortenp
parents:
603
diff
changeset
|
208 |
|
ded3bd1059cd
Added 'nodigestsub' tunable which will disable subscription to the digest version of a list (Henne Vogelsang)
mortenp
parents:
603
diff
changeset
|
209 If this file exists, subscription to the digest version of the mailinglist |
| 614 | 210 will be denied. (Useful if you don't want to allow digests and notify users |
|
612
ded3bd1059cd
Added 'nodigestsub' tunable which will disable subscription to the digest version of a list (Henne Vogelsang)
mortenp
parents:
603
diff
changeset
|
211 about it). |
|
616
62743c7b96c0
Added 'nonomailsub' tunable which will disable nomail subscriptions to a list (Henne Vogelsang)
mortenp
parents:
614
diff
changeset
|
212 |
| 735 | 213 · nonomailsub (boolean) |
|
616
62743c7b96c0
Added 'nonomailsub' tunable which will disable nomail subscriptions to a list (Henne Vogelsang)
mortenp
parents:
614
diff
changeset
|
214 |
|
62743c7b96c0
Added 'nonomailsub' tunable which will disable nomail subscriptions to a list (Henne Vogelsang)
mortenp
parents:
614
diff
changeset
|
215 If this file exists, subscription to the nomail version of the mailinglist |
|
62743c7b96c0
Added 'nonomailsub' tunable which will disable nomail subscriptions to a list (Henne Vogelsang)
mortenp
parents:
614
diff
changeset
|
216 will be denied. (Useful if you don't want to allow nomail and notify users |
|
62743c7b96c0
Added 'nonomailsub' tunable which will disable nomail subscriptions to a list (Henne Vogelsang)
mortenp
parents:
614
diff
changeset
|
217 about it). |
|
629
61e93e5c3ecf
Added support for mail size limit (Christoph Wilke)
mortenp
parents:
616
diff
changeset
|
218 |
| 735 | 219 · maxmailsize (normal) |
|
629
61e93e5c3ecf
Added support for mail size limit (Christoph Wilke)
mortenp
parents:
616
diff
changeset
|
220 |
|
61e93e5c3ecf
Added support for mail size limit (Christoph Wilke)
mortenp
parents:
616
diff
changeset
|
221 With this option the maximal allowed size of incoming mails can be specified. |
|
61e93e5c3ecf
Added support for mail size limit (Christoph Wilke)
mortenp
parents:
616
diff
changeset
|
222 |
| 735 | 223 · nomaxmailsizedenymails (boolean) |
|
629
61e93e5c3ecf
Added support for mail size limit (Christoph Wilke)
mortenp
parents:
616
diff
changeset
|
224 |
|
61e93e5c3ecf
Added support for mail size limit (Christoph Wilke)
mortenp
parents:
616
diff
changeset
|
225 If this is set, no reject notifications caused by violation of maxmailsize |
|
61e93e5c3ecf
Added support for mail size limit (Christoph Wilke)
mortenp
parents:
616
diff
changeset
|
226 will be sent. |
| 659 | 227 |
| 735 | 228 · nolistsubsemail (boolean) |
| 659 | 229 |
| 230 If this is set, the LISTNAME+list@ functionality for requesting an | |
| 231 email with the subscribers for owner is disabled. | |
|
677
c8e85bb330ed
Added support for static bounce addresses (Thomas Jarosch)
mortenp
parents:
659
diff
changeset
|
232 |
| 735 | 233 · staticbounceaddr (normal) |
|
677
c8e85bb330ed
Added support for static bounce addresses (Thomas Jarosch)
mortenp
parents:
659
diff
changeset
|
234 |
|
c8e85bb330ed
Added support for static bounce addresses (Thomas Jarosch)
mortenp
parents:
659
diff
changeset
|
235 If this is set to something@example.org, the bounce address (Return-Path:) |
|
c8e85bb330ed
Added support for static bounce addresses (Thomas Jarosch)
mortenp
parents:
659
diff
changeset
|
236 will be fixed to something+listname-bounces-and-so-on@example.org |
|
c8e85bb330ed
Added support for static bounce addresses (Thomas Jarosch)
mortenp
parents:
659
diff
changeset
|
237 in case you need to disable automatic bounce handling. |
| 705 | 238 |
| 735 | 239 · ifmodsendonlymodmoderate (boolean) |
| 705 | 240 |
| 241 If this file is present, then mlmmj in case of moderation checks the | |
| 242 envelope from, to see if the sender is a moderator, and in that case | |
| 243 only send the moderation mails to that address. In practice this means that | |
| 714 | 244 a moderator sending mail to the list won't bother all the other moderators |
| 705 | 245 with his mail. |
| 714 | 246 |
| 735 | 247 · footer (text) |
| 714 | 248 |
| 249 The content of this file is appended to mail sent to the list. | |
| 250 | |
| 735 | 251 · notmetoo (boolean) |
|
727
4575d3181ca1
Added notmetoo feature where posts are not mirrored to their senders.
Ben Schmidt
parents:
714
diff
changeset
|
252 |
|
4575d3181ca1
Added notmetoo feature where posts are not mirrored to their senders.
Ben Schmidt
parents:
714
diff
changeset
|
253 If this file is present, mlmmj attempts to exclude the sender of a post |
|
4575d3181ca1
Added notmetoo feature where posts are not mirrored to their senders.
Ben Schmidt
parents:
714
diff
changeset
|
254 from the distribution list for that post so people don't receive copies |
|
4575d3181ca1
Added notmetoo feature where posts are not mirrored to their senders.
Ben Schmidt
parents:
714
diff
changeset
|
255 of their own posts. |
|
4575d3181ca1
Added notmetoo feature where posts are not mirrored to their senders.
Ben Schmidt
parents:
714
diff
changeset
|
256 |
| 909 | 257 · smtphelo (normal) |
| 258 | |
| 259 When this file is present, it contains the hostname to send in the SMTP | |
| 260 EHLO or HELO command. Otherwise the machine hostname is used. |