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

FILES

7799       /etc/sympa/sympa.conf
7800           Sympa main configuration file.
7801
7802       $SYSCONFDIR/<mail domain name>/robot.conf
7803           Configuration specific to each mail domain.
7804
7805       $EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list
7806       name>/config
7807           List main configuration file.
7808

SEE ALSO

7810       Sympa Administration Manual.
7811       <https://sympa-community.github.io/manual/>.
7812
7813       auth.conf(5), charset.conf(5), crawlers_detection.conf(5),
7814       edit_list.conf(5), ldap_alias_manager.conf(5), nrcpt_by_domain.conf(5),
7815       sympa_scenario(5), topics.conf(5).
7816
7817
7818
78196.2.64                            2021-07-15                   SYMPA_CONFIG(5)
Impressum