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