1SYMPA_CONFIG(5) sympa 6.2.64 SYMPA_CONFIG(5)
2
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 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 Format of sympa.conf and robot.conf is as following:
19 • Lines beginning with "#" and containing only spaces are ignored.
21 • Each line has the form "parameter value". value may contain spaces
23 but may not contain newlines.
24 There are simple parameters and compound parameters.
26 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 Example:
33 process_archive on
35 archive.web_access open
36 archive.mail_access closed
37 robot.conf: Optional configuration file for the mail domain
39 robot.conf is the optional configuration file for each mail domain.
40 Format of robot.conf is the same as sympa.conf above.
42 config: Configuration file for the mailing list
44 config is main configuration file of each mailing list.
45 Format of config is as following:
47 • Lines beginning with "#" and containing only spaces are ignored.
49 • There are simple parameters and compound parameters:
51 • 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 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 Example:
62 subject This is subject of my list
64 remove_headers User-Agent,Importance
66 custom_headers X-List: mylist
68 custom_headers X-Face: %`-W7!?^]Sg'I-K>P<cdn&k:~A^{x>(]Gc{V...
69 rfc2369_header_fields post,owner
71 • 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 Several multiple line parameters may occur multiple times.
79 Example:
81 archive
83 web_access open
84 mail_access closed
85
87 Below is entire list of configuration parameters.
88 • Sub-parameters in paragraph are listed as paragraph"."sub-parameter
90 by each.
91 • "Default" is built-in default value if any. About symbols for
93 paths, such as $SENDMAIL_ALIASES, see "Directory layout
94 <https://sympa-community.github.io/manual/layout.html>".
95 Service description
97 "domain"
98 Primary mail domain name
100 Format:
102 /"[-\w]+(?:[.][-\w]+)+"/
103 Default:
105 None, mandatory.
106 Context:
108 domain (robot.conf), site (sympa.conf)
109 Example:
111 domain mail.example.org
113 "listmaster"
115 Email addresses of listmasters
117 Format:
119 Multiple values allowed, separated by ",".
120 /$addrspec/
122 Default:
124 None, mandatory.
125 Context:
127 domain (robot.conf), site (sympa.conf)
128 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 Example:
136 listmaster your_email_address@domain.tld
138 "supported_lang"
140 Supported languages
142 Format:
144 /"\w+(\-\w+)*"/
145 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 Context:
150 domain (robot.conf), site (sympa.conf)
151 All supported languages for the user interface. Languages proper locale
153 information not installed are ignored.
154 "title"
156 Title of service
158 Format:
160 /".+"/
161 Default:
163 "Mailing lists service"
164 Context:
166 domain (robot.conf), site (sympa.conf)
167 The name of your mailing list service. It will appear in the header of
169 web interface and subjects of several service messages.
170 "gecos"
172 Display name of Sympa
174 Format:
176 /".+"/
177 Default:
179 "SYMPA"
180 Context:
182 domain (robot.conf), site (sympa.conf)
183 This parameter is used for display name in the "From:" header field for
185 the messages sent by Sympa itself.
186 "legacy_character_support_feature"
188 Support of legacy character set
190 Format:
192 "on" - enabled
193 "off" - disabled
194 Default:
195 "off"
196 Context:
198 site (sympa.conf)
199 If set to "on", enables support of legacy character set according to
201 charset.conf(5) configuration file.
202 In some language environments, legacy encoding (character set) can be
204 preferred for e-mail messages: for example iso-2022-jp in Japanese
205 language.
206 Database related
208 "update_db_field_types"
209 Update database structure
211 Format:
213 "auto" - automatic
214 "off" - disabled
215 Default:
216 "auto"
217 Context:
219 site (sympa.conf)
220 auto: Updates database table structures automatically.
222 However, since version 5.3b.5, Sympa will not shorten field size if it
224 already have been longer than the size defined in database definition.
225 "db_type"
227 Type of the database
229 Format:
231 /"\w+"/
232 Default:
234 "mysql"
235 Context:
237 site (sympa.conf)
238 Possible types are "MySQL", "PostgreSQL", "Oracle" and "SQLite".
240 "db_host"
242 Hostname of the database server
244 Format:
246 /$host/
247 Default:
249 None.
250 Context:
252 site (sympa.conf)
253 With PostgreSQL, you can also use the path to Unix Socket Directory,
255 e.g. "/var/run/postgresql" for connection with Unix domain socket.
256 Example:
258 db_host localhost
260 "db_port"
262 Port of the database server
264 Format:
266 /"[-/\w]+"/
267 Default:
269 None.
270 Context:
272 site (sympa.conf)
273 "db_name"
275 Name of the database
277 Format:
279 /".+"/
280 Default:
282 "sympa"
283 Context:
285 site (sympa.conf)
286 With SQLite, this must be the full path to database file.
288 With Oracle Database, this must be SID, net service name or easy
290 connection identifier (to use net service name, db_host should be set
291 to "none" and HOST, PORT and SERVICE_NAME should be defined in
292 tnsnames.ora file).
293 "db_user"
295 User for the database connection
297 Format:
299 /".+"/
300 Default:
302 None.
303 Context:
305 site (sympa.conf)
306 Example:
308 db_user sympa
310 "db_passwd"
312 Password for the database connection
314 Format:
316 The value to be concealed.
317 Default:
319 None.
320 Context:
322 site (sympa.conf)
323 What ever you use a password or not, you must protect the SQL server
325 (is it not a public internet service ?)
326 Example:
328 db_passwd your_passwd
330 "db_options"
332 Database options
334 Format:
336 /".+"/
337 Default:
339 None.
340 Context:
342 site (sympa.conf)
343 If these options are defined, they will be appended to data source name
345 (DSN) fed to database driver. Check the related DBD documentation to
346 learn about the available options.
347 Example:
349 db_options mysql_read_default_file=/home/joe/my.cnf;mysql_socket=tmp/mysql.sock-test
351 "db_env"
353 Environment variables setting for database
355 Format:
357 /".+"/
358 Default:
360 None.
361 Context:
363 site (sympa.conf)
364 With Oracle Database, this is useful for defining ORACLE_HOME and
366 NLS_LANG.
367 Example:
369 db_env NLS_LANG=American_America.AL32UTF8;ORACLE_HOME=/u01/app/oracle/product/11.2.0/server
371 "db_timeout"
373 Database processing timeout
375 Format:
377 /"\d+"/
378 Default:
380 None.
381 Context:
383 site (sympa.conf)
384 Currently, this parameter may be used for SQLite only.
386 "db_additional_subscriber_fields"
388 Database private extension to subscriber table
390 Format:
392 Multiple values allowed, separated by ",".
393 /".+"/
395 Default:
397 None.
398 Context:
400 site (sympa.conf)
401 Adds more fields to "subscriber_table" table. Sympa recognizes fields
403 defined with this parameter. You will then be able to use them from
404 within templates and scenarios:
405 * for scenarios: [subscriber->field]
407 * for templates: [% subscriber.field %]
409 These fields will also appear in the list members review page and will
411 be editable by the list owner. This parameter is a comma-separated
412 list.
413 You need to extend the database format with these fields
415 Example:
417 db_additional_subscriber_fields billing_delay,subscription_expiration
419 "db_additional_user_fields"
421 Database private extension to user table
423 Format:
425 Multiple values allowed, separated by ",".
426 /".+"/
428 Default:
430 None.
431 Context:
433 site (sympa.conf)
434 Adds more fields to "user_table" table. Sympa recognizes fields defined
436 with this parameter. You will then be able to use them from within
437 templates: [% subscriber.field %]
438 This parameter is a comma-separated list.
440 You need to extend the database format with these fields
442 Example:
444 db_additional_user_fields age,address
446 System log
448 "syslog"
449 System log facility for Sympa
451 Format:
453 /"\S+"/
454 Default:
456 "LOCAL1"
457 Context:
459 site (sympa.conf)
460 Do not forget to configure syslog server.
462 "log_socket_type"
464 Communication mode with syslog server
466 Format:
468 /"\w+"/
469 Default:
471 "unix"
472 Context:
474 site (sympa.conf)
475 "log_level"
477 Log verbosity
479 Format:
481 /"\d+"/
482 Default:
484 0
485 Context:
487 domain (robot.conf), site (sympa.conf)
488 Sets the verbosity of logs.
490 0: Only main operations are logged
492 3: Almost everything is logged.
494 Example:
496 log_level 2
498 Mail server
500 "sendmail"
501 Path to sendmail
503 Format:
505 /".+"/
506 Default:
508 "/usr/sbin/sendmail"
509 Context:
511 site (sympa.conf)
512 Absolute path to sendmail command line utility (e.g.: a binary named
514 "sendmail" is distributed with Postfix).
515 Sympa expects this binary to be sendmail compatible (exim, Postfix,
517 qmail and so on provide it).
518 "sendmail_args"
520 Command line parameters passed to sendmail
522 Format:
524 /".+"/
525 Default:
527 "-oi -odi -oem"
528 Context:
530 site (sympa.conf)
531 Note that "-f", "-N" and "-V" options and recipient addresses should
533 not be included, because they will be included by Sympa.
534 "sendmail_aliases"
536 Path of the file that contains all list related aliases
538 Format:
540 /".+"/
541 Default:
543 $SENDMAIL_ALIASES
544 Context:
546 domain (robot.conf), site (sympa.conf)
547 It is recommended to create a specific alias file so that Sympa never
549 overwrites the standard alias file, but only a dedicated file.
550 Set this parameter to "none" if you want to disable alias management in
552 Sympa.
553 "aliases_program"
555 Program used to update alias database
557 Format:
559 /"makemap|newaliases|postalias|postmap|/.+|none"/
560 Default:
562 "newaliases"
563 Context:
565 domain (robot.conf), site (sympa.conf)
566 This may be "makemap", "newaliases", "postalias", "postmap" or full
568 path to custom program.
569 "aliases_wrapper"
571 Whether to use the alias wrapper
573 Format:
575 "off" - disabled
576 "on" - enabled
577 Default:
578 "on"
579 Context:
581 domain (robot.conf), site (sympa.conf)
582 If the program to update alias database does not require root
584 privileges, set this parameter to "off" and remove the wrapper file
585 sympa_newaliases-wrapper.
586 "aliases_db_type"
588 Type of alias database
590 Format:
592 /"\w[-\w]*"/
593 Default:
595 "hash"
596 Context:
598 domain (robot.conf), site (sympa.conf)
599 "btree", "dbm", "hash" and so on. Available when aliases_program is
601 "makemap", "postalias" or "postmap"
602 "alias_manager"
604 Path to alias manager
606 Format:
608 /".+"/
609 Default:
611 "$SBINDIR/alias_manager.pl"
612 Context:
614 site (sympa.conf)
615 The absolute path to the script that will add/remove mail aliases
617 Example:
619 alias_manager /usr/local/libexec/ldap_alias_manager.pl
621 List definition
623 "subject"
624 Subject of the list
626 Format:
628 /".+"/
629 Default:
631 None, mandatory.
632 Context:
634 list (config)
635 This parameter indicates the subject of the list, which is sent in
637 response to the LISTS mail command. The subject is a free form text
638 limited to one line.
639 "visibility"
641 Visibility of the list
643 Format:
645 Name of "visibility" scenario:
646 "conceal" - conceal except for subscribers
648 "noconceal" - no conceal
649 "secret" - conceal even for subscribers
650 Default:
651 "conceal"
652 Context:
654 list (config), domain (robot.conf), site (sympa.conf)
655 This parameter indicates whether the list should feature in the output
657 generated in response to a LISTS command or should be shown in the list
658 overview of the web-interface.
659 "topics"
661 Topics for the list
663 Format:
665 Multiple values allowed, separated by ",".
666 List topic.
668 Default:
670 None.
671 Context:
673 list (config)
674 This parameter allows the classification of lists. You may define
676 multiple topics as well as hierarchical ones. WWSympa's list of public
677 lists uses this parameter.
678 "lang"
680 Language of the list
682 Format:
684 Language tag.
685 Default:
687 "en-US"
688 Context:
690 list (config), domain (robot.conf), site (sympa.conf)
691 This parameter defines the language used for the list. It is used to
693 initialize a user's language preference; Sympa command reports are
694 extracted from the associated message catalog.
695 "family_name"
697 Family name
699 Format:
701 /$family_name/
702 Default:
704 None.
705 Context:
707 list (config)
708 "max_list_members"
710 Maximum number of list members
712 Format:
714 Number of list members.
715 Default:
717 0 (list members)
718 Context:
720 list (config), domain (robot.conf), site (sympa.conf)
721 limit for the number of subscribers. 0 means no limit.
723 "priority"
725 Priority
727 Format:
729 0 - 0 - highest priority
730 1 - 1
731 2 - 2
732 3 - 3
733 4 - 4
734 5 - 5
735 6 - 6
736 7 - 7
737 8 - 8
738 9 - 9 - lowest priority
739 "z" - queue messages only
740 Default:
741 5
742 Context:
744 list (config), domain (robot.conf), site (sympa.conf)
745 The priority with which Sympa will process messages for this list. This
747 level of priority is applied while the message is going through the
748 spool. The z priority will freeze the message in the spool.
749 Receiving
751 "sender_headers"
752 Header field name(s) used to determine sender of the messages
754 Format:
756 Default:
757 "From"
758 Context:
760 site (sympa.conf)
761 "Return-Path" means envelope sender (a.k.a. "UNIX From") which will be
763 alternative to sender of messages without "From" field. "Resent-From"
764 may also be inserted before "From", because some mailers add it into
765 redirected messages and keep original "From" field intact. In
766 particular cases, "Return-Path" can not give right sender: Several mail
767 gateway products rewrite envelope sender and add original one as non-
768 standard field such as "X-Envelope-From". If that is the case, you
769 might want to insert it in place of "Return-Path".
770 Example:
772 sender_headers Resent-From,From,Return-Path
774 "misaddressed_commands"
776 Reject misaddressed commands
778 Format:
780 Default:
781 "reject"
782 Context:
784 site (sympa.conf)
785 When a mail command is sent to a list, by default Sympa rejects this
787 message. This feature can be turned off by setting this parameter to
788 "ignore".
789 "misaddressed_commands_regexp"
791 Regular expression matching with misaddressed commands
793 Format:
795 Default:
796 "((subscribe\s+(\S+)|unsubscribe\s+(\S+)|signoff\s+(\S+)|set\s+(\S+)\s+(mail|nomail|digest))\s*)"
797 Context:
799 site (sympa.conf)
800 Perl regular expression applied on messages subject and body to detect
802 misaddressed commands.
803 "sympa_priority"
805 Priority for command messages
807 Format:
809 0 - 0 - highest priority
810 1 - 1
811 2 - 2
812 3 - 3
813 4 - 4
814 5 - 5
815 6 - 6
816 7 - 7
817 8 - 8
818 9 - 9 - lowest priority
819 "z" - queue messages only
820 Default:
821 1
822 Context:
824 domain (robot.conf), site (sympa.conf)
825 Priority applied to messages sent to Sympa command address.
827 "request_priority"
829 Priority for messages bound for list owners
831 Format:
833 0 - 0 - highest priority
834 1 - 1
835 2 - 2
836 3 - 3
837 4 - 4
838 5 - 5
839 6 - 6
840 7 - 7
841 8 - 8
842 9 - 9 - lowest priority
843 "z" - queue messages only
844 Default:
845 0
846 Context:
848 domain (robot.conf), site (sympa.conf)
849 Priority for processing of messages bound for "LIST-request" address,
851 i.e. owners of the list
852 "owner_priority"
854 Priority for non-VERP bounces
856 Format:
858 0 - 0 - highest priority
859 1 - 1
860 2 - 2
861 3 - 3
862 4 - 4
863 5 - 5
864 6 - 6
865 7 - 7
866 8 - 8
867 9 - 9 - lowest priority
868 "z" - queue messages only
869 Default:
870 9
871 Context:
873 domain (robot.conf), site (sympa.conf)
874 Priority for processing of messages bound for "LIST-owner" address,
876 i.e. non-delivery reports (bounces).
877 "incoming_max_count"
879 Max number of sympa.pl workers
881 Format:
883 /"\d+"/
884 Default:
886 1
887 Context:
889 site (sympa.conf)
890 Max number of workers of sympa.pl daemon processing incoming spool.
892 "sleep"
894 Interval between scanning incoming message spool
896 Format:
898 Number of seconds.
899 Default:
901 5 (seconds)
902 Context:
904 site (sympa.conf)
905 Must not be 0.
907 Sending/receiving setup
909 "send"
910 Who can send messages
912 Format:
914 Name of "send" scenario:
915 "closed" - closed
917 "confidential" - restricted to subscribers, messages from others
918 are discarded
919 "editordkim" - Moderated, no authentication needed if DKIM
920 signature from moderator is OK
921 "editorkey" - Moderated
922 "editorkeyonly" - Moderated, even for moderators
923 "editorkeyonlyauth" - Moderated, need authentication from moderator
924 "newsletter" - Newsletter, restricted to moderators
925 "newsletterkeyonly" - Newsletter, restricted to moderators after
926 confirmation
927 "owner" - Restricted to list owners only
928 "ownerauth" - Restricted to list owners with previous MD5
929 authentication
930 "private" - restricted to subscribers
931 "private_smime" - restricted to subscribers and checked smime
932 signature
933 "privateandeditorkey" - Moderated, restricted to subscribers
934 "privateandnomultipartoreditorkey" - Moderated, for non subscribers
935 sending multipart messages
936 "privatekey" - restricted to subscribers with previous md5
937 authentication
938 "privatekeyandeditorkeyonly" - Moderated, for subscribers and even
939 moderators themself
940 "privateoreditorkey" - Private, moderated for non subscribers
941 "privateorpublickey" - Private, confirmation for non subscribers
942 "public" - public list
943 "public_nobcc" - public list, Bcc rejected (anti-spam)
944 "publickey" - anyone no authentication if DKIM signature is OK
945 "publicnoattachment" - public list multipart/mixed messages are
946 forwarded to moderator
947 "publicnomultipart" - public list multipart messages are rejected
948 Default:
949 "private"
950 Context:
952 list (config), domain (robot.conf), site (sympa.conf)
953 This parameter specifies who can send messages to the list.
955 "delivery_time"
957 Delivery time (hh:mm)
959 Format:
961 /"[0-2]?\d\:[0-6]\d"/
962 Default:
964 None.
965 Context:
967 list (config)
968 If this parameter is present, non-digest messages will be delivered to
970 subscribers at this time: When this time has been past, delivery is
971 postponed to the same time in next day.
972 "digest"
974 (Paragraph) Digest frequency
976 Single occurrence
978 Definition of digest mode. If this parameter is present, subscribers
980 can select the option of receiving messages in multipart/digest MIME
981 format, or as a plain text digest. Messages are then grouped together,
982 and compiled messages are sent to subscribers according to the
983 frequency selected with this parameter.
984 "digest.days"
986 days
988 Format:
990 Multiple occurrences allowed.
991 Day of week, 0 - 6.
993 Default:
995 None, mandatory.
996 Context:
998 list (config)
999 "digest.hour"
1001 hour
1003 Format:
1005 /"\d+"/
1006 Default:
1008 None, mandatory.
1009 Context:
1011 list (config)
1012 "digest.minute"
1014 minute
1016 Format:
1018 /"\d+"/
1019 Default:
1021 None, mandatory.
1022 Context:
1024 list (config)
1025 "digest_max_size"
1027 Digest maximum number of messages
1029 Format:
1031 Number of messages.
1032 Default:
1034 25 (messages)
1035 Context:
1037 list (config)
1038 "available_user_options"
1040 (Paragraph) Available subscription options
1042 Single occurrence
1044 "available_user_options.reception"
1046 reception mode
1048 Format:
1050 Multiple values allowed, separated by ",".
1051 Reception mode of list member.
1053 Default:
1055 "mail,notice,digest,digestplain,summary,nomail,txt,urlize,not_me"
1056 Context:
1058 list (config)
1059 Only these modes will be allowed for the subscribers of this list. If a
1061 subscriber has a reception mode not in the list, Sympa uses the mode
1062 specified in the default_user_options paragraph.
1063 "default_user_options"
1065 (Paragraph) Subscription profile
1067 Single occurrence
1069 Default profile for the subscribers of the list.
1071 "default_user_options.reception"
1073 reception mode
1075 Format:
1077 Reception mode of list member.
1078 Default:
1080 "mail"
1081 Context:
1083 list (config)
1084 Mail reception mode.
1086 "default_user_options.visibility"
1088 visibility
1090 Format:
1092 Visibility mode of list memeber.
1093 Default:
1095 "noconceal"
1096 Context:
1098 list (config)
1099 Visibility of the subscriber.
1101 "msg_topic"
1103 (Paragraph) Topics for message categorization
1105 Multiple occurrences allowed
1107 This paragraph defines a topic used to tag a message of a list, named
1109 by msg_topic.name ("other" is a reserved word), its title is
1110 msg_topic.title. The msg_topic.keywords entry is optional and allows
1111 automatic tagging. This should be a list of keywords, separated by ','.
1112 "msg_topic.name"
1114 Message topic name
1116 Format:
1118 /"[\-\w]+"/
1119 Default:
1121 None, mandatory.
1122 Context:
1124 list (config)
1125 "msg_topic.keywords"
1127 Message topic keywords
1129 Format:
1131 /"[^,\n]+(,[^,\n]+)*"/
1132 Default:
1134 None.
1135 Context:
1137 list (config)
1138 "msg_topic.title"
1140 Message topic title
1142 Format:
1144 /".+"/
1145 Default:
1147 None, mandatory.
1148 Context:
1150 list (config)
1151 "msg_topic_keywords_apply_on"
1153 Defines to which part of messages topic keywords are applied
1155 Format:
1157 "subject" - subject field
1158 "body" - message body
1159 "subject_and_body" - subject and body
1160 Default:
1161 "subject"
1162 Context:
1164 list (config)
1165 This parameter indicates which part of the message is used to perform
1167 automatic tagging.
1168 "msg_topic_tagging"
1170 Message tagging
1172 Format:
1174 "required_sender" - required to post message
1175 "required_moderator" - required to distribute message
1176 "optional" - optional
1177 Default:
1178 "optional"
1179 Context:
1181 list (config)
1182 This parameter indicates if the tagging is optional or required for a
1184 list.
1185 "reply_to_header"
1187 (Paragraph) Reply address
1189 Single occurrence
1191 This defines what Sympa will place in the Reply-To: SMTP header field
1193 of the messages it distributes.
1194 "reply_to_header.value"
1196 value
1198 Format:
1200 "sender" - sender
1201 "list" - list
1202 "all" - all
1203 "other_email" - other email address
1204 Default:
1205 "sender"
1206 Context:
1208 list (config)
1209 This parameter indicates whether the Reply-To: field should indicate
1211 the sender of the message (sender), the list itself (list), both list
1212 and sender (all) or an arbitrary e-mail address (defined by the
1213 other_email parameter).
1214 Note: it is inadvisable to change this parameter, and particularly
1216 inadvisable to set it to list. Experience has shown it to be almost
1217 inevitable that users, mistakenly believing that they are replying only
1218 to the sender, will send private messages to a list. This can lead, at
1219 the very least, to embarrassment, and sometimes to more serious
1220 consequences.
1221 "reply_to_header.other_email"
1223 other email address
1225 Format:
1227 /$email/
1228 Default:
1230 None.
1231 Context:
1233 list (config)
1234 If value was set to other_email, this parameter defines the e-mail
1236 address used.
1237 "reply_to_header.apply"
1239 respect of existing header field
1241 Format:
1243 "forced" - overwrite Reply-To: header field
1244 "respect" - preserve existing header field
1245 Default:
1246 "respect"
1247 Context:
1249 list (config)
1250 The default is to respect (preserve) the existing Reply-To: SMTP header
1252 field in incoming messages. If set to forced, Reply-To: SMTP header
1253 field will be overwritten.
1254 "anonymous_sender"
1256 Anonymous sender
1258 Format:
1260 /".+"/
1261 Default:
1263 None.
1264 Context:
1266 list (config)
1267 To hide the sender's email address before distributing the message. It
1269 is replaced by the provided email address.
1270 "anonymous_header_fields"
1272 Header fields removed when a mailing list is setup in anonymous mode
1274 Format:
1276 Default:
1277 "Authentication-Results,Disposition-Notification-To,DKIM-Signature,Injection-Info,Organisation,Organization,Original-Recipient,Originator,Path,Received,Received-SPF,Reply-To,Resent-Reply-To,Return-Receipt-To,X-Envelope-From,X-Envelope-To,X-Sender,X-X-Sender"
1278 Context:
1280 site (sympa.conf)
1281 See "anonymous_sender" list parameter.
1283 Default value prior to Sympa 6.1.19 is:
1285 Sender,X-Sender,Received,Message-id,From,X-Envelope-To,Resent-From,Reply-To,Organization,Disposition-Notification-To,X-Envelope-From,X-X-Sender
1287 "custom_header"
1289 Custom header field
1291 Format:
1293 Multiple occurrences allowed.
1294 /"\S+:\s+.*"/
1296 Default:
1298 None.
1299 Context:
1301 list (config)
1302 This parameter is optional. The headers specified will be added to the
1304 headers of messages distributed via the list. As of release 1.2.2 of
1305 Sympa, it is possible to put several custom header lines in the
1306 configuration file at the same time.
1307 "custom_subject"
1309 Subject tagging
1311 Format:
1313 /".+"/
1314 Default:
1316 None.
1317 Context:
1319 list (config)
1320 This parameter is optional. It specifies a string which is added to the
1322 subject of distributed messages (intended to help users who do not use
1323 automatic tools to sort incoming messages). This string will be
1324 surrounded by [] characters.
1325 "footer_type"
1327 Attachment type
1329 Format:
1331 "mime" - add a new MIME part
1332 "append" - append to message body
1333 Default:
1334 "mime"
1335 Context:
1337 list (config)
1338 List owners may decide to add message headers or footers to messages
1340 sent via the list. This parameter defines the way a footer/header is
1341 added to a message.
1342 mime:
1344 The default value. Sympa will add the footer/header as a new MIME part.
1346 append:
1348 Sympa will not create new MIME parts, but will try to append the
1350 header/footer to the body of the message. Predefined message-footers
1351 will be ignored. Headers/footers may be appended to text/plain messages
1352 only.
1353 "max_size"
1355 Maximum message size
1357 Format:
1359 Number of bytes.
1360 Default:
1362 5242880 (bytes)
1363 Context:
1365 list (config), domain (robot.conf), host
1366 Maximum size of a message in 8-bit bytes.
1368 Example:
1370 max_size 2097152
1372 "personalization_feature"
1374 Allow message personalization
1376 Format:
1378 "on" - enabled
1379 "off" - disabled
1380 Default:
1381 "off"
1382 Context:
1384 list (config), domain (robot.conf), site (sympa.conf)
1385 "personalization"
1387 (Paragraph) Message personalization
1389 Single occurrence
1391 "personalization.web_apply_on"
1393 Scope for messages from the web interface
1395 Format:
1397 "none" - do nothing
1398 "footer" - header and footer
1399 "all" - all
1400 Default:
1401 "footer"
1402 Context:
1404 list (config), domain (robot.conf), site (sympa.conf)
1405 "personalization.mail_apply_on"
1407 Scope for messages from incoming email
1409 Format:
1411 "none" - do nothing
1412 "footer" - header and footer
1413 "all" - all
1414 Default:
1415 "none"
1416 Context:
1418 list (config), domain (robot.conf), site (sympa.conf)
1419 "message_hook"
1421 (Paragraph) Hook modules for message processing
1423 Single occurrence
1425 "message_hook.pre_distribute"
1427 A hook on the messages before distribution
1429 Format:
1431 /"(::|\w)+"/
1432 Default:
1434 None.
1435 Context:
1437 list (config)
1438 "message_hook.post_archive"
1440 A hook on the messages just after archiving
1442 Format:
1444 /"(::|\w)+"/
1445 Default:
1447 None.
1448 Context:
1450 list (config)
1451 "reject_mail_from_automates_feature"
1453 Reject mail from automatic processes (crontab, etc)?
1455 Format:
1457 "on" - enabled
1458 "off" - disabled
1459 Default:
1460 "on"
1461 Context:
1463 list (config), site (sympa.conf)
1464 Rejects messages that seem to be from automated services, based on a
1466 few header fields ("Content-Identifier:", "Auto-Submitted:").
1467 Sympa also can be configured to reject messages based on the "From:"
1469 header field value (see "loop_prevention_regex").
1470 "remove_headers"
1472 Header fields to be removed from incoming messages
1474 Format:
1476 Multiple values allowed, separated by ",".
1477 /"\S+"/
1479 Default:
1481 "X-Sympa-To,X-Family-To,Return-Receipt-To,Precedence,X-Sequence,Disposition-Notification-To,Sender"
1482 Context:
1484 list (config), site (sympa.conf)
1485 Use it, for example, to ensure some privacy for your users in case that
1487 "anonymous_sender" mode is inappropriate.
1488 The removal of these header fields is applied before Sympa adds its own
1490 header fields ("rfc2369_header_fields" and "custom_header").
1491 Example:
1493 remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To
1495 "remove_outgoing_headers"
1497 Header fields to be removed before message distribution
1499 Format:
1501 Multiple values allowed, separated by ",".
1502 /"\S+"/
1504 Default:
1506 "none"
1507 Context:
1509 list (config), site (sympa.conf)
1510 The removal happens after Sympa's own header fields are added;
1512 therefore, it is a convenient way to remove Sympa's own header fields
1513 (like "X-Loop:" or "X-no-archive:") if you wish.
1514 Example:
1516 remove_outgoing_headers X-no-archive
1518 "rfc2369_header_fields"
1520 RFC 2369 header fields
1522 Format:
1524 Multiple values allowed, separated by ",".
1525 "help" - help
1527 "subscribe" - subscription
1528 "unsubscribe" - unsubscription
1529 "post" - posting address
1530 "owner" - owner
1531 "archive" - list archive
1532 Default:
1533 "help,subscribe,unsubscribe,post,owner,archive"
1534 Context:
1536 list (config), site (sympa.conf)
1537 Specify which RFC 2369 mailing list header fields to be added.
1539 "List-Id:" header field defined in RFC 2919 is always added. Sympa also
1541 adds "Archived-At:" header field defined in RFC 5064.
1542 Distribution
1544 "urlize_min_size"
1545 Minimum size to be urlized
1547 Format:
1549 Number of bytes.
1550 Default:
1552 10240 (bytes)
1553 Context:
1555 domain (robot.conf), site (sympa.conf)
1556 When a subscriber chose "urlize" reception mode, attachments not
1558 smaller than this size will be urlized.
1559 "allowed_external_origin"
1561 Allowed external links in sanitized HTML
1563 Format:
1565 /"[-\w*]+(?:[.][-\w*]+)+"/
1566 Default:
1568 None.
1569 Context:
1571 domain (robot.conf), site (sympa.conf)
1572 When the HTML content of a message must be sanitized, links ("href" or
1574 "src" attributes) with the hosts listed in this parameter will not be
1575 scrubbed. If "*" character is included, it matches any subdomains.
1576 Single "*" allows any hosts.
1577 Example:
1579 allowed_external_origin *.example.org,www.example.com
1581 "sympa_packet_priority"
1583 Default priority for a packet
1585 Format:
1587 0 - 0 - highest priority
1588 1 - 1
1589 2 - 2
1590 3 - 3
1591 4 - 4
1592 5 - 5
1593 6 - 6
1594 7 - 7
1595 8 - 8
1596 9 - 9 - lowest priority
1597 "z" - queue messages only
1598 Default:
1599 5
1600 Context:
1602 domain (robot.conf), site (sympa.conf)
1603 The default priority set to a packet to be sent by the bulk.
1605 "bulk_fork_threshold"
1607 Fork threshold of bulk daemon
1609 Format:
1611 /"\d+"/
1612 Default:
1614 1
1615 Context:
1617 site (sympa.conf)
1618 The minimum number of packets before bulk daemon forks a new worker to
1620 increase sending rate.
1621 "bulk_max_count"
1623 Maximum number of bulk workers
1625 Format:
1627 /"\d+"/
1628 Default:
1630 3
1631 Context:
1633 site (sympa.conf)
1634 "bulk_lazytime"
1636 Idle timeout of bulk workers
1638 Format:
1640 Number of seconds.
1641 Default:
1643 600 (seconds)
1644 Context:
1646 site (sympa.conf)
1647 The number of seconds a bulk worker will remain running without
1649 processing a message before it spontaneously exits.
1650 "bulk_sleep"
1652 Sleep time of bulk workers
1654 Format:
1656 Number of seconds.
1657 Default:
1659 1 (seconds)
1660 Context:
1662 site (sympa.conf)
1663 The number of seconds a bulk worker sleeps between starting a new loop
1665 if it didn't find a message to send.
1666 Keep it small if you want your server to be reactive.
1668 "bulk_wait_to_fork"
1670 Interval between checks of packet numbers
1672 Format:
1674 Number of seconds.
1675 Default:
1677 10 (seconds)
1678 Context:
1680 site (sympa.conf)
1681 Number of seconds a master bulk daemon waits between two packets number
1683 checks.
1684 Keep it small if you expect brutal increases in the message sending
1686 load.
1687 "log_smtp"
1689 Log invocation of sendmail
1691 Format:
1693 "on" - enabled
1694 "off" - disabled
1695 Default:
1696 "off"
1697 Context:
1699 domain (robot.conf), site (sympa.conf)
1700 This can be overwritten by "-m" option for sympa.pl.
1702 "maxsmtp"
1704 Maximum number of sendmail processes
1706 Format:
1708 /"\d+"/
1709 Default:
1711 40
1712 Context:
1714 site (sympa.conf)
1715 Maximum number of simultaneous child processes spawned by Sympa. This
1717 is the main load control parameter.
1718 Proposed value is quite low, but you can rise it up to 100, 200 or even
1720 300 with powerful systems.
1721 Example:
1723 maxsmtp 500
1725 "nrcpt"
1727 Maximum number of recipients per call to sendmail
1729 Format:
1731 /"\d+"/
1732 Default:
1734 25
1735 Context:
1737 site (sympa.conf)
1738 This grouping factor makes it possible for the sendmail processes to
1740 optimize the number of SMTP sessions for message distribution. If
1741 needed, you can limit the number of recipients for a particular domain.
1742 Check the "nrcpt_by_domain.conf" configuration file.
1743 "avg"
1745 Maximum number of different mail domains per call to sendmail
1747 Format:
1749 /"\d+"/
1750 Default:
1752 10
1753 Context:
1755 site (sympa.conf)
1756 Privileges
1758 "create_list"
1759 Who is able to create lists
1761 Format:
1763 Name of "create_list" scenario:
1764 "listmaster" - restricted to listmaster
1766 "public_listmaster" - anybody by validation by listmaster required
1767 Default:
1768 "public_listmaster"
1769 Context:
1771 domain (robot.conf), site (sympa.conf)
1772 Defines who can create lists (or request list creation) by creating new
1774 lists or by renaming or copying existing lists.
1775 Example:
1777 create_list intranet
1779 "allow_subscribe_if_pending"
1781 Allow adding subscribers to a list not open
1783 Format:
1785 "on" - enabled
1786 "off" - disabled
1787 Default:
1788 "on"
1789 Context:
1791 domain (robot.conf), site (sympa.conf)
1792 If set to "off", adding subscribers to, or removing subscribers from a
1794 list with status other than "open" is forbidden.
1795 "global_remind"
1797 Who is able to send remind messages over all lists
1799 Format:
1801 Name of "global_remind" scenario:
1802 "listmaster" - only for listmaster
1804 Default:
1805 "listmaster"
1806 Context:
1808 site (sympa.conf)
1809 "move_user"
1811 Who is able to change user's email
1813 Format:
1815 Name of "move_user" scenario:
1816 "auth" - need authentication
1818 "closed" - impossible
1819 "listmaster" - listmaster only
1820 Default:
1821 "auth"
1822 Context:
1824 domain (robot.conf), site (sympa.conf)
1825 "use_blocklist"
1827 Use blocklist
1829 Format:
1831 /"[-.\w]+"/
1832 Default:
1834 "send,create_list"
1835 Context:
1837 domain (robot.conf), site (sympa.conf)
1838 List of operations separated by comma for which blocklist filter is
1840 applied. Setting this parameter to "none" will hide the blocklist
1841 feature.
1842 "info"
1844 Who can view list information
1846 Format:
1848 Name of "info" scenario:
1849 "conceal" - restricted to subscribers - Silent rejection otherwise.
1851 "open" - for anyone
1852 "private" - restricted to subscribers
1853 Default:
1854 "open"
1855 Context:
1857 list (config), domain (robot.conf), site (sympa.conf)
1858 "subscribe"
1860 Who can subscribe to the list
1862 Format:
1864 Name of "subscribe" scenario:
1865 "auth" - subscription request confirmed
1867 "auth_notify" - need authentication (notification is sent to
1868 owners)
1869 "auth_notifydkim" - need authentication unless DKIM signature is OK
1870 (notification is sent to owners)
1871 "auth_owner" - requires authentication then owner approval
1872 "auth_ownerdkim" - requires authentication unless DKIM signature is
1873 OK, then owner approval
1874 "authdkim" - subscription request confirmed
1875 "closed" - subscription is impossible
1876 "open" - for anyone without authentication
1877 "open_notify" - anyone, notification is sent to list owner
1878 "open_quiet" - anyone, no welcome message
1879 "owner" - owners approval
1880 "smime" - requires S/MIME signed
1881 "smimeorowner" - requires S/MIME signed or owner approval
1882 Default:
1883 "open"
1884 Context:
1886 list (config), domain (robot.conf), site (sympa.conf)
1887 The subscribe parameter defines the rules for subscribing to the list.
1889 "add"
1891 Who can add subscribers
1893 Format:
1895 Name of "add" scenario:
1896 "auth" - restricted to owner with authentication
1898 "authdkim" - restricted to owner without authentication if DKIM
1899 signature is OK.
1900 "closed" - add impossible
1901 "owner" - add performed by list owner does not need authentication
1902 "owner_notify" - add performed by owner does not need
1903 authentication (notification)
1904 "ownerdkim" - add performed by list owner does not need
1905 authentication if DKIM signature OK
1906 Default:
1907 "owner"
1908 Context:
1910 list (config), domain (robot.conf), site (sympa.conf)
1911 Privilege for adding (ADD command) a subscriber to the list
1913 "unsubscribe"
1915 Who can unsubscribe
1917 Format:
1919 Name of "unsubscribe" scenario:
1920 "auth" - need authentication
1922 "auth_notify" - authentication requested, notification sent to
1923 owner
1924 "auth_notifydkim" - authentication requested unless DKIM signature
1925 is OK, notification sent to owner
1926 "authdkim" - need authentication unless DKIM signature is OK
1927 "closed" - impossible
1928 "open" - open
1929 "open_notify" - open with mail confirmation, owner is notified
1930 "owner" - owners approval
1931 Default:
1932 "open"
1933 Context:
1935 list (config), domain (robot.conf), site (sympa.conf)
1936 This parameter specifies the unsubscription method for the list. Use
1938 open_notify or auth_notify to allow owner notification of each
1939 unsubscribe command.
1940 "del"
1942 Who can delete subscribers
1944 Format:
1946 Name of "del" scenario:
1947 "auth" - deletion performed only by list owners, need
1949 authentication
1950 "authdkim" - deletion performed only by list owners, need
1951 authentication unless DKIM signature is OK
1952 "closed" - remove subscriber impossible
1953 "owner" - by owner without authentication
1954 "owner_notify" - list owners, authentication not needed
1955 (notification)
1956 "ownerdkim" - by owner without authentication if DKIM signature OK
1957 Default:
1958 "owner"
1959 Context:
1961 list (config), domain (robot.conf), site (sympa.conf)
1962 "invite"
1964 Who can invite people
1966 Format:
1968 Name of "invite" scenario:
1969 "closed" - closed
1971 "owner" - invite perform by list owner do not need authentication
1972 "private" - restricted to subscribers
1973 "public" - public
1974 Default:
1975 "private"
1976 Context:
1978 list (config), domain (robot.conf), site (sympa.conf)
1979 "remind"
1981 Who can start a remind process
1983 Format:
1985 Name of "remind" scenario:
1986 "listmaster" - listmaster only
1988 "listmasterdkim" - listmaster only (do not require authentication
1989 if DKIM siganture is OK)
1990 "owner" - restricted to list owners
1991 "ownerdkim" - restricted to list owners (authentication is not
1992 required if a DKIM signature is OK)
1993 Default:
1994 "owner"
1995 Context:
1997 list (config), domain (robot.conf), site (sympa.conf)
1998 This parameter specifies who is authorized to use the remind command.
2000 "review"
2002 Who can review subscribers
2004 Format:
2006 Name of "review" scenario:
2007 "closed" - no one can review
2009 "listmaster" - listmaster only
2010 "owner" - only owner (and listmaster)
2011 "private" - restricted to subscribers
2012 "public" - anyone can do it!
2013 Default:
2014 "owner"
2015 Context:
2017 list (config), domain (robot.conf), site (sympa.conf)
2018 This parameter specifies who can access the list of members. Since
2020 subscriber addresses can be abused by spammers, it is strongly
2021 recommended that you only authorize owners or subscribers to access the
2022 subscriber list.
2023 "owner_domain"
2025 Required domains for list owners
2027 Format:
2029 /"$host( +$host)*"/
2030 Default:
2032 None.
2033 Context:
2035 list (config), domain (robot.conf), site (sympa.conf)
2036 Restrict list ownership to addresses in the specified domains. This can
2038 be used to reserve list ownership to a group of trusted users from a
2039 set of domains associated with an organization, while allowing
2040 moderators and subscribers from the Internet at large.
2041 "owner_domain_min"
2043 Minimum owners in required domains
2045 Format:
2047 /"\d+"/
2048 Default:
2050 0
2051 Context:
2053 list (config), domain (robot.conf), site (sympa.conf)
2054 Minimum number of owners for each list must satisfy the owner_domain
2056 restriction. The default of zero (0) means *all* list owners must
2057 match. Setting to 1 requires only one list owner to match owner_domain;
2058 all other owners can be from any domain. This setting can be used to
2059 ensure that there is always at least one known contact point for any
2060 mailing list.
2061 "shared_doc"
2063 (Paragraph) Shared documents
2065 Single occurrence
2067 This paragraph defines read and edit access to the shared document
2069 repository.
2070 "shared_doc.d_read"
2072 Who can view
2074 Format:
2076 Name of "d_read" scenario:
2077 "owner" - restricted to list owners
2079 "private" - restricted to subscribers
2080 "private-https" - restricted to subscribers authenticated with user
2081 cert
2082 "public" - public documents
2083 Default:
2084 "private"
2085 Context:
2087 list (config), domain (robot.conf), site (sympa.conf)
2088 "shared_doc.d_edit"
2090 Who can edit
2092 Format:
2094 Name of "d_edit" scenario:
2095 "editor" - moderated for subscribers
2097 "owner" - restricted to list owners
2098 "private" - restricted to subscribers
2099 "private-https" - restricted to subscribers authenticated with user
2100 cert
2101 "public" - public documents
2102 Default:
2103 "owner"
2104 Context:
2106 list (config), domain (robot.conf), site (sympa.conf)
2107 "shared_doc.quota"
2109 quota
2111 Format:
2113 Number of Kbytes.
2114 Default:
2116 None.
2117 Context:
2119 list (config), domain (robot.conf), site (sympa.conf)
2120 Archives
2122 "ignore_x_no_archive_header_feature"
2123 Ignore "X-no-archive:" header field
2125 Format:
2127 "on" - enabled
2128 "off" - disabled
2129 Default:
2130 "off"
2131 Context:
2133 site (sympa.conf)
2134 Sympa's default behavior is to skip archiving of incoming messages that
2136 have an "X-no-archive:" header field set. This parameter allows one to
2137 change this behavior.
2138 Example:
2140 ignore_x_no_archive_header_feature on
2142 "custom_archiver"
2144 Custom archiver
2146 Format:
2148 /".+"/
2149 Default:
2151 None.
2152 Context:
2154 site (sympa.conf)
2155 Activates a custom archiver to use instead of MHonArc. The value of
2157 this parameter is the absolute path to the executable file.
2158 Sympa invokes this file with these two arguments:
2160 --list
2162 The address of the list including domain part.
2164 --file
2166 Absolute path to the message to be archived.
2168 "process_archive"
2170 Store distributed messages into archive
2172 Format:
2174 "on" - enabled
2175 "off" - disabled
2176 Default:
2177 "off"
2178 Context:
2180 list (config), domain (robot.conf), site (sympa.conf)
2181 If enabled, distributed messages via lists will be archived. Otherwise
2183 archiving is disabled.
2184 Note that even if setting this parameter disabled, past archives will
2186 not be removed and will be accessible according to access settings by
2187 each list.
2188 "archive"
2190 (Paragraph) Archives
2192 Single occurrence
2194 Privilege for reading mail archives and frequency of archiving.
2196 Defines who can access the list's web archive.
2198 "archive.period"
2200 Deprecated.
2202 "archive.access"
2204 Deprecated.
2206 "archive.web_access"
2208 access right
2210 Format:
2212 Name of "archive_web_access" scenario:
2213 "closed" - closed
2215 "listmaster" - listmaster
2216 "owner" - by owner
2217 "private" - subscribers only
2218 "public" - public
2219 Default:
2220 "closed"
2221 Context:
2223 list (config), domain (robot.conf), site (sympa.conf)
2224 "archive.mail_access"
2226 access right by mail commands
2228 Format:
2230 Name of "archive_mail_access" scenario:
2231 "closed" - closed
2233 "owner" - by owner
2234 "private" - subscribers only
2235 "public" - public
2236 Default:
2237 "closed"
2238 Context:
2240 list (config), domain (robot.conf), site (sympa.conf)
2241 "archive.quota"
2243 quota
2245 Format:
2247 Number of Kbytes.
2248 Default:
2250 None.
2251 Context:
2253 list (config), site (sympa.conf)
2254 "archive.max_month"
2256 Maximum number of month archived
2258 Format:
2260 Number of months.
2261 Default:
2263 None.
2264 Context:
2266 list (config)
2267 "archive_crypted_msg"
2269 Archive encrypted mails as cleartext
2271 Format:
2273 "original" - original messages
2274 "decrypted" - decrypted messages
2275 Default:
2276 "original"
2277 Context:
2279 list (config)
2280 "web_archive_spam_protection"
2282 Protect web archive against spam harvesters
2284 Format:
2286 "cookie" - use HTTP cookie
2287 "javascript" - use JavaScript
2288 "at" - replace @ characters
2289 "concealed" - never show address
2290 "none" - do nothing
2291 Default:
2292 "cookie"
2293 Context:
2295 list (config), domain (robot.conf), site (sympa.conf)
2296 The same as "spam_protection", but restricted to the web archive.
2298 In addition to it:
2300 cookie: users must submit a small form in order to receive a cookie
2302 before browsing the web archive.
2303 concealed: e-mail addresses will never be displayed.
2305 Bounces
2307 "bounce"
2308 (Paragraph) Bounces management
2310 Single occurrence
2312 "bounce.warn_rate"
2314 warn rate
2316 Format:
2318 Number of %.
2319 Default:
2321 30 (%)
2322 Context:
2324 list (config), site (sympa.conf)
2325 The list owner receives a warning whenever a message is distributed and
2327 the number (percentage) of bounces exceeds this value.
2328 "bounce.halt_rate"
2330 Deprecated.
2332 "bouncers_level1"
2334 (Paragraph) Management of bouncers, 1st level
2336 Single occurrence
2338 Level 1 is the lower level of bouncing users
2340 "bouncers_level1.rate"
2342 threshold
2344 Format:
2346 Number of points.
2347 Default:
2349 45 (points)
2350 Context:
2352 list (config), domain (robot.conf), site (sympa.conf)
2353 Each bouncing user have a score (from 0 to 100).
2355 This parameter defines a lower limit for each category of bouncing
2357 users.For example, level 1 begins from 45 to level_2_treshold.
2358 "bouncers_level1.action"
2360 action for this population
2362 Format:
2364 "remove_bouncers" - remove bouncing users
2365 "notify_bouncers" - send notify to bouncing users
2366 "none" - do nothing
2367 Default:
2368 "notify_bouncers"
2369 Context:
2371 list (config)
2372 This parameter defines which task is automatically applied on level 1
2374 bouncers.
2375 "bouncers_level1.notification"
2377 notification
2379 Format:
2381 "none" - do nothing
2382 "owner" - owner
2383 "listmaster" - listmaster
2384 Default:
2385 "owner"
2386 Context:
2388 list (config)
2389 When automatic task is executed on level 1 bouncers, a notification
2391 email can be send to listowner or listmaster.
2392 "bouncers_level2"
2394 (Paragraph) Management of bouncers, 2nd level
2396 Single occurrence
2398 Level 2 is the highest level of bouncing users
2400 "bouncers_level2.rate"
2402 threshold
2404 Format:
2406 Number of points.
2407 Default:
2409 75 (points)
2410 Context:
2412 list (config), domain (robot.conf), site (sympa.conf)
2413 Each bouncing user have a score (from 0 to 100).
2415 This parameter defines the score range defining each category of
2417 bouncing users.For example, level 2 is for users with a score between
2418 80 and 100.
2419 "bouncers_level2.action"
2421 action for this population
2423 Format:
2425 "remove_bouncers" - remove bouncing users
2426 "notify_bouncers" - send notify to bouncing users
2427 "none" - do nothing
2428 Default:
2429 "remove_bouncers"
2430 Context:
2432 list (config)
2433 This parameter defines which task is automatically applied on level 2
2435 bouncers.
2436 "bouncers_level2.notification"
2438 notification
2440 Format:
2442 "none" - do nothing
2443 "owner" - owner
2444 "listmaster" - listmaster
2445 Default:
2446 "owner"
2447 Context:
2449 list (config)
2450 When automatic task is executed on level 2 bouncers, a notification
2452 email can be send to listowner or listmaster.
2453 "verp_rate"
2455 percentage of list members in VERP mode
2457 Format:
2459 "100%" - 100% - always
2460 "50%" - 50%
2461 "33%" - 33%
2462 "25%" - 25%
2463 "20%" - 20%
2464 "10%" - 10%
2465 "5%" - 5%
2466 "2%" - 2%
2467 "0%" - 0% - never
2468 Default:
2469 "0%"
2470 Context:
2472 list (config), domain (robot.conf), site (sympa.conf)
2473 Uses variable envelope return path (VERP) to detect bouncing subscriber
2475 addresses.
2476 0%: VERP is never used.
2478 100%: VERP is always in use.
2480 VERP requires address with extension to be supported by MTA. If
2482 tracking is enabled for a list or a message, VERP is applied for 100%
2483 of subscribers.
2484 "tracking"
2486 (Paragraph) Message tracking feature
2488 Single occurrence
2490 "tracking.delivery_status_notification"
2492 tracking message by delivery status notification
2494 Format:
2496 "on" - enabled
2497 "off" - disabled
2498 Default:
2499 "off"
2500 Context:
2502 list (config), site (sympa.conf)
2503 "tracking.message_disposition_notification"
2505 tracking message by message disposition notification
2507 Format:
2509 "on" - enabled
2510 "on_demand" - on demand
2511 "off" - disabled
2512 Default:
2513 "off"
2514 Context:
2516 list (config), site (sympa.conf)
2517 "tracking.tracking"
2519 who can view message tracking
2521 Format:
2523 Name of "tracking" scenario:
2524 "owner" - only owner (and listmaster)
2526 "private" - restricted to subscribers
2527 Default:
2528 "owner"
2529 Context:
2531 list (config), site (sympa.conf)
2532 "tracking.retention_period"
2534 Tracking datas are removed after this number of days
2536 Format:
2538 Number of days.
2539 Default:
2541 90 (days)
2542 Context:
2544 list (config), site (sympa.conf)
2545 "welcome_return_path"
2547 Welcome return-path
2549 Format:
2551 "unique" - bounce management
2552 "owner" - owner
2553 Default:
2554 "owner"
2555 Context:
2557 list (config), site (sympa.conf)
2558 If set to unique, the welcome message is sent using a unique return
2560 path in order to remove the subscriber immediately in the case of a
2561 bounce.
2562 "remind_return_path"
2564 Return-path of the REMIND command
2566 Format:
2568 "unique" - bounce management
2569 "owner" - owner
2570 Default:
2571 "owner"
2572 Context:
2574 list (config), site (sympa.conf)
2575 Same as welcome_return_path, but applied to remind messages.
2577 "expire_bounce_task"
2579 Task for expiration of old bounces
2581 Format:
2583 /"\w+"/
2584 Default:
2586 "daily"
2587 Context:
2589 site (sympa.conf)
2590 This task resets bouncing information for addresses not bouncing in the
2592 last 10 days after the latest message distribution.
2593 "purge_orphan_bounces_task"
2595 Task for cleaning invalidated bounces
2597 Format:
2599 /"\w+"/
2600 Default:
2602 "monthly"
2603 Context:
2605 site (sympa.conf)
2606 This task deletes bounce information for unsubscribed users.
2608 "eval_bouncers_task"
2610 Task for updating bounce scores
2612 Format:
2614 /"\w+"/
2615 Default:
2617 "daily"
2618 Context:
2620 site (sympa.conf)
2621 This task scans all bouncing users for all lists, and updates
2623 "bounce_score_subscriber" field in "subscriber_table" table. The scores
2624 may be used for management of bouncers.
2625 "process_bouncers_task"
2627 Task for management of bouncers
2629 Format:
2631 /"\w+"/
2632 Default:
2634 "weekly"
2635 Context:
2637 site (sympa.conf)
2638 This task executes actions on bouncing users configured by each list,
2640 according to their scores.
2641 "purge_tables_task"
2643 Task for cleaning tables
2645 Format:
2647 /"\w+"/
2648 Default:
2650 "daily"
2651 Context:
2653 site (sympa.conf)
2654 This task cleans old tracking information from "notification_table"
2656 table.
2657 "minimum_bouncing_count"
2659 Minimum number of bounces
2661 Format:
2663 /"\d+"/
2664 Default:
2666 10
2667 Context:
2669 site (sympa.conf)
2670 The minimum number of bounces received to update bounce score of a
2672 user.
2673 "minimum_bouncing_period"
2675 Minimum bouncing period
2677 Format:
2679 Number of days.
2680 Default:
2682 10 (days)
2683 Context:
2685 site (sympa.conf)
2686 The minimum period for which bouncing lasted to update bounce score of
2688 a user.
2689 "bounce_delay"
2691 Delay of bounces
2693 Format:
2695 Number of days.
2696 Default:
2698 0 (days)
2699 Context:
2701 site (sympa.conf)
2702 Average time for a bounce sent back to mailing list server after a post
2704 was sent to a list. Usually bounces are sent back on the same day as
2705 the original message.
2706 "bounce_email_prefix"
2708 Prefix of VERP return address
2710 Format:
2712 /"\S+"/
2713 Default:
2715 "bounce"
2716 Context:
2718 site (sympa.conf)
2719 The prefix to consist the return-path of probe messages used for bounce
2721 management, when variable envelope return path (VERP) is enabled. VERP
2722 requires address with extension to be supported by MTA.
2723 If you change the default value, you must modify the mail aliases too.
2725 "return_path_suffix"
2727 Suffix of list return address
2729 Format:
2731 /"\S+"/
2732 Default:
2734 "-owner"
2735 Context:
2737 site (sympa.conf)
2738 The suffix appended to the list name to form the return-path of
2740 messages distributed through the list. This address will receive all
2741 non-delivery reports (also called bounces).
2742 Loop prevention
2744 "loop_command_max"
2745 Maximum number of responses to command message
2747 Format:
2749 /"\d+"/
2750 Default:
2752 200
2753 Context:
2755 site (sympa.conf)
2756 The maximum number of command reports sent to an email address.
2758 Messages are stored in "bad" subdirectory of incoming message spool,
2759 and reports are not longer sent.
2760 "loop_command_sampling_delay"
2762 Delay before counting responses to command message
2764 Format:
2766 Number of seconds.
2767 Default:
2769 3600 (seconds)
2770 Context:
2772 site (sympa.conf)
2773 This parameter defines the delay in seconds before decrementing the
2775 counter of reports sent to an email address.
2776 "loop_command_decrease_factor"
2778 Decrementing factor of responses to command message
2780 Format:
2782 /"[.\d]+"/
2783 Default:
2785 0.5
2786 Context:
2788 site (sympa.conf)
2789 The decrementation factor (from 0 to 1), used to determine the new
2791 report counter after expiration of the delay.
2792 "msgid_table_cleanup_ttl"
2794 Expiration period of message ID table
2796 Format:
2798 Number of seconds.
2799 Default:
2801 86400 (seconds)
2802 Context:
2804 site (sympa.conf)
2805 Expiration period of entries in the table maintained by sympa_msg.pl
2807 daemon to prevent delivery of duplicate messages caused by loop.
2808 "msgid_table_cleanup_frequency"
2810 Cleanup interval of message ID table
2812 Format:
2814 Number of seconds.
2815 Default:
2817 3600 (seconds)
2818 Context:
2820 site (sympa.conf)
2821 Interval between cleanups of the table maintained by sympa_msg.pl
2823 daemon to prevent delivery of duplicate messages caused by loop.
2824 Automatic lists
2826 "automatic_list_feature"
2827 Automatic list
2829 Format:
2831 "on" - enabled
2832 "off" - disabled
2833 Default:
2834 "off"
2835 Context:
2837 domain (robot.conf), site (sympa.conf)
2838 "automatic_list_removal"
2840 Remove empty automatic list
2842 Format:
2844 "none" - do nothing
2845 "if_empty" - if_empty
2846 Default:
2847 "none"
2848 Context:
2850 domain (robot.conf), site (sympa.conf)
2851 If set to "if_empty", then Sympa will remove automatically created
2853 mailing lists just after their creation, if they contain no list
2854 member.
2855 Example:
2857 automatic_list_removal if_empty
2859 "automatic_list_creation"
2861 Who is able to create automatic list
2863 Format:
2865 Name of "automatic_list_creation" scenario:
2866 "family_owner" - Restricted to people subscribed to the list of
2868 family owners.
2869 "listmaster" - restricted to listmaster
2870 "public" - anybody. Be sure you know what you are doing
2871 Default:
2872 "public"
2873 Context:
2875 domain (robot.conf), site (sympa.conf)
2876 "automatic_list_families"
2878 Definition of automatic list families
2880 Format:
2882 /".+"/
2883 Default:
2885 None.
2886 Context:
2888 domain (robot.conf), site (sympa.conf)
2889 Defines the families the automatic lists are based on. It is a
2891 character string structured as follows:
2892 * each family is separated from the other by a semicolon (;)
2894 * inside a family definition, each field is separated from the other by
2896 a colon (:)
2897 * each field has the structure: "<field name>=<field value>"
2899 Basically, each time Sympa uses the automatic lists families, the
2901 values defined in this parameter will be available in the family
2902 object.
2903 * for scenarios: [family->name]
2905 * for templates: [% family.name %]
2907 Example:
2909 automatic_list_families name=family_one:prefix=f1:display=My automatic lists:prefix_separator=+:classes separator=-:family_owners_list=alist@domain.tld;name=family_two:prefix=f2:display=My other automatic lists:prefix_separator=+:classes separator=-:family_owners_list=anotherlist@domain.tld;
2911 "parsed_family_files"
2913 Parsed files for families
2915 Format:
2917 /"[-.\w]+"/
2918 Default:
2920 "message_header,message_header.mime,message_footer,message_footer.mime,info"
2921 Context:
2923 domain (robot.conf), site (sympa.conf)
2924 comma-separated list of files that will be parsed by Sympa when
2926 instantiating a family (no space allowed in file names)
2927 "family_signoff"
2929 Global unsubscription
2931 Format:
2933 Name of "family_signoff" scenario:
2934 "auth" - need authentication
2936 "closed" - impossible
2937 Default:
2938 "auth"
2939 Context:
2941 domain (robot.conf), site (sympa.conf)
2942 Tag based spam filtering
2944 "antispam_feature"
2945 Tag based spam filtering
2947 Format:
2949 "on" - enabled
2950 "off" - disabled
2951 Default:
2952 "off"
2953 Context:
2955 domain (robot.conf), site (sympa.conf)
2956 "antispam_tag_header_name"
2958 Header field to tag spams
2960 Format:
2962 /"\S+"/
2963 Default:
2965 "X-Spam-Status"
2966 Context:
2968 domain (robot.conf), site (sympa.conf)
2969 If a spam filter (like spamassassin or j-chkmail) add a header field to
2971 tag spams, name of this header field (example X-Spam-Status)
2972 "antispam_tag_header_spam_regexp"
2974 Regular expression to check header field to tag spams
2976 Format:
2978 /".+"/
2979 Default:
2981 "^\s*Yes"
2982 Context:
2984 domain (robot.conf), site (sympa.conf)
2985 Regular expression applied on this header to verify message is a spam
2987 (example Yes)
2988 "antispam_tag_header_ham_regexp"
2990 Regular expression to determine spam or ham.
2992 Format:
2994 /".+"/
2995 Default:
2997 "^\s*No"
2998 Context:
3000 domain (robot.conf), site (sympa.conf)
3001 Regular expression applied on this header field to verify message is
3003 NOT a spam (example No)
3004 "spam_status"
3006 Name of header field to inform
3008 Format:
3010 Name of "spam_status" scenario:
3011 "x-spam-status" - test x-spam-status header
3013 Default:
3014 "x-spam-status"
3015 Context:
3017 domain (robot.conf), site (sympa.conf)
3018 Messages are supposed to be filtered by an spam filter that adds them
3020 one or more headers. This parameter is used to select a special
3021 scenario in order to decide the message's spam status: ham, spam or
3022 unsure. This parameter replaces antispam_tag_header_name,
3023 antispam_tag_header_spam_regexp and antispam_tag_header_ham_regexp.
3024 Directories
3026 "home"
3027 List home
3029 Format:
3031 /".+"/
3032 Default:
3034 $EXPLDIR
3035 Context:
3037 site (sympa.conf)
3038 Base directory of list configurations.
3040 "etc"
3042 Directory for configuration files
3044 Format:
3046 /".+"/
3047 Default:
3049 $SYSCONFDIR
3050 Context:
3052 site (sympa.conf)
3053 Base directory of global configuration (except "sympa.conf").
3055 "spool"
3057 Base directory of spools
3059 Format:
3061 /".+"/
3062 Default:
3064 $SPOOLDIR
3065 Context:
3067 site (sympa.conf)
3068 Base directory of all spools which are created at runtime. This
3070 directory must be writable by Sympa user.
3071 "queue"
3073 Directory for message incoming spool
3075 Format:
3077 /".+"/
3078 Default:
3080 "$SPOOLDIR/msg"
3081 Context:
3083 site (sympa.conf)
3084 This spool is used both by "queue" program and "sympa_msg.pl" daemon.
3086 "queuemod"
3088 Directory for moderation spool
3090 Format:
3092 /".+"/
3093 Default:
3095 "$SPOOLDIR/moderation"
3096 Context:
3098 site (sympa.conf)
3099 "queuedigest"
3101 Directory for digest spool
3103 Format:
3105 /".+"/
3106 Default:
3108 "$SPOOLDIR/digest"
3109 Context:
3111 site (sympa.conf)
3112 "queueauth"
3114 Directory for held message spool
3116 Format:
3118 /".+"/
3119 Default:
3121 "$SPOOLDIR/auth"
3122 Context:
3124 site (sympa.conf)
3125 This parameter is named such by historical reason.
3127 "queueoutgoing"
3129 Directory for archive spool
3131 Format:
3133 /".+"/
3134 Default:
3136 "$SPOOLDIR/outgoing"
3137 Context:
3139 site (sympa.conf)
3140 This parameter is named such by historical reason.
3142 "queuesubscribe"
3144 Directory for held request spool
3146 Format:
3148 /".+"/
3149 Default:
3151 "$SPOOLDIR/subscribe"
3152 Context:
3154 site (sympa.conf)
3155 This parameter is named such by historical reason.
3157 "queuetopic"
3159 Directory for topic spool
3161 Format:
3163 /".+"/
3164 Default:
3166 "$SPOOLDIR/topic"
3167 Context:
3169 site (sympa.conf)
3170 "queuebounce"
3172 Directory for bounce incoming spool
3174 Format:
3176 /".+"/
3177 Default:
3179 "$SPOOLDIR/bounce"
3180 Context:
3182 site (sympa.conf)
3183 This spool is used both by "bouncequeue" program and "bounced.pl"
3185 daemon.
3186 "queuetask"
3188 Directory for task spool
3190 Format:
3192 /".+"/
3193 Default:
3195 "$SPOOLDIR/task"
3196 Context:
3198 site (sympa.conf)
3199 "queueautomatic"
3201 Directory for automatic list creation spool
3203 Format:
3205 /".+"/
3206 Default:
3208 "$SPOOLDIR/automatic"
3209 Context:
3211 site (sympa.conf)
3212 This spool is used both by "familyqueue" program and
3214 "sympa_automatic.pl" daemon.
3215 "queuebulk"
3217 Directory for message outgoing spool
3219 Format:
3221 /".+"/
3222 Default:
3224 "$SPOOLDIR/bulk"
3225 Context:
3227 site (sympa.conf)
3228 This parameter is named such by historical reason.
3230 "tmpdir"
3232 Temporary directory used by external programs such as virus scanner.
3234 Also, outputs to daemons' standard error are redirected to the files
3235 under this directory.
3236 Format:
3238 /".+"/
3239 Default:
3241 "$SPOOLDIR/tmp"
3242 Context:
3244 site (sympa.conf)
3245 "viewmail_dir"
3247 Directory to cache formatted messages
3249 Format:
3251 /".+"/
3252 Default:
3254 "$SPOOLDIR/viewmail"
3255 Context:
3257 site (sympa.conf)
3258 Base directory path of directories where HTML view of messages are
3260 cached.
3261 "bounce_path"
3263 Directory for storing bounces
3265 Format:
3267 /".+"/
3268 Default:
3270 $BOUNCEDIR
3271 Context:
3273 site (sympa.conf)
3274 The directory where bounced.pl daemon will store the last bouncing
3276 message for each user. A message is stored in the file:
3277 <bounce_path>/<list name>@<mail domain name>/<email address>, or, if
3278 tracking is enabled: <bounce_path>/<list name>@<mail domain
3279 name>/<email address>_<envelope ID>.
3280 Users can access to these messages using web interface in the bounce
3282 management page.
3283 Don't confuse with "queuebounce" parameter which defines the spool
3285 where incoming error reports are stored and picked by bounced.pl
3286 daemon.
3287 "arc_path"
3289 Directory for storing archives
3291 Format:
3293 /".+"/
3294 Default:
3296 $ARCDIR
3297 Context:
3299 domain (robot.conf), site (sympa.conf)
3300 Where to store HTML archives. This parameter is used by the
3302 "archived.pl" daemon. It is a good idea to install the archive outside
3303 the web document hierarchy to prevent overcoming of WWSympa's access
3304 control.
3305 "purge_spools_task"
3307 Task for cleaning spools
3309 Format:
3311 /"\w+"/
3312 Default:
3314 "daily"
3315 Context:
3317 site (sympa.conf)
3318 This task cleans old content in spools.
3320 "clean_delay_queue"
3322 Max age of incoming bad messages
3324 Format:
3326 Number of days.
3327 Default:
3329 7 (days)
3330 Context:
3332 site (sympa.conf)
3333 Number of days "bad" messages are kept in message incoming spool (as
3335 specified by "queue" parameter). Sympa keeps messages rejected for
3336 various reasons (badly formatted, looping etc.).
3337 "clean_delay_queueoutgoing"
3339 Max age of bad messages for archives
3341 Format:
3343 Number of days.
3344 Default:
3346 7 (days)
3347 Context:
3349 site (sympa.conf)
3350 Number of days "bad" messages are kept in message archive spool (as
3352 specified by "queueoutgoing" parameter). Sympa keeps messages rejected
3353 for various reasons (unable to create archive directory, to copy file
3354 etc.).
3355 "clean_delay_queuebounce"
3357 Max age of bad bounce messages
3359 Format:
3361 Number of days.
3362 Default:
3364 7 (days)
3365 Context:
3367 site (sympa.conf)
3368 Number of days "bad" messages are kept in bounce spool (as specified by
3370 "queuebounce" parameter). Sympa keeps messages rejected for various
3371 reasons (unknown original sender, unknown report type).
3372 "clean_delay_queueauth"
3374 Max age of held messages
3376 Format:
3378 Number of days.
3379 Default:
3381 30 (days)
3382 Context:
3384 site (sympa.conf)
3385 Number of days messages are kept in held message spool (as specified by
3387 "queueauth" parameter). Beyond this deadline, messages that have not
3388 been confirmed are deleted.
3389 "clean_delay_queuesubscribe"
3391 Max age of held requests
3393 Format:
3395 Number of days.
3396 Default:
3398 30 (days)
3399 Context:
3401 site (sympa.conf)
3402 Number of days requests are kept in held request spool (as specified by
3404 "queuesubscribe" parameter). Beyond this deadline, requests that have
3405 not been validated nor declined are deleted.
3406 "clean_delay_queuetopic"
3408 Max age of tagged topics
3410 Format:
3412 Number of days.
3413 Default:
3415 30 (days)
3416 Context:
3418 site (sympa.conf)
3419 Number of days (automatically or manually) tagged topics are kept in
3421 topic spool (as specified by "queuetopic" parameter). Beyond this
3422 deadline, tagging is forgotten.
3423 "clean_delay_queueautomatic"
3425 Max age of incoming bad messages in automatic list creation spool
3427 Format:
3429 Number of days.
3430 Default:
3432 10 (days)
3433 Context:
3435 site (sympa.conf)
3436 Number of days "bad" messages are kept in automatic list creation spool
3438 (as specified by "queueautomatic" parameter). Sympa keeps messages
3439 rejected for various reasons (badly formatted, looping etc.).
3440 "clean_delay_queuebulk"
3442 Max age of outgoing bad messages
3444 Format:
3446 Number of days.
3447 Default:
3449 7 (days)
3450 Context:
3452 site (sympa.conf)
3453 Number of days "bad" messages are kept in message outgoing spool (as
3455 specified by "queuebulk" parameter). Sympa keeps messages rejected for
3456 various reasons (failed personalization, bad configuration on MTA
3457 etc.).
3458 "clean_delay_queuedigest"
3460 Max age of bad messages in digest spool
3462 Format:
3464 Number of days.
3465 Default:
3467 14 (days)
3468 Context:
3470 site (sympa.conf)
3471 Number of days "bad" messages are kept in digest spool (as specified by
3473 "queuedigest" parameter). Sympa keeps messages rejected for various
3474 reasons (syntax errors in "digest.tt2" template etc.).
3475 "clean_delay_tmpdir"
3477 Max age of temporary files
3479 Format:
3481 Number of days.
3482 Default:
3484 7 (days)
3485 Context:
3487 site (sympa.conf)
3488 Number of days files in temporary directory (as specified by "tmpdir"
3490 parameter), including standard error logs, are kept.
3491 S/MIME and TLS
3493 S/MIME authentication, decryption and re-encryption. It requires these
3494 external modules: Crypt-OpenSSL-X509 and Crypt-SMIME.
3495 TLS client authentication. It requires an external module: IO-Socket-
3497 SSL.
3498 "cafile"
3500 File containing trusted CA certificates
3502 Format:
3504 /".+"/
3505 Default:
3507 None.
3508 Context:
3510 site (sympa.conf)
3511 This can be used alternatively and/or additionally to "capath".
3513 "capath"
3515 Directory containing trusted CA certificates
3517 Format:
3519 /".+"/
3520 Default:
3522 None.
3523 Context:
3525 site (sympa.conf)
3526 CA certificates in this directory are used for client authentication.
3528 The certificates need to have names including hash of subject, or
3530 symbolic links to them with such names. The links may be created by
3531 using "c_rehash" script bundled in OpenSSL.
3532 "key_passwd"
3534 Password used to crypt lists private keys
3536 Format:
3538 The value to be concealed.
3539 Default:
3541 None.
3542 Context:
3544 site (sympa.conf)
3545 If not defined, Sympa assumes that list private keys are not encrypted.
3547 Example:
3549 key_passwd your_password
3551 "ssl_cert_dir"
3553 Directory containing user certificates
3555 Format:
3557 /".+"/
3558 Default:
3560 "$EXPLDIR/X509-user-certs"
3561 Context:
3563 site (sympa.conf)
3564 Data sources setup
3566 Including subscribers, owners and moderators from data sources.
3567 Appropriate database driver (DBD) modules are required: DBD-CSV, DBD-
3568 mysql, DBD-ODBC, DBD-Oracle, DBD-Pg, DBD-SQLite and/or Net-LDAP. And
3569 also, if secure connection (LDAPS) to LDAP server is required: IO-
3570 Socket-SSL.
3571 "inclusion_notification_feature"
3573 Notify subscribers when they are included from a data source?
3575 Format:
3577 "on" - enabled
3578 "off" - disabled
3579 Default:
3580 "off"
3581 Context:
3583 list (config), site (sympa.conf)
3584 "member_include"
3586 (Paragraph) Subscribers defined in an external data source
3588 Multiple occurrences allowed
3590 "member_include.source"
3592 the data source
3594 Format:
3596 /"[\w-]+"/
3597 Default:
3599 None, mandatory.
3600 Context:
3602 list (config)
3603 "member_include.source_parameters"
3605 data source parameters
3607 Format:
3609 /".*"/
3610 Default:
3612 None.
3613 Context:
3615 list (config)
3616 "owner_include"
3618 (Paragraph) Owners defined in an external data source
3620 Multiple occurrences allowed
3622 "owner_include.source"
3624 the data source
3626 Format:
3628 /"[\w-]+"/
3629 Default:
3631 None, mandatory.
3632 Context:
3634 list (config)
3635 "owner_include.source_parameters"
3637 data source parameters
3639 Format:
3641 /".*"/
3642 Default:
3644 None.
3645 Context:
3647 list (config)
3648 "owner_include.profile"
3650 profile
3652 Format:
3654 "privileged" - privileged owner
3655 "normal" - normal owner
3656 Default:
3657 "normal"
3658 Context:
3660 list (config)
3661 "owner_include.reception"
3663 reception mode
3665 Format:
3667 "mail" - receive notification email
3668 "nomail" - no notifications
3669 Default:
3670 "mail"
3671 Context:
3673 list (config)
3674 "owner_include.visibility"
3676 visibility
3678 Format:
3680 "conceal" - concealed from list menu
3681 "noconceal" - listed on the list menu
3682 Default:
3683 "noconceal"
3684 Context:
3686 list (config)
3687 "editor_include"
3689 (Paragraph) Moderators defined in an external data source
3691 Multiple occurrences allowed
3693 "editor_include.source"
3695 the data source
3697 Format:
3699 /"[\w-]+"/
3700 Default:
3702 None, mandatory.
3703 Context:
3705 list (config)
3706 "editor_include.source_parameters"
3708 data source parameters
3710 Format:
3712 /".*"/
3713 Default:
3715 None.
3716 Context:
3718 list (config)
3719 "editor_include.reception"
3721 reception mode
3723 Format:
3725 "mail" - receive notification email
3726 "nomail" - no notifications
3727 Default:
3728 "mail"
3729 Context:
3731 list (config)
3732 "editor_include.visibility"
3734 visibility
3736 Format:
3738 "conceal" - concealed from list menu
3739 "noconceal" - listed on the list menu
3740 Default:
3741 "noconceal"
3742 Context:
3744 list (config)
3745 "sql_fetch_timeout"
3747 Timeout for fetch of include_sql_query
3749 Format:
3751 Number of seconds.
3752 Default:
3754 300 (seconds)
3755 Context:
3757 list (config), site (sympa.conf)
3758 "include_file"
3760 File inclusion
3762 Format:
3764 Multiple occurrences allowed.
3765 /"\S+"/
3767 Default:
3769 None.
3770 Context:
3772 list (config)
3773 Include subscribers from this file. The file should contain one e-mail
3775 address per line (lines beginning with a "#" are ignored).
3776 "include_remote_file"
3778 (Paragraph) Remote file inclusion
3780 Multiple occurrences allowed
3782 "include_remote_file.name"
3784 short name for this source
3786 Format:
3788 /".+"/
3789 Default:
3791 None.
3792 Context:
3794 list (config)
3795 "include_remote_file.url"
3797 data location URL
3799 Format:
3801 /".+"/
3802 Default:
3804 None, mandatory.
3805 Context:
3807 list (config)
3808 "include_remote_file.user"
3810 remote user
3812 Format:
3814 /".+"/
3815 Default:
3817 None.
3818 Context:
3820 list (config)
3821 "include_remote_file.passwd"
3823 remote password
3825 Format:
3827 The value to be concealed.
3828 Default:
3830 None.
3831 Context:
3833 list (config)
3834 "include_remote_file.timeout"
3836 idle timeout
3838 Format:
3840 Number of seconds.
3841 Default:
3843 180 (seconds)
3844 Context:
3846 list (config)
3847 "include_remote_file.ssl_version"
3849 SSL version
3851 Format:
3853 "ssl_any" - any versions
3854 "sslv2" - SSL version 2
3855 "sslv3" - SSL version 3
3856 "tlsv1" - TLS version 1
3857 "tlsv1_1" - TLS version 1.1
3858 "tlsv1_2" - TLS version 1.2
3859 "tlsv1_3" - TLS version 1.3
3860 Default:
3861 "ssl_any"
3862 Context:
3864 list (config)
3865 "include_remote_file.ssl_ciphers"
3867 SSL ciphers used
3869 Format:
3871 /".+"/
3872 Default:
3874 "ALL"
3875 Context:
3877 list (config)
3878 "include_remote_file.ca_verify"
3880 Certificate verification
3882 Format:
3884 "none" - do nothing
3885 "optional" - optional
3886 "required" - required
3887 Default:
3888 "none"
3889 Context:
3891 list (config)
3892 "include_remote_file.nosync_time_ranges"
3894 Time ranges when inclusion is not allowed
3896 Format:
3898 /$time_ranges/
3899 Default:
3901 None.
3902 Context:
3904 list (config)
3905 "include_sympa_list"
3907 (Paragraph) List inclusion
3909 Multiple occurrences allowed
3911 Include subscribers from other list. All subscribers of list listname
3913 become subscribers of the current list. You may include as many lists
3914 as required, using one include_sympa_list paragraph for each included
3915 list. Any list at all may be included; you may therefore include lists
3916 which are also defined by the inclusion of other lists. Be careful,
3917 however, not to include list A in list B and then list B in list A,
3918 since this will give rise to an infinite loop.
3919 "include_sympa_list.name"
3921 short name for this source
3923 Format:
3925 /".+"/
3926 Default:
3928 None.
3929 Context:
3931 list (config)
3932 "include_sympa_list.listname"
3934 list name to include
3936 Format:
3938 /"$listname(\@$host)?"/
3939 Default:
3941 None, mandatory.
3942 Context:
3944 list (config)
3945 "include_sympa_list.filter"
3947 filter definition
3949 Format:
3951 /".*"/
3952 Default:
3954 None.
3955 Context:
3957 list (config)
3958 "include_sympa_list.nosync_time_ranges"
3960 Time ranges when inclusion is not allowed
3962 Format:
3964 /$time_ranges/
3965 Default:
3967 None.
3968 Context:
3970 list (config)
3971 "include_remote_sympa_list"
3973 (Paragraph) remote list inclusion
3975 Multiple occurrences allowed
3977 Sympa can contact another Sympa service using HTTPS to fetch a remote
3979 list in order to include each member of a remote list as subscriber.
3980 You may include as many lists as required, using one
3981 include_remote_sympa_list paragraph for each included list. Be careful,
3982 however, not to give rise to an infinite loop resulting from cross
3983 includes.
3984 For this operation, one Sympa site acts as a server while the other one
3986 acs as client. On the server side, the only setting needed is to give
3987 permission to the remote Sympa to review the list. This is controlled
3988 by the review scenario.
3989 "include_remote_sympa_list.name"
3991 short name for this source
3993 Format:
3995 /".+"/
3996 Default:
3998 None.
3999 Context:
4001 list (config)
4002 "include_remote_sympa_list.url"
4004 data location URL
4006 Format:
4008 /".+"/
4009 Default:
4011 None.
4012 Context:
4014 list (config)
4015 "include_remote_sympa_list.user"
4017 remote user
4019 Format:
4021 /".+"/
4022 Default:
4024 None.
4025 Context:
4027 list (config)
4028 "include_remote_sympa_list.passwd"
4030 remote password
4032 Format:
4034 The value to be concealed.
4035 Default:
4037 None.
4038 Context:
4040 list (config)
4041 "include_remote_sympa_list.host"
4043 remote host
4045 Format:
4047 /$host/
4048 Default:
4050 None, mandatory.
4051 Context:
4053 list (config)
4054 obsoleted. Use "data location URL".
4056 "include_remote_sympa_list.port"
4058 remote port
4060 Format:
4062 /"\d+"/
4063 Default:
4065 443
4066 Context:
4068 list (config)
4069 obsoleted. Use "data location URL".
4071 "include_remote_sympa_list.path"
4073 remote path of sympa list dump
4075 Format:
4077 /"\S+"/
4078 Default:
4080 None, mandatory.
4081 Context:
4083 list (config)
4084 obsoleted. Use "data location URL".
4086 "include_remote_sympa_list.cert"
4088 Deprecated.
4090 "include_remote_sympa_list.timeout"
4092 idle timeout
4094 Format:
4096 Number of seconds.
4097 Default:
4099 180 (seconds)
4100 Context:
4102 list (config)
4103 "include_remote_sympa_list.ssl_version"
4105 SSL version
4107 Format:
4109 "ssl_any" - any versions
4110 "sslv2" - SSL version 2
4111 "sslv3" - SSL version 3
4112 "tlsv1" - TLS version 1
4113 "tlsv1_1" - TLS version 1.1
4114 "tlsv1_2" - TLS version 1.2
4115 "tlsv1_3" - TLS version 1.3
4116 Default:
4117 "ssl_any"
4118 Context:
4120 list (config)
4121 "include_remote_sympa_list.ssl_ciphers"
4123 SSL ciphers used
4125 Format:
4127 /".+"/
4128 Default:
4130 "ALL"
4131 Context:
4133 list (config)
4134 "include_remote_sympa_list.ca_verify"
4136 Certificate verification
4138 Format:
4140 "none" - do nothing
4141 "optional" - optional
4142 "required" - required
4143 Default:
4144 "optional"
4145 Context:
4147 list (config)
4148 "include_remote_sympa_list.nosync_time_ranges"
4150 Time ranges when inclusion is not allowed
4152 Format:
4154 /$time_ranges/
4155 Default:
4157 None.
4158 Context:
4160 list (config)
4161 "include_ldap_query"
4163 (Paragraph) LDAP query inclusion
4165 Multiple occurrences allowed
4167 This paragraph defines parameters for a query returning a list of
4169 subscribers. This feature requires the Net::LDAP (perlldap) PERL
4170 module.
4171 "include_ldap_query.name"
4173 short name for this source
4175 Format:
4177 /".+"/
4178 Default:
4180 None.
4181 Context:
4183 list (config)
4184 "include_ldap_query.host"
4186 remote host
4188 Format:
4190 /$multiple_host_or_url/
4191 Default:
4193 None, mandatory.
4194 Context:
4196 list (config)
4197 "include_ldap_query.port"
4199 Deprecated.
4201 "include_ldap_query.use_tls"
4203 use TLS (formerly SSL)
4205 Format:
4207 "starttls" - use STARTTLS
4208 "ldaps" - use LDAPS (LDAP over TLS)
4209 "none" - do nothing
4210 Default:
4211 "none"
4212 Context:
4214 list (config)
4215 "include_ldap_query.ssl_version"
4217 SSL version
4219 Format:
4221 "sslv2" - SSL version 2
4222 "sslv3" - SSL version 3
4223 "tlsv1" - TLS version 1
4224 "tlsv1_1" - TLS version 1.1
4225 "tlsv1_2" - TLS version 1.2
4226 "tlsv1_3" - TLS version 1.3
4227 Default:
4228 "tlsv1"
4229 Context:
4231 list (config)
4232 "include_ldap_query.ssl_ciphers"
4234 SSL ciphers used
4236 Format:
4238 /".+"/
4239 Default:
4241 "ALL"
4242 Context:
4244 list (config)
4245 "include_ldap_query.ca_verify"
4247 Certificate verification
4249 Format:
4251 "none" - do nothing
4252 "optional" - optional
4253 "required" - required
4254 Default:
4255 "required"
4256 Context:
4258 list (config)
4259 "include_ldap_query.bind_dn"
4261 remote user
4263 Format:
4265 /".+"/
4266 Default:
4268 None.
4269 Context:
4271 list (config)
4272 "include_ldap_query.bind_password"
4274 remote password
4276 Format:
4278 The value to be concealed.
4279 Default:
4281 None.
4282 Context:
4284 list (config)
4285 "include_ldap_query.suffix"
4287 suffix
4289 Format:
4291 /".+"/
4292 Default:
4294 None.
4295 Context:
4297 list (config)
4298 "include_ldap_query.scope"
4300 search scope
4302 Format:
4304 "base" - base
4305 "one" - one level
4306 "sub" - subtree
4307 Default:
4308 "sub"
4309 Context:
4311 list (config)
4312 "include_ldap_query.timeout"
4314 connection timeout
4316 Format:
4318 Number of seconds.
4319 Default:
4321 30 (seconds)
4322 Context:
4324 list (config)
4325 "include_ldap_query.filter"
4327 filter
4329 Format:
4331 /".+"/
4332 Default:
4334 None, mandatory.
4335 Context:
4337 list (config)
4338 "include_ldap_query.attrs"
4340 extracted attribute
4342 Format:
4344 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
4345 Default:
4347 "mail"
4348 Context:
4350 list (config)
4351 "include_ldap_query.select"
4353 selection (if multiple)
4355 Format:
4357 "all" - all
4358 "first" - first entry
4359 "regex" - entries matching regular expression
4360 Default:
4361 "first"
4362 Context:
4364 list (config)
4365 "include_ldap_query.regex"
4367 regular expression
4369 Format:
4371 /".+"/
4372 Default:
4374 ""
4375 Context:
4377 list (config)
4378 "include_ldap_query.nosync_time_ranges"
4380 Time ranges when inclusion is not allowed
4382 Format:
4384 /$time_ranges/
4385 Default:
4387 None.
4388 Context:
4390 list (config)
4391 "include_ldap_query.passwd"
4393 Obsoleted. Use "bind_password".
4395 "include_ldap_query.use_ssl"
4397 Obsoleted. Use "use_tls".
4399 "include_ldap_query.user"
4401 Obsoleted. Use "bind_dn".
4403 "include_ldap_2level_query"
4405 (Paragraph) LDAP 2-level query inclusion
4407 Multiple occurrences allowed
4409 This paragraph defines parameters for a two-level query returning a
4411 list of subscribers. Usually the first-level query returns a list of
4412 DNs and the second-level queries convert the DNs into e-mail addresses.
4413 This feature requires the Net::LDAP (perlldap) PERL module.
4414 "include_ldap_2level_query.name"
4416 short name for this source
4418 Format:
4420 /".+"/
4421 Default:
4423 None.
4424 Context:
4426 list (config)
4427 "include_ldap_2level_query.host"
4429 remote host
4431 Format:
4433 /$multiple_host_or_url/
4434 Default:
4436 None, mandatory.
4437 Context:
4439 list (config)
4440 "include_ldap_2level_query.port"
4442 Deprecated.
4444 "include_ldap_2level_query.use_tls"
4446 use TLS (formerly SSL)
4448 Format:
4450 "starttls" - use STARTTLS
4451 "ldaps" - use LDAPS (LDAP over TLS)
4452 "none" - do nothing
4453 Default:
4454 "none"
4455 Context:
4457 list (config)
4458 "include_ldap_2level_query.ssl_version"
4460 SSL version
4462 Format:
4464 "sslv2" - SSL version 2
4465 "sslv3" - SSL version 3
4466 "tlsv1" - TLS version 1
4467 "tlsv1_1" - TLS version 1.1
4468 "tlsv1_2" - TLS version 1.2
4469 "tlsv1_3" - TLS version 1.3
4470 Default:
4471 "tlsv1"
4472 Context:
4474 list (config)
4475 "include_ldap_2level_query.ssl_ciphers"
4477 SSL ciphers used
4479 Format:
4481 /".+"/
4482 Default:
4484 "ALL"
4485 Context:
4487 list (config)
4488 "include_ldap_2level_query.ca_verify"
4490 Certificate verification
4492 Format:
4494 "none" - do nothing
4495 "optional" - optional
4496 "required" - required
4497 Default:
4498 "required"
4499 Context:
4501 list (config)
4502 "include_ldap_2level_query.bind_dn"
4504 remote user
4506 Format:
4508 /".+"/
4509 Default:
4511 None.
4512 Context:
4514 list (config)
4515 "include_ldap_2level_query.bind_password"
4517 remote password
4519 Format:
4521 The value to be concealed.
4522 Default:
4524 None.
4525 Context:
4527 list (config)
4528 "include_ldap_2level_query.suffix1"
4530 first-level suffix
4532 Format:
4534 /".+"/
4535 Default:
4537 None.
4538 Context:
4540 list (config)
4541 "include_ldap_2level_query.scope1"
4543 first-level search scope
4545 Format:
4547 "base" - base
4548 "one" - one level
4549 "sub" - subtree
4550 Default:
4551 "sub"
4552 Context:
4554 list (config)
4555 "include_ldap_2level_query.timeout1"
4557 first-level connection timeout
4559 Format:
4561 Number of seconds.
4562 Default:
4564 30 (seconds)
4565 Context:
4567 list (config)
4568 "include_ldap_2level_query.filter1"
4570 first-level filter
4572 Format:
4574 /".+"/
4575 Default:
4577 None, mandatory.
4578 Context:
4580 list (config)
4581 "include_ldap_2level_query.attrs1"
4583 first-level extracted attribute
4585 Format:
4587 /$ldap_attrdesc/
4588 Default:
4590 None.
4591 Context:
4593 list (config)
4594 "include_ldap_2level_query.select1"
4596 first-level selection
4598 Format:
4600 "all" - all
4601 "first" - first entry
4602 "regex" - entries matching regular expression
4603 Default:
4604 "first"
4605 Context:
4607 list (config)
4608 "include_ldap_2level_query.regex1"
4610 first-level regular expression
4612 Format:
4614 /".+"/
4615 Default:
4617 ""
4618 Context:
4620 list (config)
4621 "include_ldap_2level_query.suffix2"
4623 second-level suffix template
4625 Format:
4627 /".+"/
4628 Default:
4630 None.
4631 Context:
4633 list (config)
4634 "include_ldap_2level_query.scope2"
4636 second-level search scope
4638 Format:
4640 "base" - base
4641 "one" - one level
4642 "sub" - subtree
4643 Default:
4644 "sub"
4645 Context:
4647 list (config)
4648 "include_ldap_2level_query.timeout2"
4650 second-level connection timeout
4652 Format:
4654 Number of seconds.
4655 Default:
4657 30 (seconds)
4658 Context:
4660 list (config)
4661 "include_ldap_2level_query.filter2"
4663 second-level filter template
4665 Format:
4667 /".+"/
4668 Default:
4670 None, mandatory.
4671 Context:
4673 list (config)
4674 "include_ldap_2level_query.attrs2"
4676 second-level extracted attribute
4678 Format:
4680 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
4681 Default:
4683 "mail"
4684 Context:
4686 list (config)
4687 "include_ldap_2level_query.select2"
4689 second-level selection
4691 Format:
4693 "all" - all
4694 "first" - first entry
4695 "regex" - entries matching regular expression
4696 Default:
4697 "first"
4698 Context:
4700 list (config)
4701 "include_ldap_2level_query.regex2"
4703 second-level regular expression
4705 Format:
4707 /".+"/
4708 Default:
4710 ""
4711 Context:
4713 list (config)
4714 "include_ldap_2level_query.nosync_time_ranges"
4716 Time ranges when inclusion is not allowed
4718 Format:
4720 /$time_ranges/
4721 Default:
4723 None.
4724 Context:
4726 list (config)
4727 "include_ldap_2level_query.passwd"
4729 Obsoleted. Use "bind_password".
4731 "include_ldap_2level_query.use_ssl"
4733 Obsoleted. Use "use_tls".
4735 "include_ldap_2level_query.user"
4737 Obsoleted. Use "bind_dn".
4739 "include_sql_query"
4741 (Paragraph) SQL query inclusion
4743 Multiple occurrences allowed
4745 This parameter is used to define the SQL query parameters.
4747 "include_sql_query.name"
4749 short name for this source
4751 Format:
4753 /".+"/
4754 Default:
4756 None.
4757 Context:
4759 list (config)
4760 "include_sql_query.db_type"
4762 database type
4764 Format:
4766 /"\S+"/
4767 Default:
4769 None, mandatory.
4770 Context:
4772 list (config)
4773 "include_sql_query.db_host"
4775 remote host
4777 Format:
4779 /$host/
4780 Default:
4782 None.
4783 Context:
4785 list (config)
4786 "include_sql_query.db_port"
4788 database port
4790 Format:
4792 /"\d+"/
4793 Default:
4795 None.
4796 Context:
4798 list (config)
4799 "include_sql_query.db_name"
4801 database name
4803 Format:
4805 /"\S+"/
4806 Default:
4808 None, mandatory.
4809 Context:
4811 list (config)
4812 "include_sql_query.db_options"
4814 connection options
4816 Format:
4818 /".+"/
4819 Default:
4821 None.
4822 Context:
4824 list (config)
4825 "include_sql_query.db_env"
4827 environment variables for database connection
4829 Format:
4831 /"\w+\=\S+(;\w+\=\S+)*"/
4832 Default:
4834 None.
4835 Context:
4837 list (config)
4838 "include_sql_query.db_user"
4840 remote user
4842 Format:
4844 /"\S+"/
4845 Default:
4847 None, mandatory.
4848 Context:
4850 list (config)
4851 "include_sql_query.db_passwd"
4853 remote password
4855 Format:
4857 The value to be concealed.
4858 Default:
4860 None.
4861 Context:
4863 list (config)
4864 "include_sql_query.sql_query"
4866 SQL query
4868 Format:
4870 /$sql_query/
4871 Default:
4873 None, mandatory.
4874 Context:
4876 list (config)
4877 "include_sql_query.f_dir"
4879 Directory where the database is stored (used for DBD::CSV only)
4881 Format:
4883 /".+"/
4884 Default:
4886 None.
4887 Context:
4889 list (config)
4890 "include_sql_query.nosync_time_ranges"
4892 Time ranges when inclusion is not allowed
4894 Format:
4896 /$time_ranges/
4897 Default:
4899 None.
4900 Context:
4902 list (config)
4903 "include_sql_query.connect_options"
4905 Obsoleted. Use "db_options".
4907 "include_sql_query.host"
4909 Obsoleted. Use "db_host".
4911 "include_sql_query.passwd"
4913 Obsoleted. Use "db_passwd".
4915 "include_sql_query.user"
4917 Obsoleted. Use "db_user".
4919 "ttl"
4921 Inclusions timeout
4923 Format:
4925 Number of seconds.
4926 Default:
4928 3600 (seconds)
4929 Context:
4931 list (config), site (sympa.conf)
4932 Sympa caches user data extracted using the include parameter. Their TTL
4934 (time-to-live) within Sympa can be controlled using this parameter. The
4935 default value is 3600
4936 "distribution_ttl"
4938 Inclusions timeout for message distribution
4940 Format:
4942 Number of seconds.
4943 Default:
4945 None.
4946 Context:
4948 list (config), site (sympa.conf)
4949 This parameter defines the delay since the last synchronization after
4951 which the user's list will be updated before performing either of
4952 following actions:
4953 * Reviewing list members
4955 * Message distribution
4957 "include_ldap_ca"
4959 (Paragraph) LDAP query custom attribute
4961 Multiple occurrences allowed
4963 "include_ldap_ca.name"
4965 short name for this source
4967 Format:
4969 /".+"/
4970 Default:
4972 None.
4973 Context:
4975 list (config)
4976 "include_ldap_ca.host"
4978 remote host
4980 Format:
4982 /$multiple_host_or_url/
4983 Default:
4985 None, mandatory.
4986 Context:
4988 list (config)
4989 "include_ldap_ca.port"
4991 Deprecated.
4993 "include_ldap_ca.use_tls"
4995 use TLS (formerly SSL)
4997 Format:
4999 "starttls" - use STARTTLS
5000 "ldaps" - use LDAPS (LDAP over TLS)
5001 "none" - do nothing
5002 Default:
5003 "none"
5004 Context:
5006 list (config)
5007 "include_ldap_ca.ssl_version"
5009 SSL version
5011 Format:
5013 "sslv2" - SSL version 2
5014 "sslv3" - SSL version 3
5015 "tlsv1" - TLS version 1
5016 "tlsv1_1" - TLS version 1.1
5017 "tlsv1_2" - TLS version 1.2
5018 "tlsv1_3" - TLS version 1.3
5019 Default:
5020 "tlsv1"
5021 Context:
5023 list (config)
5024 "include_ldap_ca.ssl_ciphers"
5026 SSL ciphers used
5028 Format:
5030 /".+"/
5031 Default:
5033 "ALL"
5034 Context:
5036 list (config)
5037 "include_ldap_ca.ca_verify"
5039 Certificate verification
5041 Format:
5043 "none" - do nothing
5044 "optional" - optional
5045 "required" - required
5046 Default:
5047 "required"
5048 Context:
5050 list (config)
5051 "include_ldap_ca.bind_dn"
5053 remote user
5055 Format:
5057 /".+"/
5058 Default:
5060 None.
5061 Context:
5063 list (config)
5064 "include_ldap_ca.bind_password"
5066 remote password
5068 Format:
5070 The value to be concealed.
5071 Default:
5073 None.
5074 Context:
5076 list (config)
5077 "include_ldap_ca.suffix"
5079 suffix
5081 Format:
5083 /".+"/
5084 Default:
5086 None.
5087 Context:
5089 list (config)
5090 "include_ldap_ca.scope"
5092 search scope
5094 Format:
5096 "base" - base
5097 "one" - one level
5098 "sub" - subtree
5099 Default:
5100 "sub"
5101 Context:
5103 list (config)
5104 "include_ldap_ca.timeout"
5106 connection timeout
5108 Format:
5110 Number of seconds.
5111 Default:
5113 30 (seconds)
5114 Context:
5116 list (config)
5117 "include_ldap_ca.filter"
5119 filter
5121 Format:
5123 /".+"/
5124 Default:
5126 None, mandatory.
5127 Context:
5129 list (config)
5130 "include_ldap_ca.attrs"
5132 extracted attribute
5134 Format:
5136 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
5137 Default:
5139 "mail"
5140 Context:
5142 list (config)
5143 "include_ldap_ca.email_entry"
5145 Name of email entry
5147 Format:
5149 /"\S+"/
5150 Default:
5152 None, mandatory.
5153 Context:
5155 list (config)
5156 "include_ldap_ca.select"
5158 selection (if multiple)
5160 Format:
5162 "all" - all
5163 "first" - first entry
5164 "regex" - entries matching regular expression
5165 Default:
5166 "first"
5167 Context:
5169 list (config)
5170 "include_ldap_ca.regex"
5172 regular expression
5174 Format:
5176 /".+"/
5177 Default:
5179 ""
5180 Context:
5182 list (config)
5183 "include_ldap_ca.nosync_time_ranges"
5185 Time ranges when inclusion is not allowed
5187 Format:
5189 /$time_ranges/
5190 Default:
5192 None.
5193 Context:
5195 list (config)
5196 "include_ldap_ca.passwd"
5198 Obsoleted. Use "bind_password".
5200 "include_ldap_ca.use_ssl"
5202 Obsoleted. Use "use_tls".
5204 "include_ldap_ca.user"
5206 Obsoleted. Use "bind_dn".
5208 "include_ldap_2level_ca"
5210 (Paragraph) LDAP 2-level query custom attribute
5212 Multiple occurrences allowed
5214 "include_ldap_2level_ca.name"
5216 short name for this source
5218 Format:
5220 /".+"/
5221 Default:
5223 None.
5224 Context:
5226 list (config)
5227 "include_ldap_2level_ca.host"
5229 remote host
5231 Format:
5233 /$multiple_host_or_url/
5234 Default:
5236 None, mandatory.
5237 Context:
5239 list (config)
5240 "include_ldap_2level_ca.port"
5242 Deprecated.
5244 "include_ldap_2level_ca.use_tls"
5246 use TLS (formerly SSL)
5248 Format:
5250 "starttls" - use STARTTLS
5251 "ldaps" - use LDAPS (LDAP over TLS)
5252 "none" - do nothing
5253 Default:
5254 "none"
5255 Context:
5257 list (config)
5258 "include_ldap_2level_ca.ssl_version"
5260 SSL version
5262 Format:
5264 "sslv2" - SSL version 2
5265 "sslv3" - SSL version 3
5266 "tlsv1" - TLS version 1
5267 "tlsv1_1" - TLS version 1.1
5268 "tlsv1_2" - TLS version 1.2
5269 "tlsv1_3" - TLS version 1.3
5270 Default:
5271 "tlsv1"
5272 Context:
5274 list (config)
5275 "include_ldap_2level_ca.ssl_ciphers"
5277 SSL ciphers used
5279 Format:
5281 /".+"/
5282 Default:
5284 "ALL"
5285 Context:
5287 list (config)
5288 "include_ldap_2level_ca.ca_verify"
5290 Certificate verification
5292 Format:
5294 "none" - do nothing
5295 "optional" - optional
5296 "required" - required
5297 Default:
5298 "required"
5299 Context:
5301 list (config)
5302 "include_ldap_2level_ca.bind_dn"
5304 remote user
5306 Format:
5308 /".+"/
5309 Default:
5311 None.
5312 Context:
5314 list (config)
5315 "include_ldap_2level_ca.bind_password"
5317 remote password
5319 Format:
5321 The value to be concealed.
5322 Default:
5324 None.
5325 Context:
5327 list (config)
5328 "include_ldap_2level_ca.suffix1"
5330 first-level suffix
5332 Format:
5334 /".+"/
5335 Default:
5337 None.
5338 Context:
5340 list (config)
5341 "include_ldap_2level_ca.scope1"
5343 first-level search scope
5345 Format:
5347 "base" - base
5348 "one" - one level
5349 "sub" - subtree
5350 Default:
5351 "sub"
5352 Context:
5354 list (config)
5355 "include_ldap_2level_ca.timeout1"
5357 first-level connection timeout
5359 Format:
5361 Number of seconds.
5362 Default:
5364 30 (seconds)
5365 Context:
5367 list (config)
5368 "include_ldap_2level_ca.filter1"
5370 first-level filter
5372 Format:
5374 /".+"/
5375 Default:
5377 None, mandatory.
5378 Context:
5380 list (config)
5381 "include_ldap_2level_ca.attrs1"
5383 first-level extracted attribute
5385 Format:
5387 /$ldap_attrdesc/
5388 Default:
5390 None.
5391 Context:
5393 list (config)
5394 "include_ldap_2level_ca.select1"
5396 first-level selection
5398 Format:
5400 "all" - all
5401 "first" - first entry
5402 "regex" - entries matching regular expression
5403 Default:
5404 "first"
5405 Context:
5407 list (config)
5408 "include_ldap_2level_ca.regex1"
5410 first-level regular expression
5412 Format:
5414 /".+"/
5415 Default:
5417 ""
5418 Context:
5420 list (config)
5421 "include_ldap_2level_ca.suffix2"
5423 second-level suffix template
5425 Format:
5427 /".+"/
5428 Default:
5430 None.
5431 Context:
5433 list (config)
5434 "include_ldap_2level_ca.scope2"
5436 second-level search scope
5438 Format:
5440 "base" - base
5441 "one" - one level
5442 "sub" - subtree
5443 Default:
5444 "sub"
5445 Context:
5447 list (config)
5448 "include_ldap_2level_ca.timeout2"
5450 second-level connection timeout
5452 Format:
5454 Number of seconds.
5455 Default:
5457 30 (seconds)
5458 Context:
5460 list (config)
5461 "include_ldap_2level_ca.filter2"
5463 second-level filter template
5465 Format:
5467 /".+"/
5468 Default:
5470 None, mandatory.
5471 Context:
5473 list (config)
5474 "include_ldap_2level_ca.attrs2"
5476 second-level extracted attribute
5478 Format:
5480 /$ldap_attrdesc/
5481 Default:
5483 "mail"
5484 Context:
5486 list (config)
5487 "include_ldap_2level_ca.select2"
5489 second-level selection
5491 Format:
5493 "all" - all
5494 "first" - first entry
5495 "regex" - entries matching regular expression
5496 Default:
5497 "first"
5498 Context:
5500 list (config)
5501 "include_ldap_2level_ca.regex2"
5503 second-level regular expression
5505 Format:
5507 /".+"/
5508 Default:
5510 ""
5511 Context:
5513 list (config)
5514 "include_ldap_2level_ca.email_entry"
5516 Name of email entry
5518 Format:
5520 /"\S+"/
5521 Default:
5523 None, mandatory.
5524 Context:
5526 list (config)
5527 "include_ldap_2level_ca.nosync_time_ranges"
5529 Time ranges when inclusion is not allowed
5531 Format:
5533 /$time_ranges/
5534 Default:
5536 None.
5537 Context:
5539 list (config)
5540 "include_ldap_2level_ca.passwd"
5542 Obsoleted. Use "bind_password".
5544 "include_ldap_2level_ca.use_ssl"
5546 Obsoleted. Use "use_tls".
5548 "include_ldap_2level_ca.user"
5550 Obsoleted. Use "bind_dn".
5552 "include_sql_ca"
5554 (Paragraph) SQL query custom attribute
5556 Multiple occurrences allowed
5558 "include_sql_ca.name"
5560 short name for this source
5562 Format:
5564 /".+"/
5565 Default:
5567 None.
5568 Context:
5570 list (config)
5571 "include_sql_ca.db_type"
5573 database type
5575 Format:
5577 /"\S+"/
5578 Default:
5580 None, mandatory.
5581 Context:
5583 list (config)
5584 "include_sql_ca.db_host"
5586 remote host
5588 Format:
5590 /$host/
5591 Default:
5593 None.
5594 Context:
5596 list (config)
5597 "include_sql_ca.db_port"
5599 database port
5601 Format:
5603 /"\d+"/
5604 Default:
5606 None.
5607 Context:
5609 list (config)
5610 "include_sql_ca.db_name"
5612 database name
5614 Format:
5616 /"\S+"/
5617 Default:
5619 None, mandatory.
5620 Context:
5622 list (config)
5623 "include_sql_ca.db_options"
5625 connection options
5627 Format:
5629 /".+"/
5630 Default:
5632 None.
5633 Context:
5635 list (config)
5636 "include_sql_ca.db_env"
5638 environment variables for database connection
5640 Format:
5642 /"\w+\=\S+(;\w+\=\S+)*"/
5643 Default:
5645 None.
5646 Context:
5648 list (config)
5649 "include_sql_ca.db_user"
5651 remote user
5653 Format:
5655 /"\S+"/
5656 Default:
5658 None, mandatory.
5659 Context:
5661 list (config)
5662 "include_sql_ca.db_passwd"
5664 remote password
5666 Format:
5668 The value to be concealed.
5669 Default:
5671 None.
5672 Context:
5674 list (config)
5675 "include_sql_ca.sql_query"
5677 SQL query
5679 Format:
5681 /$sql_query/
5682 Default:
5684 None, mandatory.
5685 Context:
5687 list (config)
5688 "include_sql_ca.f_dir"
5690 Directory where the database is stored (used for DBD::CSV only)
5692 Format:
5694 /".+"/
5695 Default:
5697 None.
5698 Context:
5700 list (config)
5701 "include_sql_ca.email_entry"
5703 Name of email entry
5705 Format:
5707 /"\S+"/
5708 Default:
5710 None, mandatory.
5711 Context:
5713 list (config)
5714 "include_sql_ca.nosync_time_ranges"
5716 Time ranges when inclusion is not allowed
5718 Format:
5720 /$time_ranges/
5721 Default:
5723 None.
5724 Context:
5726 list (config)
5727 "include_sql_ca.connect_options"
5729 Obsoleted. Use "db_options".
5731 "include_sql_ca.host"
5733 Obsoleted. Use "db_host".
5735 "include_sql_ca.passwd"
5737 Obsoleted. Use "db_passwd".
5739 "include_sql_ca.user"
5741 Obsoleted. Use "db_user".
5743 DKIM/DMARC/ARC
5745 DKIM signature verification and re-signing. It requires an external
5746 module: Mail-DKIM.
5747 ARC seals on forwarded messages. It requires an external module: Mail-
5749 DKIM.
5750 "dkim_add_signature_to"
5752 Which service messages to be signed
5754 Format:
5756 /"(?:list|robot)(?:,(?:list|robot))*"/
5757 Default:
5759 "robot,list"
5760 Context:
5762 domain (robot.conf), site (sympa.conf)
5763 Inserts a DKIM signature to service messages in context of robot, list
5765 or both
5766 "dkim_signer_identity"
5768 The "i=" tag as defined in rfc 4871
5770 Format:
5772 /"\S+"/
5773 Default:
5775 None.
5776 Context:
5778 domain (robot.conf), site (sympa.conf)
5779 Default is null.
5781 "dkim_feature"
5783 Insert DKIM signature to messages sent to the list
5785 Format:
5787 "on" - enabled
5788 "off" - disabled
5789 Default:
5790 "off"
5791 Context:
5793 domain (robot.conf), site (sympa.conf)
5794 If set to "on", Sympa may verify DKIM signatures of incoming messages
5796 and/or insert DKIM signature to outgoing messages.
5797 "dkim_parameters"
5799 (Paragraph) DKIM configuration
5801 Single occurrence
5803 A set of parameters in order to define outgoing DKIM signature
5805 "dkim_parameters.private_key_path"
5807 File path for DKIM private key
5809 Format:
5811 /"\S+"/
5812 Default:
5814 None.
5815 Context:
5817 list (config), domain (robot.conf), site (sympa.conf)
5818 The file must contain a PEM encoded private key
5820 "dkim_parameters.selector"
5822 Selector for DNS lookup of DKIM public key
5824 Format:
5826 /"\S+"/
5827 Default:
5829 None.
5830 Context:
5832 list (config), domain (robot.conf), site (sympa.conf)
5833 The selector is used in order to build the DNS query for public key. It
5835 is up to you to choose the value you want but verify that you can query
5836 the public DKIM key for "<selector>._domainkey.your_domain"
5837 "dkim_parameters.header_list"
5839 Deprecated.
5841 "dkim_parameters.signer_domain"
5843 DKIM "d=" tag, you should probably use the default value
5845 Format:
5847 /"\S+"/
5848 Default:
5850 None.
5851 Context:
5853 list (config), domain (robot.conf), site (sympa.conf)
5854 The DKIM "d=" tag, is the domain of the signing entity. The list domain
5856 MUST be included in the "d=" domain
5857 "dkim_parameters.signer_identity"
5859 DKIM "i=" tag, you should probably leave this parameter empty
5861 Format:
5863 /"\S+"/
5864 Default:
5866 None.
5867 Context:
5869 list (config)
5870 DKIM "i=" tag, you should probably not use this parameter, as
5872 recommended by RFC 4871, default for list brodcasted messages is
5873 i=<listname>-request@<domain>
5874 "dkim_signature_apply_on"
5876 The categories of messages sent to the list that will be signed using
5878 DKIM.
5879 Format:
5881 Multiple values allowed, separated by ",".
5882 "md5_authenticated_messages" - authenticated by password
5884 "smime_authenticated_messages" - authenticated by S/MIME signature
5885 "dkim_authenticated_messages" - authenticated by DKIM signature
5886 "editor_validated_messages" - approved by moderator
5887 "none" - do nothing
5888 "any" - any messages
5889 Default:
5890 "md5_authenticated_messages,smime_authenticated_messages,dkim_authenticated_messages,editor_validated_messages"
5891 Context:
5893 list (config), domain (robot.conf), site (sympa.conf)
5894 This parameter controls in which case messages must be signed using
5896 DKIM, you may sign every message choosing 'any' or a subset. The
5897 parameter value is a comma separated list of keywords
5898 "arc_feature"
5900 Add ARC seals to messages sent to the list
5902 Format:
5904 "on" - enabled
5905 "off" - disabled
5906 Default:
5907 "off"
5908 Context:
5910 list (config), domain (robot.conf), site (sympa.conf)
5911 Enable/Disable ARC. This feature requires Mail::DKIM::ARC to be
5913 installed, and maybe some custom scenario to be updated
5914 "arc_srvid"
5916 SRV ID for Authentication-Results used in ARC seal
5918 Format:
5920 /"\S+"/
5921 Default:
5923 None.
5924 Context:
5926 domain (robot.conf), site (sympa.conf)
5927 Typically the domain of the mail server
5929 "arc_parameters"
5931 (Paragraph) ARC configuration
5933 Single occurrence
5935 A set of parameters in order to define outgoing ARC seal
5937 "arc_parameters.arc_private_key_path"
5939 File path for ARC private key
5941 Format:
5943 /"\S+"/
5944 Default:
5946 None.
5947 Context:
5949 list (config), domain (robot.conf), site (sympa.conf)
5950 The file must contain a PEM encoded private key. Defaults to same file
5952 as DKIM private key
5953 "arc_parameters.arc_selector"
5955 Selector for DNS lookup of ARC public key
5957 Format:
5959 /"\S+"/
5960 Default:
5962 None.
5963 Context:
5965 list (config), domain (robot.conf), site (sympa.conf)
5966 The selector is used in order to build the DNS query for public key. It
5968 is up to you to choose the value you want but verify that you can query
5969 the public DKIM key for "<selector>._domainkey.your_domain". Default is
5970 the same selector as for DKIM signatures
5971 "arc_parameters.arc_signer_domain"
5973 ARC "d=" tag, you should probably use the default value
5975 Format:
5977 /"\S+"/
5978 Default:
5980 None.
5981 Context:
5983 list (config), domain (robot.conf), site (sympa.conf)
5984 The ARC "d=" tag is the domain of the signing entity. The DKIM d=
5986 domain name is used as its default value
5987 "dmarc_protection"
5989 (Paragraph) DMARC Protection
5991 Single occurrence
5993 Parameters to define how to manage From address processing to avoid
5995 some domains' excessive DMARC protection
5996 "dmarc_protection.mode"
5998 Protection modes
6000 Format:
6002 Multiple values allowed, separated by ",".
6003 "none" - do nothing
6005 "all" - all
6006 "dkim_signature" - DKIM signature exists
6007 "dmarc_reject" - DMARC policy suggests rejection
6008 "dmarc_any" - DMARC policy exists
6009 "dmarc_quarantine" - DMARC policy suggests quarantine
6010 "domain_regex" - domain matching regular expression
6011 Default:
6012 None.
6013 Context:
6015 list (config), domain (robot.conf), site (sympa.conf)
6016 Select one or more operation modes. "Domain matching regular
6018 expression" (domain_regex) matches the specified Domain regular
6019 expression; "DKIM signature exists" (dkim_signature) matches any
6020 message with a DKIM signature header; "DMARC policy ..." (dmarc_*)
6021 matches messages from sender domains with a DMARC policy as given;
6022 "all" (all) matches all messages.
6023 Example:
6025 dmarc_protection.mode dmarc_reject,dkim_signature
6027 "dmarc_protection.domain_regex"
6029 Regular expression for domain name match
6031 Format:
6033 /".+"/
6034 Default:
6036 None.
6037 Context:
6039 list (config), domain (robot.conf), site (sympa.conf)
6040 Regular expression match pattern for From domain
6042 "dmarc_protection.other_email"
6044 New From address
6046 Format:
6048 /".+"/
6049 Default:
6051 None.
6052 Context:
6054 list (config), domain (robot.conf), site (sympa.conf)
6055 This is the email address to use when modifying the From header. It
6057 defaults to the list address. This is similar to Anonymisation but
6058 preserves the original sender details in the From address phrase.
6059 "dmarc_protection.phrase"
6061 New From name format
6063 Format:
6065 "display_name" - "Name"
6066 "name_and_email" - "Name" (e-mail)
6067 "name_via_list" - "Name" (via List)
6068 "name_email_via_list" - "Name" (e-mail via List)
6069 "list_for_email" - "List" (on behalf of e-mail)
6070 "list_for_name" - "List" (on behalf of Name)
6071 Default:
6072 "name_via_list"
6073 Context:
6075 list (config), domain (robot.conf), site (sympa.conf)
6076 This is the format to be used for the sender name part of the new From
6078 header field.
6079 List address verification
6081 Checks if an alias with the same name as the list to be created already
6082 exists on the SMTP server. This feature requires an external module:
6083 Net-SMTP.
6084 "list_check_helo"
6086 SMTP HELO (EHLO) parameter used for address verification
6088 Format:
6090 /"\S+"/
6091 Default:
6093 None.
6094 Context:
6096 domain (robot.conf), site (sympa.conf)
6097 Default value is the host part of "list_check_smtp" parameter.
6099 "list_check_smtp"
6101 SMTP server to verify existence of the same addresses as the list to be
6103 created
6104 Format:
6106 /$hostport/
6107 Default:
6109 None.
6110 Context:
6112 domain (robot.conf), site (sympa.conf)
6113 This is needed if you are running Sympa on a host but you handle all
6115 your mail on a separate mail relay.
6116 Default value is real FQDN of the host. Port number may be specified as
6118 "mail.example.org:25" or "203.0.113.1:25". If port is not specified,
6119 standard port (25) will be used.
6120 "list_check_suffixes"
6122 Address suffixes to verify
6124 Format:
6126 /"\S+"/
6127 Default:
6129 "request,owner,editor,unsubscribe,subscribe"
6130 Context:
6132 domain (robot.conf), site (sympa.conf)
6133 List of suffixes you are using for list addresses, i.e. "mylist-
6135 request", "mylist-owner" and so on.
6136 This parameter is used with the "list_check_smtp" parameter. It is also
6138 used to check list names at list creation time.
6139 Antivirus plug-in
6141 "antivirus_path"
6142 Path to the antivirus scanner engine
6144 Format:
6146 /".+"/
6147 Default:
6149 None.
6150 Context:
6152 domain (robot.conf), site (sympa.conf)
6153 Supported antivirus: Clam AntiVirus/clamscan & clamdscan,
6155 McAfee/uvscan, Fsecure/fsav, Sophos, AVP and Trend Micro/VirusWall
6156 Example:
6158 antivirus_path /usr/local/bin/clamscan
6160 "antivirus_args"
6162 Antivirus plugin command line arguments
6164 Format:
6166 /".+"/
6167 Default:
6169 None.
6170 Context:
6172 domain (robot.conf), site (sympa.conf)
6173 Example:
6175 antivirus_args --no-summary --database /usr/local/share/clamav
6177 "antivirus_notify"
6179 Notify sender if virus checker detects malicious content
6181 Format:
6183 "sender" - sender
6184 "delivery_status" - send back DSN
6185 "none" - do nothing
6186 Default:
6187 "sender"
6188 Context:
6190 domain (robot.conf), site (sympa.conf)
6191 "sender" to notify originator of the message, "delivery_status" to send
6193 delivery status, or "none"
6194 Miscellaneous
6196 "email"
6197 Local part of Sympa email address
6199 Format:
6201 /"\S+"/
6202 Default:
6204 "sympa"
6205 Context:
6207 domain (robot.conf), site (sympa.conf)
6208 Local part (the part preceding the "@" sign) of the address by which
6210 mail interface of Sympa accepts mail commands.
6211 If you change the default value, you must modify the mail aliases too.
6213 "listmaster_email"
6215 Local part of listmaster email address
6217 Format:
6219 /"\S+"/
6220 Default:
6222 "listmaster"
6223 Context:
6225 domain (robot.conf), site (sympa.conf)
6226 Local part (the part preceding the "@" sign) of the address by which
6228 listmasters receive messages.
6229 If you change the default value, you must modify the mail aliases too.
6231 "custom_robot_parameter"
6233 Custom robot parameter
6235 Format:
6237 Multiple occurrences allowed.
6238 /".+"/
6240 Default:
6242 None.
6243 Context:
6245 domain (robot.conf), site (sympa.conf)
6246 Used to define a custom parameter for your server. Do not forget the
6248 semicolon between the parameter name and the parameter value.
6249 You will be able to access the custom parameter value in web templates
6251 by variable "conf.custom_robot_parameter.<param_name>"
6252 Example:
6254 custom_robot_parameter param_name ; param_value
6256 "prohibited_listnames"
6258 Prevent people to use some names for their lists names
6260 Format:
6262 Default:
6263 None.
6264 Context:
6266 site (sympa.conf)
6267 This parameter is a comma-separated list of names. You can use * as a
6269 wildcard character. To use a regex for this, please use
6270 prohibited_listnames_regex setting.
6271 Example:
6273 prohibited_listnames www,root,*master
6275 "prohibited_listnames_regex"
6277 Prevent people to use some names for their lists names, based on a
6279 regex
6280 Format:
6282 Default:
6283 None.
6284 Context:
6286 site (sympa.conf)
6287 This parameter is a regex. Please note that prohibited_listnames and
6289 prohibited_listnames_regex will both be applied if set, they are not
6290 exclusive.
6291 Example:
6293 prohibited_listnames_regex www|root|.*master
6295 "cache_list_config"
6297 Use of binary cache of list configuration
6299 Format:
6301 "binary_file" - use binary file
6302 "none" - do nothing
6303 Default:
6304 "none"
6305 Context:
6307 site (sympa.conf)
6308 binary_file: Sympa processes will maintain a binary version of the list
6310 configuration, "config.bin" file on local disk. If you manage a big
6311 amount of lists (1000+), it should make the web interface startup
6312 faster.
6313 You can recreate cache by running "sympa.pl --reload_list_config".
6315 "db_list_cache"
6317 Use database cache to search lists
6319 Format:
6321 "on" - enabled
6322 "off" - disabled
6323 Default:
6324 "off"
6325 Context:
6327 site (sympa.conf)
6328 Note that "list_table" database table should be filled at the first
6330 time by running:
6331 # sympa.pl --sync_list_db
6333 "purge_user_table_task"
6335 Task for expiring inactive users
6337 Format:
6339 /"\w+"/
6340 Default:
6342 "monthly"
6343 Context:
6345 site (sympa.conf)
6346 This task removes rows in the "user_table" table which have not
6348 corresponding entries in the "subscriber_table" table.
6349 "purge_logs_table_task"
6351 Task for cleaning tables
6353 Format:
6355 /"\w+"/
6356 Default:
6358 "daily"
6359 Context:
6361 site (sympa.conf)
6362 This task cleans old logs from "logs_table" table.
6364 "logs_expiration_period"
6366 Max age of logs in database
6368 Format:
6370 Number of months.
6371 Default:
6373 3 (months)
6374 Context:
6376 site (sympa.conf)
6377 Number of months that elapse before a log is expired
6379 "stats_expiration_period"
6381 Max age of statistics information in database
6383 Format:
6385 Number of months.
6386 Default:
6388 3 (months)
6389 Context:
6391 site (sympa.conf)
6392 Number of months that elapse before statistics information are expired
6394 "umask"
6396 Umask
6398 Format:
6400 /"[0-7]+"/
6401 Default:
6403 027
6404 Context:
6406 site (sympa.conf)
6407 Default mask for file creation (see umask(2)). Note that it will be
6409 interpreted as an octal value.
6410 "clean_delay_queuemod"
6412 Max age of moderated messages
6414 Format:
6416 Number of days.
6417 Default:
6419 30 (days)
6420 Context:
6422 list (config), site (sympa.conf)
6423 Number of days messages are kept in moderation spool (as specified by
6425 "queuemod" parameter). Beyond this deadline, messages that have not
6426 been processed are deleted.
6427 "custom_attribute"
6429 (Paragraph) Custom user attributes
6431 Multiple occurrences allowed
6433 "custom_attribute.id"
6435 internal identifier
6437 Format:
6439 /"\w+"/
6440 Default:
6442 None, mandatory.
6443 Context:
6445 list (config)
6446 "custom_attribute.name"
6448 label
6450 Format:
6452 /".+"/
6453 Default:
6455 None, mandatory.
6456 Context:
6458 list (config)
6459 "custom_attribute.comment"
6461 additional comment
6463 Format:
6465 /".+"/
6466 Default:
6468 None.
6469 Context:
6471 list (config)
6472 "custom_attribute.type"
6474 type
6476 Format:
6478 "string" - string
6479 "text" - multi-line text
6480 "integer" - number
6481 "enum" - set of keywords
6482 Default:
6483 "string"
6484 Context:
6486 list (config)
6487 "custom_attribute.enum_values"
6489 possible attribute values (if enum is used)
6491 Format:
6493 /".+"/
6494 Default:
6496 None.
6497 Context:
6499 list (config)
6500 "custom_attribute.optional"
6502 is the attribute optional?
6504 Format:
6506 "required" - required
6507 "optional" - optional
6508 Default:
6509 "optional"
6510 Context:
6512 list (config)
6513 "custom_vars"
6515 (Paragraph) custom parameters
6517 Multiple occurrences allowed
6519 "custom_vars.name"
6521 var name
6523 Format:
6525 /"\S+"/
6526 Default:
6528 None, mandatory.
6529 Context:
6531 list (config)
6532 "custom_vars.value"
6534 var value
6536 Format:
6538 /".+"/
6539 Default:
6541 None, mandatory.
6542 Context:
6544 list (config)
6545 "loop_prevention_regex"
6547 Regular expression applied to prevent loops with robots
6549 Format:
6551 /"\S*"/
6552 Default:
6554 "mailer-daemon|sympa|listserv|majordomo|smartlist|mailman"
6555 Context:
6557 list (config), domain (robot.conf), site (sympa.conf)
6558 If the sender address matches the regular expression, then the message
6560 is rejected.
6561 "pictures_feature"
6563 Pictures
6565 Format:
6567 "on" - enabled
6568 "off" - disabled
6569 Default:
6570 "on"
6571 Context:
6573 list (config), domain (robot.conf), site (sympa.conf)
6574 Enables or disables the pictures feature by default. If enabled,
6576 subscribers can upload their picture (from the "Subscriber option"
6577 page) to use as an avatar.
6578 Pictures are stored in a directory specified by the
6580 "static_content_path" parameter.
6581 "remind_task"
6583 Periodical subscription reminder task
6585 Format:
6587 /"\w+"/
6588 Default:
6590 None.
6591 Context:
6593 list (config), site (sympa.conf)
6594 This parameter states which model is used to create a remind task. A
6596 remind task regularly sends subscribers a message which reminds them
6597 of their list subscriptions.
6598 "latest_instantiation"
6600 (Paragraph) Latest family instantiation
6602 Single occurrence
6604 "latest_instantiation.email"
6606 who ran the instantiation
6608 Format:
6610 /"listmaster|$email"/
6611 Default:
6613 None.
6614 Context:
6616 list (config)
6617 "latest_instantiation.date_epoch"
6619 date
6621 Format:
6623 The time in second from Unix epoch.
6624 Default:
6626 None, mandatory.
6627 Context:
6629 list (config)
6630 "latest_instantiation.date"
6632 Deprecated.
6634 "creation"
6636 (Paragraph) Creation of the list
6638 Single occurrence
6640 "creation.email"
6642 who created the list
6644 Format:
6646 /"listmaster|$email"/
6647 Default:
6649 None, mandatory.
6650 Context:
6652 list (config)
6653 "creation.date_epoch"
6655 date
6657 Format:
6659 The time in second from Unix epoch.
6660 Default:
6662 None, mandatory.
6663 Context:
6665 list (config)
6666 "creation.date"
6668 Deprecated.
6670 "update"
6672 (Paragraph) Last update of config
6674 Single occurrence
6676 "update.email"
6678 who updated the config
6680 Format:
6682 /"(listmaster|automatic|$email)"/
6683 Default:
6685 None.
6686 Context:
6688 list (config)
6689 "update.date_epoch"
6691 date
6693 Format:
6695 The time in second from Unix epoch.
6696 Default:
6698 None, mandatory.
6699 Context:
6701 list (config)
6702 "update.date"
6704 Deprecated.
6706 "status"
6708 Status of the list
6710 Format:
6712 Status of list.
6713 Default:
6715 "open"
6716 Context:
6718 list (config)
6719 "serial"
6721 Serial number of the config
6723 Format:
6725 /"\d+"/
6726 Default:
6728 0
6729 Context:
6731 list (config)
6732 Web interface parameters
6734 "wwsympa_url"
6735 URL prefix of web interface
6737 Format:
6739 Default:
6740 None.
6741 Context:
6743 domain (robot.conf), site (sympa.conf)
6744 This is used to construct URLs of web interface. The protocol (either
6746 https:// or http://) is required.
6747 Example:
6749 wwsympa_url https://web.example.org/sympa
6751 "wwsympa_url_local"
6753 URL prefix of WWSympa behind proxy
6755 Format:
6757 Default:
6758 None.
6759 Context:
6761 domain (robot.conf), site (sympa.conf)
6762 "static_content_url"
6764 URL for static contents
6766 Format:
6768 Default:
6769 "/static-sympa"
6770 Context:
6772 domain (robot.conf), site (sympa.conf)
6773 HTTP server have to map it with "static_content_path" directory.
6775 "static_content_path"
6777 Directory for static contents
6779 Format:
6781 Default:
6782 $STATICDIR
6783 Context:
6785 domain (robot.conf), site (sympa.conf)
6786 "css_path"
6788 Directory for static style sheets (CSS)
6790 Format:
6792 Default:
6793 $CSSDIR
6794 Context:
6796 site (sympa.conf)
6797 After an upgrade, static CSS files are upgraded with the newly
6799 installed "css.tt2" template. Therefore, this is not a good place to
6800 store customized CSS files.
6801 "css_url"
6803 URL for style sheets (CSS)
6805 Format:
6807 Default:
6808 "/static-sympa/css"
6809 Context:
6811 site (sympa.conf)
6812 To use auto-generated static CSS, HTTP server have to map it with
6814 "css_path".
6815 "pictures_path"
6817 Directory for subscribers pictures
6819 Format:
6821 Default:
6822 $PICTURESDIR
6823 Context:
6825 site (sympa.conf)
6826 "pictures_url"
6828 URL for subscribers pictures
6830 Format:
6832 Default:
6833 "/static-sympa/pictures"
6834 Context:
6836 site (sympa.conf)
6837 HTTP server have to map it with "pictures_path" directory.
6839 "mhonarc"
6841 Path to MHonArc mail-to-HTML converter
6843 Format:
6845 Default:
6846 "/usr/bin/mhonarc"
6847 Context:
6849 domain (robot.conf), site (sympa.conf)
6850 This is required for HTML mail archiving.
6852 "log_facility"
6854 System log facility for web interface
6856 Format:
6858 Default:
6859 "LOCAL1"
6860 Context:
6862 site (sympa.conf)
6863 System log facility for WWSympa, archived.pl and bounced.pl. Default is
6865 to use value of "syslog" parameter.
6866 Web interface parameters: Appearances
6868 "logo_html_definition"
6869 Custom logo
6871 Format:
6873 Default:
6874 None.
6875 Context:
6877 domain (robot.conf), site (sympa.conf)
6878 HTML fragment to insert a logo in the page of web interface.
6880 Example:
6882 logo_html_definition <a href="http://www.example.com"><img style="float: left; margin-top: 7px; margin-left: 37px;" src="http://www.example.com/logos/mylogo.jpg" alt="My Company" /></a>
6884 "favicon_url"
6886 Custom favicon
6888 Format:
6890 Default:
6891 None.
6892 Context:
6894 domain (robot.conf), site (sympa.conf)
6895 URL of favicon image
6897 "color_0", ..., "color_15"
6899 Colors for web interface
6901 Format:
6903 Default:
6904 See description on web interface.
6905 Context:
6907 domain (robot.conf), site (sympa.conf)
6908 Colors are used in style sheet (CSS). They may be changed using web
6910 interface by listmasters.
6911 "dark_color", "light_color", "text_color", "bg_color", "error_color",
6913 "selected_color", "shaded_color"
6914 Colors for web interface, obsoleted
6916 Format:
6918 Default:
6919 See description on web interface.
6920 Context:
6922 domain (robot.conf), site (sympa.conf)
6923 "default_home"
6925 Type of main web page
6927 Format:
6929 Default:
6930 "home"
6931 Context:
6933 domain (robot.conf), site (sympa.conf)
6934 "lists" for the page of list of lists. "home" for home page.
6936 "archive_default_index"
6938 Default index organization of web archive
6940 Format:
6942 Default:
6943 "thrd"
6944 Context:
6946 site (sympa.conf)
6947 thrd: Threaded index.
6949 mail: Chronological index.
6951 "review_page_size"
6953 Size of review page
6955 Format:
6957 Default:
6958 25
6959 Context:
6961 domain (robot.conf), site (sympa.conf)
6962 Default number of lines of the array displaying users in the review
6964 page
6965 "viewlogs_page_size"
6967 Size of viewlogs page
6969 Format:
6971 Default:
6972 25
6973 Context:
6975 domain (robot.conf), site (sympa.conf)
6976 Default number of lines of the array displaying the log entries in the
6978 logs page.
6979 "main_menu_custom_button_1_title", ...
6981 "main_menu_custom_button_3_title", "main_menu_custom_button_1_url", ...
6982 "main_menu_custom_button_3_url", "main_menu_custom_button_1_target",
6983 ... "main_menu_custom_button_3_target"
6984 Custom menus
6986 Format:
6988 Default:
6989 None.
6990 Context:
6992 domain (robot.conf), site (sympa.conf)
6993 You may modify the main menu content by editing the menu.tt2 file, but
6995 you can also edit these parameters in order to add up to 3 buttons.
6996 Each button is defined by a title (the text in the button), an URL and,
6997 optionally, a target.
6998 Example:
7000 main_menu_custom_button_1_title FAQ
7002 main_menu_custom_button_1_url http://www.renater.fr/faq/universalistes/index
7003 main_menu_custom_button_1_target Help
7004 Password validation
7006 Checks if the password the user submitted has sufficient strength. This
7007 feature requires an external module: Data-Password.
7008 "password_validation"
7010 Password validation
7012 Format:
7014 Default:
7015 None.
7016 Context:
7018 site (sympa.conf)
7019 The password validation techniques to be used against user passwords
7021 that are added to mailing lists. Options come from Data::Password
7022 (http://search.cpan.org/~razinf/Data-Password-1.07/Password.pm#VARIABLES)
7023 Example:
7025 password_validation MINLEN=8,GROUPS=3,DICTIONARY=4,DICTIONARIES=/pentest/dictionaries
7027 Authentication with LDAP
7029 Authenticates users based on the directory on LDAP server. This feature
7030 requires an external module: Net-LDAP. And also, if secure connection
7031 (LDAPS) is required: IO-Socket-SSL.
7032 "ldap_force_canonical_email"
7034 Use canonical email address for LDAP authentication
7036 Format:
7038 Default:
7039 1
7040 Context:
7042 domain (robot.conf), site (sympa.conf)
7043 When using LDAP authentication, if the identifier provided by the user
7045 was a valid email, if this parameter is set to false, then the provided
7046 email will be used to authenticate the user. Otherwise, use of the
7047 first email returned by the LDAP server will be used.
7048 SOAP HTTP interface
7050 Provides some functions of Sympa through the SOAP HTTP interface. This
7051 feature requires an external module: SOAP-Lite.
7052 "soap_url"
7054 URL of SympaSOAP
7056 Format:
7058 Default:
7059 None.
7060 Context:
7062 domain (robot.conf), site (sympa.conf)
7063 WSDL document of SympaSOAP refers to this URL in its service section.
7065 Example:
7067 soap_url http://web.example.org/sympasoap
7069 "soap_url_local"
7071 URL of SympaSOAP behind proxy
7073 Format:
7075 Default:
7076 None.
7077 Context:
7079 domain (robot.conf), site (sympa.conf)
7080 Web interface parameters: Miscellaneous
7082 "cookie_domain"
7083 HTTP cookies validity domain
7085 Format:
7087 Default:
7088 "localhost"
7089 Context:
7091 domain (robot.conf), site (sympa.conf)
7092 If beginning with a dot ("."), the cookie is available within the
7094 specified Internet domain. Otherwise, for the specified host. The only
7095 reason for replacing the default value would be where WWSympa's
7096 authentication process is shared with an application running on another
7097 host.
7098 Example:
7100 cookie_domain .renater.fr
7102 "cookie_expire"
7104 HTTP cookies lifetime
7106 Format:
7108 Default:
7109 0
7110 Context:
7112 site (sympa.conf)
7113 This is the default value when not set explicitly by users. "0" means
7115 the cookie may be retained during browser sessions.
7116 "cookie_refresh"
7118 Average interval to refresh HTTP session ID.
7120 Format:
7122 Default:
7123 60
7124 Context:
7126 site (sympa.conf)
7127 "purge_session_table_task"
7129 Task for cleaning old sessions
7131 Format:
7133 /"\w+"/
7134 Default:
7136 "daily"
7137 Context:
7139 site (sympa.conf)
7140 This task removes old entries in the "session_table" table.
7142 "session_table_ttl"
7144 Max age of sessions
7146 Format:
7148 Default:
7149 "2d"
7150 Context:
7152 site (sympa.conf)
7153 Session duration is controlled by "sympa_session" cookie validity
7155 attribute. However, by security reason, this delay also need to be
7156 controlled by server side. This task removes old entries in the
7157 "session_table" table.
7158 Format of values is a string without spaces including "y" for years,
7160 "m" for months, "d" for days, "h" for hours, "min" for minutes and
7161 "sec" for seconds.
7162 "anonymous_session_table_ttl"
7164 Max age of sessions for anonymous users
7166 Format:
7168 Default:
7169 "1h"
7170 Context:
7172 site (sympa.conf)
7173 "shared_feature"
7175 Enable shared repository
7177 Format:
7179 "on" - enabled
7180 "off" - disabled
7181 Default:
7182 "off"
7183 Context:
7185 domain (robot.conf), site (sympa.conf)
7186 If set to "on", list owners can open shared repository.
7188 "use_html_editor"
7190 Use HTML editor
7192 Format:
7194 "off" - disabled
7195 "on" - enabled
7196 Default:
7197 "off"
7198 Context:
7200 domain (robot.conf), site (sympa.conf)
7201 If set to "on", users will be able to post messages in HTML using a
7203 javascript WYSIWYG editor.
7204 Example:
7206 use_html_editor on
7208 "html_editor_url"
7210 URL of HTML editor
7212 Format:
7214 Default:
7215 None.
7216 Context:
7218 domain (robot.conf), site (sympa.conf)
7219 URL path to the javascript file making the WYSIWYG HTML editor
7221 available. Relative path under <static_content_url> or absolute path.
7222 Example is for TinyMCE 4 installed under
7224 <static_content_path>/js/tinymce/.
7225 Example:
7227 html_editor_url js/tinymce/tinymce.min.js
7229 "html_editor_init"
7231 HTML editor initialization
7233 Format:
7235 Default:
7236 None.
7237 Context:
7239 domain (robot.conf), site (sympa.conf)
7240 Javascript excerpt that enables and configures the WYSIWYG HTML editor.
7242 Example:
7244 html_editor_init tinymce.init({selector:"#body",language:lang.split(/[^a-zA-Z]+/).join("_")});
7246 "max_wrong_password"
7248 Count limit of wrong password submission
7250 Format:
7252 Default:
7253 19
7254 Context:
7256 domain (robot.conf), site (sympa.conf)
7257 If this limit is reached, the account is locked until the user renews
7259 their password. The default value is chosen in order to block bots
7260 trying to log in using brute force strategy. This value should never be
7261 reached by real users that will probably uses the renew password
7262 service before they performs so many tries.
7263 "password_case"
7265 Password case
7267 Format:
7269 Default:
7270 "insensitive"
7271 Context:
7273 site (sympa.conf)
7274 "insensitive" or "sensitive".
7276 If set to "insensitive", WWSympa's password check will be insensitive.
7278 This only concerns passwords stored in the Sympa database, not the ones
7279 in LDAP.
7280 Should not be changed! May invalid all user password.
7282 "password_hash"
7284 Password hashing algorithm
7286 Format:
7288 Default:
7289 "md5"
7290 Context:
7292 site (sympa.conf)
7293 "md5" or "bcrypt".
7295 If set to "md5", Sympa will use MD5 password hashes. If set to
7297 "bcrypt", bcrypt hashes will be used instead. This only concerns
7298 passwords stored in the Sympa database, not the ones in LDAP.
7299 Should not be changed! May invalid all user passwords.
7301 "password_hash_update"
7303 Update password hashing algorithm when users log in
7305 Format:
7307 Default:
7308 1
7309 Context:
7311 site (sympa.conf)
7312 On successful login, update the encrypted user password to use the
7314 algorithm specified by "password_hash". This allows for a graceful
7315 transition to a new password hash algorithm. A value of 0 disables
7316 updating of existing password hashes. New and reset passwords will use
7317 the "password_hash" setting in all cases.
7318 "bcrypt_cost"
7320 Bcrypt hash cost
7322 Format:
7324 Default:
7325 12
7326 Context:
7328 site (sympa.conf)
7329 When "password_hash" is set to "bcrypt", this sets the "cost" parameter
7331 of the bcrypt hash function. The default of 12 is expected to require
7332 approximately 250ms to calculate the password hash on a 3.2GHz CPU.
7333 This only concerns passwords stored in the Sympa database, not the ones
7334 in LDAP.
7335 Can be changed but any new cost setting will only apply to new
7337 passwords.
7338 "one_time_ticket_lifetime"
7340 Age of one time ticket
7342 Format:
7344 Default:
7345 "2d"
7346 Context:
7348 site (sympa.conf)
7349 Duration before the one time tickets are expired
7351 "one_time_ticket_lockout"
7353 Restrict access to one time ticket
7355 Format:
7357 Default:
7358 "one_time"
7359 Context:
7361 domain (robot.conf), site (sympa.conf)
7362 Is access to the one time ticket restricted, if any users previously
7364 accessed? (one_time | remote_addr | open)
7365 "purge_one_time_ticket_table_task"
7367 Task for expiring old one time tickets
7369 Format:
7371 /"\w+"/
7372 Default:
7374 "daily"
7375 Context:
7377 site (sympa.conf)
7378 "one_time_ticket_table_ttl"
7380 Expiration period of one time ticket
7382 Format:
7384 Default:
7385 "10d"
7386 Context:
7388 site (sympa.conf)
7389 "pictures_max_size"
7391 The maximum size of uploaded picture
7393 Format:
7395 Number of bytes.
7396 Default:
7398 102400 (bytes)
7399 Context:
7401 domain (robot.conf), site (sympa.conf)
7402 "spam_protection"
7404 Protect web interface against spam harvesters
7406 Format:
7408 "at" - replace @ characters
7409 "javascript" - use JavaScript
7410 "none" - do nothing
7411 Default:
7412 "javascript"
7413 Context:
7415 list (config), domain (robot.conf), site (sympa.conf)
7416 There is a need to protect Sympa web sites against spambots which
7418 collect email addresses from public web sites. Various methods are
7419 available in Sympa and you can choose to use them with the
7420 spam_protection and web_archive_spam_protection parameters. Possible
7421 value are:
7422 javascript:
7424 the address is hidden using a javascript. A user who enables javascript
7426 can see a nice mailto address where others have nothing.
7427 at:
7429 the @ char is replaced by the string " AT ".
7431 none:
7433 no protection against spammer.
7435 "reporting_spam_script_path"
7437 Script to report spam
7439 Format:
7441 Default:
7442 None.
7443 Context:
7445 domain (robot.conf), site (sympa.conf)
7446 If set, when a list moderator report undetected spams for list
7448 moderation, this external script is invoked and the message is injected
7449 into standard input of the script.
7450 "domains_blocklist"
7452 Prevent people to subscribe to a list with adresses using these domains
7454 Format:
7456 Default:
7457 None.
7458 Context:
7460 site (sympa.conf)
7461 This parameter is a comma-separated list.
7463 Example:
7465 domains_blocklist example.org,spammer.com
7467 "quiet_subscription"
7469 Quiet subscriptions policy
7471 Format:
7473 "on" - enabled
7474 "optional" - optional
7475 "off" - disabled
7476 Default:
7477 "optional"
7478 Context:
7480 site (sympa.conf)
7481 Global policy for quiet subscriptions: "on" means that subscriptions
7483 will never send a notice to the subscriber, "off" will enforce a notice
7484 sending, and "optional" (default) allows the use of the list policy.
7485 "show_report_abuse"
7487 Add a "Report abuse" link in the side menu of the lists
7489 Format:
7491 "on" - enabled
7492 "off" - disabled
7493 Default:
7494 "off"
7495 Context:
7497 site (sympa.conf)
7498 The link is a mailto link, you can change that by overriding
7500 web_tt2/report_abuse.tt2
7501 "allow_account_deletion"
7503 EXPERIMENTAL! Allow users to delete their account. If enabled, shows a
7505 "delete my account" form in user's preferences page.
7506 Format:
7508 "on" - enabled
7509 "off" - disabled
7510 Default:
7511 "off"
7512 Context:
7514 site (sympa.conf)
7515 Account deletion unsubscribes the users from his/her lists and removes
7517 him/her from lists ownership. It is only available to users using
7518 internal authentication (i.e. no LDAP, no SSO...). See
7519 https://github.com/sympa-community/sympa/issues/300 for details
7520 Renamed parameters
7522 These parameters were renamed. Though older names are still available,
7523 their use is no longer recommended.
7524 "custom-header"
7526 See "custom_header".
7528 "custom-subject"
7530 See "custom_subject".
7532 "domains_blacklist"
7534 See "domains_blocklist".
7536 "forced_reply-to"
7538 See "forced_reply_to".
7540 "forced_replyto"
7542 See "forced_reply_to".
7544 "key_password"
7546 See "key_passwd".
7548 "max-size"
7550 See "max_size".
7552 "merge_feature"
7554 See "personalization_feature".
7556 "reply-to"
7558 See "reply_to".
7560 "replyto"
7562 See "reply_to".
7564 "subscription"
7566 See "subscribe".
7568 "unsubscription"
7570 See "unsubscribe".
7572 "use_blacklist"
7574 See "use_blocklist".
7576 Obsoleted sympa.conf parameters
7578 These parameters were used in sympa.conf or robot.conf on Sympa 6.2.56
7579 or earlier and are no longer recommended.
7580 "arc_private_key_path"
7582 See "arc_parameters.arc_private_key_path".
7584 "arc_selector"
7586 See "arc_parameters.arc_selector".
7588 "arc_signer_domain"
7590 See "arc_parameters.arc_signer_domain".
7592 "archive_mail_access"
7594 See "archive.mail_access".
7596 "archive_web_access"
7598 See "archive.web_access".
7600 "bounce_halt_rate"
7602 See "bounce.halt_rate".
7604 "bounce_warn_rate"
7606 See "bounce.warn_rate".
7608 "d_edit"
7610 See "shared_doc.d_edit".
7612 "d_read"
7614 See "shared_doc.d_read".
7616 "default_archive_quota"
7618 See "archive.quota".
7620 "default_bounce_level1_rate"
7622 See "bouncers_level1.rate".
7624 "default_bounce_level2_rate"
7626 See "bouncers_level2.rate".
7628 "default_list_priority"
7630 See "priority".
7632 "default_max_list_members"
7634 See "max_list_members".
7636 "default_remind_task"
7638 See "remind_task".
7640 "default_shared_quota"
7642 See "shared_doc.quota".
7644 "default_sql_fetch_timeout"
7646 See "sql_fetch_timeout".
7648 "default_ttl"
7650 See "ttl".
7652 "dkim_header_list"
7654 See "dkim_parameters.header_list".
7656 "dkim_private_key_path"
7658 See "dkim_parameters.private_key_path".
7660 "dkim_selector"
7662 See "dkim_parameters.selector".
7664 "dkim_signer_domain"
7666 See "dkim_parameters.signer_domain".
7668 "dmarc_protection_domain_regex"
7670 See "dmarc_protection.domain_regex".
7672 "dmarc_protection_mode"
7674 See "dmarc_protection.mode".
7676 "dmarc_protection_other_email"
7678 See "dmarc_protection.other_email".
7680 "dmarc_protection_phrase"
7682 See "dmarc_protection.phrase".
7684 "tracking"
7686 See "tracking.tracking".
7688 "tracking_default_retention_period"
7690 See "tracking.retention_period".
7692 "tracking_delivery_status_notification"
7694 See "tracking.delivery_status_notification".
7696 "tracking_message_disposition_notification"
7698 See "tracking.message_disposition_notification".
7700 Deprecated parameters
7702 These parameters were deprecated. They may not be used anymore.
7703 "account"
7705 "archived_pidfile"
7707 "automatic_list_prefix"
7709 "bounced_pidfile"
7711 "clean_delay_queueother"
7713 "cookie"
7715 "default_distribution_ttl"
7717 "distribution_mode"
7719 "edit_list"
7721 "editor"
7723 "email_gecos"
7725 "expire_task"
7727 "filesystem_encoding"
7729 "forced_reply_to"
7731 "host"
7733 "html_editor_file"
7735 "htmlarea_url"
7737 "http_host"
7739 "include_list"
7741 "ldap_export_connection_timeout"
7743 "ldap_export_dnmanager"
7745 "ldap_export_host"
7747 "ldap_export_name"
7749 "ldap_export_password"
7751 "ldap_export_suffix"
7753 "localedir"
7755 "lock_method"
7757 "log_condition"
7759 "log_module"
7761 "msgcat"
7763 "openssl"
7765 "owner"
7767 "pidfile"
7769 "pidfile_bulk"
7771 "pidfile_creation"
7773 "pidfile_distribute"
7775 "queuedistribute"
7777 "queueexpire"
7779 "reply_to"
7781 "sort"
7783 "task_manager_pidfile"
7785 "tri"
7787 "trusted_ca_options"
7789 "use_fast_cgi"
7791 "user_data_source"
7793 "web_archive"
7795 "web_recode_to"
7797
7799 /etc/sympa/sympa.conf
7800 Sympa main configuration file.
7801 $SYSCONFDIR/<mail domain name>/robot.conf
7803 Configuration specific to each mail domain.
7804 $EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list
7806 name>/config
7807 List main configuration file.
7808
7810 Sympa Administration Manual.
7811 <https://sympa-community.github.io/manual/>.
7812 auth.conf(5), charset.conf(5), crawlers_detection.conf(5),
7814 edit_list.conf(5), ldap_alias_manager.conf(5), nrcpt_by_domain.conf(5),
7815 sympa_scenario(5), topics.conf(5).
78166.2.64 2021-07-15 SYMPA_CONFIG(5)
