1SYMPA_CONFIG(5)                  sympa 6.2.70                  SYMPA_CONFIG(5)
2
3
4

NAME

6       sympa_config - Configuration files for Sympa mailing list manager
7

DESCRIPTION

9       There are three levels in Sympa's main configuration: site global, mail
10       domain and list.
11
12   sympa.conf: Configuration file for global settings
13       /etc/sympa/sympa.conf is main configuration file of Sympa.  Several
14       parameters defined in this file may be overridden by robot.conf
15       configuration file for each virtual domain, or by config configuration
16       file for each mailing list.
17
18       Format of sympa.conf and robot.conf is as following:
19
20       •   Lines beginning with "#" and containing only spaces are ignored.
21
22       •   Each line has the form "parameter value".  value may contain spaces
23           but may not contain newlines.
24
25           There are simple parameters and compound parameters.
26
27           The name of compound parameter consist of a paragraph name and a
28           sub-parameter name separated by period (".").  However some
29           compound parameters have simple synonym names to keep compatibility
30           to earlier versions (See "Obsoleted sympa.conf parameters").
31
32           Example:
33
34             process_archive on
35             archive.web_access open
36             archive.mail_access closed
37
38   robot.conf: Optional configuration file for the mail domain
39       robot.conf is the optional configuration file for each mail domain.
40
41       Format of robot.conf is the same as sympa.conf above.
42
43   config: Configuration file for the mailing list
44       config is main configuration file of each mailing list.
45
46       Format of config is as following:
47
48       •   Lines beginning with "#" and containing only spaces are ignored.
49
50       •   There are simple parameters and compound parameters:
51
52           •   A simple parameter is expressed by single line by each.  The
53               line has the form "parameter value".  value may contain spaces
54               but may not contain newlines.
55
56               Several parameters may have multiple values.  If it's the case,
57               values may be separated by comma (",") or parameter lines may
58               be repeated.  Some of parameters must have one or more of
59               limited values.
60
61               Example:
62
63                 subject This is subject of my list
64
65                 remove_headers User-Agent,Importance
66
67                 custom_headers X-List: mylist
68                 custom_headers X-Face: %`-W7!?^]Sg'I-K>P<cdn&k:~A^{x>(]Gc{V...
69
70                 rfc2369_header_fields post,owner
71
72           •   A compound parameter is expressed by multiple lines, so-called
73               "paragraph", that consists of the first line specifying
74               paragraph name and subsequent one or more sub-parameter lines.
75               Paragraph must be separated by one or more empty lines from the
76               other parameters.
77
78               Several multiple line parameters may occur multiple times.
79
80               Example:
81
82                 archive
83                 web_access open
84                 mail_access closed
85

PARAMETERS

87       Below is entire list of configuration parameters.
88
89       •   Sub-parameters in paragraph are listed as paragraph"."sub-parameter
90           by each.
91
92       •   "Default" is built-in default value if any.  About symbols for
93           paths, such as $SENDMAIL_ALIASES, see "Directory layout
94           <https://www.sympa.community/manual/layout.html>".
95
96   Service description
97       "domain"
98
99       Primary mail domain name
100
101       Format:
102           /"[-\w]+(?:[.][-\w]+)+"/
103
104       Default:
105           None, mandatory.
106
107       Context:
108           domain (robot.conf), site (sympa.conf)
109
110       Example:
111
112         domain mail.example.org
113
114       "listmaster"
115
116       Email addresses of listmasters
117
118       Format:
119           Multiple values allowed, separated by "","".
120
121           /$email/
122
123       Default:
124           None, mandatory.
125
126       Context:
127           domain (robot.conf), site (sympa.conf)
128
129       Email addresses of the listmasters (users authorized to perform global
130       server commands). Some error reports may also be sent to these
131       addresses. Listmasters can be defined for each virtual host, however,
132       the default listmasters will have privileges to manage all virtual
133       hosts.
134
135       Example:
136
137         listmaster your_email_address@domain.tld
138
139       "supported_lang"
140
141       Supported languages
142
143       Format:
144           /"\w+(\-\w+)*"/
145
146       Default:
147           "ca,cs,de,el,en-US,es,et,eu,fi,fr,gl,hu,it,ja,ko,nb,nl,oc,pl,pt-BR,ru,sv,tr,vi,zh-CN,zh-TW"
148
149       Context:
150           domain (robot.conf), site (sympa.conf)
151
152       All supported languages for the user interface. Languages proper locale
153       information not installed are ignored.
154
155       "title"
156
157       Title of service
158
159       Format:
160           /".+"/
161
162       Default:
163           "Mailing lists service"
164
165       Context:
166           domain (robot.conf), site (sympa.conf)
167
168       The name of your mailing list service. It will appear in the header of
169       web interface and subjects of several service messages.
170
171       "gecos"
172
173       Display name of Sympa
174
175       Format:
176           /".+"/
177
178       Default:
179           "SYMPA"
180
181       Context:
182           domain (robot.conf), site (sympa.conf)
183
184       Available versions:
185           6.2a.34 and later.
186
187       This parameter is used for display name in the "From:" header field for
188       the messages sent by Sympa itself.
189
190       "legacy_character_support_feature"
191
192       Support of legacy character set
193
194       Format:
195           "on" - enabled
196           "off" - disabled
197       Default:
198           "off"
199
200       Context:
201           site (sympa.conf)
202
203       If set to "on", enables support of legacy character set according to
204       charset.conf(5) configuration file.
205
206       In some language environments, legacy encoding (character set) can be
207       preferred for e-mail messages: for example iso-2022-jp in Japanese
208       language.
209
210   Database related
211       "update_db_field_types"
212
213       Update database structure
214
215       Format:
216           "auto" - automatic
217           "off" - disabled
218       Default:
219           "auto"
220
221       Context:
222           site (sympa.conf)
223
224       auto: Updates database table structures automatically.
225
226       However, since version 5.3b.5, Sympa will not shorten field size if it
227       already have been longer than the size defined in database definition.
228
229       "db_type"
230
231       Type of the database
232
233       Format:
234           /"\w+"/
235
236       Default:
237           "mysql"
238
239       Context:
240           site (sympa.conf)
241
242       Possible types are "MySQL", "PostgreSQL", "Oracle" and "SQLite".
243
244       "db_host"
245
246       Hostname of the database server
247
248       Format:
249           /$host/
250
251       Default:
252           None.
253
254       Context:
255           site (sympa.conf)
256
257       With PostgreSQL, you can also use the path to Unix Socket Directory,
258       e.g. "/var/run/postgresql" for connection with Unix domain socket.
259
260       Example:
261
262         db_host localhost
263
264       "db_port"
265
266       Port of the database server
267
268       Format:
269           /"[-/\w]+"/
270
271       Default:
272           None.
273
274       Context:
275           site (sympa.conf)
276
277       "db_name"
278
279       Name of the database
280
281       Format:
282           /".+"/
283
284       Default:
285           "sympa"
286
287       Context:
288           site (sympa.conf)
289
290       With SQLite, this must be the full path to database file.
291
292       With Oracle Database, this must be SID, net service name or easy
293       connection identifier (to use net service name, db_host should be set
294       to "none" and HOST, PORT and SERVICE_NAME should be defined in
295       tnsnames.ora file).
296
297       "db_user"
298
299       User for the database connection
300
301       Format:
302           /".+"/
303
304       Default:
305           None.
306
307       Context:
308           site (sympa.conf)
309
310       Example:
311
312         db_user sympa
313
314       "db_passwd"
315
316       Password for the database connection
317
318       Format:
319           The value to be concealed.
320
321       Default:
322           None.
323
324       Context:
325           site (sympa.conf)
326
327       What ever you use a password or not, you must protect the SQL server
328       (is it not a public internet service ?)
329
330       Example:
331
332         db_passwd your_passwd
333
334       "db_options"
335
336       Database options
337
338       Format:
339           /".+"/
340
341       Default:
342           None.
343
344       Context:
345           site (sympa.conf)
346
347       If these options are defined, they will be appended to data source name
348       (DSN) fed to database driver. Check the related DBD documentation to
349       learn about the available options.
350
351       Example:
352
353         db_options mysql_read_default_file=/home/joe/my.cnf;mysql_socket=tmp/mysql.sock-test
354
355       "db_env"
356
357       Environment variables setting for database
358
359       Format:
360           /".+"/
361
362       Default:
363           None.
364
365       Context:
366           site (sympa.conf)
367
368       With Oracle Database, this is useful for defining ORACLE_HOME and
369       NLS_LANG.
370
371       Example:
372
373         db_env NLS_LANG=American_America.AL32UTF8;ORACLE_HOME=/u01/app/oracle/product/11.2.0/server
374
375       "db_timeout"
376
377       Database processing timeout
378
379       Format:
380           /"\d+"/
381
382       Default:
383           None.
384
385       Context:
386           site (sympa.conf)
387
388       Currently, this parameter may be used for SQLite only.
389
390       "db_additional_subscriber_fields"
391
392       Database private extension to subscriber table
393
394       Format:
395           Multiple values allowed, separated by "","".
396
397           /".+"/
398
399       Default:
400           None.
401
402       Context:
403           site (sympa.conf)
404
405       Adds more fields to "subscriber_table" table. Sympa recognizes fields
406       defined with this parameter. You will then be able to use them from
407       within templates and scenarios:
408
409       * for scenarios: [subscriber->field]
410
411       * for templates: [% subscriber.field %]
412
413       These fields will also appear in the list members review page and will
414       be editable by the list owner. This parameter is a comma-separated
415       list.
416
417       You need to extend the database format with these fields
418
419       Example:
420
421         db_additional_subscriber_fields billing_delay,subscription_expiration
422
423       "db_additional_user_fields"
424
425       Database private extension to user table
426
427       Format:
428           Multiple values allowed, separated by "","".
429
430           /".+"/
431
432       Default:
433           None.
434
435       Context:
436           site (sympa.conf)
437
438       Adds more fields to "user_table" table. Sympa recognizes fields defined
439       with this parameter. You will then be able to use them from within
440       templates: [% subscriber.field %]
441
442       This parameter is a comma-separated list.
443
444       You need to extend the database format with these fields
445
446       Example:
447
448         db_additional_user_fields age,address
449
450   System log
451       "syslog"
452
453       System log facility for Sympa
454
455       Format:
456           /"\S+"/
457
458       Default:
459           "LOCAL1"
460
461       Context:
462           site (sympa.conf)
463
464       Do not forget to configure syslog server.
465
466       "log_socket_type"
467
468       Communication mode with syslog server
469
470       Format:
471           /"\w+"/
472
473       Default:
474           "unix"
475
476       Context:
477           site (sympa.conf)
478
479       "log_level"
480
481       Log verbosity
482
483       Format:
484           /"\d+"/
485
486       Default:
487           0
488
489       Context:
490           domain (robot.conf), site (sympa.conf)
491
492       Sets the verbosity of logs.
493
494       0: Only main operations are logged
495
496       3: Almost everything is logged.
497
498       Example:
499
500         log_level 2
501
502   Mail server
503       "sendmail"
504
505       Path to sendmail
506
507       Format:
508           /".+"/
509
510       Default:
511           "/usr/sbin/sendmail"
512
513       Context:
514           site (sympa.conf)
515
516       Absolute path to sendmail command line utility (e.g.: a binary named
517       "sendmail" is distributed with Postfix).
518
519       Sympa expects this binary to be sendmail compatible (exim, Postfix,
520       qmail and so on provide it).
521
522       "sendmail_args"
523
524       Command line parameters passed to sendmail
525
526       Format:
527           /".+"/
528
529       Default:
530           "-oi -odi -oem"
531
532       Context:
533           site (sympa.conf)
534
535       Note that "-f", "-N" and "-V" options and recipient addresses should
536       not be included, because they will be included by Sympa.
537
538       "sendmail_aliases"
539
540       Path of the file that contains all list related aliases
541
542       Format:
543           /".+"/
544
545       Default:
546           $SENDMAIL_ALIASES
547
548       Context:
549           domain (robot.conf), site (sympa.conf)
550
551       It is recommended to create a specific alias file so that Sympa never
552       overwrites the standard alias file, but only a dedicated file.
553
554       Set this parameter to "none" if you want to disable alias management in
555       Sympa.
556
557       "aliases_program"
558
559       Program used to update alias database
560
561       Format:
562           /"makemap|newaliases|postalias|postmap|/.+|none"/
563
564       Default:
565           "newaliases"
566
567       Context:
568           domain (robot.conf), site (sympa.conf)
569
570       This may be "makemap", "newaliases", "postalias", "postmap" or full
571       path to custom program.
572
573       "aliases_wrapper"
574
575       Whether to use the alias wrapper
576
577       Format:
578           "off" - disabled
579           "on" - enabled
580       Default:
581           "on"
582
583       Context:
584           domain (robot.conf), site (sympa.conf)
585
586       Available versions:
587           6.2.59b.1 and later.
588
589       If the program to update alias database does not require root
590       privileges, set this parameter to "off" and remove the wrapper file
591       sympa_newaliases-wrapper.
592
593       "aliases_db_type"
594
595       Type of alias database
596
597       Format:
598           /"\w[-\w]*"/
599
600       Default:
601           "hash"
602
603       Context:
604           domain (robot.conf), site (sympa.conf)
605
606       "btree", "dbm", "hash" and so on.  Available when aliases_program is
607       "makemap", "postalias" or "postmap"
608
609       "alias_manager"
610
611       Path to alias manager
612
613       Format:
614           /".+"/
615
616       Default:
617           "$SBINDIR/alias_manager.pl"
618
619       Context:
620           site (sympa.conf)
621
622       The absolute path to the script that will add/remove mail aliases
623
624       Example:
625
626         alias_manager /usr/local/libexec/ldap_alias_manager.pl
627
628   List definition
629       "subject"
630
631       Subject of the list
632
633       Format:
634           /".+"/
635
636       Default:
637           None, mandatory.
638
639       Context:
640           list (config)
641
642       This parameter indicates the subject of the list, which is sent in
643       response to the LISTS mail command. The subject is a free form text
644       limited to one line.
645
646       "visibility"
647
648       Visibility of the list
649
650       Format:
651           Name of "visibility" scenario:
652
653           "conceal" - conceal except for subscribers
654           "noconceal" - no conceal
655           "secret" - conceal even for subscribers
656       Default:
657           "conceal"
658
659       Context:
660           list (config), domain (robot.conf), site (sympa.conf)
661
662       This parameter indicates whether the list should feature in the output
663       generated in response to a LISTS command or should be shown in the list
664       overview of the web-interface.
665
666       "topics"
667
668       Topics for the list
669
670       Format:
671           Multiple values allowed, separated by "","".
672
673           List topic.
674
675       Default:
676           None.
677
678       Context:
679           list (config)
680
681       This parameter allows the classification of lists. You may define
682       multiple topics as well as hierarchical ones. WWSympa's list of public
683       lists uses this parameter.
684
685       "lang"
686
687       Language of the list
688
689       Format:
690           Language tag.
691
692       Default:
693           "en-US"
694
695       Context:
696           list (config), domain (robot.conf), site (sympa.conf)
697
698       This parameter defines the language used for the list. It is used to
699       initialize a user's language preference; Sympa command reports are
700       extracted from the associated message catalog.
701
702       "family_name"
703
704       Family name
705
706       Format:
707           /$family_name/
708
709       Default:
710           None.
711
712       Context:
713           list (config)
714
715       "max_list_members"
716
717       Maximum number of list members
718
719       Format:
720           Number of list members.
721
722       Default:
723           0 (list members)
724
725       Context:
726           list (config), domain (robot.conf), site (sympa.conf)
727
728       Available versions:
729           6.2a.5 and later.
730
731       limit for the number of subscribers. 0 means no limit.
732
733       "priority"
734
735       Priority
736
737       Format:
738           0 - 0 - highest priority
739           1 - 1
740           2 - 2
741           3 - 3
742           4 - 4
743           5 - 5
744           6 - 6
745           7 - 7
746           8 - 8
747           9 - 9 - lowest priority
748           "z" - queue messages only
749       Default:
750           5
751
752       Context:
753           list (config), domain (robot.conf), site (sympa.conf)
754
755       The priority with which Sympa will process messages for this list. This
756       level of priority is applied while the message is going through the
757       spool. The z priority will freeze the message in the spool.
758
759   Receiving
760       "sender_headers"
761
762       Header field name(s) used to determine sender of the messages
763
764       Format:
765           Any.
766
767       Default:
768           "From"
769
770       Context:
771           site (sympa.conf)
772
773       "Return-Path" means envelope sender (a.k.a. "UNIX From") which will be
774       alternative to sender of messages without "From" field.  "Resent-From"
775       may also be inserted before "From", because some mailers add it into
776       redirected messages and keep original "From" field intact.  In
777       particular cases, "Return-Path" can not give right sender: Several mail
778       gateway products rewrite envelope sender and add original one as non-
779       standard field such as "X-Envelope-From".  If that is the case, you
780       might want to insert it in place of "Return-Path".
781
782       Example:
783
784         sender_headers Resent-From,From,Return-Path
785
786       "misaddressed_commands"
787
788       Reject misaddressed commands
789
790       Format:
791           Any.
792
793       Default:
794           "reject"
795
796       Context:
797           site (sympa.conf)
798
799       When a mail command is sent to a list, by default Sympa rejects this
800       message. This feature can be turned off by setting this parameter to
801       "ignore".
802
803       "misaddressed_commands_regexp"
804
805       Regular expression matching with misaddressed commands
806
807       Format:
808           Any.
809
810       Default:
811           "((subscribe\s+(\S+)|unsubscribe\s+(\S+)|signoff\s+(\S+)|set\s+(\S+)\s+(mail|nomail|digest))\s*)"
812
813       Context:
814           site (sympa.conf)
815
816       Perl regular expression applied on messages subject and body to detect
817       misaddressed commands.
818
819       "sympa_priority"
820
821       Priority for command messages
822
823       Format:
824           0 - 0 - highest priority
825           1 - 1
826           2 - 2
827           3 - 3
828           4 - 4
829           5 - 5
830           6 - 6
831           7 - 7
832           8 - 8
833           9 - 9 - lowest priority
834           "z" - queue messages only
835       Default:
836           1
837
838       Context:
839           domain (robot.conf), site (sympa.conf)
840
841       Priority applied to messages sent to Sympa command address.
842
843       "request_priority"
844
845       Priority for messages bound for list owners
846
847       Format:
848           0 - 0 - highest priority
849           1 - 1
850           2 - 2
851           3 - 3
852           4 - 4
853           5 - 5
854           6 - 6
855           7 - 7
856           8 - 8
857           9 - 9 - lowest priority
858           "z" - queue messages only
859       Default:
860           0
861
862       Context:
863           domain (robot.conf), site (sympa.conf)
864
865       Priority for processing of messages bound for "LIST-request" address,
866       i.e. owners of the list
867
868       "owner_priority"
869
870       Priority for non-VERP bounces
871
872       Format:
873           0 - 0 - highest priority
874           1 - 1
875           2 - 2
876           3 - 3
877           4 - 4
878           5 - 5
879           6 - 6
880           7 - 7
881           8 - 8
882           9 - 9 - lowest priority
883           "z" - queue messages only
884       Default:
885           9
886
887       Context:
888           domain (robot.conf), site (sympa.conf)
889
890       Priority for processing of messages bound for "LIST-owner" address,
891       i.e. non-delivery reports (bounces).
892
893       "incoming_max_count"
894
895       Max number of sympa_msg.pl workers
896
897       Format:
898           /"\d+"/
899
900       Default:
901           1
902
903       Context:
904           site (sympa.conf)
905
906       Available versions:
907           6.2b.5 and later.
908
909       Max number of workers of sympa_msg.pl daemon processing incoming spool.
910
911       "sleep"
912
913       Interval between scanning incoming message spool
914
915       Format:
916           Number of seconds.
917
918       Default:
919           5 (seconds)
920
921       Context:
922           site (sympa.conf)
923
924       Must not be 0.
925
926   Sending/receiving setup
927       "send"
928
929       Who can send messages
930
931       Format:
932           Name of "send" scenario:
933
934           "closed" - closed
935           "confidential" - restricted to subscribers, messages from others
936           are discarded
937           "editordkim" - Moderated, no authentication needed if DKIM
938           signature from moderator is OK
939           "editorkey" - Moderated
940           "editorkeyonly" - Moderated, even for moderators
941           "editorkeyonlyauth" - Moderated, need authentication from moderator
942           "newsletter" - Newsletter, restricted to moderators
943           "newsletterkeyonly" - Newsletter, restricted to moderators after
944           confirmation
945           "owner" - Restricted to list owners only
946           "ownerauth" - Restricted to list owners with previous MD5
947           authentication
948           "private" - restricted to subscribers
949           "private_smime" - restricted to subscribers and checked smime
950           signature
951           "privateandeditorkey" - Moderated, restricted to subscribers
952           "privateandnomultipartoreditorkey" - Moderated, for non subscribers
953           sending multipart messages
954           "privatekey" - restricted to subscribers with previous md5
955           authentication
956           "privatekeyandeditorkeyonly" - Moderated, for subscribers and even
957           moderators themself
958           "privateoreditorkey" - Private, moderated for non subscribers
959           "privateorpublickey" - Private, confirmation for non subscribers
960           "public" - public list
961           "public_nobcc" - public list, Bcc rejected (anti-spam)
962           "publickey" - anyone no authentication if DKIM signature is OK
963           "publicnoattachment" - public list multipart/mixed messages are
964           forwarded to moderator
965           "publicnomultipart" - public list multipart messages are rejected
966       Default:
967           "private"
968
969       Context:
970           list (config), domain (robot.conf), site (sympa.conf)
971
972       This parameter specifies who can send messages to the list.
973
974       "delivery_time"
975
976       Delivery time (hh:mm)
977
978       Format:
979           /"[0-2]?\d\:[0-6]\d"/
980
981       Default:
982           None.
983
984       Context:
985           list (config)
986
987       If this parameter is present, non-digest messages will be delivered to
988       subscribers at this time: When this time has been past, delivery is
989       postponed to the same time in next day.
990
991       "digest"
992
993       (Paragraph) Digest frequency
994
995       Single occurrence
996
997       Definition of digest mode. If this parameter is present, subscribers
998       can select the option of receiving messages in multipart/digest MIME
999       format, or as a plain text digest. Messages are then grouped together,
1000       and compiled messages are sent to subscribers according to the
1001       frequency selected with this parameter.
1002
1003       "digest.days"
1004
1005       days
1006
1007       Format:
1008           Multiple occurrences allowed.
1009
1010           Day of week, 0 - 6.
1011
1012       Default:
1013           None, mandatory.
1014
1015       Context:
1016           list (config)
1017
1018       "digest.hour"
1019
1020       hour
1021
1022       Format:
1023           /"\d+"/
1024
1025       Default:
1026           None, mandatory.
1027
1028       Context:
1029           list (config)
1030
1031       "digest.minute"
1032
1033       minute
1034
1035       Format:
1036           /"\d+"/
1037
1038       Default:
1039           None, mandatory.
1040
1041       Context:
1042           list (config)
1043
1044       "digest_max_size"
1045
1046       Digest maximum number of messages
1047
1048       Format:
1049           Number of messages.
1050
1051       Default:
1052           25 (messages)
1053
1054       Context:
1055           list (config)
1056
1057       "available_user_options"
1058
1059       (Paragraph) Available subscription options
1060
1061       Single occurrence
1062
1063       "available_user_options.reception"
1064
1065       reception mode
1066
1067       Format:
1068           Multiple values allowed, separated by "","".
1069
1070           Reception mode of list member.
1071
1072       Default:
1073           "mail,notice,digest,digestplain,summary,nomail,txt,urlize,not_me"
1074
1075       Context:
1076           list (config)
1077
1078       Only these modes will be allowed for the subscribers of this list. If a
1079       subscriber has a reception mode not in the list, Sympa uses the mode
1080       specified in the default_user_options paragraph.
1081
1082       "default_user_options"
1083
1084       (Paragraph) Subscription profile
1085
1086       Single occurrence
1087
1088       Default profile for the subscribers of the list.
1089
1090       "default_user_options.reception"
1091
1092       reception mode
1093
1094       Format:
1095           Reception mode of list member.
1096
1097       Default:
1098           "mail"
1099
1100       Context:
1101           list (config)
1102
1103       Mail reception mode.
1104
1105       "default_user_options.visibility"
1106
1107       visibility
1108
1109       Format:
1110           Visibility mode of list memeber.
1111
1112       Default:
1113           "noconceal"
1114
1115       Context:
1116           list (config)
1117
1118       Visibility of the subscriber.
1119
1120       "msg_topic"
1121
1122       (Paragraph) Topics for message categorization
1123
1124       Multiple occurrences allowed
1125
1126       This paragraph defines a topic used to tag a message of a list, named
1127       by msg_topic.name ("other" is a reserved word), its title is
1128       msg_topic.title. The msg_topic.keywords entry is optional and allows
1129       automatic tagging. This should be a list of keywords, separated by ','.
1130
1131       "msg_topic.name"
1132
1133       Message topic name
1134
1135       Format:
1136           /"[\-\w]+"/
1137
1138       Default:
1139           None, mandatory.
1140
1141       Context:
1142           list (config)
1143
1144       "msg_topic.keywords"
1145
1146       Message topic keywords
1147
1148       Format:
1149           /"[^,\n]+(,[^,\n]+)*"/
1150
1151       Default:
1152           None.
1153
1154       Context:
1155           list (config)
1156
1157       "msg_topic.title"
1158
1159       Message topic title
1160
1161       Format:
1162           /".+"/
1163
1164       Default:
1165           None, mandatory.
1166
1167       Context:
1168           list (config)
1169
1170       "msg_topic_keywords_apply_on"
1171
1172       Defines to which part of messages topic keywords are applied
1173
1174       Format:
1175           "subject" - subject field
1176           "body" - message body
1177           "subject_and_body" - subject and body
1178       Default:
1179           "subject"
1180
1181       Context:
1182           list (config)
1183
1184       This parameter indicates which part of the message is used to perform
1185       automatic tagging.
1186
1187       "msg_topic_tagging"
1188
1189       Message tagging
1190
1191       Format:
1192           "required_sender" - required to post message
1193           "required_moderator" - required to distribute message
1194           "optional" - optional
1195       Default:
1196           "optional"
1197
1198       Context:
1199           list (config)
1200
1201       This parameter indicates if the tagging is optional or required for a
1202       list.
1203
1204       "reply_to_header"
1205
1206       (Paragraph) Reply address
1207
1208       Single occurrence
1209
1210       This defines what Sympa will place in the Reply-To: SMTP header field
1211       of the messages it distributes.
1212
1213       "reply_to_header.value"
1214
1215       value
1216
1217       Format:
1218           "sender" - sender
1219           "list" - list
1220           "all" - all
1221           "other_email" - other email address
1222       Default:
1223           "sender"
1224
1225       Context:
1226           list (config)
1227
1228       This parameter indicates whether the Reply-To: field should indicate
1229       the sender of the message (sender), the list itself (list), both list
1230       and sender (all) or an arbitrary e-mail address (defined by the
1231       other_email parameter).
1232
1233       Note: it is inadvisable to change this parameter, and particularly
1234       inadvisable to set it to list. Experience has shown it to be almost
1235       inevitable that users, mistakenly believing that they are replying only
1236       to the sender, will send private messages to a list. This can lead, at
1237       the very least, to embarrassment, and sometimes to more serious
1238       consequences.
1239
1240       "reply_to_header.other_email"
1241
1242       other email address
1243
1244       Format:
1245           /$email/
1246
1247       Default:
1248           None.
1249
1250       Context:
1251           list (config)
1252
1253       If value was set to other_email, this parameter defines the e-mail
1254       address used.
1255
1256       "reply_to_header.apply"
1257
1258       respect of existing header field
1259
1260       Format:
1261           "forced" - overwrite Reply-To: header field
1262           "respect" - preserve existing header field
1263       Default:
1264           "respect"
1265
1266       Context:
1267           list (config)
1268
1269       The default is to respect (preserve) the existing Reply-To: SMTP header
1270       field in incoming messages. If set to forced, Reply-To: SMTP header
1271       field will be overwritten.
1272
1273       "anonymous_sender"
1274
1275       Anonymous sender
1276
1277       Format:
1278           /".+"/
1279
1280       Default:
1281           None.
1282
1283       Context:
1284           list (config)
1285
1286       To hide the sender's email address before distributing the message. It
1287       is replaced by the provided email address.
1288
1289       "anonymous_header_fields"
1290
1291       Header fields removed when a mailing list is setup in anonymous mode
1292
1293       Format:
1294           Any.
1295
1296       Default:
1297           "Authentication-Results,Disposition-Notification-To,DKIM-Signature,Fax,Injection-Info,Mailer,Organisation,Organization,Original-Recipient,Originating-Client,Originator,Path,Phone,Received,Received-SPF,Reply-To,Resent-Reply-To,Return-Receipt-To,Telefax,User-Agent,X-Envelope-From,X-Envelope-To,X-Face,X-Mailer,X-MimeOLE,X-Newsreader,X-Sender,X-X-Sender"
1298
1299       Context:
1300           site (sympa.conf)
1301
1302       See "anonymous_sender" list parameter.
1303
1304       Default value prior to Sympa 6.1.19 is:
1305
1306         Sender,X-Sender,Received,Message-id,From,X-Envelope-To,Resent-From,Reply-To,Organization,Disposition-Notification-To,X-Envelope-From,X-X-Sender
1307
1308       "custom_header"
1309
1310       Custom header field
1311
1312       Format:
1313           Multiple occurrences allowed.
1314
1315           /"\S+:\s+.*"/
1316
1317       Default:
1318           None.
1319
1320       Context:
1321           list (config)
1322
1323       This parameter is optional. The headers specified will be added to the
1324       headers of messages distributed via the list. As of release 1.2.2 of
1325       Sympa, it is possible to put several custom header lines in the
1326       configuration file at the same time.
1327
1328       "custom_subject"
1329
1330       Subject tagging
1331
1332       Format:
1333           /".+"/
1334
1335       Default:
1336           None.
1337
1338       Context:
1339           list (config)
1340
1341       This parameter is optional. It specifies a string which is added to the
1342       subject of distributed messages (intended to help users who do not use
1343       automatic tools to sort incoming messages). This string will be
1344       surrounded by [] characters.
1345
1346       "footer_type"
1347
1348       Attachment type
1349
1350       Format:
1351           "mime" - add a new MIME part
1352           "append" - append to message body
1353       Default:
1354           "mime"
1355
1356       Context:
1357           list (config)
1358
1359       List owners may decide to add message headers or footers to messages
1360       sent via the list. This parameter defines the way a footer/header is
1361       added to a message.
1362
1363       mime:
1364
1365       The default value. Sympa will add the footer/header as a new MIME part.
1366
1367       append:
1368
1369       Sympa will not create new MIME parts, but will try to append the
1370       header/footer to the body of the message. Predefined message-footers
1371       will be ignored.
1372
1373       "max_size"
1374
1375       Maximum message size
1376
1377       Format:
1378           Number of bytes.
1379
1380       Default:
1381           5242880 (bytes)
1382
1383       Context:
1384           list (config), domain (robot.conf), host
1385
1386       Maximum size of a message in 8-bit bytes.
1387
1388       Example:
1389
1390         max_size 2097152
1391
1392       "personalization_feature"
1393
1394       Allow message personalization
1395
1396       Format:
1397           "on" - enabled
1398           "off" - disabled
1399       Default:
1400           "off"
1401
1402       Context:
1403           list (config), domain (robot.conf), site (sympa.conf)
1404
1405       Available versions:
1406           6.2.59b.2 and later.
1407
1408       "personalization"
1409
1410       (Paragraph) Message personalization
1411
1412       Single occurrence
1413
1414       "personalization.web_apply_on"
1415
1416       Scope for messages from the web interface
1417
1418       Format:
1419           "none" - do nothing
1420           "footer" - header and footer
1421           "all" - all
1422       Default:
1423           "footer"
1424
1425       Context:
1426           list (config), domain (robot.conf), site (sympa.conf)
1427
1428       "personalization.mail_apply_on"
1429
1430       Scope for messages from incoming email
1431
1432       Format:
1433           "none" - do nothing
1434           "footer" - header and footer
1435           "all" - all
1436       Default:
1437           "none"
1438
1439       Context:
1440           list (config), domain (robot.conf), site (sympa.conf)
1441
1442       "message_hook"
1443
1444       (Paragraph) Hook modules for message processing
1445
1446       Single occurrence
1447
1448       "message_hook.pre_distribute"
1449
1450       A hook on the messages before distribution
1451
1452       Format:
1453           /"(::|\w)+"/
1454
1455       Default:
1456           None.
1457
1458       Context:
1459           list (config)
1460
1461       "message_hook.post_archive"
1462
1463       A hook on the messages just after archiving
1464
1465       Format:
1466           /"(::|\w)+"/
1467
1468       Default:
1469           None.
1470
1471       Context:
1472           list (config)
1473
1474       "reject_mail_from_automates_feature"
1475
1476       Reject mail from automatic processes (crontab, etc)?
1477
1478       Format:
1479           "on" - enabled
1480           "off" - disabled
1481       Default:
1482           "on"
1483
1484       Context:
1485           list (config), site (sympa.conf)
1486
1487       Available versions:
1488           6.2a.0 and later.
1489
1490       Rejects messages that seem to be from automated services, based on a
1491       few header fields ("Content-Identifier:", "Auto-Submitted:").
1492
1493       Sympa also can be configured to reject messages based on the "From:"
1494       header field value (see "loop_prevention_regex").
1495
1496       "remove_headers"
1497
1498       Header fields to be removed from incoming messages
1499
1500       Format:
1501           Multiple values allowed, separated by "","".
1502
1503           /"\S+"/
1504
1505       Default:
1506           "X-Sympa-To,X-Family-To,Return-Receipt-To,Precedence,X-Sequence,Disposition-Notification-To,Sender"
1507
1508       Context:
1509           list (config), site (sympa.conf)
1510
1511       Use it, for example, to ensure some privacy for your users in case that
1512       "anonymous_sender" mode is inappropriate.
1513
1514       The removal of these header fields is applied before Sympa adds its own
1515       header fields ("rfc2369_header_fields" and "custom_header").
1516
1517       Example:
1518
1519         remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To
1520
1521       "remove_outgoing_headers"
1522
1523       Header fields to be removed before message distribution
1524
1525       Format:
1526           Multiple values allowed, separated by "","".
1527
1528           /"\S+"/
1529
1530       Default:
1531           "none"
1532
1533       Context:
1534           list (config), site (sympa.conf)
1535
1536       The removal happens after Sympa's own header fields are added;
1537       therefore, it is a convenient way to remove Sympa's own header fields
1538       (like "X-Loop:" or "X-no-archive:") if you wish.
1539
1540       Example:
1541
1542         remove_outgoing_headers X-no-archive
1543
1544       "rfc2369_header_fields"
1545
1546       RFC 2369 header fields
1547
1548       Format:
1549           Multiple values allowed, separated by "","".
1550
1551           "help" - help
1552           "subscribe" - subscription
1553           "unsubscribe" - unsubscription
1554           "post" - posting address
1555           "owner" - owner
1556           "archive" - list archive
1557       Default:
1558           "help,subscribe,unsubscribe,post,owner,archive"
1559
1560       Context:
1561           list (config), site (sympa.conf)
1562
1563       Specify which RFC 2369 mailing list header fields to be added.
1564
1565       "List-Id:" header field defined in RFC 2919 is always added. Sympa also
1566       adds "Archived-At:" header field defined in RFC 5064.
1567
1568   Distribution
1569       "urlize_min_size"
1570
1571       Minimum size to be urlized
1572
1573       Format:
1574           Number of bytes.
1575
1576       Default:
1577           10240 (bytes)
1578
1579       Context:
1580           domain (robot.conf), site (sympa.conf)
1581
1582       When a subscriber chose "urlize" reception mode, attachments not
1583       smaller than this size will be urlized.
1584
1585       "allowed_external_origin"
1586
1587       Allowed external links in sanitized HTML
1588
1589       Format:
1590           /"[-\w*]+(?:[.][-\w*]+)+"/
1591
1592       Default:
1593           None.
1594
1595       Context:
1596           domain (robot.conf), site (sympa.conf)
1597
1598       Available versions:
1599           6.2.19b.2 and later.
1600
1601       When the HTML content of a message must be sanitized, links ("href" or
1602       "src" attributes) with the hosts listed in this parameter will not be
1603       scrubbed. If "*" character is included, it matches any subdomains.
1604       Single "*" allows any hosts.
1605
1606       Example:
1607
1608         allowed_external_origin *.example.org,www.example.com
1609
1610       "sympa_packet_priority"
1611
1612       Default priority for a packet
1613
1614       Format:
1615           0 - 0 - highest priority
1616           1 - 1
1617           2 - 2
1618           3 - 3
1619           4 - 4
1620           5 - 5
1621           6 - 6
1622           7 - 7
1623           8 - 8
1624           9 - 9 - lowest priority
1625           "z" - queue messages only
1626       Default:
1627           5
1628
1629       Context:
1630           domain (robot.conf), site (sympa.conf)
1631
1632       The default priority set to a packet to be sent by the bulk.
1633
1634       "bulk_fork_threshold"
1635
1636       Fork threshold of bulk daemon
1637
1638       Format:
1639           /"\d+"/
1640
1641       Default:
1642           1
1643
1644       Context:
1645           site (sympa.conf)
1646
1647       The minimum number of packets before bulk daemon forks a new worker to
1648       increase sending rate.
1649
1650       "bulk_max_count"
1651
1652       Maximum number of bulk workers
1653
1654       Format:
1655           /"\d+"/
1656
1657       Default:
1658           3
1659
1660       Context:
1661           site (sympa.conf)
1662
1663       "bulk_lazytime"
1664
1665       Idle timeout of bulk workers
1666
1667       Format:
1668           Number of seconds.
1669
1670       Default:
1671           600 (seconds)
1672
1673       Context:
1674           site (sympa.conf)
1675
1676       The number of seconds a bulk worker will remain running without
1677       processing a message before it spontaneously exits.
1678
1679       "bulk_sleep"
1680
1681       Sleep time of bulk workers
1682
1683       Format:
1684           Number of seconds.
1685
1686       Default:
1687           1 (seconds)
1688
1689       Context:
1690           site (sympa.conf)
1691
1692       The number of seconds a bulk worker sleeps between starting a new loop
1693       if it didn't find a message to send.
1694
1695       Keep it small if you want your server to be reactive.
1696
1697       "bulk_wait_to_fork"
1698
1699       Interval between checks of packet numbers
1700
1701       Format:
1702           Number of seconds.
1703
1704       Default:
1705           10 (seconds)
1706
1707       Context:
1708           site (sympa.conf)
1709
1710       Number of seconds a master bulk daemon waits between two packets number
1711       checks.
1712
1713       Keep it small if you expect brutal increases in the message sending
1714       load.
1715
1716       "log_smtp"
1717
1718       Log invocation of sendmail
1719
1720       Format:
1721           "on" - enabled
1722           "off" - disabled
1723       Default:
1724           "off"
1725
1726       Context:
1727           domain (robot.conf), site (sympa.conf)
1728
1729       This can be overwritten by "-m" option for sympa.pl.
1730
1731       "maxsmtp"
1732
1733       Maximum number of sendmail processes
1734
1735       Format:
1736           /"\d+"/
1737
1738       Default:
1739           40
1740
1741       Context:
1742           site (sympa.conf)
1743
1744       Maximum number of simultaneous child processes spawned by Sympa. This
1745       is the main load control parameter.
1746
1747       Proposed value is quite low, but you can rise it up to 100, 200 or even
1748       300 with powerful systems.
1749
1750       Example:
1751
1752         maxsmtp 500
1753
1754       "nrcpt"
1755
1756       Maximum number of recipients per call to sendmail
1757
1758       Format:
1759           /"\d+"/
1760
1761       Default:
1762           25
1763
1764       Context:
1765           site (sympa.conf)
1766
1767       This grouping factor makes it possible for the sendmail processes to
1768       optimize the number of SMTP sessions for message distribution. If
1769       needed, you can limit the number of recipients for a particular domain.
1770       Check the "nrcpt_by_domain.conf" configuration file.
1771
1772       "avg"
1773
1774       Maximum number of different mail domains per call to sendmail
1775
1776       Format:
1777           /"\d+"/
1778
1779       Default:
1780           10
1781
1782       Context:
1783           site (sympa.conf)
1784
1785   Privileges
1786       "create_list"
1787
1788       Who is able to create lists
1789
1790       Format:
1791           Name of "create_list" scenario:
1792
1793           "listmaster" - restricted to listmaster
1794           "public_listmaster" - anybody by validation by listmaster required
1795       Default:
1796           "public_listmaster"
1797
1798       Context:
1799           domain (robot.conf), site (sympa.conf)
1800
1801       Defines who can create lists (or request list creation) by creating new
1802       lists or by renaming or copying existing lists.
1803
1804       Example:
1805
1806         create_list listmaster
1807
1808       "allow_subscribe_if_pending"
1809
1810       Allow adding subscribers to a list not open
1811
1812       Format:
1813           "on" - enabled
1814           "off" - disabled
1815       Default:
1816           "on"
1817
1818       Context:
1819           domain (robot.conf), site (sympa.conf)
1820
1821       If set to "off", adding subscribers to, or removing subscribers from a
1822       list with status other than "open" is forbidden.
1823
1824       "global_remind"
1825
1826       Who is able to send remind messages over all lists
1827
1828       Format:
1829           Name of "global_remind" scenario:
1830
1831           "listmaster" - only for listmaster
1832       Default:
1833           "listmaster"
1834
1835       Context:
1836           site (sympa.conf)
1837
1838       "move_user"
1839
1840       Who is able to change user's email
1841
1842       Format:
1843           Name of "move_user" scenario:
1844
1845           "auth" - need authentication
1846           "closed" - impossible
1847           "listmaster" - listmaster only
1848       Default:
1849           "auth"
1850
1851       Context:
1852           domain (robot.conf), site (sympa.conf)
1853
1854       Available versions:
1855           6.2.19b.1 and later.
1856
1857       "use_blocklist"
1858
1859       Use blocklist
1860
1861       Format:
1862           /"[-.\w]+"/
1863
1864       Default:
1865           "send,create_list"
1866
1867       Context:
1868           domain (robot.conf), site (sympa.conf)
1869
1870       Available versions:
1871           6.2.61b.1 and later.
1872
1873       List of operations separated by comma for which blocklist filter is
1874       applied.  Setting this parameter to "none" will hide the blocklist
1875       feature.
1876
1877       "info"
1878
1879       Who can view list information
1880
1881       Format:
1882           Name of "info" scenario:
1883
1884           "conceal" - restricted to subscribers - Silent rejection otherwise.
1885           "open" - for anyone
1886           "private" - restricted to subscribers
1887       Default:
1888           "open"
1889
1890       Context:
1891           list (config), domain (robot.conf), site (sympa.conf)
1892
1893       "subscribe"
1894
1895       Who can subscribe to the list
1896
1897       Format:
1898           Name of "subscribe" scenario:
1899
1900           "auth" - subscription request confirmed
1901           "auth_notify" - need authentication (notification is sent to
1902           owners)
1903           "auth_notifydkim" - need authentication unless DKIM signature is OK
1904           (notification is sent to owners)
1905           "auth_owner" - requires authentication then owner approval
1906           "auth_ownerdkim" - requires authentication unless DKIM signature is
1907           OK, then owner approval
1908           "authdkim" - subscription request confirmed
1909           "closed" - subscription is impossible
1910           "open" - for anyone without authentication
1911           "open_notify" - anyone, notification is sent to list owner
1912           "open_quiet" - anyone, no welcome message
1913           "owner" - owners approval
1914           "smime" - requires S/MIME signed
1915           "smimeorowner" - requires S/MIME signed or owner approval
1916       Default:
1917           "open"
1918
1919       Context:
1920           list (config), domain (robot.conf), site (sympa.conf)
1921
1922       The subscribe parameter defines the rules for subscribing to the list.
1923
1924       "add"
1925
1926       Who can add subscribers
1927
1928       Format:
1929           Name of "add" scenario:
1930
1931           "auth" - restricted to owner with authentication
1932           "authdkim" - restricted to owner without authentication if DKIM
1933           signature is OK.
1934           "closed" - add impossible
1935           "owner" - add performed by list owner does not need authentication
1936           "owner_notify" - add performed by owner does not need
1937           authentication (notification)
1938           "ownerdkim" - add performed by list owner does not need
1939           authentication if DKIM signature OK
1940       Default:
1941           "owner"
1942
1943       Context:
1944           list (config), domain (robot.conf), site (sympa.conf)
1945
1946       Privilege for adding (ADD command) a subscriber to the list
1947
1948       "unsubscribe"
1949
1950       Who can unsubscribe
1951
1952       Format:
1953           Name of "unsubscribe" scenario:
1954
1955           "auth" - need authentication
1956           "auth_notify" - authentication requested, notification sent to
1957           owner
1958           "auth_notifydkim" - authentication requested unless DKIM signature
1959           is OK, notification sent to owner
1960           "authdkim" - need authentication unless DKIM signature is OK
1961           "closed" - impossible
1962           "open" - open
1963           "open_notify" - open with mail confirmation, owner is notified
1964           "owner" - owners approval
1965       Default:
1966           "open"
1967
1968       Context:
1969           list (config), domain (robot.conf), site (sympa.conf)
1970
1971       This parameter specifies the unsubscription method for the list. Use
1972       open_notify or auth_notify to allow owner notification of each
1973       unsubscribe command.
1974
1975       "del"
1976
1977       Who can delete subscribers
1978
1979       Format:
1980           Name of "del" scenario:
1981
1982           "auth" - deletion performed only by list owners, need
1983           authentication
1984           "authdkim" - deletion performed only by list owners, need
1985           authentication unless DKIM signature is OK
1986           "closed" - remove subscriber impossible
1987           "owner" - by owner without authentication
1988           "owner_notify" - list owners, authentication not needed
1989           (notification)
1990           "ownerdkim" - by owner without authentication if DKIM signature OK
1991       Default:
1992           "owner"
1993
1994       Context:
1995           list (config), domain (robot.conf), site (sympa.conf)
1996
1997       "invite"
1998
1999       Who can invite people
2000
2001       Format:
2002           Name of "invite" scenario:
2003
2004           "closed" - closed
2005           "owner" - invite perform by list owner do not need authentication
2006           "private" - restricted to subscribers
2007           "public" - public
2008       Default:
2009           "private"
2010
2011       Context:
2012           list (config), domain (robot.conf), site (sympa.conf)
2013
2014       "remind"
2015
2016       Who can start a remind process
2017
2018       Format:
2019           Name of "remind" scenario:
2020
2021           "listmaster" - listmaster only
2022           "listmasterdkim" - listmaster only (do not require authentication
2023           if DKIM siganture is OK)
2024           "owner" - restricted to list owners
2025           "ownerdkim" - restricted to list owners (authentication is not
2026           required if a DKIM signature is OK)
2027       Default:
2028           "owner"
2029
2030       Context:
2031           list (config), domain (robot.conf), site (sympa.conf)
2032
2033       This parameter specifies who is authorized to use the remind command.
2034
2035       "review"
2036
2037       Who can review subscribers
2038
2039       Format:
2040           Name of "review" scenario:
2041
2042           "closed" - no one can review
2043           "listmaster" - listmaster only
2044           "owner" - only owner (and listmaster)
2045           "private" - restricted to subscribers
2046           "public" - anyone can do it!
2047       Default:
2048           "owner"
2049
2050       Context:
2051           list (config), domain (robot.conf), site (sympa.conf)
2052
2053       This parameter specifies who can access the list of members. Since
2054       subscriber addresses can be abused by spammers, it is strongly
2055       recommended that you only authorize owners or subscribers to access the
2056       subscriber list.
2057
2058       "owner_domain"
2059
2060       Required domains for list owners
2061
2062       Format:
2063           /"$host( +$host)*"/
2064
2065       Default:
2066           None.
2067
2068       Context:
2069           list (config), domain (robot.conf), site (sympa.conf)
2070
2071       Available versions:
2072           6.2.23b.3 and later.
2073
2074       Restrict list ownership to addresses in the specified domains. This can
2075       be used to reserve list ownership to a group of trusted users from a
2076       set of domains associated with an organization, while allowing
2077       moderators and subscribers from the Internet at large.
2078
2079       "owner_domain_min"
2080
2081       Minimum owners in required domains
2082
2083       Format:
2084           /"\d+"/
2085
2086       Default:
2087           0
2088
2089       Context:
2090           list (config), domain (robot.conf), site (sympa.conf)
2091
2092       Available versions:
2093           6.2.23b.3 and later.
2094
2095       Minimum number of owners for each list must satisfy the owner_domain
2096       restriction. The default of zero (0) means *all* list owners must
2097       match. Setting to 1 requires only one list owner to match owner_domain;
2098       all other owners can be from any domain. This setting can be used to
2099       ensure that there is always at least one known contact point for any
2100       mailing list.
2101
2102       "default_owner_options"
2103
2104       (Paragraph) Owner profile
2105
2106       Single occurrence
2107
2108       Default profile for the owners of the list.
2109
2110       "default_owner_options.profile"
2111
2112       profile
2113
2114       Format:
2115           "privileged" - privileged owner
2116           "normal" - normal owner
2117       Default:
2118           "normal"
2119
2120       Context:
2121           list (config), domain (robot.conf), site (sympa.conf)
2122
2123       "default_owner_options.reception"
2124
2125       reception mode
2126
2127       Format:
2128           "mail" - receive notification email
2129           "nomail" - no notifications
2130       Default:
2131           "mail"
2132
2133       Context:
2134           list (config), domain (robot.conf), site (sympa.conf)
2135
2136       Mail reception mode.
2137
2138       "default_owner_options.visibility"
2139
2140       visibility
2141
2142       Format:
2143           "conceal" - concealed from list menu
2144           "noconceal" - listed on the list menu
2145       Default:
2146           "noconceal"
2147
2148       Context:
2149           list (config), domain (robot.conf), site (sympa.conf)
2150
2151       Visibility of the owner.
2152
2153       "default_editor_options"
2154
2155       (Paragraph) Moderator profile
2156
2157       Single occurrence
2158
2159       Default profile for the moderators of the list.
2160
2161       "default_editor_options.reception"
2162
2163       reception mode
2164
2165       Format:
2166           "mail" - receive notification email
2167           "nomail" - no notifications
2168       Default:
2169           "mail"
2170
2171       Context:
2172           list (config), domain (robot.conf), site (sympa.conf)
2173
2174       Mail reception mode.
2175
2176       "default_editor_options.visibility"
2177
2178       visibility
2179
2180       Format:
2181           "conceal" - concealed from list menu
2182           "noconceal" - listed on the list menu
2183       Default:
2184           "noconceal"
2185
2186       Context:
2187           list (config), domain (robot.conf), site (sympa.conf)
2188
2189       Visibility of the moderator.
2190
2191       "shared_doc"
2192
2193       (Paragraph) Shared documents
2194
2195       Single occurrence
2196
2197       This paragraph defines read and edit access to the shared document
2198       repository.
2199
2200       "shared_doc.d_read"
2201
2202       Who can view
2203
2204       Format:
2205           Name of "d_read" scenario:
2206
2207           "owner" - restricted to list owners
2208           "private" - restricted to subscribers
2209           "private-https" - restricted to subscribers authenticated with user
2210           cert
2211           "public" - public documents
2212       Default:
2213           "private"
2214
2215       Context:
2216           list (config), domain (robot.conf), site (sympa.conf)
2217
2218       "shared_doc.d_edit"
2219
2220       Who can edit
2221
2222       Format:
2223           Name of "d_edit" scenario:
2224
2225           "editor" - moderated for subscribers
2226           "owner" - restricted to list owners
2227           "private" - restricted to subscribers
2228           "private-https" - restricted to subscribers authenticated with user
2229           cert
2230           "public" - public documents
2231       Default:
2232           "owner"
2233
2234       Context:
2235           list (config), domain (robot.conf), site (sympa.conf)
2236
2237       "shared_doc.quota"
2238
2239       quota
2240
2241       Format:
2242           Number of Kbytes.
2243
2244       Default:
2245           None.
2246
2247       Context:
2248           list (config), domain (robot.conf), site (sympa.conf)
2249
2250   Archives
2251       "ignore_x_no_archive_header_feature"
2252
2253       Ignore "X-no-archive:" header field
2254
2255       Format:
2256           "on" - enabled
2257           "off" - disabled
2258       Default:
2259           "off"
2260
2261       Context:
2262           site (sympa.conf)
2263
2264       Sympa's default behavior is to skip archiving of incoming messages that
2265       have an "X-no-archive:" header field set. This parameter allows one to
2266       change this behavior.
2267
2268       Example:
2269
2270         ignore_x_no_archive_header_feature on
2271
2272       "custom_archiver"
2273
2274       Custom archiver
2275
2276       Format:
2277           /".+"/
2278
2279       Default:
2280           None.
2281
2282       Context:
2283           site (sympa.conf)
2284
2285       Activates a custom archiver to use instead of MHonArc. The value of
2286       this parameter is the absolute path to the executable file.
2287
2288       Sympa invokes this file with these two arguments:
2289
2290       --list
2291
2292       The address of the list including domain part.
2293
2294       --file
2295
2296       Absolute path to the message to be archived.
2297
2298       "process_archive"
2299
2300       Store distributed messages into archive
2301
2302       Format:
2303           "on" - enabled
2304           "off" - disabled
2305       Default:
2306           "off"
2307
2308       Context:
2309           list (config), domain (robot.conf), site (sympa.conf)
2310
2311       Available versions:
2312           6.2b.1 and later.
2313
2314       If enabled, distributed messages via lists will be archived. Otherwise
2315       archiving is disabled.
2316
2317       Note that even if setting this parameter disabled, past archives will
2318       not be removed and will be accessible according to access settings by
2319       each list.
2320
2321       "archive"
2322
2323       (Paragraph) Archives
2324
2325       Single occurrence
2326
2327       Privilege for reading mail archives and frequency of archiving.
2328
2329       Defines who can access the list's web archive.
2330
2331       "archive.period"
2332
2333       Deprecated.
2334
2335       Context:
2336           list (config)
2337
2338       "archive.access"
2339
2340       Deprecated.
2341
2342       Context:
2343           list (config)
2344
2345       Available versions:
2346           up to 6.2a.43.
2347
2348       "archive.web_access"
2349
2350       access right
2351
2352       Format:
2353           Name of "archive_web_access" scenario:
2354
2355           "closed" - closed
2356           "listmaster" - listmaster
2357           "owner" - by owner
2358           "private" - subscribers only
2359           "public" - public
2360       Default:
2361           "closed"
2362
2363       Context:
2364           list (config), domain (robot.conf), site (sympa.conf)
2365
2366       Available versions:
2367           6.2b.1 and later.
2368
2369       "archive.mail_access"
2370
2371       access right by mail commands
2372
2373       Format:
2374           Name of "archive_mail_access" scenario:
2375
2376           "closed" - closed
2377           "owner" - by owner
2378           "private" - subscribers only
2379           "public" - public
2380       Default:
2381           "closed"
2382
2383       Context:
2384           list (config), domain (robot.conf), site (sympa.conf)
2385
2386       Available versions:
2387           6.2b.1 and later.
2388
2389       "archive.quota"
2390
2391       quota
2392
2393       Format:
2394           Number of Kbytes.
2395
2396       Default:
2397           None.
2398
2399       Context:
2400           list (config), site (sympa.conf)
2401
2402       Available versions:
2403           6.2b.1 and later.
2404
2405       "archive.max_month"
2406
2407       Maximum number of month archived
2408
2409       Format:
2410           Number of months.
2411
2412       Default:
2413           None.
2414
2415       Context:
2416           list (config)
2417
2418       Available versions:
2419           6.2b.1 and later.
2420
2421       "archive_crypted_msg"
2422
2423       Archive encrypted mails as cleartext
2424
2425       Format:
2426           "original" - original messages
2427           "decrypted" - decrypted messages
2428       Default:
2429           "original"
2430
2431       Context:
2432           list (config)
2433
2434       "web_archive_spam_protection"
2435
2436       Protect web archive against spam harvesters
2437
2438       Format:
2439           "cookie" - use HTTP cookie
2440           "javascript" - use JavaScript
2441           "at" - replace @ characters
2442           "concealed" - never show address
2443           "none" - do nothing
2444       Default:
2445           "cookie"
2446
2447       Context:
2448           list (config), domain (robot.conf), site (sympa.conf)
2449
2450       The same as "spam_protection", but restricted to the web archive.
2451
2452       In addition to it:
2453
2454       cookie: users must submit a small form in order to receive a cookie
2455       before browsing the web archive.
2456
2457       concealed: e-mail addresses will never be displayed.
2458
2459   Bounces
2460       "bounce"
2461
2462       (Paragraph) Bounces management
2463
2464       Single occurrence
2465
2466       "bounce.warn_rate"
2467
2468       warn rate
2469
2470       Format:
2471           Number of %.
2472
2473       Default:
2474           30 (%)
2475
2476       Context:
2477           list (config), site (sympa.conf)
2478
2479       The list owner receives a warning whenever a message is distributed and
2480       the number (percentage) of bounces exceeds this value.
2481
2482       "bounce.halt_rate"
2483
2484       Deprecated.
2485
2486       Context:
2487           list (config), site (sympa.conf)
2488
2489       "bouncers_level1"
2490
2491       (Paragraph) Management of bouncers, 1st level
2492
2493       Single occurrence
2494
2495       Level 1 is the lower level of bouncing users
2496
2497       "bouncers_level1.rate"
2498
2499       threshold
2500
2501       Format:
2502           Number of points.
2503
2504       Default:
2505           45 (points)
2506
2507       Context:
2508           list (config), domain (robot.conf), site (sympa.conf)
2509
2510       Each bouncing user have a score (from 0 to 100).
2511
2512       This parameter defines a lower limit for each category of bouncing
2513       users.For example, level 1 begins from 45 to level_2_treshold.
2514
2515       "bouncers_level1.action"
2516
2517       action for this population
2518
2519       Format:
2520           "remove_bouncers" - remove bouncing users
2521           "notify_bouncers" - send notify to bouncing users
2522           "none" - do nothing
2523       Default:
2524           "notify_bouncers"
2525
2526       Context:
2527           list (config)
2528
2529       This parameter defines which task is automatically applied on level 1
2530       bouncers.
2531
2532       "bouncers_level1.notification"
2533
2534       notification
2535
2536       Format:
2537           "none" - do nothing
2538           "owner" - owner
2539           "listmaster" - listmaster
2540       Default:
2541           "owner"
2542
2543       Context:
2544           list (config)
2545
2546       When automatic task is executed on level 1 bouncers, a notification
2547       email can be send to listowner or listmaster.
2548
2549       "bouncers_level2"
2550
2551       (Paragraph) Management of bouncers, 2nd level
2552
2553       Single occurrence
2554
2555       Level 2 is the highest level of bouncing users
2556
2557       "bouncers_level2.rate"
2558
2559       threshold
2560
2561       Format:
2562           Number of points.
2563
2564       Default:
2565           75 (points)
2566
2567       Context:
2568           list (config), domain (robot.conf), site (sympa.conf)
2569
2570       Each bouncing user have a score (from 0 to 100).
2571
2572       This parameter defines the score range defining each category of
2573       bouncing users.For example, level 2 is for users with a score between
2574       80 and 100.
2575
2576       "bouncers_level2.action"
2577
2578       action for this population
2579
2580       Format:
2581           "remove_bouncers" - remove bouncing users
2582           "notify_bouncers" - send notify to bouncing users
2583           "none" - do nothing
2584       Default:
2585           "remove_bouncers"
2586
2587       Context:
2588           list (config)
2589
2590       This parameter defines which task is automatically applied on level 2
2591       bouncers.
2592
2593       "bouncers_level2.notification"
2594
2595       notification
2596
2597       Format:
2598           "none" - do nothing
2599           "owner" - owner
2600           "listmaster" - listmaster
2601       Default:
2602           "owner"
2603
2604       Context:
2605           list (config)
2606
2607       When automatic task is executed on level 2 bouncers, a notification
2608       email can be send to listowner or listmaster.
2609
2610       "verp_rate"
2611
2612       percentage of list members in VERP mode
2613
2614       Format:
2615           "100%" - 100% - always
2616           "50%" - 50%
2617           "33%" - 33%
2618           "25%" - 25%
2619           "20%" - 20%
2620           "10%" - 10%
2621           "5%" - 5%
2622           "2%" - 2%
2623           "0%" - 0% - never
2624       Default:
2625           "0%"
2626
2627       Context:
2628           list (config), domain (robot.conf), site (sympa.conf)
2629
2630       Uses variable envelope return path (VERP) to detect bouncing subscriber
2631       addresses.
2632
2633       0%: VERP is never used.
2634
2635       100%: VERP is always in use.
2636
2637       VERP requires address with extension to be supported by MTA. If
2638       tracking is enabled for a list or a message, VERP is applied for 100%
2639       of subscribers.
2640
2641       "tracking"
2642
2643       (Paragraph) Message tracking feature
2644
2645       Single occurrence
2646
2647       "tracking.delivery_status_notification"
2648
2649       tracking message by delivery status notification
2650
2651       Format:
2652           "on" - enabled
2653           "off" - disabled
2654       Default:
2655           "off"
2656
2657       Context:
2658           list (config), site (sympa.conf)
2659
2660       "tracking.message_disposition_notification"
2661
2662       tracking message by message disposition notification
2663
2664       Format:
2665           "on" - enabled
2666           "on_demand" - on demand
2667           "off" - disabled
2668       Default:
2669           "off"
2670
2671       Context:
2672           list (config), site (sympa.conf)
2673
2674       Available versions:
2675           6.2a.41 and later.
2676
2677       "tracking.tracking"
2678
2679       who can view message tracking
2680
2681       Format:
2682           Name of "tracking" scenario:
2683
2684           "owner" - only owner (and listmaster)
2685           "private" - restricted to subscribers
2686       Default:
2687           "owner"
2688
2689       Context:
2690           list (config), site (sympa.conf)
2691
2692       Available versions:
2693           6.2a.3 and later.
2694
2695       "tracking.retention_period"
2696
2697       Tracking datas are removed after this number of days
2698
2699       Format:
2700           Number of days.
2701
2702       Default:
2703           90 (days)
2704
2705       Context:
2706           list (config), site (sympa.conf)
2707
2708       Available versions:
2709           6.2a.3 and later.
2710
2711       "tracking.message_delivery_notification"
2712
2713       See "message_disposition_notification".
2714
2715       Context:
2716           list (config)
2717
2718       Available versions:
2719           6.2a.0 to 6.2a.40.
2720
2721       "welcome_return_path"
2722
2723       Welcome return-path
2724
2725       Format:
2726           "unique" - bounce management
2727           "owner" - owner
2728       Default:
2729           "owner"
2730
2731       Context:
2732           list (config), site (sympa.conf)
2733
2734       If set to unique, the welcome message is sent using a unique return
2735       path in order to remove the subscriber immediately in the case of a
2736       bounce.
2737
2738       "remind_return_path"
2739
2740       Return-path of the REMIND command
2741
2742       Format:
2743           "unique" - bounce management
2744           "owner" - owner
2745       Default:
2746           "owner"
2747
2748       Context:
2749           list (config), site (sympa.conf)
2750
2751       Same as welcome_return_path, but applied to remind messages.
2752
2753       "expire_bounce_task"
2754
2755       Task for expiration of old bounces
2756
2757       Format:
2758           /"\w+"/
2759
2760       Default:
2761           "daily"
2762
2763       Context:
2764           site (sympa.conf)
2765
2766       This task resets bouncing information for addresses not bouncing in the
2767       last 10 days after the latest message distribution.
2768
2769       "purge_orphan_bounces_task"
2770
2771       Task for cleaning invalidated bounces
2772
2773       Format:
2774           /"\w+"/
2775
2776       Default:
2777           "monthly"
2778
2779       Context:
2780           site (sympa.conf)
2781
2782       This task deletes bounce information for unsubscribed users.
2783
2784       "eval_bouncers_task"
2785
2786       Task for updating bounce scores
2787
2788       Format:
2789           /"\w+"/
2790
2791       Default:
2792           "daily"
2793
2794       Context:
2795           site (sympa.conf)
2796
2797       This task scans all bouncing users for all lists, and updates
2798       "bounce_score_subscriber" field in "subscriber_table" table. The scores
2799       may be used for management of bouncers.
2800
2801       "process_bouncers_task"
2802
2803       Task for management of bouncers
2804
2805       Format:
2806           /"\w+"/
2807
2808       Default:
2809           "weekly"
2810
2811       Context:
2812           site (sympa.conf)
2813
2814       This task executes actions on bouncing users configured by each list,
2815       according to their scores.
2816
2817       "purge_tables_task"
2818
2819       Task for cleaning tables
2820
2821       Format:
2822           /"\w+"/
2823
2824       Default:
2825           "daily"
2826
2827       Context:
2828           site (sympa.conf)
2829
2830       This task cleans old tracking information from "notification_table"
2831       table.
2832
2833       "minimum_bouncing_count"
2834
2835       Minimum number of bounces
2836
2837       Format:
2838           /"\d+"/
2839
2840       Default:
2841           10
2842
2843       Context:
2844           site (sympa.conf)
2845
2846       The minimum number of bounces received to update bounce score of a
2847       user.
2848
2849       "minimum_bouncing_period"
2850
2851       Minimum bouncing period
2852
2853       Format:
2854           Number of days.
2855
2856       Default:
2857           10 (days)
2858
2859       Context:
2860           site (sympa.conf)
2861
2862       The minimum period for which bouncing lasted to update bounce score of
2863       a user.
2864
2865       "bounce_delay"
2866
2867       Delay of bounces
2868
2869       Format:
2870           Number of days.
2871
2872       Default:
2873           0 (days)
2874
2875       Context:
2876           site (sympa.conf)
2877
2878       Average time for a bounce sent back to mailing list server after a post
2879       was sent to a list. Usually bounces are sent back on the same day as
2880       the original message.
2881
2882       "bounce_email_prefix"
2883
2884       Prefix of VERP return address
2885
2886       Format:
2887           /"\S+"/
2888
2889       Default:
2890           "bounce"
2891
2892       Context:
2893           site (sympa.conf)
2894
2895       The prefix to consist the return-path of probe messages used for bounce
2896       management, when variable envelope return path (VERP) is enabled. VERP
2897       requires address with extension to be supported by MTA.
2898
2899       If you change the default value, you must modify the mail aliases too.
2900
2901       "return_path_suffix"
2902
2903       Suffix of list return address
2904
2905       Format:
2906           /"\S+"/
2907
2908       Default:
2909           "-owner"
2910
2911       Context:
2912           site (sympa.conf)
2913
2914       The suffix appended to the list name to form the return-path of
2915       messages distributed through the list. This address will receive all
2916       non-delivery reports (also called bounces).
2917
2918   Loop prevention
2919       "loop_command_max"
2920
2921       Maximum number of responses to command message
2922
2923       Format:
2924           /"\d+"/
2925
2926       Default:
2927           200
2928
2929       Context:
2930           site (sympa.conf)
2931
2932       The maximum number of command reports sent to an email address.
2933       Messages are stored in "bad" subdirectory of incoming message spool,
2934       and reports are not longer sent.
2935
2936       "loop_command_sampling_delay"
2937
2938       Delay before counting responses to command message
2939
2940       Format:
2941           Number of seconds.
2942
2943       Default:
2944           3600 (seconds)
2945
2946       Context:
2947           site (sympa.conf)
2948
2949       This parameter defines the delay in seconds before decrementing the
2950       counter of reports sent to an email address.
2951
2952       "loop_command_decrease_factor"
2953
2954       Decrementing factor of responses to command message
2955
2956       Format:
2957           /"[.\d]+"/
2958
2959       Default:
2960           0.5
2961
2962       Context:
2963           site (sympa.conf)
2964
2965       The decrementation factor (from 0 to 1), used to determine the new
2966       report counter after expiration of the delay.
2967
2968       "msgid_table_cleanup_ttl"
2969
2970       Expiration period of message ID table
2971
2972       Format:
2973           Number of seconds.
2974
2975       Default:
2976           86400 (seconds)
2977
2978       Context:
2979           site (sympa.conf)
2980
2981       Expiration period of entries in the table maintained by sympa_msg.pl
2982       daemon to prevent delivery of duplicate messages caused by loop.
2983
2984       "msgid_table_cleanup_frequency"
2985
2986       Cleanup interval of message ID table
2987
2988       Format:
2989           Number of seconds.
2990
2991       Default:
2992           3600 (seconds)
2993
2994       Context:
2995           site (sympa.conf)
2996
2997       Interval between cleanups of the table maintained by sympa_msg.pl
2998       daemon to prevent delivery of duplicate messages caused by loop.
2999
3000   Automatic lists
3001       "automatic_list_feature"
3002
3003       Automatic list
3004
3005       Format:
3006           "on" - enabled
3007           "off" - disabled
3008       Default:
3009           "off"
3010
3011       Context:
3012           domain (robot.conf), site (sympa.conf)
3013
3014       "automatic_list_removal"
3015
3016       Remove empty automatic list
3017
3018       Format:
3019           "none" - do nothing
3020           "if_empty" - if_empty
3021       Default:
3022           "none"
3023
3024       Context:
3025           domain (robot.conf), site (sympa.conf)
3026
3027       If set to "if_empty", then Sympa will remove automatically created
3028       mailing lists just after their creation, if they contain no list
3029       member.
3030
3031       Example:
3032
3033         automatic_list_removal if_empty
3034
3035       "automatic_list_creation"
3036
3037       Who is able to create automatic list
3038
3039       Format:
3040           Name of "automatic_list_creation" scenario:
3041
3042           "family_owner" - Restricted to people subscribed to the list of
3043           family owners.
3044           "listmaster" - restricted to listmaster
3045           "public" - anybody. Be sure you know what you are doing
3046       Default:
3047           "public"
3048
3049       Context:
3050           domain (robot.conf), site (sympa.conf)
3051
3052       "automatic_list_families"
3053
3054       Definition of automatic list families
3055
3056       Format:
3057           /".+"/
3058
3059       Default:
3060           None.
3061
3062       Context:
3063           domain (robot.conf), site (sympa.conf)
3064
3065       Defines the families the automatic lists are based on. It is a
3066       character string structured as follows:
3067
3068       * each family is separated from the other by a semicolon (;)
3069
3070       * inside a family definition, each field is separated from the other by
3071       a colon (:)
3072
3073       * each field has the structure: "<field name>=<field value>"
3074
3075       Basically, each time Sympa uses the automatic lists families, the
3076       values defined in this parameter will be available in the family
3077       object.
3078
3079       * for scenarios: [family->name]
3080
3081       * for templates: [% family.name %]
3082
3083       Example:
3084
3085         automatic_list_families name=family_one:prefix=f1:display=My automatic lists:prefix_separator=+:classes separator=-:family_owners_list=alist@domain.tld;name=family_two:prefix=f2:display=My other automatic lists:prefix_separator=+:classes separator=-:family_owners_list=anotherlist@domain.tld;
3086
3087       "parsed_family_files"
3088
3089       Parsed files for families
3090
3091       Format:
3092           /"[-.\w]+"/
3093
3094       Default:
3095           "message_header,message_header.mime,message_footer,message_footer.mime,info"
3096
3097       Context:
3098           domain (robot.conf), site (sympa.conf)
3099
3100       comma-separated list of files that will be parsed by Sympa when
3101       instantiating a family (no space allowed in file names)
3102
3103       "family_signoff"
3104
3105       Global unsubscription
3106
3107       Format:
3108           Name of "family_signoff" scenario:
3109
3110           "auth" - need authentication
3111           "closed" - impossible
3112       Default:
3113           "auth"
3114
3115       Context:
3116           domain (robot.conf), site (sympa.conf)
3117
3118       Available versions:
3119           6.2.54 and later.
3120
3121   Tag based spam filtering
3122       "antispam_feature"
3123
3124       Tag based spam filtering
3125
3126       Format:
3127           "on" - enabled
3128           "off" - disabled
3129       Default:
3130           "off"
3131
3132       Context:
3133           domain (robot.conf), site (sympa.conf)
3134
3135       "antispam_tag_header_name"
3136
3137       Header field to tag spams
3138
3139       Format:
3140           /"\S+"/
3141
3142       Default:
3143           "X-Spam-Status"
3144
3145       Context:
3146           domain (robot.conf), site (sympa.conf)
3147
3148       If a spam filter (like spamassassin or j-chkmail) add a header field to
3149       tag spams, name of this header field (example X-Spam-Status)
3150
3151       "antispam_tag_header_spam_regexp"
3152
3153       Regular expression to check header field to tag spams
3154
3155       Format:
3156           /".+"/
3157
3158       Default:
3159           "^\s*Yes"
3160
3161       Context:
3162           domain (robot.conf), site (sympa.conf)
3163
3164       Regular expression applied on this header to verify message is a spam
3165       (example Yes)
3166
3167       "antispam_tag_header_ham_regexp"
3168
3169       Regular expression to determine spam or ham.
3170
3171       Format:
3172           /".+"/
3173
3174       Default:
3175           "^\s*No"
3176
3177       Context:
3178           domain (robot.conf), site (sympa.conf)
3179
3180       Regular expression applied on this header field to verify message is
3181       NOT a spam (example No)
3182
3183       "spam_status"
3184
3185       Name of header field to inform
3186
3187       Format:
3188           Name of "spam_status" scenario:
3189
3190           "x-spam-status" - test X-Spam-Status header
3191       Default:
3192           "x-spam-status"
3193
3194       Context:
3195           domain (robot.conf), site (sympa.conf)
3196
3197       Messages are supposed to be filtered by an spam filter that adds them
3198       one or more headers. This parameter is used to select a special
3199       scenario in order to decide the message's spam status: ham, spam or
3200       unsure. This parameter replaces antispam_tag_header_name,
3201       antispam_tag_header_spam_regexp and antispam_tag_header_ham_regexp.
3202
3203   Directories
3204       "home"
3205
3206       List home
3207
3208       Format:
3209           /".+"/
3210
3211       Default:
3212           $EXPLDIR
3213
3214       Context:
3215           site (sympa.conf)
3216
3217       Base directory of list configurations.
3218
3219       "etc"
3220
3221       Directory for configuration files
3222
3223       Format:
3224           /".+"/
3225
3226       Default:
3227           $SYSCONFDIR
3228
3229       Context:
3230           site (sympa.conf)
3231
3232       Base directory of global configuration (except "sympa.conf").
3233
3234       "spool"
3235
3236       Base directory of spools
3237
3238       Format:
3239           /".+"/
3240
3241       Default:
3242           $SPOOLDIR
3243
3244       Context:
3245           site (sympa.conf)
3246
3247       Base directory of all spools which are created at runtime. This
3248       directory must be writable by Sympa user.
3249
3250       "queue"
3251
3252       Directory for message incoming spool
3253
3254       Format:
3255           /".+"/
3256
3257       Default:
3258           "$SPOOLDIR/msg"
3259
3260       Context:
3261           site (sympa.conf)
3262
3263       This spool is used both by "queue" program and "sympa_msg.pl" daemon.
3264
3265       "queuemod"
3266
3267       Directory for moderation spool
3268
3269       Format:
3270           /".+"/
3271
3272       Default:
3273           "$SPOOLDIR/moderation"
3274
3275       Context:
3276           site (sympa.conf)
3277
3278       "queuedigest"
3279
3280       Directory for digest spool
3281
3282       Format:
3283           /".+"/
3284
3285       Default:
3286           "$SPOOLDIR/digest"
3287
3288       Context:
3289           site (sympa.conf)
3290
3291       "queueauth"
3292
3293       Directory for held message spool
3294
3295       Format:
3296           /".+"/
3297
3298       Default:
3299           "$SPOOLDIR/auth"
3300
3301       Context:
3302           site (sympa.conf)
3303
3304       This parameter is named such by historical reason.
3305
3306       "queueoutgoing"
3307
3308       Directory for archive spool
3309
3310       Format:
3311           /".+"/
3312
3313       Default:
3314           "$SPOOLDIR/outgoing"
3315
3316       Context:
3317           site (sympa.conf)
3318
3319       This parameter is named such by historical reason.
3320
3321       "queuesubscribe"
3322
3323       Directory for held request spool
3324
3325       Format:
3326           /".+"/
3327
3328       Default:
3329           "$SPOOLDIR/subscribe"
3330
3331       Context:
3332           site (sympa.conf)
3333
3334       This parameter is named such by historical reason.
3335
3336       "queuetopic"
3337
3338       Directory for topic spool
3339
3340       Format:
3341           /".+"/
3342
3343       Default:
3344           "$SPOOLDIR/topic"
3345
3346       Context:
3347           site (sympa.conf)
3348
3349       "queuebounce"
3350
3351       Directory for bounce incoming spool
3352
3353       Format:
3354           /".+"/
3355
3356       Default:
3357           "$SPOOLDIR/bounce"
3358
3359       Context:
3360           site (sympa.conf)
3361
3362       This spool is used both by "bouncequeue" program and "bounced.pl"
3363       daemon.
3364
3365       "queuetask"
3366
3367       Directory for task spool
3368
3369       Format:
3370           /".+"/
3371
3372       Default:
3373           "$SPOOLDIR/task"
3374
3375       Context:
3376           site (sympa.conf)
3377
3378       "queueautomatic"
3379
3380       Directory for automatic list creation spool
3381
3382       Format:
3383           /".+"/
3384
3385       Default:
3386           "$SPOOLDIR/automatic"
3387
3388       Context:
3389           site (sympa.conf)
3390
3391       This spool is used both by "familyqueue" program and
3392       "sympa_automatic.pl" daemon.
3393
3394       "queuebulk"
3395
3396       Directory for message outgoing spool
3397
3398       Format:
3399           /".+"/
3400
3401       Default:
3402           "$SPOOLDIR/bulk"
3403
3404       Context:
3405           site (sympa.conf)
3406
3407       Available versions:
3408           6.2a.41 and later.
3409
3410       This parameter is named such by historical reason.
3411
3412       "tmpdir"
3413
3414       Temporary directory used by external programs such as virus scanner.
3415       Also, outputs to daemons' standard error are redirected to the files
3416       under this directory.
3417
3418       Format:
3419           /".+"/
3420
3421       Default:
3422           "$SPOOLDIR/tmp"
3423
3424       Context:
3425           site (sympa.conf)
3426
3427       "viewmail_dir"
3428
3429       Directory to cache formatted messages
3430
3431       Format:
3432           /".+"/
3433
3434       Default:
3435           "$SPOOLDIR/viewmail"
3436
3437       Context:
3438           site (sympa.conf)
3439
3440       Base directory path of directories where HTML view of messages are
3441       cached.
3442
3443       "bounce_path"
3444
3445       Directory for storing bounces
3446
3447       Format:
3448           /".+"/
3449
3450       Default:
3451           $BOUNCEDIR
3452
3453       Context:
3454           site (sympa.conf)
3455
3456       The directory where bounced.pl daemon will store the last bouncing
3457       message for each user. A message is stored in the file:
3458       <bounce_path>/<list name>@<mail domain name>/<email address>, or, if
3459       tracking is enabled: <bounce_path>/<list name>@<mail domain
3460       name>/<email address>_<envelope ID>.
3461
3462       Users can access to these messages using web interface in the bounce
3463       management page.
3464
3465       Don't confuse with "queuebounce" parameter which defines the spool
3466       where incoming error reports are stored and picked by bounced.pl
3467       daemon.
3468
3469       "arc_path"
3470
3471       Directory for storing archives
3472
3473       Format:
3474           /".+"/
3475
3476       Default:
3477           $ARCDIR
3478
3479       Context:
3480           domain (robot.conf), site (sympa.conf)
3481
3482       Where to store HTML archives. This parameter is used by the
3483       "archived.pl" daemon. It is a good idea to install the archive outside
3484       the web document hierarchy to prevent overcoming of WWSympa's access
3485       control.
3486
3487       "purge_spools_task"
3488
3489       Task for cleaning spools
3490
3491       Format:
3492           /"\w+"/
3493
3494       Default:
3495           "daily"
3496
3497       Context:
3498           site (sympa.conf)
3499
3500       Available versions:
3501           6.2b.4 and later.
3502
3503       This task cleans old content in spools.
3504
3505       "clean_delay_queue"
3506
3507       Max age of incoming bad messages
3508
3509       Format:
3510           Number of days.
3511
3512       Default:
3513           7 (days)
3514
3515       Context:
3516           site (sympa.conf)
3517
3518       Number of days "bad" messages are kept in message incoming spool (as
3519       specified by "queue" parameter). Sympa keeps messages rejected for
3520       various reasons (badly formatted, looping etc.).
3521
3522       "clean_delay_queueoutgoing"
3523
3524       Max age of bad messages for archives
3525
3526       Format:
3527           Number of days.
3528
3529       Default:
3530           7 (days)
3531
3532       Context:
3533           site (sympa.conf)
3534
3535       Number of days "bad" messages are kept in message archive spool (as
3536       specified by "queueoutgoing" parameter). Sympa keeps messages rejected
3537       for various reasons (unable to create archive directory, to copy file
3538       etc.).
3539
3540       "clean_delay_queuebounce"
3541
3542       Max age of bad bounce messages
3543
3544       Format:
3545           Number of days.
3546
3547       Default:
3548           7 (days)
3549
3550       Context:
3551           site (sympa.conf)
3552
3553       Number of days "bad" messages are kept in bounce spool (as specified by
3554       "queuebounce" parameter). Sympa keeps messages rejected for various
3555       reasons (unknown original sender, unknown report type).
3556
3557       "clean_delay_queueauth"
3558
3559       Max age of held messages
3560
3561       Format:
3562           Number of days.
3563
3564       Default:
3565           30 (days)
3566
3567       Context:
3568           site (sympa.conf)
3569
3570       Number of days messages are kept in held message spool (as specified by
3571       "queueauth" parameter). Beyond this deadline, messages that have not
3572       been confirmed are deleted.
3573
3574       "clean_delay_queuesubscribe"
3575
3576       Max age of held requests
3577
3578       Format:
3579           Number of days.
3580
3581       Default:
3582           30 (days)
3583
3584       Context:
3585           site (sympa.conf)
3586
3587       Number of days requests are kept in held request spool (as specified by
3588       "queuesubscribe" parameter). Beyond this deadline, requests that have
3589       not been validated nor declined are deleted.
3590
3591       "clean_delay_queuetopic"
3592
3593       Max age of tagged topics
3594
3595       Format:
3596           Number of days.
3597
3598       Default:
3599           30 (days)
3600
3601       Context:
3602           site (sympa.conf)
3603
3604       Number of days (automatically or manually) tagged topics are kept in
3605       topic spool (as specified by "queuetopic" parameter). Beyond this
3606       deadline, tagging is forgotten.
3607
3608       "clean_delay_queueautomatic"
3609
3610       Max age of incoming bad messages in automatic list creation spool
3611
3612       Format:
3613           Number of days.
3614
3615       Default:
3616           10 (days)
3617
3618       Context:
3619           site (sympa.conf)
3620
3621       Number of days "bad" messages are kept in automatic list creation spool
3622       (as specified by "queueautomatic" parameter). Sympa keeps messages
3623       rejected for various reasons (badly formatted, looping etc.).
3624
3625       "clean_delay_queuebulk"
3626
3627       Max age of outgoing bad messages
3628
3629       Format:
3630           Number of days.
3631
3632       Default:
3633           7 (days)
3634
3635       Context:
3636           site (sympa.conf)
3637
3638       Number of days "bad" messages are kept in message outgoing spool (as
3639       specified by "queuebulk" parameter). Sympa keeps messages rejected for
3640       various reasons (failed personalization, bad configuration on MTA
3641       etc.).
3642
3643       "clean_delay_queuedigest"
3644
3645       Max age of bad messages in digest spool
3646
3647       Format:
3648           Number of days.
3649
3650       Default:
3651           14 (days)
3652
3653       Context:
3654           site (sympa.conf)
3655
3656       Available versions:
3657           6.2.6 and later.
3658
3659       Number of days "bad" messages are kept in digest spool (as specified by
3660       "queuedigest" parameter). Sympa keeps messages rejected for various
3661       reasons (syntax errors in "digest.tt2" template etc.).
3662
3663       "clean_delay_tmpdir"
3664
3665       Max age of temporary files
3666
3667       Format:
3668           Number of days.
3669
3670       Default:
3671           7 (days)
3672
3673       Context:
3674           site (sympa.conf)
3675
3676       Number of days files in temporary directory (as specified by "tmpdir"
3677       parameter), including standard error logs, are kept.
3678
3679   S/MIME and TLS
3680       S/MIME authentication, decryption and re-encryption. It requires these
3681       external modules: Crypt-OpenSSL-X509 and Crypt-SMIME.
3682
3683       TLS client authentication. It requires an external module: IO-Socket-
3684       SSL.
3685
3686       "cafile"
3687
3688       File containing trusted CA certificates
3689
3690       Format:
3691           /".+"/
3692
3693       Default:
3694           None.
3695
3696       Context:
3697           site (sympa.conf)
3698
3699       Available versions:
3700           3.3.6b.1 and later.
3701
3702       This can be used alternatively and/or additionally to "capath".
3703
3704       "capath"
3705
3706       Directory containing trusted CA certificates
3707
3708       Format:
3709           /".+"/
3710
3711       Default:
3712           None.
3713
3714       Context:
3715           site (sympa.conf)
3716
3717       Available versions:
3718           3.3.6b.1 and later.
3719
3720       CA certificates in this directory are used for client authentication.
3721
3722       The certificates need to have names including hash of subject, or
3723       symbolic links to them with such names. The links may be created by
3724       using "c_rehash" script bundled in OpenSSL.
3725
3726       "key_passwd"
3727
3728       Password used to crypt lists private keys
3729
3730       Format:
3731           The value to be concealed.
3732
3733       Default:
3734           None.
3735
3736       Context:
3737           site (sympa.conf)
3738
3739       If not defined, Sympa assumes that list private keys are not encrypted.
3740
3741       Example:
3742
3743         key_passwd your_password
3744
3745       "ssl_cert_dir"
3746
3747       Directory containing user certificates
3748
3749       Format:
3750           /".+"/
3751
3752       Default:
3753           "$EXPLDIR/X509-user-certs"
3754
3755       Context:
3756           site (sympa.conf)
3757
3758   Data sources setup
3759       Including subscribers, owners and moderators from data sources.
3760       Appropriate database driver (DBD) modules are required: DBD-CSV, DBD-
3761       mysql, DBD-ODBC, DBD-Oracle, DBD-Pg, DBD-SQLite and/or Net-LDAP. And
3762       also, if secure connection (LDAPS) to LDAP server is required: IO-
3763       Socket-SSL.
3764
3765       "inclusion_notification_feature"
3766
3767       Notify subscribers when they are included from a data source?
3768
3769       Format:
3770           "on" - enabled
3771           "off" - disabled
3772       Default:
3773           "off"
3774
3775       Context:
3776           list (config), site (sympa.conf)
3777
3778       "member_include"
3779
3780       (Paragraph) Subscribers defined in an external data source
3781
3782       Multiple occurrences allowed
3783
3784       "member_include.source"
3785
3786       the data source
3787
3788       Format:
3789           /"[\w-]+"/
3790
3791       Default:
3792           None, mandatory.
3793
3794       Context:
3795           list (config)
3796
3797       "member_include.source_parameters"
3798
3799       data source parameters
3800
3801       Format:
3802           /".*"/
3803
3804       Default:
3805           None.
3806
3807       Context:
3808           list (config)
3809
3810       "member_include.reception"
3811
3812       reception mode
3813
3814       Format:
3815           Reception mode of list member.
3816
3817       Default:
3818           None.
3819
3820       Context:
3821           list (config)
3822
3823       Available versions:
3824           6.2.67b.2 and later.
3825
3826       Mail reception mode.
3827
3828       "member_include.visibility"
3829
3830       visibility
3831
3832       Format:
3833           Visibility mode of list memeber.
3834
3835       Default:
3836           None.
3837
3838       Context:
3839           list (config)
3840
3841       Available versions:
3842           6.2.67b.2 and later.
3843
3844       Visibility of the subscriber.
3845
3846       "owner_include"
3847
3848       (Paragraph) Owners defined in an external data source
3849
3850       Multiple occurrences allowed
3851
3852       "owner_include.source"
3853
3854       the data source
3855
3856       Format:
3857           /"[\w-]+"/
3858
3859       Default:
3860           None, mandatory.
3861
3862       Context:
3863           list (config)
3864
3865       "owner_include.source_parameters"
3866
3867       data source parameters
3868
3869       Format:
3870           /".*"/
3871
3872       Default:
3873           None.
3874
3875       Context:
3876           list (config)
3877
3878       Available versions:
3879           5.0a and later.
3880
3881       "owner_include.profile"
3882
3883       profile
3884
3885       Format:
3886           "privileged" - privileged owner
3887           "normal" - normal owner
3888       Default:
3889           None.
3890
3891       Context:
3892           list (config)
3893
3894       "owner_include.reception"
3895
3896       reception mode
3897
3898       Format:
3899           "mail" - receive notification email
3900           "nomail" - no notifications
3901       Default:
3902           None.
3903
3904       Context:
3905           list (config)
3906
3907       "owner_include.visibility"
3908
3909       visibility
3910
3911       Format:
3912           "conceal" - concealed from list menu
3913           "noconceal" - listed on the list menu
3914       Default:
3915           None.
3916
3917       Context:
3918           list (config)
3919
3920       Available versions:
3921           5.4a.6 and later.
3922
3923       "editor_include"
3924
3925       (Paragraph) Moderators defined in an external data source
3926
3927       Multiple occurrences allowed
3928
3929       "editor_include.source"
3930
3931       the data source
3932
3933       Format:
3934           /"[\w-]+"/
3935
3936       Default:
3937           None, mandatory.
3938
3939       Context:
3940           list (config)
3941
3942       "editor_include.source_parameters"
3943
3944       data source parameters
3945
3946       Format:
3947           /".*"/
3948
3949       Default:
3950           None.
3951
3952       Context:
3953           list (config)
3954
3955       Available versions:
3956           5.0a and later.
3957
3958       "editor_include.reception"
3959
3960       reception mode
3961
3962       Format:
3963           "mail" - receive notification email
3964           "nomail" - no notifications
3965       Default:
3966           None.
3967
3968       Context:
3969           list (config)
3970
3971       "editor_include.visibility"
3972
3973       visibility
3974
3975       Format:
3976           "conceal" - concealed from list menu
3977           "noconceal" - listed on the list menu
3978       Default:
3979           None.
3980
3981       Context:
3982           list (config)
3983
3984       Available versions:
3985           5.4a.6 and later.
3986
3987       "sql_fetch_timeout"
3988
3989       Timeout for fetch of include_sql_query
3990
3991       Format:
3992           Number of seconds.
3993
3994       Default:
3995           300 (seconds)
3996
3997       Context:
3998           list (config), site (sympa.conf)
3999
4000       Available versions:
4001           6.2a.0 and later.
4002
4003       "include_file"
4004
4005       File inclusion
4006
4007       Format:
4008           Multiple occurrences allowed.
4009
4010           /"\S+"/
4011
4012       Default:
4013           None.
4014
4015       Context:
4016           list (config)
4017
4018       Include subscribers from this file.  The file should contain one e-mail
4019       address per line (lines beginning with a "#" are ignored).
4020
4021       "include_remote_file"
4022
4023       (Paragraph) Remote file inclusion
4024
4025       Multiple occurrences allowed
4026
4027       "include_remote_file.name"
4028
4029       short name for this source
4030
4031       Format:
4032           /".+"/
4033
4034       Default:
4035           None.
4036
4037       Context:
4038           list (config)
4039
4040       "include_remote_file.url"
4041
4042       data location URL
4043
4044       Format:
4045           /".+"/
4046
4047       Default:
4048           None, mandatory.
4049
4050       Context:
4051           list (config)
4052
4053       "include_remote_file.user"
4054
4055       remote user
4056
4057       Format:
4058           /".+"/
4059
4060       Default:
4061           None.
4062
4063       Context:
4064           list (config)
4065
4066       "include_remote_file.passwd"
4067
4068       remote password
4069
4070       Format:
4071           The value to be concealed.
4072
4073       Default:
4074           None.
4075
4076       Context:
4077           list (config)
4078
4079       "include_remote_file.timeout"
4080
4081       idle timeout
4082
4083       Format:
4084           Number of seconds.
4085
4086       Default:
4087           180 (seconds)
4088
4089       Context:
4090           list (config)
4091
4092       "include_remote_file.ssl_version"
4093
4094       SSL version
4095
4096       Format:
4097           "ssl_any" - any versions
4098           "sslv2" - SSL version 2
4099           "sslv3" - SSL version 3
4100           "tlsv1" - TLS version 1
4101           "tlsv1_1" - TLS version 1.1
4102           "tlsv1_2" - TLS version 1.2
4103           "tlsv1_3" - TLS version 1.3
4104       Default:
4105           "ssl_any"
4106
4107       Context:
4108           list (config)
4109
4110       "include_remote_file.ssl_ciphers"
4111
4112       SSL ciphers used
4113
4114       Format:
4115           /".+"/
4116
4117       Default:
4118           "ALL"
4119
4120       Context:
4121           list (config)
4122
4123       "include_remote_file.ca_verify"
4124
4125       Certificate verification
4126
4127       Format:
4128           "none" - do nothing
4129           "optional" - optional
4130           "required" - required
4131       Default:
4132           "none"
4133
4134       Context:
4135           list (config)
4136
4137       "include_remote_file.nosync_time_ranges"
4138
4139       Time ranges when inclusion is not allowed
4140
4141       Format:
4142           /$time_ranges/
4143
4144       Default:
4145           None.
4146
4147       Context:
4148           list (config)
4149
4150       "include_sympa_list"
4151
4152       (Paragraph) List inclusion
4153
4154       Multiple occurrences allowed
4155
4156       Include subscribers from other list. All subscribers of list listname
4157       become subscribers of the current list. You may include as many lists
4158       as required, using one include_sympa_list paragraph for each included
4159       list. Any list at all may be included; you may therefore include lists
4160       which are also defined by the inclusion of other lists. Be careful,
4161       however, not to include list A in list B and then list B in list A,
4162       since this will give rise to an infinite loop.
4163
4164       "include_sympa_list.name"
4165
4166       short name for this source
4167
4168       Format:
4169           /".+"/
4170
4171       Default:
4172           None.
4173
4174       Context:
4175           list (config)
4176
4177       "include_sympa_list.listname"
4178
4179       list name to include
4180
4181       Format:
4182           /"$listname(\@$host)?"/
4183
4184       Default:
4185           None, mandatory.
4186
4187       Context:
4188           list (config)
4189
4190       "include_sympa_list.filter"
4191
4192       filter definition
4193
4194       Format:
4195           /".*"/
4196
4197       Default:
4198           None.
4199
4200       Context:
4201           list (config)
4202
4203       "include_sympa_list.nosync_time_ranges"
4204
4205       Time ranges when inclusion is not allowed
4206
4207       Format:
4208           /$time_ranges/
4209
4210       Default:
4211           None.
4212
4213       Context:
4214           list (config)
4215
4216       "include_remote_sympa_list"
4217
4218       (Paragraph) remote list inclusion
4219
4220       Multiple occurrences allowed
4221
4222       Sympa can contact another Sympa service using HTTPS to fetch a remote
4223       list in order to include each member of a remote list as subscriber.
4224       You may include as many lists as required, using one
4225       include_remote_sympa_list paragraph for each included list. Be careful,
4226       however, not to give rise to an infinite loop resulting from cross
4227       includes.
4228
4229       For this operation, one Sympa site acts as a server while the other one
4230       acs as client. On the server side, the only setting needed is to give
4231       permission to the remote Sympa to review the list. This is controlled
4232       by the review scenario.
4233
4234       "include_remote_sympa_list.name"
4235
4236       short name for this source
4237
4238       Format:
4239           /".+"/
4240
4241       Default:
4242           None.
4243
4244       Context:
4245           list (config)
4246
4247       "include_remote_sympa_list.url"
4248
4249       data location URL
4250
4251       Format:
4252           /".+"/
4253
4254       Default:
4255           None.
4256
4257       Context:
4258           list (config)
4259
4260       Available versions:
4261           6.2.45b.1 and later.
4262
4263       "include_remote_sympa_list.user"
4264
4265       remote user
4266
4267       Format:
4268           /".+"/
4269
4270       Default:
4271           None.
4272
4273       Context:
4274           list (config)
4275
4276       Available versions:
4277           6.2.45b.1 and later.
4278
4279       "include_remote_sympa_list.passwd"
4280
4281       remote password
4282
4283       Format:
4284           The value to be concealed.
4285
4286       Default:
4287           None.
4288
4289       Context:
4290           list (config)
4291
4292       Available versions:
4293           6.2.45b.1 and later.
4294
4295       "include_remote_sympa_list.host"
4296
4297       remote host
4298
4299       Format:
4300           /$host/
4301
4302       Default:
4303           None, mandatory.
4304
4305       Context:
4306           list (config)
4307
4308       obsoleted.  Use "data location URL".
4309
4310       "include_remote_sympa_list.port"
4311
4312       remote port
4313
4314       Format:
4315           /"\d+"/
4316
4317       Default:
4318           443
4319
4320       Context:
4321           list (config)
4322
4323       obsoleted.  Use "data location URL".
4324
4325       "include_remote_sympa_list.path"
4326
4327       remote path of sympa list dump
4328
4329       Format:
4330           /"\S+"/
4331
4332       Default:
4333           None, mandatory.
4334
4335       Context:
4336           list (config)
4337
4338       obsoleted.  Use "data location URL".
4339
4340       "include_remote_sympa_list.cert"
4341
4342       Deprecated.
4343
4344       Context:
4345           list (config)
4346
4347       Available versions:
4348           up to 6.2.44.
4349
4350       "include_remote_sympa_list.timeout"
4351
4352       idle timeout
4353
4354       Format:
4355           Number of seconds.
4356
4357       Default:
4358           180 (seconds)
4359
4360       Context:
4361           list (config)
4362
4363       Available versions:
4364           6.2.45b.1 and later.
4365
4366       "include_remote_sympa_list.ssl_version"
4367
4368       SSL version
4369
4370       Format:
4371           "ssl_any" - any versions
4372           "sslv2" - SSL version 2
4373           "sslv3" - SSL version 3
4374           "tlsv1" - TLS version 1
4375           "tlsv1_1" - TLS version 1.1
4376           "tlsv1_2" - TLS version 1.2
4377           "tlsv1_3" - TLS version 1.3
4378       Default:
4379           "ssl_any"
4380
4381       Context:
4382           list (config)
4383
4384       Available versions:
4385           6.2.45b.1 and later.
4386
4387       "include_remote_sympa_list.ssl_ciphers"
4388
4389       SSL ciphers used
4390
4391       Format:
4392           /".+"/
4393
4394       Default:
4395           "ALL"
4396
4397       Context:
4398           list (config)
4399
4400       Available versions:
4401           6.2.45b.1 and later.
4402
4403       "include_remote_sympa_list.ca_verify"
4404
4405       Certificate verification
4406
4407       Format:
4408           "none" - do nothing
4409           "optional" - optional
4410           "required" - required
4411       Default:
4412           "optional"
4413
4414       Context:
4415           list (config)
4416
4417       Available versions:
4418           6.2.45b.1 and later.
4419
4420       "include_remote_sympa_list.nosync_time_ranges"
4421
4422       Time ranges when inclusion is not allowed
4423
4424       Format:
4425           /$time_ranges/
4426
4427       Default:
4428           None.
4429
4430       Context:
4431           list (config)
4432
4433       "include_ldap_query"
4434
4435       (Paragraph) LDAP query inclusion
4436
4437       Multiple occurrences allowed
4438
4439       This paragraph defines parameters for a query returning a list of
4440       subscribers. This feature requires the Net::LDAP (perlldap) PERL
4441       module.
4442
4443       "include_ldap_query.name"
4444
4445       short name for this source
4446
4447       Format:
4448           /".+"/
4449
4450       Default:
4451           None.
4452
4453       Context:
4454           list (config)
4455
4456       "include_ldap_query.host"
4457
4458       remote host
4459
4460       Format:
4461           /$multiple_host_or_url/
4462
4463       Default:
4464           None, mandatory.
4465
4466       Context:
4467           list (config)
4468
4469       "include_ldap_query.port"
4470
4471       Deprecated.
4472
4473       Context:
4474           list (config)
4475
4476       "include_ldap_query.use_tls"
4477
4478       use TLS (formerly SSL)
4479
4480       Format:
4481           "starttls" - use STARTTLS
4482           "ldaps" - use LDAPS (LDAP over TLS)
4483           "none" - do nothing
4484       Default:
4485           "none"
4486
4487       Context:
4488           list (config)
4489
4490       Available versions:
4491           6.2.15 and later.
4492
4493       "include_ldap_query.ssl_version"
4494
4495       SSL version
4496
4497       Format:
4498           "sslv2" - SSL version 2
4499           "sslv3" - SSL version 3
4500           "tlsv1" - TLS version 1
4501           "tlsv1_1" - TLS version 1.1
4502           "tlsv1_2" - TLS version 1.2
4503           "tlsv1_3" - TLS version 1.3
4504       Default:
4505           "tlsv1"
4506
4507       Context:
4508           list (config)
4509
4510       "include_ldap_query.ssl_ciphers"
4511
4512       SSL ciphers used
4513
4514       Format:
4515           /".+"/
4516
4517       Default:
4518           "ALL"
4519
4520       Context:
4521           list (config)
4522
4523       "include_ldap_query.ca_verify"
4524
4525       Certificate verification
4526
4527       Format:
4528           "none" - do nothing
4529           "optional" - optional
4530           "required" - required
4531       Default:
4532           "required"
4533
4534       Context:
4535           list (config)
4536
4537       Available versions:
4538           6.2.13 and later.
4539
4540       "include_ldap_query.bind_dn"
4541
4542       remote user
4543
4544       Format:
4545           /".+"/
4546
4547       Default:
4548           None.
4549
4550       Context:
4551           list (config)
4552
4553       Available versions:
4554           6.2.57b.1 and later.
4555
4556       "include_ldap_query.bind_password"
4557
4558       remote password
4559
4560       Format:
4561           The value to be concealed.
4562
4563       Default:
4564           None.
4565
4566       Context:
4567           list (config)
4568
4569       Available versions:
4570           6.2.57b.1 and later.
4571
4572       "include_ldap_query.suffix"
4573
4574       suffix
4575
4576       Format:
4577           /".+"/
4578
4579       Default:
4580           None.
4581
4582       Context:
4583           list (config)
4584
4585       "include_ldap_query.scope"
4586
4587       search scope
4588
4589       Format:
4590           "base" - base
4591           "one" - one level
4592           "sub" - subtree
4593       Default:
4594           "sub"
4595
4596       Context:
4597           list (config)
4598
4599       "include_ldap_query.timeout"
4600
4601       connection timeout
4602
4603       Format:
4604           Number of seconds.
4605
4606       Default:
4607           30 (seconds)
4608
4609       Context:
4610           list (config)
4611
4612       "include_ldap_query.filter"
4613
4614       filter
4615
4616       Format:
4617           /".+"/
4618
4619       Default:
4620           None, mandatory.
4621
4622       Context:
4623           list (config)
4624
4625       "include_ldap_query.attrs"
4626
4627       extracted attribute
4628
4629       Format:
4630           /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
4631
4632       Default:
4633           "mail"
4634
4635       Context:
4636           list (config)
4637
4638       "include_ldap_query.select"
4639
4640       selection (if multiple)
4641
4642       Format:
4643           "all" - all
4644           "first" - first entry
4645           "regex" - entries matching regular expression
4646       Default:
4647           "first"
4648
4649       Context:
4650           list (config)
4651
4652       "include_ldap_query.regex"
4653
4654       regular expression
4655
4656       Format:
4657           /".+"/
4658
4659       Default:
4660           ""
4661
4662       Context:
4663           list (config)
4664
4665       "include_ldap_query.nosync_time_ranges"
4666
4667       Time ranges when inclusion is not allowed
4668
4669       Format:
4670           /$time_ranges/
4671
4672       Default:
4673           None.
4674
4675       Context:
4676           list (config)
4677
4678       Available versions:
4679           6.2a.16 and later.
4680
4681       "include_ldap_query.passwd"
4682
4683       See "bind_password".
4684
4685       Context:
4686           list (config)
4687
4688       Available versions:
4689           up to 6.2.56.
4690
4691       "include_ldap_query.use_ssl"
4692
4693       See "use_tls".
4694
4695       Context:
4696           list (config)
4697
4698       Available versions:
4699           5.3a.2 to 6.2.14.
4700
4701       "include_ldap_query.user"
4702
4703       See "bind_dn".
4704
4705       Context:
4706           list (config)
4707
4708       Available versions:
4709           up to 6.2.56.
4710
4711       "include_ldap_2level_query"
4712
4713       (Paragraph) LDAP 2-level query inclusion
4714
4715       Multiple occurrences allowed
4716
4717       This paragraph defines parameters for a two-level query returning a
4718       list of subscribers. Usually the first-level query returns a list of
4719       DNs and the second-level queries convert the DNs into e-mail addresses.
4720       This feature requires the Net::LDAP (perlldap) PERL module.
4721
4722       "include_ldap_2level_query.name"
4723
4724       short name for this source
4725
4726       Format:
4727           /".+"/
4728
4729       Default:
4730           None.
4731
4732       Context:
4733           list (config)
4734
4735       "include_ldap_2level_query.host"
4736
4737       remote host
4738
4739       Format:
4740           /$multiple_host_or_url/
4741
4742       Default:
4743           None, mandatory.
4744
4745       Context:
4746           list (config)
4747
4748       "include_ldap_2level_query.port"
4749
4750       Deprecated.
4751
4752       Context:
4753           list (config)
4754
4755       "include_ldap_2level_query.use_tls"
4756
4757       use TLS (formerly SSL)
4758
4759       Format:
4760           "starttls" - use STARTTLS
4761           "ldaps" - use LDAPS (LDAP over TLS)
4762           "none" - do nothing
4763       Default:
4764           "none"
4765
4766       Context:
4767           list (config)
4768
4769       Available versions:
4770           6.2.15 and later.
4771
4772       "include_ldap_2level_query.ssl_version"
4773
4774       SSL version
4775
4776       Format:
4777           "sslv2" - SSL version 2
4778           "sslv3" - SSL version 3
4779           "tlsv1" - TLS version 1
4780           "tlsv1_1" - TLS version 1.1
4781           "tlsv1_2" - TLS version 1.2
4782           "tlsv1_3" - TLS version 1.3
4783       Default:
4784           "tlsv1"
4785
4786       Context:
4787           list (config)
4788
4789       "include_ldap_2level_query.ssl_ciphers"
4790
4791       SSL ciphers used
4792
4793       Format:
4794           /".+"/
4795
4796       Default:
4797           "ALL"
4798
4799       Context:
4800           list (config)
4801
4802       "include_ldap_2level_query.ca_verify"
4803
4804       Certificate verification
4805
4806       Format:
4807           "none" - do nothing
4808           "optional" - optional
4809           "required" - required
4810       Default:
4811           "required"
4812
4813       Context:
4814           list (config)
4815
4816       Available versions:
4817           6.2.13 and later.
4818
4819       "include_ldap_2level_query.bind_dn"
4820
4821       remote user
4822
4823       Format:
4824           /".+"/
4825
4826       Default:
4827           None.
4828
4829       Context:
4830           list (config)
4831
4832       Available versions:
4833           6.2.57b.1 and later.
4834
4835       "include_ldap_2level_query.bind_password"
4836
4837       remote password
4838
4839       Format:
4840           The value to be concealed.
4841
4842       Default:
4843           None.
4844
4845       Context:
4846           list (config)
4847
4848       Available versions:
4849           6.2.57b.1 and later.
4850
4851       "include_ldap_2level_query.suffix1"
4852
4853       first-level suffix
4854
4855       Format:
4856           /".+"/
4857
4858       Default:
4859           None.
4860
4861       Context:
4862           list (config)
4863
4864       "include_ldap_2level_query.scope1"
4865
4866       first-level search scope
4867
4868       Format:
4869           "base" - base
4870           "one" - one level
4871           "sub" - subtree
4872       Default:
4873           "sub"
4874
4875       Context:
4876           list (config)
4877
4878       "include_ldap_2level_query.timeout1"
4879
4880       first-level connection timeout
4881
4882       Format:
4883           Number of seconds.
4884
4885       Default:
4886           30 (seconds)
4887
4888       Context:
4889           list (config)
4890
4891       "include_ldap_2level_query.filter1"
4892
4893       first-level filter
4894
4895       Format:
4896           /".+"/
4897
4898       Default:
4899           None, mandatory.
4900
4901       Context:
4902           list (config)
4903
4904       "include_ldap_2level_query.attrs1"
4905
4906       first-level extracted attribute
4907
4908       Format:
4909           /$ldap_attrdesc/
4910
4911       Default:
4912           None.
4913
4914       Context:
4915           list (config)
4916
4917       "include_ldap_2level_query.select1"
4918
4919       first-level selection
4920
4921       Format:
4922           "all" - all
4923           "first" - first entry
4924           "regex" - entries matching regular expression
4925       Default:
4926           "first"
4927
4928       Context:
4929           list (config)
4930
4931       "include_ldap_2level_query.regex1"
4932
4933       first-level regular expression
4934
4935       Format:
4936           /".+"/
4937
4938       Default:
4939           ""
4940
4941       Context:
4942           list (config)
4943
4944       "include_ldap_2level_query.suffix2"
4945
4946       second-level suffix template
4947
4948       Format:
4949           /".+"/
4950
4951       Default:
4952           None.
4953
4954       Context:
4955           list (config)
4956
4957       "include_ldap_2level_query.scope2"
4958
4959       second-level search scope
4960
4961       Format:
4962           "base" - base
4963           "one" - one level
4964           "sub" - subtree
4965       Default:
4966           "sub"
4967
4968       Context:
4969           list (config)
4970
4971       "include_ldap_2level_query.timeout2"
4972
4973       second-level connection timeout
4974
4975       Format:
4976           Number of seconds.
4977
4978       Default:
4979           30 (seconds)
4980
4981       Context:
4982           list (config)
4983
4984       "include_ldap_2level_query.filter2"
4985
4986       second-level filter template
4987
4988       Format:
4989           /".+"/
4990
4991       Default:
4992           None, mandatory.
4993
4994       Context:
4995           list (config)
4996
4997       "include_ldap_2level_query.attrs2"
4998
4999       second-level extracted attribute
5000
5001       Format:
5002           /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
5003
5004       Default:
5005           "mail"
5006
5007       Context:
5008           list (config)
5009
5010       "include_ldap_2level_query.select2"
5011
5012       second-level selection
5013
5014       Format:
5015           "all" - all
5016           "first" - first entry
5017           "regex" - entries matching regular expression
5018       Default:
5019           "first"
5020
5021       Context:
5022           list (config)
5023
5024       "include_ldap_2level_query.regex2"
5025
5026       second-level regular expression
5027
5028       Format:
5029           /".+"/
5030
5031       Default:
5032           ""
5033
5034       Context:
5035           list (config)
5036
5037       "include_ldap_2level_query.nosync_time_ranges"
5038
5039       Time ranges when inclusion is not allowed
5040
5041       Format:
5042           /$time_ranges/
5043
5044       Default:
5045           None.
5046
5047       Context:
5048           list (config)
5049
5050       Available versions:
5051           6.2a.16 and later.
5052
5053       "include_ldap_2level_query.passwd"
5054
5055       See "bind_password".
5056
5057       Context:
5058           list (config)
5059
5060       Available versions:
5061           up to 6.2.56.
5062
5063       "include_ldap_2level_query.use_ssl"
5064
5065       See "use_tls".
5066
5067       Context:
5068           list (config)
5069
5070       Available versions:
5071           5.3a.2 to 6.2.14.
5072
5073       "include_ldap_2level_query.user"
5074
5075       See "bind_dn".
5076
5077       Context:
5078           list (config)
5079
5080       Available versions:
5081           up to 6.2.56.
5082
5083       "include_sql_query"
5084
5085       (Paragraph) SQL query inclusion
5086
5087       Multiple occurrences allowed
5088
5089       This parameter is used to define the SQL query parameters.
5090
5091       "include_sql_query.name"
5092
5093       short name for this source
5094
5095       Format:
5096           /".+"/
5097
5098       Default:
5099           None.
5100
5101       Context:
5102           list (config)
5103
5104       "include_sql_query.db_type"
5105
5106       database type
5107
5108       Format:
5109           /"\S+"/
5110
5111       Default:
5112           None, mandatory.
5113
5114       Context:
5115           list (config)
5116
5117       "include_sql_query.db_host"
5118
5119       remote host
5120
5121       Format:
5122           /$host/
5123
5124       Default:
5125           None.
5126
5127       Context:
5128           list (config)
5129
5130       Available versions:
5131           6.2.57b.1 and later.
5132
5133       "include_sql_query.db_port"
5134
5135       database port
5136
5137       Format:
5138           /"\d+"/
5139
5140       Default:
5141           None.
5142
5143       Context:
5144           list (config)
5145
5146       "include_sql_query.db_name"
5147
5148       database name
5149
5150       Format:
5151           /"\S+"/
5152
5153       Default:
5154           None, mandatory.
5155
5156       Context:
5157           list (config)
5158
5159       "include_sql_query.db_options"
5160
5161       connection options
5162
5163       Format:
5164           /".+"/
5165
5166       Default:
5167           None.
5168
5169       Context:
5170           list (config)
5171
5172       Available versions:
5173           6.2.57b.1 and later.
5174
5175       "include_sql_query.db_env"
5176
5177       environment variables for database connection
5178
5179       Format:
5180           /"\w+\=\S+(;\w+\=\S+)*"/
5181
5182       Default:
5183           None.
5184
5185       Context:
5186           list (config)
5187
5188       "include_sql_query.db_user"
5189
5190       remote user
5191
5192       Format:
5193           /"\S+"/
5194
5195       Default:
5196           None, mandatory.
5197
5198       Context:
5199           list (config)
5200
5201       Available versions:
5202           6.2.57b.1 and later.
5203
5204       "include_sql_query.db_passwd"
5205
5206       remote password
5207
5208       Format:
5209           The value to be concealed.
5210
5211       Default:
5212           None.
5213
5214       Context:
5215           list (config)
5216
5217       Available versions:
5218           6.2.57b.1 and later.
5219
5220       "include_sql_query.sql_query"
5221
5222       SQL query
5223
5224       Format:
5225           /$sql_query/
5226
5227       Default:
5228           None, mandatory.
5229
5230       Context:
5231           list (config)
5232
5233       "include_sql_query.f_dir"
5234
5235       Directory where the database is stored (used for DBD::CSV only)
5236
5237       Format:
5238           /".+"/
5239
5240       Default:
5241           None.
5242
5243       Context:
5244           list (config)
5245
5246       "include_sql_query.nosync_time_ranges"
5247
5248       Time ranges when inclusion is not allowed
5249
5250       Format:
5251           /$time_ranges/
5252
5253       Default:
5254           None.
5255
5256       Context:
5257           list (config)
5258
5259       Available versions:
5260           6.2a.16 and later.
5261
5262       "include_sql_query.connect_options"
5263
5264       See "db_options".
5265
5266       Context:
5267           list (config)
5268
5269       Available versions:
5270           up to 6.2.56.
5271
5272       "include_sql_query.host"
5273
5274       See "db_host".
5275
5276       Context:
5277           list (config)
5278
5279       Available versions:
5280           up to 6.2.56.
5281
5282       "include_sql_query.passwd"
5283
5284       See "db_passwd".
5285
5286       Context:
5287           list (config)
5288
5289       Available versions:
5290           up to 6.2.56.
5291
5292       "include_sql_query.user"
5293
5294       See "db_user".
5295
5296       Context:
5297           list (config)
5298
5299       Available versions:
5300           up to 6.2.56.
5301
5302       "ttl"
5303
5304       Inclusions timeout
5305
5306       Format:
5307           Number of seconds.
5308
5309       Default:
5310           3600 (seconds)
5311
5312       Context:
5313           list (config), site (sympa.conf)
5314
5315       Sympa caches user data extracted using the include parameter. Their TTL
5316       (time-to-live) within Sympa can be controlled using this parameter. The
5317       default value is 3600
5318
5319       "distribution_ttl"
5320
5321       Inclusions timeout for message distribution
5322
5323       Format:
5324           Number of seconds.
5325
5326       Default:
5327           None.
5328
5329       Context:
5330           list (config), site (sympa.conf)
5331
5332       This parameter defines the delay since the last synchronization after
5333       which the user's list will be updated before performing either of
5334       following actions:
5335
5336       * Reviewing list members
5337
5338       * Message distribution
5339
5340       "include_ldap_ca"
5341
5342       (Paragraph) LDAP query custom attribute
5343
5344       Multiple occurrences allowed
5345
5346       "include_ldap_ca.name"
5347
5348       short name for this source
5349
5350       Format:
5351           /".+"/
5352
5353       Default:
5354           None.
5355
5356       Context:
5357           list (config)
5358
5359       "include_ldap_ca.host"
5360
5361       remote host
5362
5363       Format:
5364           /$multiple_host_or_url/
5365
5366       Default:
5367           None, mandatory.
5368
5369       Context:
5370           list (config)
5371
5372       "include_ldap_ca.port"
5373
5374       Deprecated.
5375
5376       Context:
5377           list (config)
5378
5379       "include_ldap_ca.use_tls"
5380
5381       use TLS (formerly SSL)
5382
5383       Format:
5384           "starttls" - use STARTTLS
5385           "ldaps" - use LDAPS (LDAP over TLS)
5386           "none" - do nothing
5387       Default:
5388           "none"
5389
5390       Context:
5391           list (config)
5392
5393       Available versions:
5394           6.2.15 and later.
5395
5396       "include_ldap_ca.ssl_version"
5397
5398       SSL version
5399
5400       Format:
5401           "sslv2" - SSL version 2
5402           "sslv3" - SSL version 3
5403           "tlsv1" - TLS version 1
5404           "tlsv1_1" - TLS version 1.1
5405           "tlsv1_2" - TLS version 1.2
5406           "tlsv1_3" - TLS version 1.3
5407       Default:
5408           "tlsv1"
5409
5410       Context:
5411           list (config)
5412
5413       "include_ldap_ca.ssl_ciphers"
5414
5415       SSL ciphers used
5416
5417       Format:
5418           /".+"/
5419
5420       Default:
5421           "ALL"
5422
5423       Context:
5424           list (config)
5425
5426       "include_ldap_ca.ca_verify"
5427
5428       Certificate verification
5429
5430       Format:
5431           "none" - do nothing
5432           "optional" - optional
5433           "required" - required
5434       Default:
5435           "required"
5436
5437       Context:
5438           list (config)
5439
5440       Available versions:
5441           6.2.13 and later.
5442
5443       "include_ldap_ca.bind_dn"
5444
5445       remote user
5446
5447       Format:
5448           /".+"/
5449
5450       Default:
5451           None.
5452
5453       Context:
5454           list (config)
5455
5456       Available versions:
5457           6.2.57b.1 and later.
5458
5459       "include_ldap_ca.bind_password"
5460
5461       remote password
5462
5463       Format:
5464           The value to be concealed.
5465
5466       Default:
5467           None.
5468
5469       Context:
5470           list (config)
5471
5472       Available versions:
5473           6.2.57b.1 and later.
5474
5475       "include_ldap_ca.suffix"
5476
5477       suffix
5478
5479       Format:
5480           /".+"/
5481
5482       Default:
5483           None.
5484
5485       Context:
5486           list (config)
5487
5488       "include_ldap_ca.scope"
5489
5490       search scope
5491
5492       Format:
5493           "base" - base
5494           "one" - one level
5495           "sub" - subtree
5496       Default:
5497           "sub"
5498
5499       Context:
5500           list (config)
5501
5502       "include_ldap_ca.timeout"
5503
5504       connection timeout
5505
5506       Format:
5507           Number of seconds.
5508
5509       Default:
5510           30 (seconds)
5511
5512       Context:
5513           list (config)
5514
5515       "include_ldap_ca.filter"
5516
5517       filter
5518
5519       Format:
5520           /".+"/
5521
5522       Default:
5523           None, mandatory.
5524
5525       Context:
5526           list (config)
5527
5528       "include_ldap_ca.attrs"
5529
5530       extracted attribute
5531
5532       Format:
5533           /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
5534
5535       Default:
5536           "mail"
5537
5538       Context:
5539           list (config)
5540
5541       "include_ldap_ca.email_entry"
5542
5543       Name of email entry
5544
5545       Format:
5546           /"\S+"/
5547
5548       Default:
5549           None, mandatory.
5550
5551       Context:
5552           list (config)
5553
5554       "include_ldap_ca.select"
5555
5556       selection (if multiple)
5557
5558       Format:
5559           "all" - all
5560           "first" - first entry
5561           "regex" - entries matching regular expression
5562       Default:
5563           "first"
5564
5565       Context:
5566           list (config)
5567
5568       "include_ldap_ca.regex"
5569
5570       regular expression
5571
5572       Format:
5573           /".+"/
5574
5575       Default:
5576           ""
5577
5578       Context:
5579           list (config)
5580
5581       "include_ldap_ca.nosync_time_ranges"
5582
5583       Time ranges when inclusion is not allowed
5584
5585       Format:
5586           /$time_ranges/
5587
5588       Default:
5589           None.
5590
5591       Context:
5592           list (config)
5593
5594       "include_ldap_ca.passwd"
5595
5596       See "bind_password".
5597
5598       Context:
5599           list (config)
5600
5601       Available versions:
5602           up to 6.2.56.
5603
5604       "include_ldap_ca.use_ssl"
5605
5606       See "use_tls".
5607
5608       Context:
5609           list (config)
5610
5611       Available versions:
5612           6.2a? to 6.2.14.
5613
5614       "include_ldap_ca.user"
5615
5616       See "bind_dn".
5617
5618       Context:
5619           list (config)
5620
5621       Available versions:
5622           up to 6.2.56.
5623
5624       "include_ldap_2level_ca"
5625
5626       (Paragraph) LDAP 2-level query custom attribute
5627
5628       Multiple occurrences allowed
5629
5630       "include_ldap_2level_ca.name"
5631
5632       short name for this source
5633
5634       Format:
5635           /".+"/
5636
5637       Default:
5638           None.
5639
5640       Context:
5641           list (config)
5642
5643       "include_ldap_2level_ca.host"
5644
5645       remote host
5646
5647       Format:
5648           /$multiple_host_or_url/
5649
5650       Default:
5651           None, mandatory.
5652
5653       Context:
5654           list (config)
5655
5656       "include_ldap_2level_ca.port"
5657
5658       Deprecated.
5659
5660       Context:
5661           list (config)
5662
5663       "include_ldap_2level_ca.use_tls"
5664
5665       use TLS (formerly SSL)
5666
5667       Format:
5668           "starttls" - use STARTTLS
5669           "ldaps" - use LDAPS (LDAP over TLS)
5670           "none" - do nothing
5671       Default:
5672           "none"
5673
5674       Context:
5675           list (config)
5676
5677       Available versions:
5678           6.2.15 and later.
5679
5680       "include_ldap_2level_ca.ssl_version"
5681
5682       SSL version
5683
5684       Format:
5685           "sslv2" - SSL version 2
5686           "sslv3" - SSL version 3
5687           "tlsv1" - TLS version 1
5688           "tlsv1_1" - TLS version 1.1
5689           "tlsv1_2" - TLS version 1.2
5690           "tlsv1_3" - TLS version 1.3
5691       Default:
5692           "tlsv1"
5693
5694       Context:
5695           list (config)
5696
5697       "include_ldap_2level_ca.ssl_ciphers"
5698
5699       SSL ciphers used
5700
5701       Format:
5702           /".+"/
5703
5704       Default:
5705           "ALL"
5706
5707       Context:
5708           list (config)
5709
5710       "include_ldap_2level_ca.ca_verify"
5711
5712       Certificate verification
5713
5714       Format:
5715           "none" - do nothing
5716           "optional" - optional
5717           "required" - required
5718       Default:
5719           "required"
5720
5721       Context:
5722           list (config)
5723
5724       Available versions:
5725           6.2.13 and later.
5726
5727       "include_ldap_2level_ca.bind_dn"
5728
5729       remote user
5730
5731       Format:
5732           /".+"/
5733
5734       Default:
5735           None.
5736
5737       Context:
5738           list (config)
5739
5740       Available versions:
5741           6.2.57b.1 and later.
5742
5743       "include_ldap_2level_ca.bind_password"
5744
5745       remote password
5746
5747       Format:
5748           The value to be concealed.
5749
5750       Default:
5751           None.
5752
5753       Context:
5754           list (config)
5755
5756       Available versions:
5757           6.2.57b.1 and later.
5758
5759       "include_ldap_2level_ca.suffix1"
5760
5761       first-level suffix
5762
5763       Format:
5764           /".+"/
5765
5766       Default:
5767           None.
5768
5769       Context:
5770           list (config)
5771
5772       "include_ldap_2level_ca.scope1"
5773
5774       first-level search scope
5775
5776       Format:
5777           "base" - base
5778           "one" - one level
5779           "sub" - subtree
5780       Default:
5781           "sub"
5782
5783       Context:
5784           list (config)
5785
5786       "include_ldap_2level_ca.timeout1"
5787
5788       first-level connection timeout
5789
5790       Format:
5791           Number of seconds.
5792
5793       Default:
5794           30 (seconds)
5795
5796       Context:
5797           list (config)
5798
5799       "include_ldap_2level_ca.filter1"
5800
5801       first-level filter
5802
5803       Format:
5804           /".+"/
5805
5806       Default:
5807           None, mandatory.
5808
5809       Context:
5810           list (config)
5811
5812       "include_ldap_2level_ca.attrs1"
5813
5814       first-level extracted attribute
5815
5816       Format:
5817           /$ldap_attrdesc/
5818
5819       Default:
5820           None.
5821
5822       Context:
5823           list (config)
5824
5825       "include_ldap_2level_ca.select1"
5826
5827       first-level selection
5828
5829       Format:
5830           "all" - all
5831           "first" - first entry
5832           "regex" - entries matching regular expression
5833       Default:
5834           "first"
5835
5836       Context:
5837           list (config)
5838
5839       "include_ldap_2level_ca.regex1"
5840
5841       first-level regular expression
5842
5843       Format:
5844           /".+"/
5845
5846       Default:
5847           ""
5848
5849       Context:
5850           list (config)
5851
5852       "include_ldap_2level_ca.suffix2"
5853
5854       second-level suffix template
5855
5856       Format:
5857           /".+"/
5858
5859       Default:
5860           None.
5861
5862       Context:
5863           list (config)
5864
5865       "include_ldap_2level_ca.scope2"
5866
5867       second-level search scope
5868
5869       Format:
5870           "base" - base
5871           "one" - one level
5872           "sub" - subtree
5873       Default:
5874           "sub"
5875
5876       Context:
5877           list (config)
5878
5879       "include_ldap_2level_ca.timeout2"
5880
5881       second-level connection timeout
5882
5883       Format:
5884           Number of seconds.
5885
5886       Default:
5887           30 (seconds)
5888
5889       Context:
5890           list (config)
5891
5892       "include_ldap_2level_ca.filter2"
5893
5894       second-level filter template
5895
5896       Format:
5897           /".+"/
5898
5899       Default:
5900           None, mandatory.
5901
5902       Context:
5903           list (config)
5904
5905       "include_ldap_2level_ca.attrs2"
5906
5907       second-level extracted attribute
5908
5909       Format:
5910           /$ldap_attrdesc/
5911
5912       Default:
5913           "mail"
5914
5915       Context:
5916           list (config)
5917
5918       "include_ldap_2level_ca.select2"
5919
5920       second-level selection
5921
5922       Format:
5923           "all" - all
5924           "first" - first entry
5925           "regex" - entries matching regular expression
5926       Default:
5927           "first"
5928
5929       Context:
5930           list (config)
5931
5932       "include_ldap_2level_ca.regex2"
5933
5934       second-level regular expression
5935
5936       Format:
5937           /".+"/
5938
5939       Default:
5940           ""
5941
5942       Context:
5943           list (config)
5944
5945       "include_ldap_2level_ca.email_entry"
5946
5947       Name of email entry
5948
5949       Format:
5950           /"\S+"/
5951
5952       Default:
5953           None, mandatory.
5954
5955       Context:
5956           list (config)
5957
5958       "include_ldap_2level_ca.nosync_time_ranges"
5959
5960       Time ranges when inclusion is not allowed
5961
5962       Format:
5963           /$time_ranges/
5964
5965       Default:
5966           None.
5967
5968       Context:
5969           list (config)
5970
5971       "include_ldap_2level_ca.passwd"
5972
5973       See "bind_password".
5974
5975       Context:
5976           list (config)
5977
5978       Available versions:
5979           up to 6.2.56.
5980
5981       "include_ldap_2level_ca.use_ssl"
5982
5983       See "use_tls".
5984
5985       Context:
5986           list (config)
5987
5988       Available versions:
5989           6.2a? to 6.2.14.
5990
5991       "include_ldap_2level_ca.user"
5992
5993       See "bind_dn".
5994
5995       Context:
5996           list (config)
5997
5998       Available versions:
5999           up to 6.2.56.
6000
6001       "include_sql_ca"
6002
6003       (Paragraph) SQL query custom attribute
6004
6005       Multiple occurrences allowed
6006
6007       "include_sql_ca.name"
6008
6009       short name for this source
6010
6011       Format:
6012           /".+"/
6013
6014       Default:
6015           None.
6016
6017       Context:
6018           list (config)
6019
6020       "include_sql_ca.db_type"
6021
6022       database type
6023
6024       Format:
6025           /"\S+"/
6026
6027       Default:
6028           None, mandatory.
6029
6030       Context:
6031           list (config)
6032
6033       "include_sql_ca.db_host"
6034
6035       remote host
6036
6037       Format:
6038           /$host/
6039
6040       Default:
6041           None.
6042
6043       Context:
6044           list (config)
6045
6046       Available versions:
6047           6.2.57b.1 and later.
6048
6049       "include_sql_ca.db_port"
6050
6051       database port
6052
6053       Format:
6054           /"\d+"/
6055
6056       Default:
6057           None.
6058
6059       Context:
6060           list (config)
6061
6062       "include_sql_ca.db_name"
6063
6064       database name
6065
6066       Format:
6067           /"\S+"/
6068
6069       Default:
6070           None, mandatory.
6071
6072       Context:
6073           list (config)
6074
6075       "include_sql_ca.db_options"
6076
6077       connection options
6078
6079       Format:
6080           /".+"/
6081
6082       Default:
6083           None.
6084
6085       Context:
6086           list (config)
6087
6088       Available versions:
6089           6.2.57b.1 and later.
6090
6091       "include_sql_ca.db_env"
6092
6093       environment variables for database connection
6094
6095       Format:
6096           /"\w+\=\S+(;\w+\=\S+)*"/
6097
6098       Default:
6099           None.
6100
6101       Context:
6102           list (config)
6103
6104       "include_sql_ca.db_user"
6105
6106       remote user
6107
6108       Format:
6109           /"\S+"/
6110
6111       Default:
6112           None, mandatory.
6113
6114       Context:
6115           list (config)
6116
6117       Available versions:
6118           6.2.57b.1 and later.
6119
6120       "include_sql_ca.db_passwd"
6121
6122       remote password
6123
6124       Format:
6125           The value to be concealed.
6126
6127       Default:
6128           None.
6129
6130       Context:
6131           list (config)
6132
6133       Available versions:
6134           6.2.57b.1 and later.
6135
6136       "include_sql_ca.sql_query"
6137
6138       SQL query
6139
6140       Format:
6141           /$sql_query/
6142
6143       Default:
6144           None, mandatory.
6145
6146       Context:
6147           list (config)
6148
6149       "include_sql_ca.f_dir"
6150
6151       Directory where the database is stored (used for DBD::CSV only)
6152
6153       Format:
6154           /".+"/
6155
6156       Default:
6157           None.
6158
6159       Context:
6160           list (config)
6161
6162       "include_sql_ca.email_entry"
6163
6164       Name of email entry
6165
6166       Format:
6167           /"\S+"/
6168
6169       Default:
6170           None, mandatory.
6171
6172       Context:
6173           list (config)
6174
6175       "include_sql_ca.nosync_time_ranges"
6176
6177       Time ranges when inclusion is not allowed
6178
6179       Format:
6180           /$time_ranges/
6181
6182       Default:
6183           None.
6184
6185       Context:
6186           list (config)
6187
6188       "include_sql_ca.connect_options"
6189
6190       See "db_options".
6191
6192       Context:
6193           list (config)
6194
6195       Available versions:
6196           up to 6.2.56.
6197
6198       "include_sql_ca.host"
6199
6200       See "db_host".
6201
6202       Context:
6203           list (config)
6204
6205       Available versions:
6206           up to 6.2.56.
6207
6208       "include_sql_ca.passwd"
6209
6210       See "db_passwd".
6211
6212       Context:
6213           list (config)
6214
6215       Available versions:
6216           up to 6.2.56.
6217
6218       "include_sql_ca.user"
6219
6220       See "db_user".
6221
6222       Context:
6223           list (config)
6224
6225       Available versions:
6226           up to 6.2.56.
6227
6228   DKIM/DMARC/ARC
6229       DKIM signature verification and re-signing. It requires an external
6230       module: Mail-DKIM.
6231
6232       ARC seals on forwarded messages. It requires an external module: Mail-
6233       DKIM.
6234
6235       "dkim_add_signature_to"
6236
6237       Which service messages to be signed
6238
6239       Format:
6240           /"(?:list|robot)(?:,(?:list|robot))*"/
6241
6242       Default:
6243           "robot,list"
6244
6245       Context:
6246           domain (robot.conf), site (sympa.conf)
6247
6248       Inserts a DKIM signature to service messages in context of robot, list
6249       or both
6250
6251       "dkim_signer_identity"
6252
6253       The "i=" tag as defined in rfc 4871
6254
6255       Format:
6256           /"\S+"/
6257
6258       Default:
6259           None.
6260
6261       Context:
6262           domain (robot.conf), site (sympa.conf)
6263
6264       Default is null.
6265
6266       "dkim_feature"
6267
6268       Insert DKIM signature to messages sent to the list
6269
6270       Format:
6271           "on" - enabled
6272           "off" - disabled
6273       Default:
6274           "off"
6275
6276       Context:
6277           domain (robot.conf), site (sympa.conf)
6278
6279       If set to "on", Sympa may verify DKIM signatures of incoming messages
6280       and/or insert DKIM signature to outgoing messages.
6281
6282       "dkim_parameters"
6283
6284       (Paragraph) DKIM configuration
6285
6286       Single occurrence
6287
6288       A set of parameters in order to define outgoing DKIM signature
6289
6290       "dkim_parameters.private_key_path"
6291
6292       File path for DKIM private key
6293
6294       Format:
6295           /"\S+"/
6296
6297       Default:
6298           None.
6299
6300       Context:
6301           list (config), domain (robot.conf), site (sympa.conf)
6302
6303       The file must contain a PEM encoded private key
6304
6305       "dkim_parameters.selector"
6306
6307       Selector for DNS lookup of DKIM public key
6308
6309       Format:
6310           /"\S+"/
6311
6312       Default:
6313           None.
6314
6315       Context:
6316           list (config), domain (robot.conf), site (sympa.conf)
6317
6318       The selector is used in order to build the DNS query for public key. It
6319       is up to you to choose the value you want but verify that you can query
6320       the public DKIM key for "<selector>._domainkey.your_domain"
6321
6322       "dkim_parameters.header_list"
6323
6324       Deprecated.
6325
6326       Context:
6327           list (config), domain (robot.conf), site (sympa.conf)
6328
6329       "dkim_parameters.signer_domain"
6330
6331       DKIM "d=" tag, you should probably use the default value
6332
6333       Format:
6334           /"\S+"/
6335
6336       Default:
6337           None.
6338
6339       Context:
6340           list (config), domain (robot.conf), site (sympa.conf)
6341
6342       The DKIM "d=" tag, is the domain of the signing entity. The list domain
6343       MUST be included in the "d=" domain
6344
6345       "dkim_parameters.signer_identity"
6346
6347       DKIM "i=" tag, you should probably leave this parameter empty
6348
6349       Format:
6350           /"\S+"/
6351
6352       Default:
6353           None.
6354
6355       Context:
6356           list (config)
6357
6358       DKIM "i=" tag, you should probably not use this parameter, as
6359       recommended by RFC 4871, default for list broadcasted messages is
6360       i=<listname>-request@<domain>
6361
6362       "dkim_signature_apply_on"
6363
6364       The categories of messages sent to the list that will be signed using
6365       DKIM.
6366
6367       Format:
6368           Multiple values allowed, separated by "","".
6369
6370           "md5_authenticated_messages" - authenticated by password
6371           "smime_authenticated_messages" - authenticated by S/MIME signature
6372           "dkim_authenticated_messages" - authenticated by DKIM signature
6373           "editor_validated_messages" - approved by moderator
6374           "none" - do nothing
6375           "any" - any messages
6376       Default:
6377           "md5_authenticated_messages,smime_authenticated_messages,dkim_authenticated_messages,editor_validated_messages"
6378
6379       Context:
6380           list (config), domain (robot.conf), site (sympa.conf)
6381
6382       This parameter controls in which case messages must be signed using
6383       DKIM, you may sign every message choosing 'any' or a subset. The
6384       parameter value is a comma separated list of keywords
6385
6386       "arc_feature"
6387
6388       Add ARC seals to messages sent to the list
6389
6390       Format:
6391           "on" - enabled
6392           "off" - disabled
6393       Default:
6394           "off"
6395
6396       Context:
6397           list (config), domain (robot.conf), site (sympa.conf)
6398
6399       Available versions:
6400           6.2.37b.1 and later.
6401
6402       Enable/Disable ARC. This feature requires Mail::DKIM::ARC to be
6403       installed, and maybe some custom scenario to be updated
6404
6405       "arc_srvid"
6406
6407       SRV ID for Authentication-Results used in ARC seal
6408
6409       Format:
6410           /"\S+"/
6411
6412       Default:
6413           None.
6414
6415       Context:
6416           domain (robot.conf), site (sympa.conf)
6417
6418       Available versions:
6419           6.2.37b.1 and later.
6420
6421       Typically the domain of the mail server
6422
6423       "arc_parameters"
6424
6425       (Paragraph) ARC configuration
6426
6427       Single occurrence
6428
6429       A set of parameters in order to define outgoing ARC seal
6430
6431       "arc_parameters.arc_private_key_path"
6432
6433       File path for ARC private key
6434
6435       Format:
6436           /"\S+"/
6437
6438       Default:
6439           None.
6440
6441       Context:
6442           list (config), domain (robot.conf), site (sympa.conf)
6443
6444       The file must contain a PEM encoded private key. Defaults to same file
6445       as DKIM private key
6446
6447       "arc_parameters.arc_selector"
6448
6449       Selector for DNS lookup of ARC public key
6450
6451       Format:
6452           /"\S+"/
6453
6454       Default:
6455           None.
6456
6457       Context:
6458           list (config), domain (robot.conf), site (sympa.conf)
6459
6460       The selector is used in order to build the DNS query for public key. It
6461       is up to you to choose the value you want but verify that you can query
6462       the public DKIM key for "<selector>._domainkey.your_domain". Default is
6463       the same selector as for DKIM signatures
6464
6465       "arc_parameters.arc_signer_domain"
6466
6467       ARC "d=" tag, you should probably use the default value
6468
6469       Format:
6470           /"\S+"/
6471
6472       Default:
6473           None.
6474
6475       Context:
6476           list (config), domain (robot.conf), site (sympa.conf)
6477
6478       The ARC "d=" tag is the domain of the signing entity. The DKIM d=
6479       domain name is used as its default value
6480
6481       "dmarc_protection"
6482
6483       (Paragraph) DMARC Protection
6484
6485       Single occurrence
6486
6487       Parameters to define how to manage From address processing to avoid
6488       some domains' excessive DMARC protection
6489
6490       "dmarc_protection.mode"
6491
6492       Protection modes
6493
6494       Format:
6495           Multiple values allowed, separated by "","".
6496
6497           "none" - do nothing
6498           "all" - all
6499           "dkim_signature" - DKIM signature exists
6500           "dmarc_reject" - DMARC policy suggests rejection
6501           "dmarc_any" - DMARC policy exists
6502           "dmarc_quarantine" - DMARC policy suggests quarantine
6503           "domain_regex" - domain matching regular expression
6504       Default:
6505           None.
6506
6507       Context:
6508           list (config), domain (robot.conf), site (sympa.conf)
6509
6510       Select one or more operation modes.  "Domain matching regular
6511       expression" (domain_regex) matches the specified Domain regular
6512       expression; "DKIM signature exists" (dkim_signature) matches any
6513       message with a DKIM signature header; "DMARC policy ..." (dmarc_*)
6514       matches messages from sender domains with a DMARC policy as given;
6515       "all" (all) matches all messages.
6516
6517       Example:
6518
6519         dmarc_protection.mode dmarc_reject,dkim_signature
6520
6521       "dmarc_protection.domain_regex"
6522
6523       Regular expression for domain name match
6524
6525       Format:
6526           /".+"/
6527
6528       Default:
6529           None.
6530
6531       Context:
6532           list (config), domain (robot.conf), site (sympa.conf)
6533
6534       Regular expression match pattern for From domain
6535
6536       "dmarc_protection.other_email"
6537
6538       New From address
6539
6540       Format:
6541           /".+"/
6542
6543       Default:
6544           None.
6545
6546       Context:
6547           list (config), domain (robot.conf), site (sympa.conf)
6548
6549       This is the email address to use when modifying the From header.  It
6550       defaults to the list address.  This is similar to Anonymisation but
6551       preserves the original sender details in the From address phrase.
6552
6553       "dmarc_protection.phrase"
6554
6555       New From name format
6556
6557       Format:
6558           "display_name" - "Name"
6559           "name_and_email" - "Name" (e-mail)
6560           "name_via_list" - "Name" (via List)
6561           "name_email_via_list" - "Name" (e-mail via List)
6562           "list_for_email" - "List" (on behalf of e-mail)
6563           "list_for_name" - "List" (on behalf of Name)
6564       Default:
6565           "name_via_list"
6566
6567       Context:
6568           list (config), domain (robot.conf), site (sympa.conf)
6569
6570       This is the format to be used for the sender name part of the new From
6571       header field.
6572
6573   List address verification
6574       Checks if an alias with the same name as the list to be created already
6575       exists on the SMTP server. This feature requires an external module:
6576       Net-SMTP.
6577
6578       "list_check_helo"
6579
6580       SMTP HELO (EHLO) parameter used for address verification
6581
6582       Format:
6583           /"\S+"/
6584
6585       Default:
6586           None.
6587
6588       Context:
6589           domain (robot.conf), site (sympa.conf)
6590
6591       Available versions:
6592           6.2a.0 and later.
6593
6594       Default value is the host part of "list_check_smtp" parameter.
6595
6596       "list_check_smtp"
6597
6598       SMTP server to verify existence of the same addresses as the list to be
6599       created
6600
6601       Format:
6602           /$hostport/
6603
6604       Default:
6605           None.
6606
6607       Context:
6608           domain (robot.conf), site (sympa.conf)
6609
6610       This is needed if you are running Sympa on a host but you handle all
6611       your mail on a separate mail relay.
6612
6613       Default value is real FQDN of the host. Port number may be specified as
6614       "mail.example.org:25" or "203.0.113.1:25".  If port is not specified,
6615       standard port (25) will be used.
6616
6617       "list_check_suffixes"
6618
6619       Address suffixes to verify
6620
6621       Format:
6622           /"\S+"/
6623
6624       Default:
6625           "request,owner,editor,unsubscribe,subscribe"
6626
6627       Context:
6628           domain (robot.conf), site (sympa.conf)
6629
6630       List of suffixes you are using for list addresses, i.e. "mylist-
6631       request", "mylist-owner" and so on.
6632
6633       This parameter is used with the "list_check_smtp" parameter. It is also
6634       used to check list names at list creation time.
6635
6636   Antivirus plug-in
6637       "antivirus_path"
6638
6639       Path to the antivirus scanner engine
6640
6641       Format:
6642           /".+"/
6643
6644       Default:
6645           None.
6646
6647       Context:
6648           domain (robot.conf), site (sympa.conf)
6649
6650       Supported antivirus: Clam AntiVirus/clamscan & clamdscan,
6651       McAfee/uvscan, Fsecure/fsav, Sophos, AVP and Trend Micro/VirusWall
6652
6653       Example:
6654
6655         antivirus_path /usr/local/bin/clamscan
6656
6657       "antivirus_args"
6658
6659       Antivirus plugin command line arguments
6660
6661       Format:
6662           /".+"/
6663
6664       Default:
6665           None.
6666
6667       Context:
6668           domain (robot.conf), site (sympa.conf)
6669
6670       Example:
6671
6672         antivirus_args --no-summary --database /usr/local/share/clamav
6673
6674       "antivirus_notify"
6675
6676       Notify sender if virus checker detects malicious content
6677
6678       Format:
6679           "sender" - sender
6680           "delivery_status" - send back DSN
6681           "none" - do nothing
6682       Default:
6683           "sender"
6684
6685       Context:
6686           domain (robot.conf), site (sympa.conf)
6687
6688       "sender" to notify originator of the message, "delivery_status" to send
6689       delivery status, or "none"
6690
6691   Miscellaneous
6692       "email"
6693
6694       Local part of Sympa email address
6695
6696       Format:
6697           /"\S+"/
6698
6699       Default:
6700           "sympa"
6701
6702       Context:
6703           domain (robot.conf), site (sympa.conf)
6704
6705       Local part (the part preceding the "@" sign) of the address by which
6706       mail interface of Sympa accepts mail commands.
6707
6708       If you change the default value, you must modify the mail aliases too.
6709
6710       "listmaster_email"
6711
6712       Local part of listmaster email address
6713
6714       Format:
6715           /"\S+"/
6716
6717       Default:
6718           "listmaster"
6719
6720       Context:
6721           domain (robot.conf), site (sympa.conf)
6722
6723       Local part (the part preceding the "@" sign) of the address by which
6724       listmasters receive messages.
6725
6726       If you change the default value, you must modify the mail aliases too.
6727
6728       "custom_robot_parameter"
6729
6730       Custom robot parameter
6731
6732       Format:
6733           Multiple occurrences allowed.
6734
6735           /".+"/
6736
6737       Default:
6738           None.
6739
6740       Context:
6741           domain (robot.conf), site (sympa.conf)
6742
6743       Used to define a custom parameter for your server. Do not forget the
6744       semicolon between the parameter name and the parameter value.
6745
6746       You will be able to access the custom parameter value in web templates
6747       by variable "conf.custom_robot_parameter.<param_name>"
6748
6749       Example:
6750
6751         custom_robot_parameter param_name ; param_value
6752
6753       "prohibited_listnames"
6754
6755       Prevent people to use some names for their lists names
6756
6757       Format:
6758           Any.
6759
6760       Default:
6761           None.
6762
6763       Context:
6764           site (sympa.conf)
6765
6766       Available versions:
6767           6.2.63b.1 and later.
6768
6769       This parameter is a comma-separated list of names. You can use * as a
6770       wildcard character. To use a regex for this, please use
6771       prohibited_listnames_regex setting.
6772
6773       Example:
6774
6775         prohibited_listnames www,root,*master
6776
6777       "prohibited_listnames_regex"
6778
6779       Prevent people to use some names for their lists names, based on a
6780       regex
6781
6782       Format:
6783           Any.
6784
6785       Default:
6786           None.
6787
6788       Context:
6789           site (sympa.conf)
6790
6791       Available versions:
6792           6.2.63b.1 and later.
6793
6794       This parameter is a regex. Please note that prohibited_listnames and
6795       prohibited_listnames_regex will both be applied if set, they are not
6796       exclusive.
6797
6798       Example:
6799
6800         prohibited_listnames_regex www|root|.*master
6801
6802       "cache_list_config"
6803
6804       Use of binary cache of list configuration
6805
6806       Format:
6807           "binary_file" - use binary file
6808           "none" - do nothing
6809       Default:
6810           "none"
6811
6812       Context:
6813           site (sympa.conf)
6814
6815       binary_file: Sympa processes will maintain a binary version of the list
6816       configuration, "config.bin" file on local disk. If you manage a big
6817       amount of lists (1000+), it should make the web interface startup
6818       faster.
6819
6820       You can recreate cache by running "sympa.pl --reload_list_config".
6821
6822       "db_list_cache"
6823
6824       Use database cache to search lists
6825
6826       Format:
6827           "on" - enabled
6828           "off" - disabled
6829       Default:
6830           "off"
6831
6832       Context:
6833           site (sympa.conf)
6834
6835       Note that "list_table" database table should be filled at the first
6836       time by running:
6837
6838         # sympa.pl --sync_list_db
6839
6840       "purge_user_table_task"
6841
6842       Task for expiring inactive users
6843
6844       Format:
6845           /"\w+"/
6846
6847       Default:
6848           "monthly"
6849
6850       Context:
6851           site (sympa.conf)
6852
6853       This task removes rows in the "user_table" table which have not
6854       corresponding entries in the "subscriber_table" table.
6855
6856       "purge_logs_table_task"
6857
6858       Task for cleaning tables
6859
6860       Format:
6861           /"\w+"/
6862
6863       Default:
6864           "daily"
6865
6866       Context:
6867           site (sympa.conf)
6868
6869       This task cleans old logs from "logs_table" table.
6870
6871       "logs_expiration_period"
6872
6873       Max age of logs in database
6874
6875       Format:
6876           Number of months.
6877
6878       Default:
6879           3 (months)
6880
6881       Context:
6882           site (sympa.conf)
6883
6884       Number of months that elapse before a log is expired
6885
6886       "stats_expiration_period"
6887
6888       Max age of statistics information in database
6889
6890       Format:
6891           Number of months.
6892
6893       Default:
6894           3 (months)
6895
6896       Context:
6897           site (sympa.conf)
6898
6899       Available versions:
6900           6.2b.7 and later.
6901
6902       Number of months that elapse before statistics information are expired
6903
6904       "umask"
6905
6906       Umask
6907
6908       Format:
6909           /"[0-7]+"/
6910
6911       Default:
6912           027
6913
6914       Context:
6915           site (sympa.conf)
6916
6917       Default mask for file creation (see umask(2)). Note that it will be
6918       interpreted as an octal value.
6919
6920       "clean_delay_queuemod"
6921
6922       Max age of moderated messages
6923
6924       Format:
6925           Number of days.
6926
6927       Default:
6928           30 (days)
6929
6930       Context:
6931           list (config), site (sympa.conf)
6932
6933       Number of days messages are kept in moderation spool (as specified by
6934       "queuemod" parameter). Beyond this deadline, messages that have not
6935       been processed are deleted.
6936
6937       "custom_attribute"
6938
6939       (Paragraph) Custom user attributes
6940
6941       Multiple occurrences allowed
6942
6943       "custom_attribute.id"
6944
6945       internal identifier
6946
6947       Format:
6948           /"\w+"/
6949
6950       Default:
6951           None, mandatory.
6952
6953       Context:
6954           list (config)
6955
6956       "custom_attribute.name"
6957
6958       label
6959
6960       Format:
6961           /".+"/
6962
6963       Default:
6964           None, mandatory.
6965
6966       Context:
6967           list (config)
6968
6969       "custom_attribute.comment"
6970
6971       additional comment
6972
6973       Format:
6974           /".+"/
6975
6976       Default:
6977           None.
6978
6979       Context:
6980           list (config)
6981
6982       "custom_attribute.type"
6983
6984       type
6985
6986       Format:
6987           "string" - string
6988           "text" - multi-line text
6989           "integer" - number
6990           "enum" - set of keywords
6991       Default:
6992           "string"
6993
6994       Context:
6995           list (config)
6996
6997       "custom_attribute.enum_values"
6998
6999       possible attribute values (if enum is used)
7000
7001       Format:
7002           /".+"/
7003
7004       Default:
7005           None.
7006
7007       Context:
7008           list (config)
7009
7010       "custom_attribute.optional"
7011
7012       is the attribute optional?
7013
7014       Format:
7015           "required" - required
7016           "optional" - optional
7017       Default:
7018           "optional"
7019
7020       Context:
7021           list (config)
7022
7023       "custom_vars"
7024
7025       (Paragraph) custom parameters
7026
7027       Multiple occurrences allowed
7028
7029       "custom_vars.name"
7030
7031       var name
7032
7033       Format:
7034           /"\S+"/
7035
7036       Default:
7037           None, mandatory.
7038
7039       Context:
7040           list (config)
7041
7042       "custom_vars.value"
7043
7044       var value
7045
7046       Format:
7047           /".+"/
7048
7049       Default:
7050           None, mandatory.
7051
7052       Context:
7053           list (config)
7054
7055       "loop_prevention_regex"
7056
7057       Regular expression applied to prevent loops with robots
7058
7059       Format:
7060           /"\S*"/
7061
7062       Default:
7063           "mailer-daemon|sympa|listserv|majordomo|smartlist|mailman"
7064
7065       Context:
7066           list (config), domain (robot.conf), site (sympa.conf)
7067
7068       If the sender address matches the regular expression, then the message
7069       is rejected.
7070
7071       "pictures_feature"
7072
7073       Pictures
7074
7075       Format:
7076           "on" - enabled
7077           "off" - disabled
7078       Default:
7079           "on"
7080
7081       Context:
7082           list (config), domain (robot.conf), site (sympa.conf)
7083
7084       Enables or disables the pictures feature by default.  If enabled,
7085       subscribers can upload their picture (from the "Subscriber option"
7086       page) to use as an avatar.
7087
7088       Pictures are stored in a directory specified by the
7089       "static_content_path" parameter.
7090
7091       "remind_task"
7092
7093       Periodical subscription reminder task
7094
7095       Format:
7096           /"\w+"/
7097
7098       Default:
7099           None.
7100
7101       Context:
7102           list (config), site (sympa.conf)
7103
7104       This parameter states which model is used to create a remind task. A
7105       remind task regularly sends  subscribers a message which reminds them
7106       of their list subscriptions.
7107
7108       "latest_instantiation"
7109
7110       (Paragraph) Latest family instantiation
7111
7112       Single occurrence
7113
7114       "latest_instantiation.email"
7115
7116       who ran the instantiation
7117
7118       Format:
7119           /"listmaster|$email"/
7120
7121       Default:
7122           None.
7123
7124       Context:
7125           list (config)
7126
7127       "latest_instantiation.date_epoch"
7128
7129       date
7130
7131       Format:
7132           The time in second from Unix epoch.
7133
7134       Default:
7135           None, mandatory.
7136
7137       Context:
7138           list (config)
7139
7140       "latest_instantiation.date"
7141
7142       Deprecated.
7143
7144       Context:
7145           list (config)
7146
7147       Available versions:
7148           up to 6.2.16.
7149
7150       "creation"
7151
7152       (Paragraph) Creation of the list
7153
7154       Single occurrence
7155
7156       "creation.email"
7157
7158       who created the list
7159
7160       Format:
7161           /"listmaster|$email"/
7162
7163       Default:
7164           None, mandatory.
7165
7166       Context:
7167           list (config)
7168
7169       "creation.date_epoch"
7170
7171       date
7172
7173       Format:
7174           The time in second from Unix epoch.
7175
7176       Default:
7177           None, mandatory.
7178
7179       Context:
7180           list (config)
7181
7182       "creation.date"
7183
7184       Deprecated.
7185
7186       Context:
7187           list (config)
7188
7189       Available versions:
7190           up to 6.2.16.
7191
7192       "update"
7193
7194       (Paragraph) Last update of config
7195
7196       Single occurrence
7197
7198       "update.email"
7199
7200       who updated the config
7201
7202       Format:
7203           /"(listmaster|automatic|$email)"/
7204
7205       Default:
7206           None.
7207
7208       Context:
7209           list (config)
7210
7211       "update.date_epoch"
7212
7213       date
7214
7215       Format:
7216           The time in second from Unix epoch.
7217
7218       Default:
7219           None, mandatory.
7220
7221       Context:
7222           list (config)
7223
7224       "update.date"
7225
7226       Deprecated.
7227
7228       Context:
7229           list (config)
7230
7231       Available versions:
7232           up to 6.2.16.
7233
7234       "status"
7235
7236       Status of the list
7237
7238       Format:
7239           Status of list.
7240
7241       Default:
7242           "open"
7243
7244       Context:
7245           list (config)
7246
7247       "serial"
7248
7249       Serial number of the config
7250
7251       Format:
7252           /"\d+"/
7253
7254       Default:
7255           0
7256
7257       Context:
7258           list (config)
7259
7260   Web interface parameters
7261       "wwsympa_url"
7262
7263       URL prefix of web interface
7264
7265       Format:
7266           Any.
7267
7268       Default:
7269           None.
7270
7271       Context:
7272           domain (robot.conf), site (sympa.conf)
7273
7274       This is used to construct URLs of web interface. The protocol (either
7275       https:// or http://) is required.
7276
7277       Example:
7278
7279         wwsympa_url https://web.example.org/sympa
7280
7281       "wwsympa_url_local"
7282
7283       URL prefix of WWSympa behind proxy
7284
7285       Format:
7286           Any.
7287
7288       Default:
7289           None.
7290
7291       Context:
7292           domain (robot.conf), site (sympa.conf)
7293
7294       Available versions:
7295           6.2.56 and later.
7296
7297       "static_content_url"
7298
7299       URL for static contents
7300
7301       Format:
7302           Any.
7303
7304       Default:
7305           "/static-sympa"
7306
7307       Context:
7308           domain (robot.conf), site (sympa.conf)
7309
7310       HTTP server have to map it with "static_content_path" directory.
7311
7312       "static_content_path"
7313
7314       Directory for static contents
7315
7316       Format:
7317           Any.
7318
7319       Default:
7320           $STATICDIR
7321
7322       Context:
7323           domain (robot.conf), site (sympa.conf)
7324
7325       "css_path"
7326
7327       Directory for static style sheets (CSS)
7328
7329       Format:
7330           Any.
7331
7332       Default:
7333           $CSSDIR
7334
7335       Context:
7336           site (sympa.conf)
7337
7338       After an upgrade, static CSS files are upgraded with the newly
7339       installed "css.tt2" template. Therefore, this is not a good place to
7340       store customized CSS files.
7341
7342       "css_url"
7343
7344       URL for style sheets (CSS)
7345
7346       Format:
7347           Any.
7348
7349       Default:
7350           "/static-sympa/css"
7351
7352       Context:
7353           site (sympa.conf)
7354
7355       To use auto-generated static CSS, HTTP server have to map it with
7356       "css_path".
7357
7358       "pictures_path"
7359
7360       Directory for subscribers pictures
7361
7362       Format:
7363           Any.
7364
7365       Default:
7366           $PICTURESDIR
7367
7368       Context:
7369           site (sympa.conf)
7370
7371       Available versions:
7372           6.2.25b.2 and later.
7373
7374       "pictures_url"
7375
7376       URL for subscribers pictures
7377
7378       Format:
7379           Any.
7380
7381       Default:
7382           "/static-sympa/pictures"
7383
7384       Context:
7385           site (sympa.conf)
7386
7387       Available versions:
7388           6.2.25b.2 and later.
7389
7390       HTTP server have to map it with "pictures_path" directory.
7391
7392       "mhonarc"
7393
7394       Path to MHonArc mail-to-HTML converter
7395
7396       Format:
7397           Any.
7398
7399       Default:
7400           "/usr/bin/mhonarc"
7401
7402       Context:
7403           domain (robot.conf), site (sympa.conf)
7404
7405       This is required for HTML mail archiving.
7406
7407       "log_facility"
7408
7409       System log facility for web interface
7410
7411       Format:
7412           Any.
7413
7414       Default:
7415           "LOCAL1"
7416
7417       Context:
7418           site (sympa.conf)
7419
7420       System log facility for WWSympa, archived.pl and bounced.pl. Default is
7421       to use value of "syslog" parameter.
7422
7423   Web interface parameters: Appearances
7424       "logo_html_definition"
7425
7426       Custom logo
7427
7428       Format:
7429           Any.
7430
7431       Default:
7432           None.
7433
7434       Context:
7435           domain (robot.conf), site (sympa.conf)
7436
7437       HTML fragment to insert a logo in the page of web interface.
7438
7439       Example:
7440
7441         logo_html_definition <a href="http://www.example.com"><img style="float: left; margin-top: 7px; margin-left: 37px;" src="http://www.example.com/logos/mylogo.jpg" alt="My Company" /></a>
7442
7443       "favicon_url"
7444
7445       Custom favicon
7446
7447       Format:
7448           Any.
7449
7450       Default:
7451           None.
7452
7453       Context:
7454           domain (robot.conf), site (sympa.conf)
7455
7456       Available versions:
7457           6.2a.5 and later.
7458
7459       URL of favicon image
7460
7461       "color_0", ..., "color_15"
7462
7463       Colors for web interface
7464
7465       Format:
7466           Any.
7467
7468       Default:
7469           See description on web interface.
7470
7471       Context:
7472           domain (robot.conf), site (sympa.conf)
7473
7474       Colors are used in style sheet (CSS). They may be changed using web
7475       interface by listmasters.
7476
7477       "dark_color", "light_color", "text_color", "bg_color", "error_color",
7478       "selected_color", "shaded_color"
7479
7480       Colors for web interface, obsoleted
7481
7482       Format:
7483           Any.
7484
7485       Default:
7486           See description on web interface.
7487
7488       Context:
7489           domain (robot.conf), site (sympa.conf)
7490
7491       "default_home"
7492
7493       Type of main web page
7494
7495       Format:
7496           Any.
7497
7498       Default:
7499           "home"
7500
7501       Context:
7502           domain (robot.conf), site (sympa.conf)
7503
7504       "lists" for the page of list of lists. "home" for home page.
7505
7506       "archive_default_index"
7507
7508       Default index organization of web archive
7509
7510       Format:
7511           Any.
7512
7513       Default:
7514           "thrd"
7515
7516       Context:
7517           site (sympa.conf)
7518
7519       thrd: Threaded index.
7520
7521       mail: Chronological index.
7522
7523       "review_page_size"
7524
7525       Size of review page
7526
7527       Format:
7528           Any.
7529
7530       Default:
7531           25
7532
7533       Context:
7534           domain (robot.conf), site (sympa.conf)
7535
7536       Default number of lines of the array displaying users in the review
7537       page
7538
7539       "viewlogs_page_size"
7540
7541       Size of viewlogs page
7542
7543       Format:
7544           Any.
7545
7546       Default:
7547           25
7548
7549       Context:
7550           domain (robot.conf), site (sympa.conf)
7551
7552       Default number of lines of the array displaying the log entries in the
7553       logs page.
7554
7555       "main_menu_custom_button_1_title", ...
7556       "main_menu_custom_button_3_title", "main_menu_custom_button_1_url", ...
7557       "main_menu_custom_button_3_url", "main_menu_custom_button_1_target",
7558       ... "main_menu_custom_button_3_target"
7559
7560       Custom menus
7561
7562       Format:
7563           Any.
7564
7565       Default:
7566           None.
7567
7568       Context:
7569           domain (robot.conf), site (sympa.conf)
7570
7571       You may modify the main menu content by editing the menu.tt2 file, but
7572       you can also edit these parameters in order to add up to 3 buttons.
7573       Each button is defined by a title (the text in the button), an URL and,
7574       optionally, a target.
7575
7576       Example:
7577
7578         main_menu_custom_button_1_title FAQ
7579         main_menu_custom_button_1_url http://www.renater.fr/faq/universalistes/index
7580         main_menu_custom_button_1_target Help
7581
7582   Password validation
7583       Checks if the password the user submitted has sufficient strength. This
7584       feature requires an external module: Data-Password.
7585
7586       "password_validation"
7587
7588       Password validation
7589
7590       Format:
7591           Any.
7592
7593       Default:
7594           None.
7595
7596       Context:
7597           site (sympa.conf)
7598
7599       Available versions:
7600           6.1.23 and later.
7601
7602       The password validation techniques to be used against user passwords
7603       that are added to mailing lists. Options come from Data::Password
7604       https://metacpan.org/pod/Data::Password#VARIABLES
7605
7606       Example:
7607
7608         password_validation MINLEN=8,GROUPS=3,DICTIONARY=4,DICTIONARIES=/pentest/dictionaries
7609
7610   Authentication with LDAP
7611       Authenticates users based on the directory on LDAP server. This feature
7612       requires an external module: Net-LDAP. And also, if secure connection
7613       (LDAPS) is required: IO-Socket-SSL.
7614
7615       "ldap_force_canonical_email"
7616
7617       Use canonical email address for LDAP authentication
7618
7619       Format:
7620           Any.
7621
7622       Default:
7623           1
7624
7625       Context:
7626           domain (robot.conf), site (sympa.conf)
7627
7628       When using LDAP authentication, if the identifier provided by the user
7629       was a valid email, if this parameter is set to false, then the provided
7630       email will be used to authenticate the user. Otherwise, use of the
7631       first email returned by the LDAP server will be used.
7632
7633   SOAP HTTP interface
7634       Provides some functions of Sympa through the SOAP HTTP interface. This
7635       feature requires an external module: SOAP-Lite.
7636
7637       "soap_url"
7638
7639       URL of SympaSOAP
7640
7641       Format:
7642           Any.
7643
7644       Default:
7645           None.
7646
7647       Context:
7648           domain (robot.conf), site (sympa.conf)
7649
7650       WSDL document of SympaSOAP refers to this URL in its service section.
7651
7652       Example:
7653
7654         soap_url http://web.example.org/sympasoap
7655
7656       "soap_url_local"
7657
7658       URL of SympaSOAP behind proxy
7659
7660       Format:
7661           Any.
7662
7663       Default:
7664           None.
7665
7666       Context:
7667           domain (robot.conf), site (sympa.conf)
7668
7669       Available versions:
7670           6.2.19b.1 and later.
7671
7672   Web interface parameters: Miscellaneous
7673       "cookie_domain"
7674
7675       HTTP cookies validity domain
7676
7677       Format:
7678           Any.
7679
7680       Default:
7681           "localhost"
7682
7683       Context:
7684           domain (robot.conf), site (sympa.conf)
7685
7686       If beginning with a dot ("."), the cookie is available within the
7687       specified Internet domain. Otherwise, for the specified host. The only
7688       reason for replacing the default value would be where WWSympa's
7689       authentication process is shared with an application running on another
7690       host.
7691
7692       Example:
7693
7694         cookie_domain .renater.fr
7695
7696       "cookie_expire"
7697
7698       HTTP cookies lifetime
7699
7700       Format:
7701           Any.
7702
7703       Default:
7704           0
7705
7706       Context:
7707           site (sympa.conf)
7708
7709       This is the default value when not set explicitly by users. "0" means
7710       the cookie may be retained during browser sessions.
7711
7712       "cookie_refresh"
7713
7714       Average interval to refresh HTTP session ID.
7715
7716       Format:
7717           Any.
7718
7719       Default:
7720           60
7721
7722       Context:
7723           site (sympa.conf)
7724
7725       "purge_session_table_task"
7726
7727       Task for cleaning old sessions
7728
7729       Format:
7730           /"\w+"/
7731
7732       Default:
7733           "daily"
7734
7735       Context:
7736           site (sympa.conf)
7737
7738       This task removes old entries in the "session_table" table.
7739
7740       "session_table_ttl"
7741
7742       Max age of sessions
7743
7744       Format:
7745           Any.
7746
7747       Default:
7748           "2d"
7749
7750       Context:
7751           site (sympa.conf)
7752
7753       Session duration is controlled by "sympa_session" cookie validity
7754       attribute. However, by security reason, this delay also need to be
7755       controlled by server side. This task removes old entries in the
7756       "session_table" table.
7757
7758       Format of values is a string without spaces including "y" for years,
7759       "m" for months, "d" for days, "h" for hours, "min" for minutes and
7760       "sec" for seconds.
7761
7762       "anonymous_session_table_ttl"
7763
7764       Max age of sessions for anonymous users
7765
7766       Format:
7767           Any.
7768
7769       Default:
7770           "1h"
7771
7772       Context:
7773           site (sympa.conf)
7774
7775       "shared_feature"
7776
7777       Enable shared repository
7778
7779       Format:
7780           "on" - enabled
7781           "off" - disabled
7782       Default:
7783           "off"
7784
7785       Context:
7786           domain (robot.conf), site (sympa.conf)
7787
7788       Available versions:
7789           6.2.41b.2 and later.
7790
7791       If set to "on", list owners can open shared repository.
7792
7793       "use_html_editor"
7794
7795       Use HTML editor
7796
7797       Format:
7798           "off" - disabled
7799           "on" - enabled
7800       Default:
7801           "off"
7802
7803       Context:
7804           domain (robot.conf), site (sympa.conf)
7805
7806       Available versions:
7807           6.2a.0 and later.
7808
7809       If set to "on", users will be able to post messages in HTML using a
7810       javascript WYSIWYG editor.
7811
7812       Example:
7813
7814         use_html_editor on
7815
7816       "html_editor_url"
7817
7818       URL of HTML editor
7819
7820       Format:
7821           Any.
7822
7823       Default:
7824           None.
7825
7826       Context:
7827           domain (robot.conf), site (sympa.conf)
7828
7829       Available versions:
7830           6.2a.34 and later.
7831
7832       URL path to the javascript file making the WYSIWYG HTML editor
7833       available.  Relative path under <static_content_url> or absolute path.
7834
7835       Example is for TinyMCE 4 installed under
7836       <static_content_path>/js/tinymce/.
7837
7838       Example:
7839
7840         html_editor_url js/tinymce/tinymce.min.js
7841
7842       "html_editor_init"
7843
7844       HTML editor initialization
7845
7846       Format:
7847           Any.
7848
7849       Default:
7850           None.
7851
7852       Context:
7853           domain (robot.conf), site (sympa.conf)
7854
7855       Available versions:
7856           6.2a.0 and later.
7857
7858       Javascript excerpt that enables and configures the WYSIWYG HTML editor.
7859
7860       Example:
7861
7862         html_editor_init tinymce.init({selector:"#body",language:lang.split(/[^a-zA-Z]+/).join("_")});
7863
7864       "max_wrong_password"
7865
7866       Count limit of wrong password submission
7867
7868       Format:
7869           Any.
7870
7871       Default:
7872           19
7873
7874       Context:
7875           domain (robot.conf), site (sympa.conf)
7876
7877       If this limit is reached, the account is locked until the user renews
7878       their password. The default value is chosen in order to block bots
7879       trying to log in using brute force strategy. This value should never be
7880       reached by real users that will probably uses the renew password
7881       service before they performs so many tries.
7882
7883       "password_case"
7884
7885       Password case
7886
7887       Format:
7888           Any.
7889
7890       Default:
7891           "insensitive"
7892
7893       Context:
7894           site (sympa.conf)
7895
7896       "insensitive" or "sensitive".
7897
7898       If set to "insensitive", WWSympa's password check will be insensitive.
7899       This only concerns passwords stored in the Sympa database, not the ones
7900       in LDAP.
7901
7902       Should not be changed! May invalid all user password.
7903
7904       "password_hash"
7905
7906       Password hashing algorithm
7907
7908       Format:
7909           Any.
7910
7911       Default:
7912           "md5"
7913
7914       Context:
7915           site (sympa.conf)
7916
7917       Available versions:
7918           6.2.25b.3 and later.
7919
7920       "md5" or "bcrypt".
7921
7922       If set to "md5", Sympa will use MD5 password hashes. If set to
7923       "bcrypt", bcrypt hashes will be used instead. This only concerns
7924       passwords stored in the Sympa database, not the ones in LDAP.
7925
7926       "password_hash_update"
7927
7928       Update password hashing algorithm when users log in
7929
7930       Format:
7931           Any.
7932
7933       Default:
7934           1
7935
7936       Context:
7937           site (sympa.conf)
7938
7939       Available versions:
7940           6.2.25b.3 and later.
7941
7942       On successful login, update the encrypted user password to use the
7943       algorithm specified by "password_hash". This allows for a graceful
7944       transition to a new password hash algorithm. A value of 0 disables
7945       updating of existing password hashes.  New and reset passwords will use
7946       the "password_hash" setting in all cases.
7947
7948       "bcrypt_cost"
7949
7950       Bcrypt hash cost
7951
7952       Format:
7953           Any.
7954
7955       Default:
7956           12
7957
7958       Context:
7959           site (sympa.conf)
7960
7961       Available versions:
7962           6.2.25b.3 and later.
7963
7964       When "password_hash" is set to "bcrypt", this sets the "cost" parameter
7965       of the bcrypt hash function. The default of 12 is expected to require
7966       approximately 250ms to calculate the password hash on a 3.2GHz CPU.
7967       This only concerns passwords stored in the Sympa database, not the ones
7968       in LDAP.
7969
7970       Can be changed but any new cost setting will only apply to new
7971       passwords.
7972
7973       "one_time_ticket_lifetime"
7974
7975       Age of one time ticket
7976
7977       Format:
7978           Any.
7979
7980       Default:
7981           "2d"
7982
7983       Context:
7984           site (sympa.conf)
7985
7986       Duration before the one time tickets are expired
7987
7988       "one_time_ticket_lockout"
7989
7990       Restrict access to one time ticket
7991
7992       Format:
7993           Any.
7994
7995       Default:
7996           "one_time"
7997
7998       Context:
7999           domain (robot.conf), site (sympa.conf)
8000
8001       Is access to the one time ticket restricted, if any users previously
8002       accessed? (one_time | remote_addr | open)
8003
8004       "purge_one_time_ticket_table_task"
8005
8006       Task for expiring old one time tickets
8007
8008       Format:
8009           /"\w+"/
8010
8011       Default:
8012           "daily"
8013
8014       Context:
8015           site (sympa.conf)
8016
8017       "one_time_ticket_table_ttl"
8018
8019       Expiration period of one time ticket
8020
8021       Format:
8022           Any.
8023
8024       Default:
8025           "10d"
8026
8027       Context:
8028           site (sympa.conf)
8029
8030       "pictures_max_size"
8031
8032       The maximum size of uploaded picture
8033
8034       Format:
8035           Number of bytes.
8036
8037       Default:
8038           102400 (bytes)
8039
8040       Context:
8041           domain (robot.conf), site (sympa.conf)
8042
8043       "spam_protection"
8044
8045       Protect web interface against spam harvesters
8046
8047       Format:
8048           "at" - replace @ characters
8049           "javascript" - use JavaScript
8050           "none" - do nothing
8051       Default:
8052           "javascript"
8053
8054       Context:
8055           list (config), domain (robot.conf), site (sympa.conf)
8056
8057       There is a need to protect Sympa web sites against spambots which
8058       collect email addresses from public web sites. Various methods are
8059       available in Sympa and you can choose to use them with the
8060       spam_protection and web_archive_spam_protection parameters. Possible
8061       value are:
8062
8063       javascript:
8064
8065       the address is hidden using a javascript. A user who enables javascript
8066       can see a nice mailto address where others have nothing.
8067
8068       at:
8069
8070       the @ char is replaced by the string " AT ".
8071
8072       none:
8073
8074       no protection against spammer.
8075
8076       "reporting_spam_script_path"
8077
8078       Script to report spam
8079
8080       Format:
8081           Any.
8082
8083       Default:
8084           None.
8085
8086       Context:
8087           domain (robot.conf), site (sympa.conf)
8088
8089       Available versions:
8090           6.2a.0 and later.
8091
8092       If set, when a list moderator report undetected spams for list
8093       moderation, this external script is invoked and the message is injected
8094       into standard input of the script.
8095
8096       "domains_blocklist"
8097
8098       Prevent people to subscribe to a list with addresses using these
8099       domains
8100
8101       Format:
8102           Any.
8103
8104       Default:
8105           None.
8106
8107       Context:
8108           site (sympa.conf)
8109
8110       Available versions:
8111           6.2.61b.1 and later.
8112
8113       This parameter is a comma-separated list.
8114
8115       Example:
8116
8117         domains_blocklist example.org,spammer.com
8118
8119       "quiet_subscription"
8120
8121       Quiet subscriptions policy
8122
8123       Format:
8124           "on" - enabled
8125           "optional" - optional
8126           "off" - disabled
8127       Default:
8128           "optional"
8129
8130       Context:
8131           site (sympa.conf)
8132
8133       Available versions:
8134           6.2.41b.1 and later.
8135
8136       Global policy for quiet subscriptions: "on" means that subscriptions
8137       will never send a notice to the subscriber, "off" will enforce a notice
8138       sending, and "optional" (default) allows the use of the list policy.
8139
8140       "show_report_abuse"
8141
8142       Add a "Report abuse" link in the side menu of the lists
8143
8144       Format:
8145           "on" - enabled
8146           "off" - disabled
8147       Default:
8148           "off"
8149
8150       Context:
8151           site (sympa.conf)
8152
8153       Available versions:
8154           6.2.37b.3 and later.
8155
8156       The link is a mailto link, you can change that by overriding
8157       web_tt2/report_abuse.tt2
8158
8159       "allow_account_deletion"
8160
8161       EXPERIMENTAL! Allow users to delete their account. If enabled, shows a
8162       "delete my account" form in user's preferences page.
8163
8164       Format:
8165           "on" - enabled
8166           "off" - disabled
8167       Default:
8168           "off"
8169
8170       Context:
8171           site (sympa.conf)
8172
8173       Available versions:
8174           6.2.41b.1 and later.
8175
8176       Account deletion unsubscribes the users from his/her lists and removes
8177       him/her from lists ownership. It is only available to users using
8178       internal authentication (i.e. no LDAP, no SSO...). See
8179       https://github.com/sympa-community/sympa/issues/300 for details
8180
8181   Renamed parameters
8182       These parameters were renamed.  Though older names are still available,
8183       their use is no longer recommended.
8184
8185       "arc_private_key_path"
8186
8187       See "arc_parameters.arc_private_key_path".
8188
8189       Context:
8190           domain (robot.conf), site (sympa.conf)
8191
8192       Available versions:
8193           6.2.37b.1 to 6.2.56.
8194
8195       "arc_selector"
8196
8197       See "arc_parameters.arc_selector".
8198
8199       Context:
8200           domain (robot.conf), site (sympa.conf)
8201
8202       Available versions:
8203           6.2.37b.1 to 6.2.56.
8204
8205       "arc_signer_domain"
8206
8207       See "arc_parameters.arc_signer_domain".
8208
8209       Context:
8210           domain (robot.conf), site (sympa.conf)
8211
8212       Available versions:
8213           6.2.37b.1 to 6.2.56.
8214
8215       "archive_mail_access"
8216
8217       See "archive.mail_access".
8218
8219       Context:
8220           domain (robot.conf), site (sympa.conf)
8221
8222       Available versions:
8223           up to 6.2.56.
8224
8225       "archive_web_access"
8226
8227       See "archive.web_access".
8228
8229       Context:
8230           domain (robot.conf), site (sympa.conf)
8231
8232       Available versions:
8233           up to 6.2.56.
8234
8235       "bounce_halt_rate"
8236
8237       See "bounce.halt_rate".
8238
8239       Context:
8240           site (sympa.conf)
8241
8242       Available versions:
8243           up to 6.2.56.
8244
8245       "bounce_warn_rate"
8246
8247       See "bounce.warn_rate".
8248
8249       Context:
8250           site (sympa.conf)
8251
8252       Available versions:
8253           up to 6.2.56.
8254
8255       "custom-header"
8256
8257       See "custom_header".
8258
8259       Context:
8260           Unknown.
8261
8262       "custom-subject"
8263
8264       See "custom_subject".
8265
8266       Context:
8267           Unknown.
8268
8269       "d_edit"
8270
8271       See "shared_doc.d_edit".
8272
8273       Context:
8274           domain (robot.conf), site (sympa.conf)
8275
8276       Available versions:
8277           up to 6.2.56.
8278
8279       "d_read"
8280
8281       See "shared_doc.d_read".
8282
8283       Context:
8284           domain (robot.conf), site (sympa.conf)
8285
8286       Available versions:
8287           up to 6.2.56.
8288
8289       "default_archive_quota"
8290
8291       See "archive.quota".
8292
8293       Context:
8294           site (sympa.conf)
8295
8296       Available versions:
8297           up to 6.2.56.
8298
8299       "default_bounce_level1_rate"
8300
8301       See "bouncers_level1.rate".
8302
8303       Context:
8304           domain (robot.conf), site (sympa.conf)
8305
8306       Available versions:
8307           up to 6.2.56.
8308
8309       "default_bounce_level2_rate"
8310
8311       See "bouncers_level2.rate".
8312
8313       Context:
8314           domain (robot.conf), site (sympa.conf)
8315
8316       Available versions:
8317           up to 6.2.56.
8318
8319       "default_list_priority"
8320
8321       See "priority".
8322
8323       Context:
8324           domain (robot.conf), site (sympa.conf)
8325
8326       Available versions:
8327           up to 6.2.56.
8328
8329       "default_max_list_members"
8330
8331       See "max_list_members".
8332
8333       Context:
8334           domain (robot.conf), site (sympa.conf)
8335
8336       Available versions:
8337           up to 6.2.56.
8338
8339       "default_remind_task"
8340
8341       See "remind_task".
8342
8343       Context:
8344           site (sympa.conf)
8345
8346       Available versions:
8347           up to 6.2.56.
8348
8349       "default_shared_quota"
8350
8351       See "shared_doc.quota".
8352
8353       Context:
8354           domain (robot.conf), site (sympa.conf)
8355
8356       Available versions:
8357           up to 6.2.56.
8358
8359       "default_sql_fetch_timeout"
8360
8361       See "sql_fetch_timeout".
8362
8363       Context:
8364           site (sympa.conf)
8365
8366       Available versions:
8367           6.2a.0 to 6.2.56.
8368
8369       "default_ttl"
8370
8371       See "ttl".
8372
8373       Context:
8374           site (sympa.conf)
8375
8376       Available versions:
8377           up to 6.2.56.
8378
8379       "dkim_private_key_path"
8380
8381       See "dkim_parameters.private_key_path".
8382
8383       Context:
8384           domain (robot.conf), site (sympa.conf)
8385
8386       Available versions:
8387           up to 6.2.56.
8388
8389       "dkim_selector"
8390
8391       See "dkim_parameters.selector".
8392
8393       Context:
8394           domain (robot.conf), site (sympa.conf)
8395
8396       Available versions:
8397           up to 6.2.56.
8398
8399       "dkim_signer_domain"
8400
8401       See "dkim_parameters.signer_domain".
8402
8403       Context:
8404           domain (robot.conf), site (sympa.conf)
8405
8406       Available versions:
8407           up to 6.2.56.
8408
8409       "dmarc_protection_domain_regex"
8410
8411       See "dmarc_protection.domain_regex".
8412
8413       Context:
8414           domain (robot.conf), site (sympa.conf)
8415
8416       Available versions:
8417           up to 6.2.56.
8418
8419       "dmarc_protection_mode"
8420
8421       See "dmarc_protection.mode".
8422
8423       Context:
8424           domain (robot.conf), site (sympa.conf)
8425
8426       Available versions:
8427           up to 6.2.56.
8428
8429       "dmarc_protection_other_email"
8430
8431       See "dmarc_protection.other_email".
8432
8433       Context:
8434           domain (robot.conf), site (sympa.conf)
8435
8436       Available versions:
8437           up to 6.2.56.
8438
8439       "dmarc_protection_phrase"
8440
8441       See "dmarc_protection.phrase".
8442
8443       Context:
8444           domain (robot.conf), site (sympa.conf)
8445
8446       Available versions:
8447           up to 6.2.56.
8448
8449       "domains_blacklist"
8450
8451       See "domains_blocklist".
8452
8453       Context:
8454           site (sympa.conf)
8455
8456       Available versions:
8457           6.2.41b.1 to 6.2.60.
8458
8459       "email_gecos"
8460
8461       See "gecos".
8462
8463       Context:
8464           site (sympa.conf)
8465
8466       Available versions:
8467           6.2a.5 to 6.2a.33.
8468
8469       "forced_reply-to"
8470
8471       See "forced_reply_to".
8472
8473       Context:
8474           Unknown.
8475
8476       "forced_replyto"
8477
8478       See "forced_reply_to".
8479
8480       Context:
8481           Unknown.
8482
8483       "key_password"
8484
8485       See "key_passwd".
8486
8487       Context:
8488           site (sympa.conf)
8489
8490       "max-size"
8491
8492       See "max_size".
8493
8494       Context:
8495           Unknown.
8496
8497       "merge_feature"
8498
8499       See "personalization_feature".
8500
8501       Context:
8502           Unknown.
8503
8504       Available versions:
8505           6.0b.2 to 6.2.59b.1.
8506
8507       "reply-to"
8508
8509       See "reply_to".
8510
8511       Context:
8512           Unknown.
8513
8514       "replyto"
8515
8516       See "reply_to".
8517
8518       Context:
8519           Unknown.
8520
8521       "subscription"
8522
8523       See "subscribe".
8524
8525       Context:
8526           Unknown.
8527
8528       "tracking_default_retention_period"
8529
8530       See "tracking.retention_period".
8531
8532       Context:
8533           site (sympa.conf)
8534
8535       Available versions:
8536           6.2a.3 to 6.2.56.
8537
8538       "tracking_delivery_status_notification"
8539
8540       See "tracking.delivery_status_notification".
8541
8542       Context:
8543           site (sympa.conf)
8544
8545       Available versions:
8546           6.2a.0 to 6.2.56.
8547
8548       "tracking_message_delivery_notification"
8549
8550       See "tracking_message_disposition_notification".
8551
8552       Context:
8553           site (sympa.conf)
8554
8555       Available versions:
8556           6.2a.0 to 6.2a.40.
8557
8558       "tracking_message_disposition_notification"
8559
8560       See "tracking.message_disposition_notification".
8561
8562       Context:
8563           site (sympa.conf)
8564
8565       Available versions:
8566           6.2a.41 to 6.2.56.
8567
8568       "unsubscription"
8569
8570       See "unsubscribe".
8571
8572       Context:
8573           Unknown.
8574
8575       "use_blacklist"
8576
8577       See "use_blocklist".
8578
8579       Context:
8580           domain (robot.conf), site (sympa.conf)
8581
8582       Available versions:
8583           5.3a.4 to 6.2.60.
8584
8585   Deprecated parameters
8586       These parameters were deprecated. They may not be used anymore.
8587
8588       "account"
8589
8590       Deprecated.
8591
8592       Context:
8593           list (config)
8594
8595       "archived_pidfile"
8596
8597       Deprecated.
8598
8599       Context:
8600           site (sympa.conf)
8601
8602       Available versions:
8603           up to 6.1.17.
8604
8605       "automatic_list_prefix"
8606
8607       Deprecated.
8608
8609       Context:
8610           site (sympa.conf)
8611
8612       "bounced_pidfile"
8613
8614       Deprecated.
8615
8616       Context:
8617           site (sympa.conf)
8618
8619       Available versions:
8620           up to 6.1.17.
8621
8622       "clean_delay_queueother"
8623
8624       Deprecated.
8625
8626       Context:
8627           site (sympa.conf)
8628
8629       Available versions:
8630           5.4a.9 to 5.4.7.
8631
8632       "cookie"
8633
8634       Deprecated.
8635
8636       Context:
8637           list (config), site (sympa.conf)
8638
8639       Available versions:
8640           up to 6.2.60.
8641
8642       "default_distribution_ttl"
8643
8644       Deprecated.
8645
8646       Context:
8647           site (sympa.conf)
8648
8649       "distribution_mode"
8650
8651       Deprecated.
8652
8653       Context:
8654           site (sympa.conf)
8655
8656       Available versions:
8657           5.0a.1 to 6.2a.40.
8658
8659       "edit_list"
8660
8661       Deprecated.
8662
8663       Context:
8664           site (sympa.conf)
8665
8666       "editor"
8667
8668       Deprecated.
8669
8670       Context:
8671           list (config)
8672
8673       Available versions:
8674           up to 6.2.32.
8675
8676       "expire_task"
8677
8678       Deprecated.
8679
8680       Context:
8681           list (config)
8682
8683       "filesystem_encoding"
8684
8685       Deprecated.
8686
8687       Context:
8688           site (sympa.conf)
8689
8690       Available versions:
8691           5.3a.7 to 6.2.52.
8692
8693       "forced_reply_to"
8694
8695       Deprecated.
8696
8697       Context:
8698           list (config)
8699
8700       "host"
8701
8702       Deprecated.
8703
8704       Context:
8705           list (config), domain (robot.conf), site (sympa.conf)
8706
8707       "html_editor_file"
8708
8709       Deprecated.
8710
8711       Context:
8712           site (sympa.conf)
8713
8714       Available versions:
8715           6.0a.0 to 6.2a.33.
8716
8717       "htmlarea_url"
8718
8719       Deprecated.
8720
8721       Context:
8722           site (sympa.conf)
8723
8724       Available versions:
8725           up to 6.2.35b.1.
8726
8727       "http_host"
8728
8729       Deprecated.
8730
8731       Context:
8732           domain (robot.conf), site (sympa.conf)
8733
8734       Available versions:
8735           up to 6.2.54.
8736
8737       "include_list"
8738
8739       Deprecated.
8740
8741       Context:
8742           list (config)
8743
8744       Available versions:
8745           2.2.6 to 6.2.15.
8746
8747       "ldap_export_connection_timeout"
8748
8749       Deprecated.
8750
8751       Context:
8752           site (sympa.conf)
8753
8754       Available versions:
8755           3.3b.3 to 4.1?.
8756
8757       "ldap_export_dnmanager"
8758
8759       Deprecated.
8760
8761       Context:
8762           site (sympa.conf)
8763
8764       Available versions:
8765           3.3b.3 to 4.1?.
8766
8767       "ldap_export_host"
8768
8769       Deprecated.
8770
8771       Context:
8772           site (sympa.conf)
8773
8774       Available versions:
8775           3.3b.3 to 4.1?.
8776
8777       "ldap_export_name"
8778
8779       Deprecated.
8780
8781       Context:
8782           site (sympa.conf)
8783
8784       Available versions:
8785           3.3b.3 to 4.1?.
8786
8787       "ldap_export_password"
8788
8789       Deprecated.
8790
8791       Context:
8792           site (sympa.conf)
8793
8794       Available versions:
8795           3.3b.3 to 4.1?.
8796
8797       "ldap_export_suffix"
8798
8799       Deprecated.
8800
8801       Context:
8802           site (sympa.conf)
8803
8804       Available versions:
8805           3.3b.3 to 4.1?.
8806
8807       "localedir"
8808
8809       Deprecated.
8810
8811       Context:
8812           site (sympa.conf)
8813
8814       Available versions:
8815           4.2b.2 to 6.2a.32.
8816
8817       "lock_method"
8818
8819       Deprecated.
8820
8821       Context:
8822           site (sympa.conf)
8823
8824       Available versions:
8825           5.3b.3 to 6.2a.33.
8826
8827       "log_condition"
8828
8829       Deprecated.
8830
8831       Context:
8832           domain (robot.conf), site (sympa.conf)
8833
8834       Available versions:
8835           6.2a.29 to 6.2.41b.1.
8836
8837       "log_module"
8838
8839       Deprecated.
8840
8841       Context:
8842           domain (robot.conf), site (sympa.conf)
8843
8844       Available versions:
8845           6.2a.29 to 6.2.41b.1.
8846
8847       "msgcat"
8848
8849       Deprecated.
8850
8851       Context:
8852           site (sympa.conf)
8853
8854       Available versions:
8855           up to 4.2b.1.
8856
8857       "openssl"
8858
8859       Deprecated.
8860
8861       Context:
8862           site (sympa.conf)
8863
8864       Available versions:
8865           up to 6.2a.40.
8866
8867       "owner"
8868
8869       Deprecated.
8870
8871       Context:
8872           list (config)
8873
8874       Available versions:
8875           up to 6.2.32.
8876
8877       "pidfile"
8878
8879       Deprecated.
8880
8881       Context:
8882           site (sympa.conf)
8883
8884       Available versions:
8885           up to 6.1.17.
8886
8887       "pidfile_bulk"
8888
8889       Deprecated.
8890
8891       Context:
8892           site (sympa.conf)
8893
8894       Available versions:
8895           up to 6.1.17.
8896
8897       "pidfile_creation"
8898
8899       Deprecated.
8900
8901       Context:
8902           site (sympa.conf)
8903
8904       Available versions:
8905           up to 6.1.17.
8906
8907       "pidfile_distribute"
8908
8909       Deprecated.
8910
8911       Context:
8912           site (sympa.conf)
8913
8914       Available versions:
8915           up to 6.1.17.
8916
8917       "queuedistribute"
8918
8919       Deprecated.
8920
8921       Context:
8922           site (sympa.conf)
8923
8924       Available versions:
8925           5.0a.1 to 6.2a.40.
8926
8927       "queueexpire"
8928
8929       Deprecated.
8930
8931       Context:
8932           site (sympa.conf)
8933
8934       Available versions:
8935           up to 5.1.2.
8936
8937       "reply_to"
8938
8939       Deprecated.
8940
8941       Context:
8942           list (config)
8943
8944       "sort"
8945
8946       Deprecated.
8947
8948       Context:
8949           site (sympa.conf)
8950
8951       Available versions:
8952           1.4.0 and later.
8953
8954       "task_manager_pidfile"
8955
8956       Deprecated.
8957
8958       Context:
8959           site (sympa.conf)
8960
8961       Available versions:
8962           up to 6.1.17.
8963
8964       "tracking" (domain and site)
8965
8966       See "tracking.tracking".
8967
8968       Context:
8969           domain (robot.conf), site (sympa.conf)
8970
8971       Available versions:
8972           up to 6.2.56.
8973
8974       "tri"
8975
8976       Deprecated.
8977
8978       Context:
8979           site (sympa.conf)
8980
8981       Available versions:
8982           up to 1.3.4-1.
8983
8984       "trusted_ca_options"
8985
8986       Deprecated.
8987
8988       Context:
8989           site (sympa.conf)
8990
8991       Available versions:
8992           up to 3.3.5.
8993
8994       "use_fast_cgi"
8995
8996       Deprecated.
8997
8998       Context:
8999           site (sympa.conf)
9000
9001       Available versions:
9002           up to 6.2.22.
9003
9004       "user_data_source"
9005
9006       Deprecated.
9007
9008       Context:
9009           list (config)
9010
9011       "web_archive"
9012
9013       Deprecated.
9014
9015       Context:
9016           list (config), domain (robot.conf), site (sympa.conf)
9017
9018       Available versions:
9019           up to 6.2a.43.
9020
9021       "web_recode_to"
9022
9023       Deprecated.
9024
9025       Context:
9026           site (sympa.conf)
9027
9028       Available versions:
9029           up to 5.2.
9030

FILES

9032       /etc/sympa/sympa.conf
9033           Sympa main configuration file.
9034
9035       $SYSCONFDIR/<mail domain name>/robot.conf
9036           Configuration specific to each mail domain.
9037
9038       $EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list
9039       name>/config
9040           List main configuration file.
9041

SEE ALSO

9043       Sympa Administration Manual.  <https://www.sympa.community/manual/>.
9044
9045       auth.conf(5), charset.conf(5), crawlers_detection.conf(5),
9046       edit_list.conf(5), ldap_alias_manager.conf(5), nrcpt_by_domain.conf(5),
9047       sympa_scenario(5), topics.conf(5).
9048
9049
9050
90516.2.70                            2022-12-11                   SYMPA_CONFIG(5)
Impressum