1
<!-- RCS Identication ; $Revision: 1.4 $ ; $Date: 2002/04/09 13:15:28 $ -->
1
<!-- RCS Identication ; $Revision: 1.6.2.1 $ ; $Date: 2004/04/02 07:22:11 $ -->
5
<B>[p->title]</B> ([p->NAME]):
9
Privilege for adding (ADD command) a subscriber to the list
10
[ELSIF p->NAME=anonymous_sender]
11
To hide the sender's email address before distributing the message.
12
It is replaced by the provided email address.
13
[ELSIF p->NAME=archive]
14
Privilege for reading mail archives and frequency of archiving
16
Owners are managing subscribers of the list. They may review subscribers and
17
add or delete email addresses from the mailing list. If you are a privileged
18
owner of the list, you can choose other owners for the mailing list.
19
Privileged owners may edit a few more options than other owners. There can
20
only be one privileged owner per list; his/her email address may not
21
be edited from the web.
22
[ELSIF p->NAME=editor]
23
Editors are responsible for moderating messages. If the mailing list is
24
moderated, messages posted to the list will first be passed to the editors,
25
who will decide whether to distribute or reject it. <BR>
26
FYI: Defining editors will not make the list moderated ; you will have to
27
set the "send" parameter.<BR>
28
FYI: If the list is moderated, any editor can distribute or reject a message
29
without the knowledge or consent of the other editors. Messages that have not
30
been distributed or rejected will remain in the moderation spool until they
4
<A NAME="[p->NAME]"></a>
5
<B>[p->title]</B> ([p->NAME]):
9
Privilege for adding (ADD command) a subscriber to the list
10
[ELSIF p->NAME=anonymous_sender]
11
To hide the sender's email address before distributing the message.
12
It is replaced by the provided email address.
13
[ELSIF p->NAME=archive]
14
Privilege for reading mail archives and frequency of archiving
15
[ELSIF p->NAME=available_user_options]
16
The available_user_options parameter starts a paragraph to define available
17
options for the subscribers of the list.<BR><BR>
19
<LI>reception <i>modelist</i> (Default value: reception mail,notice,digest,summary,nomail)<BR><BR>
20
<i>modelist</i> is a list of modes (mail, notice, digest, summary, nomail), separated
21
by commas. Only these modes will be allowed for the subscribers of this list.
22
If a subscriber has a reception mode not in the list, sympa uses the mode
23
specified in the default_user_options paragraph.
26
[ELSIF p->NAME=bounce]
27
This paragraph defines bounce management parameters:<BR><BR>
29
<LI>warn_rate (Default value: bounce_warn_rate robot parameter)<BR><BR>
30
The list owner receives a warning whenever a message is distributed and the
31
number (percentage) of bounces exceeds this value.<BR><BR>
33
<LI>halt_rate (Default value: bounce_halt_rate robot parameter)<BR><BR>
34
NOT USED YET. If bounce rate reaches the halt_rate, messages for the list
35
will be halted, i.e. they are retained for subsequent moderation. Once the
36
number of bounces exceeds this value, messages for the list are no longer
39
<LI>expire_bounce_task (Default value: daily)<BR><BR>
40
Name of the task template use to remove old bounces. Usefull to remove bounces
41
for a subscriber email if some message are distributed without receiving new
42
bounce. In this case, the subscriber email seems to be OK again. Active if
43
task_manager.pl is running.
47
[ELSIF p->NAME=bouncers_level1]
48
The Bouncers_level1 paragraphs defines the automatic behavior of bounce management.<BR>
49
Level 1 is the lower level of bouncing users <BR><BR>
52
<LI>rate (Default value: 45)<BR><BR>
53
Each bouncing user have a score (from 0 to 100).This parameter defines lower limit foreach
54
category of bouncing users.for example, level 1 begins from 45 to level_2_treshold.<BR><BR>
56
<LI> action (Default value: notify_bouncers)<BR><BR>
57
This parameter defines which task is automaticaly applied on level 1
60
<LI>Notification (Default value: owner)<BR><BR>
61
When automatic task is executed on level 1 bouncers, a notification
62
email can be send to listowner or listmaster.<BR><BR>
66
[ELSIF p->NAME=bouncers_level2]
67
The Bouncers_levelX paragraphs defines the automatic behavior of bounce management.<BR>
68
Level 2 is the highest level of bouncing users <BR><BR>
71
<LI>rate (Default value: 80)<BR><BR>
72
Each bouncing user have a score (from 0 to 100).This parameter defines limit between each
73
category of bouncing users.For example, level 2 is for users with a score between 80
76
<LI>action (Default value: notify_bouncers)<BR><BR>
77
This parameter defines which task is automaticaly applied on level 2
80
<LI>Notification (Default value: owner)<BR><BR>
81
When automatic task is executed on level 2 bouncers, a notification
82
email can be send to listowner or listmaster.<BR><BR>
85
[ELSIF p->NAME=cookie]
86
This parameter is a confidential item for generating authentication keys for
87
administrative commands (ADD, DELETE, etc.). This parameter should remain
88
concealed, even for owners. The cookie is applied to all list owners, and is
89
only taken into account when the owner has the auth parameter.
90
[ELSIF p->NAME=custom_header]
91
This parameter is optional. The headers specified will be added to the headers
92
of messages distributed via the list. As of release 1.2.2 of Sympa, it is possible
93
to put several custom header lines in the configuration file at the same time.
94
[ELSIF p->NAME=custom_subject]
95
This parameter is optional. It specifies a string which is added to the subject
96
of distributed messages (intended to help users who do not use automatic tools to
97
sort incoming messages). This string will be surrounded by [] characters.
98
[ELSIF p->NAME=default_user_options]
99
The default_user_options parameter starts a paragraph to define a default profile
100
for the subscribers of the list.<BR><BR>
102
<LI>reception notice | digest | summary | nomail | mail<BR><BR>Mail reception mode.<BR><BR></LI>
103
<LI>visibility conceal | noconceal<BR><BR>Visibility of the subscriber with the REVIEW command.</LI>
106
This parameter specifies who is authorized to use the DEL command.
107
[ELSIF p->NAME=digest]
108
Definition of digest mode. If this parameter is present, subscribers can select
109
the option of receiving messages in multipart/digest MIME format. Messages are then
110
grouped together, and compilations of messages are sent to subscribers in accordance
111
with the rythm selected with this parameter.
112
[ELSIF p->NAME=editor]
113
Editors are responsible for moderating messages. If the mailing list is
114
moderated, messages posted to the list will first be passed to the editors,
115
who will decide whether to distribute or reject it. <BR>
116
FYI: Defining editors will not make the list moderated ; you will have to
117
set the "send" parameter.<BR>
118
FYI: If the list is moderated, any editor can distribute or reject a message
119
without the knowledge or consent of the other editors. Messages that have not
120
been distributed or rejected will remain in the moderation spool until they
122
[ELSIF p->NAME=expire_task]
123
This parameter states which model is used to create a remind task. A expire
124
task regurlaly checks the inscription or reinscription date of subscribers and
125
asks them to renew their subscription. If they don't they are deleted.
126
[ELSIF p->NAME=footer_type]
127
List owners may decide to add message headers or footers to messages sent via
128
the list. This parameter defines the way a footer/header is added to a message.<BR><BR>
130
<LI>footer_type mime<BR><BR>
131
The default value. Sympa will add the footer/header as a new MIME part.
132
If the message is in multipart/alternative format, no action is taken (since this
133
would require another level of MIME encapsulation).<BR><BR>
135
<LI>footer_type append<BR><BR>
136
Sympa will not create new MIME parts, but will try to append the header/footer to the
137
body of the message. Predefined message-footers will will be ignored. Headers/footers may be
138
appended to text/plain messages only.
142
Domain name of the list, default is the robot domain name set in the related
143
robot.conf file or in file /etc/sympa.conf.
144
[ELSIF p->NAME=include_file]
145
This parameter will be interpreted only if the user_data_source value is set
146
to include. The file should contain one e-mail address per line (lines beginning
147
with a "#" are ignored).
148
[ELSIF p->NAME=include_ldap_2level_query]
149
This paragraph defines parameters for a two-level query returning a list of
150
subscribers. Usually the first-level query returns a list of DNs and the
151
second-level queries convert the DNs into e-mail addresses. This paragraph is
152
used only if user_data_source is set to include. This feature requires the
153
Net::LDAP (perlldap) PERL module.
154
[ELSIF p->NAME=include_ldap_query]
155
This paragraph defines parameters for a query returning a list of subscribers.
156
This paragraph is used only if user_data_source is set to include. This feature
157
requires the Net::LDAP (perlldap) PERL module.
158
[ELSIF p->NAME=include_list]
159
This parameter will be interpreted only if user_data_source is set to include.
160
All subscribers of list listname become subscribers of the current list. You
161
may include as many lists as required, using one include_list listname line
162
for each included list. Any list at all may be included; the user_data_source
163
definition of the included list is irrelevant, and you may therefore include
164
lists which are also defined by the inclusion of other lists. Be careful, however,
165
not to include list A in list B and then list B in list A, since this will give
166
rise an infinite loop.
167
[ELSIF p->NAME=include_remote_sympa_list]
168
Sympa can contact another Sympa service using https to fetch a remote list in
169
order to include each member of a remote list as subscriber. You may include
170
as many lists as required, using one include_remote_sympa_list paragraph for
171
each included list. Be careful, however, not to give rise an infinite loop
172
making cross includes.<BR><BR>
173
For this operation, one Sympa site act as a server while the other one act as
174
client. On the server side, the only setting needed is to give permission to the
175
remote Sympa to review the list. This is controled by the review scenario.
176
[ELSIF p->NAME=include_sql_query]
177
This parameter will be interpreted only if the user_data_source value is set to
178
include, and is used to begin a paragraph defining the SQL query parameters.
180
This parameter defines the language used for the list. It is used to initialize
181
a user's language preference; Sympa command reports are extracted from the
182
associated message catalog.
183
[ELSIF p->NAME=max_size]
184
Maximum size of a message in 8-bit bytes.
185
[ELSIF p->NAME=owner]
186
Owners are managing subscribers of the list. They may review subscribers and
187
add or delete email addresses from the mailing list. If you are a privileged
188
owner of the list, you can choose other owners for the mailing list.
189
Privileged owners may edit a few more options than other owners. There can
190
only be one privileged owner per list; his/her email address may not
191
be edited from the web.
192
[ELSIF p->NAME=priority]
193
The priority with which Sympa will process messages for this list. This level of
194
priority is applied while the message is going through the spool.
195
[ELSIF p->NAME=remind]
196
This parameter specifies who is authorized to use the remind command.
197
[ELSIF p->NAME=remind_return_path]
198
Same as welcome_return_path, but applied to remind messages.
199
[ELSIF p->NAME=remind_task]
200
This parameter states which model is used to create a remind task. A remind task
201
regurlaly sends to the subscribers a message which reminds them their subscription
203
[ELSIF p->NAME=reply_to_header]
204
The reply_to_header parameter starts a paragraph defining what Sympa will place in
205
the Reply-To: SMTP header field of the messages it distributes.<BR><BR>
207
<LI>value sender | list | all | other_email (Default value: sender)<BR><BR>
208
This parameter indicates whether the Reply-To: field should indicate the sender of
209
the message (sender), the list itself (list), both list and sender (all) or an
210
arbitrary e-mail address (defined by the other_email parameter).<BR><BR>
211
Note: it is inadvisable to change this parameter, and particularly inadvisable to
212
set it to list. Experience has shown it to be almost inevitable that users,
213
mistakenly believing that they are replying only to the sender, will send private
214
messages to a list. This can lead, at the very least, to embarrassment, and
215
sometimes to more serious consequences.<BR><BR>
217
<LI>other_email an_email_address<BR><BR>
218
If value was set to other_email, this parameter defines the e-mail address used.<BR><BR>
220
<LI>apply respect | forced (Default value: respect)<BR><BR>
221
The default is to respect (preserve) the existing Reply-To: SMTP header field in
222
incoming messages. If set to forced, Reply-To: SMTP header field will be overwritten.
225
[ELSIF p->NAME=review]
226
This parameter specifies who can use read addresses of subscribers. Since subscriber
227
addresses can be abused by spammers, it is strongly recommended that you only
228
authorize owners or subscribers to access the subscriber list.
230
This parameter specifies who can send messages to the list. Valid values for this
231
parameter are pointers to scenarii.<BR><BR>
233
<LI>send closed<BR>closed<BR><BR></LI>
234
<LI>send editor<BR>Moderated, old style<BR><BR></LI>
235
<LI>send editorkey<BR>Moderated<BR><BR></LI>
236
<LI>send editorkeyonly<BR>Moderated, even for moderators<BR><BR></LI>
237
<LI>send editorkeyonlyauth<BR>Moderated, with editor confirmation<BR><BR></LI>
238
<LI>send intranet<BR>restricted to local domain<BR><BR></LI>
239
<LI>send intranetorprivate<BR>restricted to local domain and subscribers<BR><BR></LI>
240
<LI>send newsletter<BR>Newsletter, restricted to moderators<BR><BR></LI>
241
<LI>send newsletterkeyonly<BR>Newsletter, restricted to moderators after confirmation<BR><BR></LI>
242
<LI>send private<BR>restricted to subscribers<BR><BR></LI>
243
<LI>send private_smime<BR>restricted to subscribers check smime signature<BR><BR></LI>
244
<LI>send privateandeditorkey<BR>Moderated, restricted to subscribers<BR><BR></LI>
245
<LI>send privateandnomultipartoreditorkey<BR>Moderated, for non subscribers sending multipart messages<BR><BR></LI>
246
<LI>send privatekey<BR>restricted to subscribers with previous md5 authentication<BR><BR></LI>
247
<LI>send privatekeyandeditorkeyonly<BR>Moderated, for subscribers and moderators<BR><BR></LI>
248
<LI>send privateoreditorkey<BR>Private, moderated for non subscribers<BR><BR></LI>
249
<LI>send privateorpublickey<BR>Private, confirmation for non subscribers<BR><BR></LI>
250
<LI>send public<BR>public list<BR><BR></LI>
251
<LI>send public_nobcc<BR>public list, Bcc rejected (anti-spam)<BR><BR></LI>
252
<LI>send publickey<BR>anyone with previous md5 authentication<BR><BR></LI>
253
<LI>send publicnoattachment<BR>public list multipart/mixed messages are forwarded to moderator<BR><BR></LI>
254
<LI>send publicnomultipart<BR>public list multipart messages are rejected<BR><BR></LI>
256
[ELSIF p->NAME=shared_doc]
257
This paragraph defines read and edit access to the shared document repository.
258
[ELSIF p->NAME=spam_protection]
259
There is a need to protection Sympa web site against spambot which collect email address
260
in public web site. Various method are availible into Sympa and you can choose it with
261
spam_protection and web_archive_spam_protection parameters. Possible value are:<BR><BR>
263
<LI>javascript: the address is hidden using a javascript. User who enable javascript can see a nice mailto address where others have nothing.</LI>
264
<LI>at: the @ char is replaced by the string " AT ".</LI>
265
<LI>none : no protection against spammer.</LI>
267
[ELSIF p->NAME=subject]
268
This parameter indicates the subject of the list, which is sent in response to
269
the LISTS mail command. The subject is a free form text limited to one line.
270
[ELSIF p->NAME=subscribe]
271
The subscribe parameter defines the rules for subscribing to the list.
272
Predefined scenarii are:<BR><BR>
274
<LI>subscribe auth<BR>subscription request confirmed<BR><BR></LI>
275
<LI>ubscribe auth_notify<BR>need authentication (notification is sent to owners)<BR><BR></LI>
276
<LI>subscribe auth_owner<BR>requires authentication then owner approval<BR><BR></LI>
277
<LI>subscribe closed<BR>subscribe is impossible<BR><BR></LI>
278
<LI>subscribe intranet<BR>restricted to local domain users<BR><BR></LI>
279
<LI>subscribe intranetorowner<BR>local domain users or owner approval<BR><BR></LI>
280
<LI>subscribe open<BR>for anyone without authentication<BR><BR></LI>
281
<LI>subscribe open_notify<BR>anyone, notification is sent to list owner<BR><BR></LI>
282
<LI>subscribe open_quiet<BR>anyone, no welcome message<BR><BR></LI>
283
<LI>subscribe owner<BR>owners approval<BR><BR></LI>
284
<LI>subscribe smime<BR>requires S/MIME signed<BR><BR></LI>
285
<LI>subscribe smimeorowner<BR>requires S/MIME signed or owner approval<BR><BR></LI>
287
[ELSIF p->NAME=topics]
288
This parameter allows the classification of lists. You may define multiple topics
289
as well as hierarchical ones. WWSympa's list of public lists uses this parameter.
291
Sympa caches user data extracted using the include parameter. Their TTL (time-to-live)
292
within Sympa can be controlled using this parameter. The default value is 3600
293
[ELSIF p->NAME=unsubscribe]
294
This parameter specifies the unsubscription method for the list. Use open_notify or
295
auth_notify to allow owner notification of each unsubscribe command. Predefined
296
scenarii are:<BR><BR>
298
<LI>unsubscribe auth<BR>need authentication<BR><BR></LI>
299
<LI>unsubscribe auth_notify<BR>authentication requested, notification sent to owner<BR><BR></LI>
300
<LI>unsubscribe closed<BR>impossible<BR><BR></LI>
301
<LI>unsubscribe open<BR>anyone without authentication<BR><BR></LI>
302
<LI>unsubscribe open_notify<BR>without authentication, notification is sent to owners<BR><BR></LI>
303
<LI>unsubscribe owner<BR>owner approval<BR><BR></LI>
305
[ELSIF p->NAME=user_data_source]
306
Sympa allows the mailing list manager to choose how Sympa loads subscriber data.
307
Subscriber information can be stored in a text file or relational database, or
308
included from various external sources (list, flat file, result of or query).
309
[ELSIF p->NAME=visibility]
310
This parameter indicates whether the list should feature in the output generated
311
in response to a LISTS command or should be shown in the list overview of the
313
[ELSIF p->NAME=web_archive]
314
Defines who can access the web archive for the list. Predefined scenarii are:<BR><BR>
316
<LI>access closed<BR>closed<BR><BR></LI>
317
<LI>access intranet<BR>restricted to local domain users<BR><BR></LI>
318
<LI>access listmaster<BR>listmaster<BR><BR></LI>
319
<LI>access owner<BR>by owner<BR><BR></LI>
320
<LI>access private<BR>subscribers only<BR><BR></LI>
321
<LI>access public<BR>public<BR><BR></LI>
323
[ELSIF p->NAME=web_archive_spam_protection]
324
Idem spam_protection but restricted to web archive. A additional value is available: cookie
325
which mean that users must submit a small form in order to receive a cookie before browsing
326
archives. This block all robot, even google and co.
327
[ELSIF p->NAME=welcome_return_path]
328
If set to unique, the welcome message is sent using a unique return path in order to remove
329
the subscriber immediately in the case of a bounce.