1SYMPA_CONFIG(5) sympa 6.2.60 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|/.+"/
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 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 which part of message from web conversion is applied
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 which part of e-mail message conversion is applied
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_blacklist"
1827 Use blacklist
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 blacklist filter is
1840 applied. Setting this parameter to "none" will hide the blacklist
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 "gecos" - only show gecos
2290 "none" - do nothing
2291 Default:
2292 "cookie"
2293 Context:
2295 list (config), domain (robot.conf), site (sympa.conf)
2296 Idem spam_protection is provided but it can be used only for web
2298 archives. Access requires a cookie, and users must submit a small form
2299 in order to receive a cookie before browsing the archives. This blocks
2300 all robot, even google and co.
2301 Bounces
2303 "bounce"
2304 (Paragraph) Bounces management
2306 Single occurrence
2308 "bounce.warn_rate"
2310 warn rate
2312 Format:
2314 Number of %.
2315 Default:
2317 30 (%)
2318 Context:
2320 list (config), site (sympa.conf)
2321 The list owner receives a warning whenever a message is distributed and
2323 the number (percentage) of bounces exceeds this value.
2324 "bounce.halt_rate"
2326 Deprecated.
2328 "bouncers_level1"
2330 (Paragraph) Management of bouncers, 1st level
2332 Single occurrence
2334 Level 1 is the lower level of bouncing users
2336 "bouncers_level1.rate"
2338 threshold
2340 Format:
2342 Number of points.
2343 Default:
2345 45 (points)
2346 Context:
2348 list (config), domain (robot.conf), site (sympa.conf)
2349 Each bouncing user have a score (from 0 to 100).
2351 This parameter defines a lower limit for each category of bouncing
2353 users.For example, level 1 begins from 45 to level_2_treshold.
2354 "bouncers_level1.action"
2356 action for this population
2358 Format:
2360 "remove_bouncers" - remove bouncing users
2361 "notify_bouncers" - send notify to bouncing users
2362 "none" - do nothing
2363 Default:
2364 "notify_bouncers"
2365 Context:
2367 list (config)
2368 This parameter defines which task is automatically applied on level 1
2370 bouncers.
2371 "bouncers_level1.notification"
2373 notification
2375 Format:
2377 "none" - do nothing
2378 "owner" - owner
2379 "listmaster" - listmaster
2380 Default:
2381 "owner"
2382 Context:
2384 list (config)
2385 When automatic task is executed on level 1 bouncers, a notification
2387 email can be send to listowner or listmaster.
2388 "bouncers_level2"
2390 (Paragraph) Management of bouncers, 2nd level
2392 Single occurrence
2394 Level 2 is the highest level of bouncing users
2396 "bouncers_level2.rate"
2398 threshold
2400 Format:
2402 Number of points.
2403 Default:
2405 75 (points)
2406 Context:
2408 list (config), domain (robot.conf), site (sympa.conf)
2409 Each bouncing user have a score (from 0 to 100).
2411 This parameter defines the score range defining each category of
2413 bouncing users.For example, level 2 is for users with a score between
2414 80 and 100.
2415 "bouncers_level2.action"
2417 action for this population
2419 Format:
2421 "remove_bouncers" - remove bouncing users
2422 "notify_bouncers" - send notify to bouncing users
2423 "none" - do nothing
2424 Default:
2425 "remove_bouncers"
2426 Context:
2428 list (config)
2429 This parameter defines which task is automatically applied on level 2
2431 bouncers.
2432 "bouncers_level2.notification"
2434 notification
2436 Format:
2438 "none" - do nothing
2439 "owner" - owner
2440 "listmaster" - listmaster
2441 Default:
2442 "owner"
2443 Context:
2445 list (config)
2446 When automatic task is executed on level 2 bouncers, a notification
2448 email can be send to listowner or listmaster.
2449 "verp_rate"
2451 percentage of list members in VERP mode
2453 Format:
2455 "100%" - 100% - always
2456 "50%" - 50%
2457 "33%" - 33%
2458 "25%" - 25%
2459 "20%" - 20%
2460 "10%" - 10%
2461 "5%" - 5%
2462 "2%" - 2%
2463 "0%" - 0% - never
2464 Default:
2465 "0%"
2466 Context:
2468 list (config), domain (robot.conf), site (sympa.conf)
2469 Uses variable envelope return path (VERP) to detect bouncing subscriber
2471 addresses.
2472 0%: VERP is never used.
2474 100%: VERP is always in use.
2476 VERP requires address with extension to be supported by MTA. If
2478 tracking is enabled for a list or a message, VERP is applied for 100%
2479 of subscribers.
2480 "tracking"
2482 (Paragraph) Message tracking feature
2484 Single occurrence
2486 "tracking.delivery_status_notification"
2488 tracking message by delivery status notification
2490 Format:
2492 "on" - enabled
2493 "off" - disabled
2494 Default:
2495 "off"
2496 Context:
2498 list (config), site (sympa.conf)
2499 "tracking.message_disposition_notification"
2501 tracking message by message disposition notification
2503 Format:
2505 "on" - enabled
2506 "on_demand" - on demand
2507 "off" - disabled
2508 Default:
2509 "off"
2510 Context:
2512 list (config), site (sympa.conf)
2513 "tracking.tracking"
2515 who can view message tracking
2517 Format:
2519 Name of "tracking" scenario:
2520 "owner" - only owner (and listmaster)
2522 "private" - restricted to subscribers
2523 Default:
2524 "owner"
2525 Context:
2527 list (config), site (sympa.conf)
2528 "tracking.retention_period"
2530 Tracking datas are removed after this number of days
2532 Format:
2534 Number of days.
2535 Default:
2537 90 (days)
2538 Context:
2540 list (config), site (sympa.conf)
2541 "welcome_return_path"
2543 Welcome return-path
2545 Format:
2547 "unique" - bounce management
2548 "owner" - owner
2549 Default:
2550 "owner"
2551 Context:
2553 list (config), site (sympa.conf)
2554 If set to unique, the welcome message is sent using a unique return
2556 path in order to remove the subscriber immediately in the case of a
2557 bounce.
2558 "remind_return_path"
2560 Return-path of the REMIND command
2562 Format:
2564 "unique" - bounce management
2565 "owner" - owner
2566 Default:
2567 "owner"
2568 Context:
2570 list (config), site (sympa.conf)
2571 Same as welcome_return_path, but applied to remind messages.
2573 "expire_bounce_task"
2575 Task for expiration of old bounces
2577 Format:
2579 /"\w+"/
2580 Default:
2582 "daily"
2583 Context:
2585 site (sympa.conf)
2586 This task resets bouncing information for addresses not bouncing in the
2588 last 10 days after the latest message distribution.
2589 "purge_orphan_bounces_task"
2591 Task for cleaning invalidated bounces
2593 Format:
2595 /"\w+"/
2596 Default:
2598 "monthly"
2599 Context:
2601 site (sympa.conf)
2602 This task deletes bounce information for unsubscribed users.
2604 "eval_bouncers_task"
2606 Task for updating bounce scores
2608 Format:
2610 /"\w+"/
2611 Default:
2613 "daily"
2614 Context:
2616 site (sympa.conf)
2617 This task scans all bouncing users for all lists, and updates
2619 "bounce_score_subscriber" field in "subscriber_table" table. The scores
2620 may be used for management of bouncers.
2621 "process_bouncers_task"
2623 Task for management of bouncers
2625 Format:
2627 /"\w+"/
2628 Default:
2630 "weekly"
2631 Context:
2633 site (sympa.conf)
2634 This task executes actions on bouncing users configured by each list,
2636 according to their scores.
2637 "purge_tables_task"
2639 Task for cleaning tables
2641 Format:
2643 /"\w+"/
2644 Default:
2646 "daily"
2647 Context:
2649 site (sympa.conf)
2650 This task cleans old tracking information from "notification_table"
2652 table.
2653 "minimum_bouncing_count"
2655 Minimum number of bounces
2657 Format:
2659 /"\d+"/
2660 Default:
2662 10
2663 Context:
2665 site (sympa.conf)
2666 The minimum number of bounces received to update bounce score of a
2668 user.
2669 "minimum_bouncing_period"
2671 Minimum bouncing period
2673 Format:
2675 Number of days.
2676 Default:
2678 10 (days)
2679 Context:
2681 site (sympa.conf)
2682 The minimum period for which bouncing lasted to update bounce score of
2684 a user.
2685 "bounce_delay"
2687 Delay of bounces
2689 Format:
2691 Number of days.
2692 Default:
2694 0 (days)
2695 Context:
2697 site (sympa.conf)
2698 Average time for a bounce sent back to mailing list server after a post
2700 was sent to a list. Usually bounces are sent back on the same day as
2701 the original message.
2702 "bounce_email_prefix"
2704 Prefix of VERP return address
2706 Format:
2708 /"\S+"/
2709 Default:
2711 "bounce"
2712 Context:
2714 site (sympa.conf)
2715 The prefix to consist the return-path of probe messages used for bounce
2717 management, when variable envelope return path (VERP) is enabled. VERP
2718 requires address with extension to be supported by MTA.
2719 If you change the default value, you must modify the mail aliases too.
2721 "return_path_suffix"
2723 Suffix of list return address
2725 Format:
2727 /"\S+"/
2728 Default:
2730 "-owner"
2731 Context:
2733 site (sympa.conf)
2734 The suffix appended to the list name to form the return-path of
2736 messages distributed through the list. This address will receive all
2737 non-delivery reports (also called bounces).
2738 Loop prevention
2740 "loop_command_max"
2741 Maximum number of responses to command message
2743 Format:
2745 /"\d+"/
2746 Default:
2748 200
2749 Context:
2751 site (sympa.conf)
2752 The maximum number of command reports sent to an email address.
2754 Messages are stored in "bad" subdirectory of incoming message spool,
2755 and reports are not longer sent.
2756 "loop_command_sampling_delay"
2758 Delay before counting responses to command message
2760 Format:
2762 Number of seconds.
2763 Default:
2765 3600 (seconds)
2766 Context:
2768 site (sympa.conf)
2769 This parameter defines the delay in seconds before decrementing the
2771 counter of reports sent to an email address.
2772 "loop_command_decrease_factor"
2774 Decrementing factor of responses to command message
2776 Format:
2778 /"[.\d]+"/
2779 Default:
2781 0.5
2782 Context:
2784 site (sympa.conf)
2785 The decrementation factor (from 0 to 1), used to determine the new
2787 report counter after expiration of the delay.
2788 "msgid_table_cleanup_ttl"
2790 Expiration period of message ID table
2792 Format:
2794 Number of seconds.
2795 Default:
2797 86400 (seconds)
2798 Context:
2800 site (sympa.conf)
2801 Expiration period of entries in the table maintained by sympa_msg.pl
2803 daemon to prevent delivery of duplicate messages caused by loop.
2804 "msgid_table_cleanup_frequency"
2806 Cleanup interval of message ID table
2808 Format:
2810 Number of seconds.
2811 Default:
2813 3600 (seconds)
2814 Context:
2816 site (sympa.conf)
2817 Interval between cleanups of the table maintained by sympa_msg.pl
2819 daemon to prevent delivery of duplicate messages caused by loop.
2820 Automatic lists
2822 "automatic_list_feature"
2823 Automatic list
2825 Format:
2827 "on" - enabled
2828 "off" - disabled
2829 Default:
2830 "off"
2831 Context:
2833 domain (robot.conf), site (sympa.conf)
2834 "automatic_list_removal"
2836 Remove empty automatic list
2838 Format:
2840 "none" - do nothing
2841 "if_empty" - if_empty
2842 Default:
2843 "none"
2844 Context:
2846 domain (robot.conf), site (sympa.conf)
2847 If set to "if_empty", then Sympa will remove automatically created
2849 mailing lists just after their creation, if they contain no list
2850 member.
2851 Example:
2853 automatic_list_removal if_empty
2855 "automatic_list_creation"
2857 Who is able to create automatic list
2859 Format:
2861 Name of "automatic_list_creation" scenario:
2862 "family_owner" - Restricted to people subscribed to the list of
2864 family owners.
2865 "listmaster" - restricted to listmaster
2866 "public" - anybody. Be sure you know what you are doing
2867 Default:
2868 "public"
2869 Context:
2871 domain (robot.conf), site (sympa.conf)
2872 "automatic_list_families"
2874 Definition of automatic list families
2876 Format:
2878 /".+"/
2879 Default:
2881 None.
2882 Context:
2884 domain (robot.conf), site (sympa.conf)
2885 Defines the families the automatic lists are based on. It is a
2887 character string structured as follows:
2888 * each family is separated from the other by a semicolon (;)
2890 * inside a family definition, each field is separated from the other by
2892 a colon (:)
2893 * each field has the structure: "<field name>=<field value>"
2895 Basically, each time Sympa uses the automatic lists families, the
2897 values defined in this parameter will be available in the family
2898 object.
2899 * for scenarios: [family->name]
2901 * for templates: [% family.name %]
2903 Example:
2905 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;
2907 "parsed_family_files"
2909 Parsed files for families
2911 Format:
2913 /"[-.\w]+"/
2914 Default:
2916 "message_header,message_header.mime,message_footer,message_footer.mime,info"
2917 Context:
2919 domain (robot.conf), site (sympa.conf)
2920 comma-separated list of files that will be parsed by Sympa when
2922 instantiating a family (no space allowed in file names)
2923 "family_signoff"
2925 Global unsubscription
2927 Format:
2929 Name of "family_signoff" scenario:
2930 "auth" - need authentication
2932 "closed" - impossible
2933 Default:
2934 "auth"
2935 Context:
2937 domain (robot.conf), site (sympa.conf)
2938 Tag based spam filtering
2940 "antispam_feature"
2941 Tag based spam filtering
2943 Format:
2945 "on" - enabled
2946 "off" - disabled
2947 Default:
2948 "off"
2949 Context:
2951 domain (robot.conf), site (sympa.conf)
2952 "antispam_tag_header_name"
2954 Header field to tag spams
2956 Format:
2958 /"\S+"/
2959 Default:
2961 "X-Spam-Status"
2962 Context:
2964 domain (robot.conf), site (sympa.conf)
2965 If a spam filter (like spamassassin or j-chkmail) add a header field to
2967 tag spams, name of this header field (example X-Spam-Status)
2968 "antispam_tag_header_spam_regexp"
2970 Regular expression to check header field to tag spams
2972 Format:
2974 /".+"/
2975 Default:
2977 "^\s*Yes"
2978 Context:
2980 domain (robot.conf), site (sympa.conf)
2981 Regular expression applied on this header to verify message is a spam
2983 (example Yes)
2984 "antispam_tag_header_ham_regexp"
2986 Regular expression to determine spam or ham.
2988 Format:
2990 /".+"/
2991 Default:
2993 "^\s*No"
2994 Context:
2996 domain (robot.conf), site (sympa.conf)
2997 Regular expression applied on this header field to verify message is
2999 NOT a spam (example No)
3000 "spam_status"
3002 Name of header field to inform
3004 Format:
3006 Name of "spam_status" scenario:
3007 "x-spam-status" - test x-spam-status header
3009 Default:
3010 "x-spam-status"
3011 Context:
3013 domain (robot.conf), site (sympa.conf)
3014 Messages are supposed to be filtered by an spam filter that adds them
3016 one or more headers. This parameter is used to select a special
3017 scenario in order to decide the message's spam status: ham, spam or
3018 unsure. This parameter replaces antispam_tag_header_name,
3019 antispam_tag_header_spam_regexp and antispam_tag_header_ham_regexp.
3020 Directories
3022 "home"
3023 List home
3025 Format:
3027 /".+"/
3028 Default:
3030 $EXPLDIR
3031 Context:
3033 site (sympa.conf)
3034 Base directory of list configurations.
3036 "etc"
3038 Directory for configuration files
3040 Format:
3042 /".+"/
3043 Default:
3045 $SYSCONFDIR
3046 Context:
3048 site (sympa.conf)
3049 Base directory of global configuration (except "sympa.conf").
3051 "spool"
3053 Base directory of spools
3055 Format:
3057 /".+"/
3058 Default:
3060 $SPOOLDIR
3061 Context:
3063 site (sympa.conf)
3064 Base directory of all spools which are created at runtime. This
3066 directory must be writable by Sympa user.
3067 "queue"
3069 Directory for message incoming spool
3071 Format:
3073 /".+"/
3074 Default:
3076 "$SPOOLDIR/msg"
3077 Context:
3079 site (sympa.conf)
3080 This spool is used both by "queue" program and "sympa_msg.pl" daemon.
3082 "queuemod"
3084 Directory for moderation spool
3086 Format:
3088 /".+"/
3089 Default:
3091 "$SPOOLDIR/moderation"
3092 Context:
3094 site (sympa.conf)
3095 "queuedigest"
3097 Directory for digest spool
3099 Format:
3101 /".+"/
3102 Default:
3104 "$SPOOLDIR/digest"
3105 Context:
3107 site (sympa.conf)
3108 "queueauth"
3110 Directory for held message spool
3112 Format:
3114 /".+"/
3115 Default:
3117 "$SPOOLDIR/auth"
3118 Context:
3120 site (sympa.conf)
3121 This parameter is named such by historical reason.
3123 "queueoutgoing"
3125 Directory for archive spool
3127 Format:
3129 /".+"/
3130 Default:
3132 "$SPOOLDIR/outgoing"
3133 Context:
3135 site (sympa.conf)
3136 This parameter is named such by historical reason.
3138 "queuesubscribe"
3140 Directory for held request spool
3142 Format:
3144 /".+"/
3145 Default:
3147 "$SPOOLDIR/subscribe"
3148 Context:
3150 site (sympa.conf)
3151 This parameter is named such by historical reason.
3153 "queuetopic"
3155 Directory for topic spool
3157 Format:
3159 /".+"/
3160 Default:
3162 "$SPOOLDIR/topic"
3163 Context:
3165 site (sympa.conf)
3166 "queuebounce"
3168 Directory for bounce incoming spool
3170 Format:
3172 /".+"/
3173 Default:
3175 "$SPOOLDIR/bounce"
3176 Context:
3178 site (sympa.conf)
3179 This spool is used both by "bouncequeue" program and "bounced.pl"
3181 daemon.
3182 "queuetask"
3184 Directory for task spool
3186 Format:
3188 /".+"/
3189 Default:
3191 "$SPOOLDIR/task"
3192 Context:
3194 site (sympa.conf)
3195 "queueautomatic"
3197 Directory for automatic list creation spool
3199 Format:
3201 /".+"/
3202 Default:
3204 "$SPOOLDIR/automatic"
3205 Context:
3207 site (sympa.conf)
3208 This spool is used both by "familyqueue" program and
3210 "sympa_automatic.pl" daemon.
3211 "queuebulk"
3213 Directory for message outgoing spool
3215 Format:
3217 /".+"/
3218 Default:
3220 "$SPOOLDIR/bulk"
3221 Context:
3223 site (sympa.conf)
3224 This parameter is named such by historical reason.
3226 "tmpdir"
3228 Temporary directory used by external programs such as virus scanner.
3230 Also, outputs to daemons' standard error are redirected to the files
3231 under this directory.
3232 Format:
3234 /".+"/
3235 Default:
3237 "$SPOOLDIR/tmp"
3238 Context:
3240 site (sympa.conf)
3241 "viewmail_dir"
3243 Directory to cache formatted messages
3245 Format:
3247 /".+"/
3248 Default:
3250 "$SPOOLDIR/viewmail"
3251 Context:
3253 site (sympa.conf)
3254 Base directory path of directories where HTML view of messages are
3256 cached.
3257 "bounce_path"
3259 Directory for storing bounces
3261 Format:
3263 /".+"/
3264 Default:
3266 $BOUNCEDIR
3267 Context:
3269 site (sympa.conf)
3270 The directory where bounced.pl daemon will store the last bouncing
3272 message for each user. A message is stored in the file:
3273 <bounce_path>/<list name>@<mail domain name>/<email address>, or, if
3274 tracking is enabled: <bounce_path>/<list name>@<mail domain
3275 name>/<email address>_<envelope ID>.
3276 Users can access to these messages using web interface in the bounce
3278 management page.
3279 Don't confuse with "queuebounce" parameter which defines the spool
3281 where incoming error reports are stored and picked by bounced.pl
3282 daemon.
3283 "arc_path"
3285 Directory for storing archives
3287 Format:
3289 /".+"/
3290 Default:
3292 $ARCDIR
3293 Context:
3295 domain (robot.conf), site (sympa.conf)
3296 Where to store HTML archives. This parameter is used by the
3298 "archived.pl" daemon. It is a good idea to install the archive outside
3299 the web document hierarchy to prevent overcoming of WWSympa's access
3300 control.
3301 "purge_spools_task"
3303 Task for cleaning spools
3305 Format:
3307 /"\w+"/
3308 Default:
3310 "daily"
3311 Context:
3313 site (sympa.conf)
3314 This task cleans old content in spools.
3316 "clean_delay_queue"
3318 Max age of incoming bad messages
3320 Format:
3322 Number of days.
3323 Default:
3325 7 (days)
3326 Context:
3328 site (sympa.conf)
3329 Number of days "bad" messages are kept in message incoming spool (as
3331 specified by "queue" parameter). Sympa keeps messages rejected for
3332 various reasons (badly formatted, looping etc.).
3333 "clean_delay_queueoutgoing"
3335 Max age of bad messages for archives
3337 Format:
3339 Number of days.
3340 Default:
3342 7 (days)
3343 Context:
3345 site (sympa.conf)
3346 Number of days "bad" messages are kept in message archive spool (as
3348 specified by "queueoutgoing" parameter). Sympa keeps messages rejected
3349 for various reasons (unable to create archive directory, to copy file
3350 etc.).
3351 "clean_delay_queuebounce"
3353 Max age of bad bounce messages
3355 Format:
3357 Number of days.
3358 Default:
3360 7 (days)
3361 Context:
3363 site (sympa.conf)
3364 Number of days "bad" messages are kept in bounce spool (as specified by
3366 "queuebounce" parameter). Sympa keeps messages rejected for various
3367 reasons (unknown original sender, unknown report type).
3368 "clean_delay_queueauth"
3370 Max age of held messages
3372 Format:
3374 Number of days.
3375 Default:
3377 30 (days)
3378 Context:
3380 site (sympa.conf)
3381 Number of days messages are kept in held message spool (as specified by
3383 "queueauth" parameter). Beyond this deadline, messages that have not
3384 been confirmed are deleted.
3385 "clean_delay_queuesubscribe"
3387 Max age of held requests
3389 Format:
3391 Number of days.
3392 Default:
3394 30 (days)
3395 Context:
3397 site (sympa.conf)
3398 Number of days requests are kept in held request spool (as specified by
3400 "queuesubscribe" parameter). Beyond this deadline, requests that have
3401 not been validated nor declined are deleted.
3402 "clean_delay_queuetopic"
3404 Max age of tagged topics
3406 Format:
3408 Number of days.
3409 Default:
3411 30 (days)
3412 Context:
3414 site (sympa.conf)
3415 Number of days (automatically or manually) tagged topics are kept in
3417 topic spool (as specified by "queuetopic" parameter). Beyond this
3418 deadline, tagging is forgotten.
3419 "clean_delay_queueautomatic"
3421 Max age of incoming bad messages in automatic list creation spool
3423 Format:
3425 Number of days.
3426 Default:
3428 10 (days)
3429 Context:
3431 site (sympa.conf)
3432 Number of days "bad" messages are kept in automatic list creation spool
3434 (as specified by "queueautomatic" parameter). Sympa keeps messages
3435 rejected for various reasons (badly formatted, looping etc.).
3436 "clean_delay_queuebulk"
3438 Max age of outgoing bad messages
3440 Format:
3442 Number of days.
3443 Default:
3445 7 (days)
3446 Context:
3448 site (sympa.conf)
3449 Number of days "bad" messages are kept in message outgoing spool (as
3451 specified by "queuebulk" parameter). Sympa keeps messages rejected for
3452 various reasons (failed personalization, bad configuration on MTA
3453 etc.).
3454 "clean_delay_queuedigest"
3456 Max age of bad messages in digest spool
3458 Format:
3460 Number of days.
3461 Default:
3463 14 (days)
3464 Context:
3466 site (sympa.conf)
3467 Number of days "bad" messages are kept in digest spool (as specified by
3469 "queuedigest" parameter). Sympa keeps messages rejected for various
3470 reasons (syntax errors in "digest.tt2" template etc.).
3471 "clean_delay_tmpdir"
3473 Max age of temporary files
3475 Format:
3477 Number of days.
3478 Default:
3480 7 (days)
3481 Context:
3483 site (sympa.conf)
3484 Number of days files in temporary directory (as specified by "tmpdir"
3486 parameter), including standard error logs, are kept.
3487 S/MIME and TLS
3489 S/MIME authentication, decryption and re-encryption. It requires these
3490 external modules: Crypt-OpenSSL-X509 and Crypt-SMIME.
3491 TLS client authentication. It requires an external module: IO-Socket-
3493 SSL.
3494 "cafile"
3496 File containing trusted CA certificates
3498 Format:
3500 /".+"/
3501 Default:
3503 None.
3504 Context:
3506 site (sympa.conf)
3507 This can be used alternatively and/or additionally to "capath".
3509 "capath"
3511 Directory containing trusted CA certificates
3513 Format:
3515 /".+"/
3516 Default:
3518 None.
3519 Context:
3521 site (sympa.conf)
3522 CA certificates in this directory are used for client authentication.
3524 The certificates need to have names including hash of subject, or
3526 symbolic links to them with such names. The links may be created by
3527 using "c_rehash" script bundled in OpenSSL.
3528 "key_passwd"
3530 Password used to crypt lists private keys
3532 Format:
3534 The value to be concealed.
3535 Default:
3537 None.
3538 Context:
3540 site (sympa.conf)
3541 If not defined, Sympa assumes that list private keys are not encrypted.
3543 Example:
3545 key_passwd your_password
3547 "ssl_cert_dir"
3549 Directory containing user certificates
3551 Format:
3553 /".+"/
3554 Default:
3556 "$EXPLDIR/X509-user-certs"
3557 Context:
3559 site (sympa.conf)
3560 Data sources setup
3562 Including subscribers, owners and moderators from data sources.
3563 Appropriate database driver (DBD) modules are required: DBD-CSV, DBD-
3564 mysql, DBD-ODBC, DBD-Oracle, DBD-Pg, DBD-SQLite and/or Net-LDAP. And
3565 also, if secure connection (LDAPS) to LDAP server is required: IO-
3566 Socket-SSL.
3567 "inclusion_notification_feature"
3569 Notify subscribers when they are included from a data source?
3571 Format:
3573 "on" - enabled
3574 "off" - disabled
3575 Default:
3576 "off"
3577 Context:
3579 list (config)
3580 "member_include"
3582 (Paragraph) Subscribers defined in an external data source
3584 Multiple occurrences allowed
3586 "member_include.source"
3588 the data source
3590 Format:
3592 /"[\w-]+"/
3593 Default:
3595 None, mandatory.
3596 Context:
3598 list (config)
3599 "member_include.source_parameters"
3601 data source parameters
3603 Format:
3605 /".*"/
3606 Default:
3608 None.
3609 Context:
3611 list (config)
3612 "owner_include"
3614 (Paragraph) Owners defined in an external data source
3616 Multiple occurrences allowed
3618 "owner_include.source"
3620 the data source
3622 Format:
3624 /"[\w-]+"/
3625 Default:
3627 None, mandatory.
3628 Context:
3630 list (config)
3631 "owner_include.source_parameters"
3633 data source parameters
3635 Format:
3637 /".*"/
3638 Default:
3640 None.
3641 Context:
3643 list (config)
3644 "owner_include.profile"
3646 profile
3648 Format:
3650 "privileged" - privileged owner
3651 "normal" - normal owner
3652 Default:
3653 "normal"
3654 Context:
3656 list (config)
3657 "owner_include.reception"
3659 reception mode
3661 Format:
3663 "mail" - receive notification email
3664 "nomail" - no notifications
3665 Default:
3666 "mail"
3667 Context:
3669 list (config)
3670 "owner_include.visibility"
3672 visibility
3674 Format:
3676 "conceal" - concealed from list menu
3677 "noconceal" - listed on the list menu
3678 Default:
3679 "noconceal"
3680 Context:
3682 list (config)
3683 "editor_include"
3685 (Paragraph) Moderators defined in an external data source
3687 Multiple occurrences allowed
3689 "editor_include.source"
3691 the data source
3693 Format:
3695 /"[\w-]+"/
3696 Default:
3698 None, mandatory.
3699 Context:
3701 list (config)
3702 "editor_include.source_parameters"
3704 data source parameters
3706 Format:
3708 /".*"/
3709 Default:
3711 None.
3712 Context:
3714 list (config)
3715 "editor_include.reception"
3717 reception mode
3719 Format:
3721 "mail" - receive notification email
3722 "nomail" - no notifications
3723 Default:
3724 "mail"
3725 Context:
3727 list (config)
3728 "editor_include.visibility"
3730 visibility
3732 Format:
3734 "conceal" - concealed from list menu
3735 "noconceal" - listed on the list menu
3736 Default:
3737 "noconceal"
3738 Context:
3740 list (config)
3741 "sql_fetch_timeout"
3743 Timeout for fetch of include_sql_query
3745 Format:
3747 Number of seconds.
3748 Default:
3750 300 (seconds)
3751 Context:
3753 list (config), site (sympa.conf)
3754 "include_file"
3756 File inclusion
3758 Format:
3760 Multiple occurrences allowed.
3761 /"\S+"/
3763 Default:
3765 None.
3766 Context:
3768 list (config)
3769 Include subscribers from this file. The file should contain one e-mail
3771 address per line (lines beginning with a "#" are ignored).
3772 "include_remote_file"
3774 (Paragraph) Remote file inclusion
3776 Multiple occurrences allowed
3778 "include_remote_file.name"
3780 short name for this source
3782 Format:
3784 /".+"/
3785 Default:
3787 None.
3788 Context:
3790 list (config)
3791 "include_remote_file.url"
3793 data location URL
3795 Format:
3797 /".+"/
3798 Default:
3800 None, mandatory.
3801 Context:
3803 list (config)
3804 "include_remote_file.user"
3806 remote user
3808 Format:
3810 /".+"/
3811 Default:
3813 None.
3814 Context:
3816 list (config)
3817 "include_remote_file.passwd"
3819 remote password
3821 Format:
3823 The value to be concealed.
3824 Default:
3826 None.
3827 Context:
3829 list (config)
3830 "include_remote_file.timeout"
3832 idle timeout
3834 Format:
3836 Number of seconds.
3837 Default:
3839 180 (seconds)
3840 Context:
3842 list (config)
3843 "include_remote_file.ssl_version"
3845 SSL version
3847 Format:
3849 "ssl_any" - any versions
3850 "sslv2" - SSL version 2
3851 "sslv3" - SSL version 3
3852 "tlsv1" - TLS version 1
3853 "tlsv1_1" - TLS version 1.1
3854 "tlsv1_2" - TLS version 1.2
3855 "tlsv1_3" - TLS version 1.3
3856 Default:
3857 "ssl_any"
3858 Context:
3860 list (config)
3861 "include_remote_file.ssl_ciphers"
3863 SSL ciphers used
3865 Format:
3867 /".+"/
3868 Default:
3870 "ALL"
3871 Context:
3873 list (config)
3874 "include_remote_file.ca_verify"
3876 Certificate verification
3878 Format:
3880 "none" - do nothing
3881 "optional" - optional
3882 "required" - required
3883 Default:
3884 "none"
3885 Context:
3887 list (config)
3888 "include_remote_file.nosync_time_ranges"
3890 Time ranges when inclusion is not allowed
3892 Format:
3894 /$time_ranges/
3895 Default:
3897 None.
3898 Context:
3900 list (config)
3901 "include_sympa_list"
3903 (Paragraph) List inclusion
3905 Multiple occurrences allowed
3907 Include subscribers from other list. All subscribers of list listname
3909 become subscribers of the current list. You may include as many lists
3910 as required, using one include_sympa_list paragraph for each included
3911 list. Any list at all may be included; you may therefore include lists
3912 which are also defined by the inclusion of other lists. Be careful,
3913 however, not to include list A in list B and then list B in list A,
3914 since this will give rise to an infinite loop.
3915 "include_sympa_list.name"
3917 short name for this source
3919 Format:
3921 /".+"/
3922 Default:
3924 None.
3925 Context:
3927 list (config)
3928 "include_sympa_list.listname"
3930 list name to include
3932 Format:
3934 /"$listname(\@$host)?"/
3935 Default:
3937 None, mandatory.
3938 Context:
3940 list (config)
3941 "include_sympa_list.filter"
3943 filter definition
3945 Format:
3947 /".*"/
3948 Default:
3950 None.
3951 Context:
3953 list (config)
3954 "include_sympa_list.nosync_time_ranges"
3956 Time ranges when inclusion is not allowed
3958 Format:
3960 /$time_ranges/
3961 Default:
3963 None.
3964 Context:
3966 list (config)
3967 "include_remote_sympa_list"
3969 (Paragraph) remote list inclusion
3971 Multiple occurrences allowed
3973 Sympa can contact another Sympa service using HTTPS to fetch a remote
3975 list in order to include each member of a remote list as subscriber.
3976 You may include as many lists as required, using one
3977 include_remote_sympa_list paragraph for each included list. Be careful,
3978 however, not to give rise to an infinite loop resulting from cross
3979 includes.
3980 For this operation, one Sympa site acts as a server while the other one
3982 acs as client. On the server side, the only setting needed is to give
3983 permission to the remote Sympa to review the list. This is controlled
3984 by the review scenario.
3985 "include_remote_sympa_list.name"
3987 short name for this source
3989 Format:
3991 /".+"/
3992 Default:
3994 None.
3995 Context:
3997 list (config)
3998 "include_remote_sympa_list.url"
4000 data location URL
4002 Format:
4004 /".+"/
4005 Default:
4007 None.
4008 Context:
4010 list (config)
4011 "include_remote_sympa_list.user"
4013 remote user
4015 Format:
4017 /".+"/
4018 Default:
4020 None.
4021 Context:
4023 list (config)
4024 "include_remote_sympa_list.passwd"
4026 remote password
4028 Format:
4030 The value to be concealed.
4031 Default:
4033 None.
4034 Context:
4036 list (config)
4037 "include_remote_sympa_list.host"
4039 remote host
4041 Format:
4043 /$host/
4044 Default:
4046 None, mandatory.
4047 Context:
4049 list (config)
4050 obsoleted. Use "data location URL".
4052 "include_remote_sympa_list.port"
4054 remote port
4056 Format:
4058 /"\d+"/
4059 Default:
4061 443
4062 Context:
4064 list (config)
4065 obsoleted. Use "data location URL".
4067 "include_remote_sympa_list.path"
4069 remote path of sympa list dump
4071 Format:
4073 /"\S+"/
4074 Default:
4076 None, mandatory.
4077 Context:
4079 list (config)
4080 obsoleted. Use "data location URL".
4082 "include_remote_sympa_list.cert"
4084 Deprecated.
4086 "include_remote_sympa_list.timeout"
4088 idle timeout
4090 Format:
4092 Number of seconds.
4093 Default:
4095 180 (seconds)
4096 Context:
4098 list (config)
4099 "include_remote_sympa_list.ssl_version"
4101 SSL version
4103 Format:
4105 "ssl_any" - any versions
4106 "sslv2" - SSL version 2
4107 "sslv3" - SSL version 3
4108 "tlsv1" - TLS version 1
4109 "tlsv1_1" - TLS version 1.1
4110 "tlsv1_2" - TLS version 1.2
4111 "tlsv1_3" - TLS version 1.3
4112 Default:
4113 "ssl_any"
4114 Context:
4116 list (config)
4117 "include_remote_sympa_list.ssl_ciphers"
4119 SSL ciphers used
4121 Format:
4123 /".+"/
4124 Default:
4126 "ALL"
4127 Context:
4129 list (config)
4130 "include_remote_sympa_list.ca_verify"
4132 Certificate verification
4134 Format:
4136 "none" - do nothing
4137 "optional" - optional
4138 "required" - required
4139 Default:
4140 "optional"
4141 Context:
4143 list (config)
4144 "include_remote_sympa_list.nosync_time_ranges"
4146 Time ranges when inclusion is not allowed
4148 Format:
4150 /$time_ranges/
4151 Default:
4153 None.
4154 Context:
4156 list (config)
4157 "include_ldap_query"
4159 (Paragraph) LDAP query inclusion
4161 Multiple occurrences allowed
4163 This paragraph defines parameters for a query returning a list of
4165 subscribers. This feature requires the Net::LDAP (perlldap) PERL
4166 module.
4167 "include_ldap_query.name"
4169 short name for this source
4171 Format:
4173 /".+"/
4174 Default:
4176 None.
4177 Context:
4179 list (config)
4180 "include_ldap_query.host"
4182 remote host
4184 Format:
4186 /$multiple_host_or_url/
4187 Default:
4189 None, mandatory.
4190 Context:
4192 list (config)
4193 "include_ldap_query.port"
4195 Deprecated.
4197 "include_ldap_query.use_tls"
4199 use TLS (formerly SSL)
4201 Format:
4203 "starttls" - use STARTTLS
4204 "ldaps" - use LDAPS (LDAP over TLS)
4205 "none" - do nothing
4206 Default:
4207 "none"
4208 Context:
4210 list (config)
4211 "include_ldap_query.ssl_version"
4213 SSL version
4215 Format:
4217 "sslv2" - SSL version 2
4218 "sslv3" - SSL version 3
4219 "tlsv1" - TLS version 1
4220 "tlsv1_1" - TLS version 1.1
4221 "tlsv1_2" - TLS version 1.2
4222 "tlsv1_3" - TLS version 1.3
4223 Default:
4224 "tlsv1"
4225 Context:
4227 list (config)
4228 "include_ldap_query.ssl_ciphers"
4230 SSL ciphers used
4232 Format:
4234 /".+"/
4235 Default:
4237 "ALL"
4238 Context:
4240 list (config)
4241 "include_ldap_query.ca_verify"
4243 Certificate verification
4245 Format:
4247 "none" - do nothing
4248 "optional" - optional
4249 "required" - required
4250 Default:
4251 "required"
4252 Context:
4254 list (config)
4255 "include_ldap_query.bind_dn"
4257 remote user
4259 Format:
4261 /".+"/
4262 Default:
4264 None.
4265 Context:
4267 list (config)
4268 "include_ldap_query.bind_password"
4270 remote password
4272 Format:
4274 The value to be concealed.
4275 Default:
4277 None.
4278 Context:
4280 list (config)
4281 "include_ldap_query.suffix"
4283 suffix
4285 Format:
4287 /".+"/
4288 Default:
4290 None.
4291 Context:
4293 list (config)
4294 "include_ldap_query.scope"
4296 search scope
4298 Format:
4300 "base" - base
4301 "one" - one level
4302 "sub" - subtree
4303 Default:
4304 "sub"
4305 Context:
4307 list (config)
4308 "include_ldap_query.timeout"
4310 connection timeout
4312 Format:
4314 Number of seconds.
4315 Default:
4317 30 (seconds)
4318 Context:
4320 list (config)
4321 "include_ldap_query.filter"
4323 filter
4325 Format:
4327 /".+"/
4328 Default:
4330 None, mandatory.
4331 Context:
4333 list (config)
4334 "include_ldap_query.attrs"
4336 extracted attribute
4338 Format:
4340 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
4341 Default:
4343 "mail"
4344 Context:
4346 list (config)
4347 "include_ldap_query.select"
4349 selection (if multiple)
4351 Format:
4353 "all" - all
4354 "first" - first entry
4355 "regex" - entries matching regular expression
4356 Default:
4357 "first"
4358 Context:
4360 list (config)
4361 "include_ldap_query.regex"
4363 regular expression
4365 Format:
4367 /".+"/
4368 Default:
4370 ""
4371 Context:
4373 list (config)
4374 "include_ldap_query.nosync_time_ranges"
4376 Time ranges when inclusion is not allowed
4378 Format:
4380 /$time_ranges/
4381 Default:
4383 None.
4384 Context:
4386 list (config)
4387 "include_ldap_query.passwd"
4389 Obsoleted. Use "bind_password".
4391 "include_ldap_query.use_ssl"
4393 Obsoleted. Use "use_tls".
4395 "include_ldap_query.user"
4397 Obsoleted. Use "bind_dn".
4399 "include_ldap_2level_query"
4401 (Paragraph) LDAP 2-level query inclusion
4403 Multiple occurrences allowed
4405 This paragraph defines parameters for a two-level query returning a
4407 list of subscribers. Usually the first-level query returns a list of
4408 DNs and the second-level queries convert the DNs into e-mail addresses.
4409 This feature requires the Net::LDAP (perlldap) PERL module.
4410 "include_ldap_2level_query.name"
4412 short name for this source
4414 Format:
4416 /".+"/
4417 Default:
4419 None.
4420 Context:
4422 list (config)
4423 "include_ldap_2level_query.host"
4425 remote host
4427 Format:
4429 /$multiple_host_or_url/
4430 Default:
4432 None, mandatory.
4433 Context:
4435 list (config)
4436 "include_ldap_2level_query.port"
4438 Deprecated.
4440 "include_ldap_2level_query.use_tls"
4442 use TLS (formerly SSL)
4444 Format:
4446 "starttls" - use STARTTLS
4447 "ldaps" - use LDAPS (LDAP over TLS)
4448 "none" - do nothing
4449 Default:
4450 "none"
4451 Context:
4453 list (config)
4454 "include_ldap_2level_query.ssl_version"
4456 SSL version
4458 Format:
4460 "sslv2" - SSL version 2
4461 "sslv3" - SSL version 3
4462 "tlsv1" - TLS version 1
4463 "tlsv1_1" - TLS version 1.1
4464 "tlsv1_2" - TLS version 1.2
4465 "tlsv1_3" - TLS version 1.3
4466 Default:
4467 "tlsv1"
4468 Context:
4470 list (config)
4471 "include_ldap_2level_query.ssl_ciphers"
4473 SSL ciphers used
4475 Format:
4477 /".+"/
4478 Default:
4480 "ALL"
4481 Context:
4483 list (config)
4484 "include_ldap_2level_query.ca_verify"
4486 Certificate verification
4488 Format:
4490 "none" - do nothing
4491 "optional" - optional
4492 "required" - required
4493 Default:
4494 "required"
4495 Context:
4497 list (config)
4498 "include_ldap_2level_query.bind_dn"
4500 remote user
4502 Format:
4504 /".+"/
4505 Default:
4507 None.
4508 Context:
4510 list (config)
4511 "include_ldap_2level_query.bind_password"
4513 remote password
4515 Format:
4517 The value to be concealed.
4518 Default:
4520 None.
4521 Context:
4523 list (config)
4524 "include_ldap_2level_query.suffix1"
4526 first-level suffix
4528 Format:
4530 /".+"/
4531 Default:
4533 None.
4534 Context:
4536 list (config)
4537 "include_ldap_2level_query.scope1"
4539 first-level search scope
4541 Format:
4543 "base" - base
4544 "one" - one level
4545 "sub" - subtree
4546 Default:
4547 "sub"
4548 Context:
4550 list (config)
4551 "include_ldap_2level_query.timeout1"
4553 first-level connection timeout
4555 Format:
4557 Number of seconds.
4558 Default:
4560 30 (seconds)
4561 Context:
4563 list (config)
4564 "include_ldap_2level_query.filter1"
4566 first-level filter
4568 Format:
4570 /".+"/
4571 Default:
4573 None, mandatory.
4574 Context:
4576 list (config)
4577 "include_ldap_2level_query.attrs1"
4579 first-level extracted attribute
4581 Format:
4583 /$ldap_attrdesc/
4584 Default:
4586 None.
4587 Context:
4589 list (config)
4590 "include_ldap_2level_query.select1"
4592 first-level selection
4594 Format:
4596 "all" - all
4597 "first" - first entry
4598 "regex" - entries matching regular expression
4599 Default:
4600 "first"
4601 Context:
4603 list (config)
4604 "include_ldap_2level_query.regex1"
4606 first-level regular expression
4608 Format:
4610 /".+"/
4611 Default:
4613 ""
4614 Context:
4616 list (config)
4617 "include_ldap_2level_query.suffix2"
4619 second-level suffix template
4621 Format:
4623 /".+"/
4624 Default:
4626 None.
4627 Context:
4629 list (config)
4630 "include_ldap_2level_query.scope2"
4632 second-level search scope
4634 Format:
4636 "base" - base
4637 "one" - one level
4638 "sub" - subtree
4639 Default:
4640 "sub"
4641 Context:
4643 list (config)
4644 "include_ldap_2level_query.timeout2"
4646 second-level connection timeout
4648 Format:
4650 Number of seconds.
4651 Default:
4653 30 (seconds)
4654 Context:
4656 list (config)
4657 "include_ldap_2level_query.filter2"
4659 second-level filter template
4661 Format:
4663 /".+"/
4664 Default:
4666 None, mandatory.
4667 Context:
4669 list (config)
4670 "include_ldap_2level_query.attrs2"
4672 second-level extracted attribute
4674 Format:
4676 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
4677 Default:
4679 "mail"
4680 Context:
4682 list (config)
4683 "include_ldap_2level_query.select2"
4685 second-level selection
4687 Format:
4689 "all" - all
4690 "first" - first entry
4691 "regex" - entries matching regular expression
4692 Default:
4693 "first"
4694 Context:
4696 list (config)
4697 "include_ldap_2level_query.regex2"
4699 second-level regular expression
4701 Format:
4703 /".+"/
4704 Default:
4706 ""
4707 Context:
4709 list (config)
4710 "include_ldap_2level_query.nosync_time_ranges"
4712 Time ranges when inclusion is not allowed
4714 Format:
4716 /$time_ranges/
4717 Default:
4719 None.
4720 Context:
4722 list (config)
4723 "include_ldap_2level_query.passwd"
4725 Obsoleted. Use "bind_password".
4727 "include_ldap_2level_query.use_ssl"
4729 Obsoleted. Use "use_tls".
4731 "include_ldap_2level_query.user"
4733 Obsoleted. Use "bind_dn".
4735 "include_sql_query"
4737 (Paragraph) SQL query inclusion
4739 Multiple occurrences allowed
4741 This parameter is used to define the SQL query parameters.
4743 "include_sql_query.name"
4745 short name for this source
4747 Format:
4749 /".+"/
4750 Default:
4752 None.
4753 Context:
4755 list (config)
4756 "include_sql_query.db_type"
4758 database type
4760 Format:
4762 /"\S+"/
4763 Default:
4765 None, mandatory.
4766 Context:
4768 list (config)
4769 "include_sql_query.db_host"
4771 remote host
4773 Format:
4775 /$host/
4776 Default:
4778 None.
4779 Context:
4781 list (config)
4782 "include_sql_query.db_port"
4784 database port
4786 Format:
4788 /"\d+"/
4789 Default:
4791 None.
4792 Context:
4794 list (config)
4795 "include_sql_query.db_name"
4797 database name
4799 Format:
4801 /"\S+"/
4802 Default:
4804 None, mandatory.
4805 Context:
4807 list (config)
4808 "include_sql_query.db_options"
4810 connection options
4812 Format:
4814 /".+"/
4815 Default:
4817 None.
4818 Context:
4820 list (config)
4821 "include_sql_query.db_env"
4823 environment variables for database connection
4825 Format:
4827 /"\w+\=\S+(;\w+\=\S+)*"/
4828 Default:
4830 None.
4831 Context:
4833 list (config)
4834 "include_sql_query.db_user"
4836 remote user
4838 Format:
4840 /"\S+"/
4841 Default:
4843 None, mandatory.
4844 Context:
4846 list (config)
4847 "include_sql_query.db_passwd"
4849 remote password
4851 Format:
4853 The value to be concealed.
4854 Default:
4856 None.
4857 Context:
4859 list (config)
4860 "include_sql_query.sql_query"
4862 SQL query
4864 Format:
4866 /$sql_query/
4867 Default:
4869 None, mandatory.
4870 Context:
4872 list (config)
4873 "include_sql_query.f_dir"
4875 Directory where the database is stored (used for DBD::CSV only)
4877 Format:
4879 /".+"/
4880 Default:
4882 None.
4883 Context:
4885 list (config)
4886 "include_sql_query.nosync_time_ranges"
4888 Time ranges when inclusion is not allowed
4890 Format:
4892 /$time_ranges/
4893 Default:
4895 None.
4896 Context:
4898 list (config)
4899 "include_sql_query.connect_options"
4901 Obsoleted. Use "db_options".
4903 "include_sql_query.host"
4905 Obsoleted. Use "db_host".
4907 "include_sql_query.passwd"
4909 Obsoleted. Use "db_passwd".
4911 "include_sql_query.user"
4913 Obsoleted. Use "db_user".
4915 "ttl"
4917 Inclusions timeout
4919 Format:
4921 Number of seconds.
4922 Default:
4924 3600 (seconds)
4925 Context:
4927 list (config), site (sympa.conf)
4928 Sympa caches user data extracted using the include parameter. Their TTL
4930 (time-to-live) within Sympa can be controlled using this parameter. The
4931 default value is 3600
4932 "distribution_ttl"
4934 Inclusions timeout for message distribution
4936 Format:
4938 Number of seconds.
4939 Default:
4941 None.
4942 Context:
4944 list (config)
4945 This parameter defines the delay since the last synchronization after
4947 which the user's list will be updated before performing either of
4948 following actions:
4949 * Reviewing list members
4951 * Message distribution
4953 "include_ldap_ca"
4955 (Paragraph) LDAP query custom attribute
4957 Multiple occurrences allowed
4959 "include_ldap_ca.name"
4961 short name for this source
4963 Format:
4965 /".+"/
4966 Default:
4968 None.
4969 Context:
4971 list (config)
4972 "include_ldap_ca.host"
4974 remote host
4976 Format:
4978 /$multiple_host_or_url/
4979 Default:
4981 None, mandatory.
4982 Context:
4984 list (config)
4985 "include_ldap_ca.port"
4987 Deprecated.
4989 "include_ldap_ca.use_tls"
4991 use TLS (formerly SSL)
4993 Format:
4995 "starttls" - use STARTTLS
4996 "ldaps" - use LDAPS (LDAP over TLS)
4997 "none" - do nothing
4998 Default:
4999 "none"
5000 Context:
5002 list (config)
5003 "include_ldap_ca.ssl_version"
5005 SSL version
5007 Format:
5009 "sslv2" - SSL version 2
5010 "sslv3" - SSL version 3
5011 "tlsv1" - TLS version 1
5012 "tlsv1_1" - TLS version 1.1
5013 "tlsv1_2" - TLS version 1.2
5014 "tlsv1_3" - TLS version 1.3
5015 Default:
5016 "tlsv1"
5017 Context:
5019 list (config)
5020 "include_ldap_ca.ssl_ciphers"
5022 SSL ciphers used
5024 Format:
5026 /".+"/
5027 Default:
5029 "ALL"
5030 Context:
5032 list (config)
5033 "include_ldap_ca.ca_verify"
5035 Certificate verification
5037 Format:
5039 "none" - do nothing
5040 "optional" - optional
5041 "required" - required
5042 Default:
5043 "required"
5044 Context:
5046 list (config)
5047 "include_ldap_ca.bind_dn"
5049 remote user
5051 Format:
5053 /".+"/
5054 Default:
5056 None.
5057 Context:
5059 list (config)
5060 "include_ldap_ca.bind_password"
5062 remote password
5064 Format:
5066 The value to be concealed.
5067 Default:
5069 None.
5070 Context:
5072 list (config)
5073 "include_ldap_ca.suffix"
5075 suffix
5077 Format:
5079 /".+"/
5080 Default:
5082 None.
5083 Context:
5085 list (config)
5086 "include_ldap_ca.scope"
5088 search scope
5090 Format:
5092 "base" - base
5093 "one" - one level
5094 "sub" - subtree
5095 Default:
5096 "sub"
5097 Context:
5099 list (config)
5100 "include_ldap_ca.timeout"
5102 connection timeout
5104 Format:
5106 Number of seconds.
5107 Default:
5109 30 (seconds)
5110 Context:
5112 list (config)
5113 "include_ldap_ca.filter"
5115 filter
5117 Format:
5119 /".+"/
5120 Default:
5122 None, mandatory.
5123 Context:
5125 list (config)
5126 "include_ldap_ca.attrs"
5128 extracted attribute
5130 Format:
5132 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
5133 Default:
5135 "mail"
5136 Context:
5138 list (config)
5139 "include_ldap_ca.email_entry"
5141 Name of email entry
5143 Format:
5145 /"\S+"/
5146 Default:
5148 None, mandatory.
5149 Context:
5151 list (config)
5152 "include_ldap_ca.select"
5154 selection (if multiple)
5156 Format:
5158 "all" - all
5159 "first" - first entry
5160 "regex" - entries matching regular expression
5161 Default:
5162 "first"
5163 Context:
5165 list (config)
5166 "include_ldap_ca.regex"
5168 regular expression
5170 Format:
5172 /".+"/
5173 Default:
5175 ""
5176 Context:
5178 list (config)
5179 "include_ldap_ca.nosync_time_ranges"
5181 Time ranges when inclusion is not allowed
5183 Format:
5185 /$time_ranges/
5186 Default:
5188 None.
5189 Context:
5191 list (config)
5192 "include_ldap_ca.passwd"
5194 Obsoleted. Use "bind_password".
5196 "include_ldap_ca.use_ssl"
5198 Obsoleted. Use "use_tls".
5200 "include_ldap_ca.user"
5202 Obsoleted. Use "bind_dn".
5204 "include_ldap_2level_ca"
5206 (Paragraph) LDAP 2-level query custom attribute
5208 Multiple occurrences allowed
5210 "include_ldap_2level_ca.name"
5212 short name for this source
5214 Format:
5216 /".+"/
5217 Default:
5219 None.
5220 Context:
5222 list (config)
5223 "include_ldap_2level_ca.host"
5225 remote host
5227 Format:
5229 /$multiple_host_or_url/
5230 Default:
5232 None, mandatory.
5233 Context:
5235 list (config)
5236 "include_ldap_2level_ca.port"
5238 Deprecated.
5240 "include_ldap_2level_ca.use_tls"
5242 use TLS (formerly SSL)
5244 Format:
5246 "starttls" - use STARTTLS
5247 "ldaps" - use LDAPS (LDAP over TLS)
5248 "none" - do nothing
5249 Default:
5250 "none"
5251 Context:
5253 list (config)
5254 "include_ldap_2level_ca.ssl_version"
5256 SSL version
5258 Format:
5260 "sslv2" - SSL version 2
5261 "sslv3" - SSL version 3
5262 "tlsv1" - TLS version 1
5263 "tlsv1_1" - TLS version 1.1
5264 "tlsv1_2" - TLS version 1.2
5265 "tlsv1_3" - TLS version 1.3
5266 Default:
5267 "tlsv1"
5268 Context:
5270 list (config)
5271 "include_ldap_2level_ca.ssl_ciphers"
5273 SSL ciphers used
5275 Format:
5277 /".+"/
5278 Default:
5280 "ALL"
5281 Context:
5283 list (config)
5284 "include_ldap_2level_ca.ca_verify"
5286 Certificate verification
5288 Format:
5290 "none" - do nothing
5291 "optional" - optional
5292 "required" - required
5293 Default:
5294 "required"
5295 Context:
5297 list (config)
5298 "include_ldap_2level_ca.bind_dn"
5300 remote user
5302 Format:
5304 /".+"/
5305 Default:
5307 None.
5308 Context:
5310 list (config)
5311 "include_ldap_2level_ca.bind_password"
5313 remote password
5315 Format:
5317 The value to be concealed.
5318 Default:
5320 None.
5321 Context:
5323 list (config)
5324 "include_ldap_2level_ca.suffix1"
5326 first-level suffix
5328 Format:
5330 /".+"/
5331 Default:
5333 None.
5334 Context:
5336 list (config)
5337 "include_ldap_2level_ca.scope1"
5339 first-level search scope
5341 Format:
5343 "base" - base
5344 "one" - one level
5345 "sub" - subtree
5346 Default:
5347 "sub"
5348 Context:
5350 list (config)
5351 "include_ldap_2level_ca.timeout1"
5353 first-level connection timeout
5355 Format:
5357 Number of seconds.
5358 Default:
5360 30 (seconds)
5361 Context:
5363 list (config)
5364 "include_ldap_2level_ca.filter1"
5366 first-level filter
5368 Format:
5370 /".+"/
5371 Default:
5373 None, mandatory.
5374 Context:
5376 list (config)
5377 "include_ldap_2level_ca.attrs1"
5379 first-level extracted attribute
5381 Format:
5383 /$ldap_attrdesc/
5384 Default:
5386 None.
5387 Context:
5389 list (config)
5390 "include_ldap_2level_ca.select1"
5392 first-level selection
5394 Format:
5396 "all" - all
5397 "first" - first entry
5398 "regex" - entries matching regular expression
5399 Default:
5400 "first"
5401 Context:
5403 list (config)
5404 "include_ldap_2level_ca.regex1"
5406 first-level regular expression
5408 Format:
5410 /".+"/
5411 Default:
5413 ""
5414 Context:
5416 list (config)
5417 "include_ldap_2level_ca.suffix2"
5419 second-level suffix template
5421 Format:
5423 /".+"/
5424 Default:
5426 None.
5427 Context:
5429 list (config)
5430 "include_ldap_2level_ca.scope2"
5432 second-level search scope
5434 Format:
5436 "base" - base
5437 "one" - one level
5438 "sub" - subtree
5439 Default:
5440 "sub"
5441 Context:
5443 list (config)
5444 "include_ldap_2level_ca.timeout2"
5446 second-level connection timeout
5448 Format:
5450 Number of seconds.
5451 Default:
5453 30 (seconds)
5454 Context:
5456 list (config)
5457 "include_ldap_2level_ca.filter2"
5459 second-level filter template
5461 Format:
5463 /".+"/
5464 Default:
5466 None, mandatory.
5467 Context:
5469 list (config)
5470 "include_ldap_2level_ca.attrs2"
5472 second-level extracted attribute
5474 Format:
5476 /$ldap_attrdesc/
5477 Default:
5479 "mail"
5480 Context:
5482 list (config)
5483 "include_ldap_2level_ca.select2"
5485 second-level selection
5487 Format:
5489 "all" - all
5490 "first" - first entry
5491 "regex" - entries matching regular expression
5492 Default:
5493 "first"
5494 Context:
5496 list (config)
5497 "include_ldap_2level_ca.regex2"
5499 second-level regular expression
5501 Format:
5503 /".+"/
5504 Default:
5506 ""
5507 Context:
5509 list (config)
5510 "include_ldap_2level_ca.email_entry"
5512 Name of email entry
5514 Format:
5516 /"\S+"/
5517 Default:
5519 None, mandatory.
5520 Context:
5522 list (config)
5523 "include_ldap_2level_ca.nosync_time_ranges"
5525 Time ranges when inclusion is not allowed
5527 Format:
5529 /$time_ranges/
5530 Default:
5532 None.
5533 Context:
5535 list (config)
5536 "include_ldap_2level_ca.passwd"
5538 Obsoleted. Use "bind_password".
5540 "include_ldap_2level_ca.use_ssl"
5542 Obsoleted. Use "use_tls".
5544 "include_ldap_2level_ca.user"
5546 Obsoleted. Use "bind_dn".
5548 "include_sql_ca"
5550 (Paragraph) SQL query custom attribute
5552 Multiple occurrences allowed
5554 "include_sql_ca.name"
5556 short name for this source
5558 Format:
5560 /".+"/
5561 Default:
5563 None.
5564 Context:
5566 list (config)
5567 "include_sql_ca.db_type"
5569 database type
5571 Format:
5573 /"\S+"/
5574 Default:
5576 None, mandatory.
5577 Context:
5579 list (config)
5580 "include_sql_ca.db_host"
5582 remote host
5584 Format:
5586 /$host/
5587 Default:
5589 None.
5590 Context:
5592 list (config)
5593 "include_sql_ca.db_port"
5595 database port
5597 Format:
5599 /"\d+"/
5600 Default:
5602 None.
5603 Context:
5605 list (config)
5606 "include_sql_ca.db_name"
5608 database name
5610 Format:
5612 /"\S+"/
5613 Default:
5615 None, mandatory.
5616 Context:
5618 list (config)
5619 "include_sql_ca.db_options"
5621 connection options
5623 Format:
5625 /".+"/
5626 Default:
5628 None.
5629 Context:
5631 list (config)
5632 "include_sql_ca.db_env"
5634 environment variables for database connection
5636 Format:
5638 /"\w+\=\S+(;\w+\=\S+)*"/
5639 Default:
5641 None.
5642 Context:
5644 list (config)
5645 "include_sql_ca.db_user"
5647 remote user
5649 Format:
5651 /"\S+"/
5652 Default:
5654 None, mandatory.
5655 Context:
5657 list (config)
5658 "include_sql_ca.db_passwd"
5660 remote password
5662 Format:
5664 The value to be concealed.
5665 Default:
5667 None.
5668 Context:
5670 list (config)
5671 "include_sql_ca.sql_query"
5673 SQL query
5675 Format:
5677 /$sql_query/
5678 Default:
5680 None, mandatory.
5681 Context:
5683 list (config)
5684 "include_sql_ca.f_dir"
5686 Directory where the database is stored (used for DBD::CSV only)
5688 Format:
5690 /".+"/
5691 Default:
5693 None.
5694 Context:
5696 list (config)
5697 "include_sql_ca.email_entry"
5699 Name of email entry
5701 Format:
5703 /"\S+"/
5704 Default:
5706 None, mandatory.
5707 Context:
5709 list (config)
5710 "include_sql_ca.nosync_time_ranges"
5712 Time ranges when inclusion is not allowed
5714 Format:
5716 /$time_ranges/
5717 Default:
5719 None.
5720 Context:
5722 list (config)
5723 "include_sql_ca.connect_options"
5725 Obsoleted. Use "db_options".
5727 "include_sql_ca.host"
5729 Obsoleted. Use "db_host".
5731 "include_sql_ca.passwd"
5733 Obsoleted. Use "db_passwd".
5735 "include_sql_ca.user"
5737 Obsoleted. Use "db_user".
5739 DKIM/DMARC/ARC
5741 DKIM signature verification and re-signing. It requires an external
5742 module: Mail-DKIM.
5743 ARC seals on forwarded messages. It requires an external module: Mail-
5745 DKIM.
5746 "dkim_add_signature_to"
5748 Which service messages to be signed
5750 Format:
5752 /"(?:list|robot)(?:,(?:list|robot))*"/
5753 Default:
5755 "robot,list"
5756 Context:
5758 domain (robot.conf), site (sympa.conf)
5759 Inserts a DKIM signature to service messages in context of robot, list
5761 or both
5762 "dkim_signer_identity"
5764 The "i=" tag as defined in rfc 4871
5766 Format:
5768 /"\S+"/
5769 Default:
5771 None.
5772 Context:
5774 domain (robot.conf), site (sympa.conf)
5775 Default is null.
5777 "dkim_feature"
5779 Insert DKIM signature to messages sent to the list
5781 Format:
5783 "on" - enabled
5784 "off" - disabled
5785 Default:
5786 "off"
5787 Context:
5789 domain (robot.conf), site (sympa.conf)
5790 If set to "on", Sympa may verify DKIM signatures of incoming messages
5792 and/or insert DKIM signature to outgoing messages.
5793 "dkim_parameters"
5795 (Paragraph) DKIM configuration
5797 Single occurrence
5799 A set of parameters in order to define outgoing DKIM signature
5801 "dkim_parameters.private_key_path"
5803 File path for DKIM private key
5805 Format:
5807 /"\S+"/
5808 Default:
5810 None.
5811 Context:
5813 list (config), domain (robot.conf), site (sympa.conf)
5814 The file must contain a PEM encoded private key
5816 "dkim_parameters.selector"
5818 Selector for DNS lookup of DKIM public key
5820 Format:
5822 /"\S+"/
5823 Default:
5825 None.
5826 Context:
5828 list (config), domain (robot.conf), site (sympa.conf)
5829 The selector is used in order to build the DNS query for public key. It
5831 is up to you to choose the value you want but verify that you can query
5832 the public DKIM key for "<selector>._domainkey.your_domain"
5833 "dkim_parameters.header_list"
5835 Deprecated.
5837 "dkim_parameters.signer_domain"
5839 DKIM "d=" tag, you should probably use the default value
5841 Format:
5843 /"\S+"/
5844 Default:
5846 None.
5847 Context:
5849 list (config), domain (robot.conf), site (sympa.conf)
5850 The DKIM "d=" tag, is the domain of the signing entity. The list domain
5852 MUST be included in the "d=" domain
5853 "dkim_parameters.signer_identity"
5855 DKIM "i=" tag, you should probably leave this parameter empty
5857 Format:
5859 /"\S+"/
5860 Default:
5862 None.
5863 Context:
5865 list (config)
5866 DKIM "i=" tag, you should probably not use this parameter, as
5868 recommended by RFC 4871, default for list brodcasted messages is
5869 i=<listname>-request@<domain>
5870 "dkim_signature_apply_on"
5872 The categories of messages sent to the list that will be signed using
5874 DKIM.
5875 Format:
5877 Multiple values allowed, separated by ",".
5878 "md5_authenticated_messages" - authenticated by password
5880 "smime_authenticated_messages" - authenticated by S/MIME signature
5881 "dkim_authenticated_messages" - authenticated by DKIM signature
5882 "editor_validated_messages" - approved by moderator
5883 "none" - do nothing
5884 "any" - any messages
5885 Default:
5886 "md5_authenticated_messages,smime_authenticated_messages,dkim_authenticated_messages,editor_validated_messages"
5887 Context:
5889 list (config), domain (robot.conf), site (sympa.conf)
5890 This parameter controls in which case messages must be signed using
5892 DKIM, you may sign every message choosing 'any' or a subset. The
5893 parameter value is a comma separated list of keywords
5894 "arc_feature"
5896 Add ARC seals to messages sent to the list
5898 Format:
5900 "on" - enabled
5901 "off" - disabled
5902 Default:
5903 "off"
5904 Context:
5906 list (config), domain (robot.conf), site (sympa.conf)
5907 Enable/Disable ARC. This feature requires Mail::DKIM::ARC to be
5909 installed, and maybe some custom scenario to be updated
5910 "arc_srvid"
5912 SRV ID for Authentication-Results used in ARC seal
5914 Format:
5916 /"\S+"/
5917 Default:
5919 None.
5920 Context:
5922 domain (robot.conf), site (sympa.conf)
5923 Typically the domain of the mail server
5925 "arc_parameters"
5927 (Paragraph) ARC configuration
5929 Single occurrence
5931 A set of parameters in order to define outgoing ARC seal
5933 "arc_parameters.arc_private_key_path"
5935 File path for ARC private key
5937 Format:
5939 /"\S+"/
5940 Default:
5942 None.
5943 Context:
5945 list (config), domain (robot.conf), site (sympa.conf)
5946 The file must contain a PEM encoded private key. Defaults to same file
5948 as DKIM private key
5949 "arc_parameters.arc_selector"
5951 Selector for DNS lookup of ARC public key
5953 Format:
5955 /"\S+"/
5956 Default:
5958 None.
5959 Context:
5961 list (config), domain (robot.conf), site (sympa.conf)
5962 The selector is used in order to build the DNS query for public key. It
5964 is up to you to choose the value you want but verify that you can query
5965 the public DKIM key for "<selector>._domainkey.your_domain". Default is
5966 the same selector as for DKIM signatures
5967 "arc_parameters.arc_signer_domain"
5969 ARC "d=" tag, you should probably use the default value
5971 Format:
5973 /"\S+"/
5974 Default:
5976 None.
5977 Context:
5979 list (config), domain (robot.conf), site (sympa.conf)
5980 The ARC "d=" tag is the domain of the signing entity. The DKIM d=
5982 domain name is used as its default value
5983 "dmarc_protection"
5985 (Paragraph) DMARC Protection
5987 Single occurrence
5989 Parameters to define how to manage From address processing to avoid
5991 some domains' excessive DMARC protection
5992 "dmarc_protection.mode"
5994 Protection modes
5996 Format:
5998 Multiple values allowed, separated by ",".
5999 "none" - do nothing
6001 "all" - all
6002 "dkim_signature" - DKIM signature exists
6003 "dmarc_reject" - DMARC policy suggests rejection
6004 "dmarc_any" - DMARC policy exists
6005 "dmarc_quarantine" - DMARC policy suggests quarantine
6006 "domain_regex" - domain matching regular expression
6007 Default:
6008 None.
6009 Context:
6011 list (config), domain (robot.conf), site (sympa.conf)
6012 Select one or more operation modes. "Domain matching regular
6014 expression" (domain_regex) matches the specified Domain regular
6015 expression; "DKIM signature exists" (dkim_signature) matches any
6016 message with a DKIM signature header; "DMARC policy ..." (dmarc_*)
6017 matches messages from sender domains with a DMARC policy as given;
6018 "all" (all) matches all messages.
6019 Example:
6021 dmarc_protection.mode dmarc_reject,dkim_signature
6023 "dmarc_protection.domain_regex"
6025 Regular expression for domain name match
6027 Format:
6029 /".+"/
6030 Default:
6032 None.
6033 Context:
6035 list (config), domain (robot.conf), site (sympa.conf)
6036 Regular expression match pattern for From domain
6038 "dmarc_protection.other_email"
6040 New From address
6042 Format:
6044 /".+"/
6045 Default:
6047 None.
6048 Context:
6050 list (config), domain (robot.conf), site (sympa.conf)
6051 This is the email address to use when modifying the From header. It
6053 defaults to the list address. This is similar to Anonymisation but
6054 preserves the original sender details in the From address phrase.
6055 "dmarc_protection.phrase"
6057 New From name format
6059 Format:
6061 "display_name" - "Name"
6062 "name_and_email" - "Name" (e-mail)
6063 "name_via_list" - "Name" (via List)
6064 "name_email_via_list" - "Name" (e-mail via List)
6065 "list_for_email" - "List" (on behalf of e-mail)
6066 "list_for_name" - "List" (on behalf of Name)
6067 Default:
6068 "name_via_list"
6069 Context:
6071 list (config), domain (robot.conf), site (sympa.conf)
6072 This is the format to be used for the sender name part of the new From
6074 header field.
6075 List address verification
6077 Checks if an alias with the same name as the list to be created already
6078 exists on the SMTP server. This feature requires an external module:
6079 Net-SMTP.
6080 "list_check_helo"
6082 SMTP HELO (EHLO) parameter used for address verification
6084 Format:
6086 /"\S+"/
6087 Default:
6089 None.
6090 Context:
6092 domain (robot.conf), site (sympa.conf)
6093 Default value is the host part of "list_check_smtp" parameter.
6095 "list_check_smtp"
6097 SMTP server to verify existence of the same addresses as the list to be
6099 created
6100 Format:
6102 /$hostport/
6103 Default:
6105 None.
6106 Context:
6108 domain (robot.conf), site (sympa.conf)
6109 This is needed if you are running Sympa on a host but you handle all
6111 your mail on a separate mail relay.
6112 Default value is real FQDN of the host. Port number may be specified as
6114 "mail.example.org:25" or "203.0.113.1:25". If port is not specified,
6115 standard port (25) will be used.
6116 "list_check_suffixes"
6118 Address suffixes to verify
6120 Format:
6122 /"\S+"/
6123 Default:
6125 "request,owner,editor,unsubscribe,subscribe"
6126 Context:
6128 domain (robot.conf), site (sympa.conf)
6129 List of suffixes you are using for list addresses, i.e. "mylist-
6131 request", "mylist-owner" and so on.
6132 This parameter is used with the "list_check_smtp" parameter. It is also
6134 used to check list names at list creation time.
6135 Antivirus plug-in
6137 "antivirus_path"
6138 Path to the antivirus scanner engine
6140 Format:
6142 /".+"/
6143 Default:
6145 None.
6146 Context:
6148 domain (robot.conf), site (sympa.conf)
6149 Supported antivirus: Clam AntiVirus/clamscan & clamdscan,
6151 McAfee/uvscan, Fsecure/fsav, Sophos, AVP and Trend Micro/VirusWall
6152 Example:
6154 antivirus_path /usr/local/bin/clamscan
6156 "antivirus_args"
6158 Antivirus plugin command line arguments
6160 Format:
6162 /".+"/
6163 Default:
6165 None.
6166 Context:
6168 domain (robot.conf), site (sympa.conf)
6169 Example:
6171 antivirus_args --no-summary --database /usr/local/share/clamav
6173 "antivirus_notify"
6175 Notify sender if virus checker detects malicious content
6177 Format:
6179 "sender" - sender
6180 "delivery_status" - send back DSN
6181 "none" - do nothing
6182 Default:
6183 "sender"
6184 Context:
6186 domain (robot.conf), site (sympa.conf)
6187 "sender" to notify originator of the message, "delivery_status" to send
6189 delivery status, or "none"
6190 Miscellaneous
6192 "email"
6193 Local part of Sympa email address
6195 Format:
6197 /"\S+"/
6198 Default:
6200 "sympa"
6201 Context:
6203 domain (robot.conf), site (sympa.conf)
6204 Local part (the part preceding the "@" sign) of the address by which
6206 mail interface of Sympa accepts mail commands.
6207 If you change the default value, you must modify the mail aliases too.
6209 "listmaster_email"
6211 Local part of listmaster email address
6213 Format:
6215 /"\S+"/
6216 Default:
6218 "listmaster"
6219 Context:
6221 domain (robot.conf), site (sympa.conf)
6222 Local part (the part preceding the "@" sign) of the address by which
6224 listmasters receive messages.
6225 If you change the default value, you must modify the mail aliases too.
6227 "custom_robot_parameter"
6229 Custom robot parameter
6231 Format:
6233 Multiple occurrences allowed.
6234 /".+"/
6236 Default:
6238 None.
6239 Context:
6241 domain (robot.conf), site (sympa.conf)
6242 Used to define a custom parameter for your server. Do not forget the
6244 semicolon between the parameter name and the parameter value.
6245 You will be able to access the custom parameter value in web templates
6247 by variable "conf.custom_robot_parameter.<param_name>"
6248 Example:
6250 custom_robot_parameter param_name ; param_value
6252 "cache_list_config"
6254 Use of binary cache of list configuration
6256 Format:
6258 "binary_file" - use binary file
6259 "none" - do nothing
6260 Default:
6261 "none"
6262 Context:
6264 site (sympa.conf)
6265 binary_file: Sympa processes will maintain a binary version of the list
6267 configuration, "config.bin" file on local disk. If you manage a big
6268 amount of lists (1000+), it should make the web interface startup
6269 faster.
6270 You can recreate cache by running "sympa.pl --reload_list_config".
6272 "db_list_cache"
6274 Use database cache to search lists
6276 Format:
6278 "on" - enabled
6279 "off" - disabled
6280 Default:
6281 "off"
6282 Context:
6284 site (sympa.conf)
6285 Note that "list_table" database table should be filled at the first
6287 time by running:
6288 # sympa.pl --sync_list_db
6290 "purge_user_table_task"
6292 Task for expiring inactive users
6294 Format:
6296 /"\w+"/
6297 Default:
6299 "monthly"
6300 Context:
6302 site (sympa.conf)
6303 This task removes rows in the "user_table" table which have not
6305 corresponding entries in the "subscriber_table" table.
6306 "purge_logs_table_task"
6308 Task for cleaning tables
6310 Format:
6312 /"\w+"/
6313 Default:
6315 "daily"
6316 Context:
6318 site (sympa.conf)
6319 This task cleans old logs from "logs_table" table.
6321 "logs_expiration_period"
6323 Max age of logs in database
6325 Format:
6327 Number of months.
6328 Default:
6330 3 (months)
6331 Context:
6333 site (sympa.conf)
6334 Number of months that elapse before a log is expired
6336 "stats_expiration_period"
6338 Max age of statistics information in database
6340 Format:
6342 Number of months.
6343 Default:
6345 3 (months)
6346 Context:
6348 site (sympa.conf)
6349 Number of months that elapse before statistics information are expired
6351 "umask"
6353 Umask
6355 Format:
6357 /"[0-7]+"/
6358 Default:
6360 027
6361 Context:
6363 site (sympa.conf)
6364 Default mask for file creation (see umask(2)). Note that it will be
6366 interpreted as an octal value.
6367 "clean_delay_queuemod"
6369 Max age of moderated messages
6371 Format:
6373 Number of days.
6374 Default:
6376 30 (days)
6377 Context:
6379 list (config), site (sympa.conf)
6380 Number of days messages are kept in moderation spool (as specified by
6382 "queuemod" parameter). Beyond this deadline, messages that have not
6383 been processed are deleted.
6384 "cookie"
6386 Secret string for generating unique keys
6388 Format:
6390 The value to be concealed.
6391 Default:
6393 None.
6394 Context:
6396 list (config), site (sympa.conf)
6397 This allows generated authentication keys to differ from a site to
6399 another. It is also used for encryption of user passwords stored in the
6400 database. The presence of this string is one reason why access to
6401 "sympa.conf" needs to be restricted to the "sympa" user.
6402 Note that changing this parameter will break all HTTP cookies stored in
6404 users' browsers, as well as all user passwords and lists X509 private
6405 keys. To prevent a catastrophe, Sympa refuses to start if this "cookie"
6406 parameter was changed.
6407 Example:
6409 cookie 123456789
6411 "custom_attribute"
6413 (Paragraph) Custom user attributes
6415 Multiple occurrences allowed
6417 "custom_attribute.id"
6419 internal identifier
6421 Format:
6423 /"\w+"/
6424 Default:
6426 None, mandatory.
6427 Context:
6429 list (config)
6430 "custom_attribute.name"
6432 label
6434 Format:
6436 /".+"/
6437 Default:
6439 None, mandatory.
6440 Context:
6442 list (config)
6443 "custom_attribute.comment"
6445 additional comment
6447 Format:
6449 /".+"/
6450 Default:
6452 None.
6453 Context:
6455 list (config)
6456 "custom_attribute.type"
6458 type
6460 Format:
6462 "string" - string
6463 "text" - multi-line text
6464 "integer" - number
6465 "enum" - set of keywords
6466 Default:
6467 "string"
6468 Context:
6470 list (config)
6471 "custom_attribute.enum_values"
6473 possible attribute values (if enum is used)
6475 Format:
6477 /".+"/
6478 Default:
6480 None.
6481 Context:
6483 list (config)
6484 "custom_attribute.optional"
6486 is the attribute optional?
6488 Format:
6490 "required" - required
6491 "optional" - optional
6492 Default:
6493 "optional"
6494 Context:
6496 list (config)
6497 "custom_vars"
6499 (Paragraph) custom parameters
6501 Multiple occurrences allowed
6503 "custom_vars.name"
6505 var name
6507 Format:
6509 /"\S+"/
6510 Default:
6512 None, mandatory.
6513 Context:
6515 list (config)
6516 "custom_vars.value"
6518 var value
6520 Format:
6522 /".+"/
6523 Default:
6525 None, mandatory.
6526 Context:
6528 list (config)
6529 "loop_prevention_regex"
6531 Regular expression applied to prevent loops with robots
6533 Format:
6535 /"\S*"/
6536 Default:
6538 "mailer-daemon|sympa|listserv|majordomo|smartlist|mailman"
6539 Context:
6541 list (config), domain (robot.conf), site (sympa.conf)
6542 If the sender address matches the regular expression, then the message
6544 is rejected.
6545 "pictures_feature"
6547 Pictures
6549 Format:
6551 "on" - enabled
6552 "off" - disabled
6553 Default:
6554 "on"
6555 Context:
6557 list (config), domain (robot.conf), site (sympa.conf)
6558 Enables or disables the pictures feature by default. If enabled,
6560 subscribers can upload their picture (from the "Subscriber option"
6561 page) to use as an avatar.
6562 Pictures are stored in a directory specified by the
6564 "static_content_path" parameter.
6565 "remind_task"
6567 Periodical subscription reminder task
6569 Format:
6571 /"\w+"/
6572 Default:
6574 None.
6575 Context:
6577 list (config), site (sympa.conf)
6578 This parameter states which model is used to create a remind task. A
6580 remind task regularly sends subscribers a message which reminds them
6581 of their list subscriptions.
6582 "latest_instantiation"
6584 (Paragraph) Latest family instantiation
6586 Single occurrence
6588 "latest_instantiation.email"
6590 who ran the instantiation
6592 Format:
6594 /"listmaster|$email"/
6595 Default:
6597 None.
6598 Context:
6600 list (config)
6601 "latest_instantiation.date_epoch"
6603 date
6605 Format:
6607 The time in second from Unix epoch.
6608 Default:
6610 None, mandatory.
6611 Context:
6613 list (config)
6614 "latest_instantiation.date"
6616 Deprecated.
6618 "creation"
6620 (Paragraph) Creation of the list
6622 Single occurrence
6624 "creation.email"
6626 who created the list
6628 Format:
6630 /"listmaster|$email"/
6631 Default:
6633 None, mandatory.
6634 Context:
6636 list (config)
6637 "creation.date_epoch"
6639 date
6641 Format:
6643 The time in second from Unix epoch.
6644 Default:
6646 None, mandatory.
6647 Context:
6649 list (config)
6650 "creation.date"
6652 Deprecated.
6654 "update"
6656 (Paragraph) Last update of config
6658 Single occurrence
6660 "update.email"
6662 who updated the config
6664 Format:
6666 /"(listmaster|automatic|$email)"/
6667 Default:
6669 None.
6670 Context:
6672 list (config)
6673 "update.date_epoch"
6675 date
6677 Format:
6679 The time in second from Unix epoch.
6680 Default:
6682 None, mandatory.
6683 Context:
6685 list (config)
6686 "update.date"
6688 Deprecated.
6690 "status"
6692 Status of the list
6694 Format:
6696 Status of list.
6697 Default:
6699 "open"
6700 Context:
6702 list (config)
6703 "serial"
6705 Serial number of the config
6707 Format:
6709 /"\d+"/
6710 Default:
6712 0
6713 Context:
6715 list (config)
6716 Web interface parameters
6718 "wwsympa_url"
6719 URL prefix of web interface
6721 Format:
6723 Default:
6724 None.
6725 Context:
6727 domain (robot.conf), site (sympa.conf)
6728 This is used to construct URLs of web interface.
6730 Example:
6732 wwsympa_url https://web.example.org/sympa
6734 "wwsympa_url_local"
6736 URL prefix of WWSympa behind proxy
6738 Format:
6740 Default:
6741 None.
6742 Context:
6744 domain (robot.conf), site (sympa.conf)
6745 "static_content_url"
6747 URL for static contents
6749 Format:
6751 Default:
6752 "/static-sympa"
6753 Context:
6755 domain (robot.conf), site (sympa.conf)
6756 HTTP server have to map it with "static_content_path" directory.
6758 "static_content_path"
6760 Directory for static contents
6762 Format:
6764 Default:
6765 $STATICDIR
6766 Context:
6768 domain (robot.conf), site (sympa.conf)
6769 "css_path"
6771 Directory for static style sheets (CSS)
6773 Format:
6775 Default:
6776 $CSSDIR
6777 Context:
6779 site (sympa.conf)
6780 After an upgrade, static CSS files are upgraded with the newly
6782 installed "css.tt2" template. Therefore, this is not a good place to
6783 store customized CSS files.
6784 "css_url"
6786 URL for style sheets (CSS)
6788 Format:
6790 Default:
6791 "/static-sympa/css"
6792 Context:
6794 site (sympa.conf)
6795 To use auto-generated static CSS, HTTP server have to map it with
6797 "css_path".
6798 "pictures_path"
6800 Directory for subscribers pictures
6802 Format:
6804 Default:
6805 $PICTURESDIR
6806 Context:
6808 site (sympa.conf)
6809 "pictures_url"
6811 URL for subscribers pictures
6813 Format:
6815 Default:
6816 "/static-sympa/pictures"
6817 Context:
6819 site (sympa.conf)
6820 HTTP server have to map it with "pictures_path" directory.
6822 "mhonarc"
6824 Path to MHonArc mail-to-HTML converter
6826 Format:
6828 Default:
6829 "/usr/bin/mhonarc"
6830 Context:
6832 domain (robot.conf), site (sympa.conf)
6833 This is required for HTML mail archiving.
6835 "log_facility"
6837 System log facility for web interface
6839 Format:
6841 Default:
6842 "LOCAL1"
6843 Context:
6845 site (sympa.conf)
6846 System log facility for WWSympa, archived.pl and bounced.pl. Default is
6848 to use value of "syslog" parameter.
6849 Web interface parameters: Appearances
6851 "logo_html_definition"
6852 Custom logo
6854 Format:
6856 Default:
6857 None.
6858 Context:
6860 domain (robot.conf), site (sympa.conf)
6861 HTML fragment to insert a logo in the page of web interface.
6863 Example:
6865 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>
6867 "favicon_url"
6869 Custom favicon
6871 Format:
6873 Default:
6874 None.
6875 Context:
6877 domain (robot.conf), site (sympa.conf)
6878 URL of favicon image
6880 "color_0", ..., "color_15"
6882 Colors for web interface
6884 Format:
6886 Default:
6887 See description on web interface.
6888 Context:
6890 domain (robot.conf), site (sympa.conf)
6891 Colors are used in style sheet (CSS). They may be changed using web
6893 interface by listmasters.
6894 "dark_color", "light_color", "text_color", "bg_color", "error_color",
6896 "selected_color", "shaded_color"
6897 Colors for web interface, obsoleted
6899 Format:
6901 Default:
6902 See description on web interface.
6903 Context:
6905 domain (robot.conf), site (sympa.conf)
6906 "default_home"
6908 Type of main web page
6910 Format:
6912 Default:
6913 "home"
6914 Context:
6916 domain (robot.conf), site (sympa.conf)
6917 "lists" for the page of list of lists. "home" for home page.
6919 "archive_default_index"
6921 Default index organization of web archive
6923 Format:
6925 Default:
6926 "thrd"
6927 Context:
6929 site (sympa.conf)
6930 thrd: Threaded index.
6932 mail: Chronological index.
6934 "review_page_size"
6936 Size of review page
6938 Format:
6940 Default:
6941 25
6942 Context:
6944 domain (robot.conf), site (sympa.conf)
6945 Default number of lines of the array displaying users in the review
6947 page
6948 "viewlogs_page_size"
6950 Size of viewlogs page
6952 Format:
6954 Default:
6955 25
6956 Context:
6958 domain (robot.conf), site (sympa.conf)
6959 Default number of lines of the array displaying the log entries in the
6961 logs page.
6962 "main_menu_custom_button_1_title", ...
6964 "main_menu_custom_button_3_title", "main_menu_custom_button_1_url", ...
6965 "main_menu_custom_button_3_url", "main_menu_custom_button_1_target",
6966 ... "main_menu_custom_button_3_target"
6967 Custom menus
6969 Format:
6971 Default:
6972 None.
6973 Context:
6975 domain (robot.conf), site (sympa.conf)
6976 You may modify the main menu content by editing the menu.tt2 file, but
6978 you can also edit these parameters in order to add up to 3 buttons.
6979 Each button is defined by a title (the text in the button), an URL and,
6980 optionally, a target.
6981 Example:
6983 main_menu_custom_button_1_title FAQ
6985 main_menu_custom_button_1_url http://www.renater.fr/faq/universalistes/index
6986 main_menu_custom_button_1_target Help
6987 Password validation
6989 Checks if the password the user submitted has sufficient strength. This
6990 feature requires an external module: Data-Password.
6991 "password_validation"
6993 Password validation
6995 Format:
6997 Default:
6998 None.
6999 Context:
7001 site (sympa.conf)
7002 The password validation techniques to be used against user passwords
7004 that are added to mailing lists. Options come from Data::Password
7005 (http://search.cpan.org/~razinf/Data-Password-1.07/Password.pm#VARIABLES)
7006 Example:
7008 password_validation MINLEN=8,GROUPS=3,DICTIONARY=4,DICTIONARIES=/pentest/dictionaries
7010 Authentication with LDAP
7012 Authenticates users based on the directory on LDAP server. This feature
7013 requires an external module: Net-LDAP. And also, if secure connection
7014 (LDAPS) is required: IO-Socket-SSL.
7015 "ldap_force_canonical_email"
7017 Use canonical email address for LDAP authentication
7019 Format:
7021 Default:
7022 1
7023 Context:
7025 domain (robot.conf), site (sympa.conf)
7026 When using LDAP authentication, if the identifier provided by the user
7028 was a valid email, if this parameter is set to false, then the provided
7029 email will be used to authenticate the user. Otherwise, use of the
7030 first email returned by the LDAP server will be used.
7031 SOAP HTTP interface
7033 Provides some functions of Sympa through the SOAP HTTP interface. This
7034 feature requires an external module: SOAP-Lite.
7035 "soap_url"
7037 URL of SympaSOAP
7039 Format:
7041 Default:
7042 None.
7043 Context:
7045 domain (robot.conf), site (sympa.conf)
7046 WSDL document of SympaSOAP refers to this URL in its service section.
7048 Example:
7050 soap_url http://web.example.org/sympasoap
7052 "soap_url_local"
7054 URL of SympaSOAP behind proxy
7056 Format:
7058 Default:
7059 None.
7060 Context:
7062 domain (robot.conf), site (sympa.conf)
7063 Web interface parameters: Miscellaneous
7065 "cookie_domain"
7066 HTTP cookies validity domain
7068 Format:
7070 Default:
7071 "localhost"
7072 Context:
7074 domain (robot.conf), site (sympa.conf)
7075 If beginning with a dot ("."), the cookie is available within the
7077 specified Internet domain. Otherwise, for the specified host. The only
7078 reason for replacing the default value would be where WWSympa's
7079 authentication process is shared with an application running on another
7080 host.
7081 Example:
7083 cookie_domain .renater.fr
7085 "cookie_expire"
7087 HTTP cookies lifetime
7089 Format:
7091 Default:
7092 0
7093 Context:
7095 site (sympa.conf)
7096 This is the default value when not set explicitly by users. "0" means
7098 the cookie may be retained during browser sessions.
7099 "cookie_refresh"
7101 Average interval to refresh HTTP session ID.
7103 Format:
7105 Default:
7106 60
7107 Context:
7109 site (sympa.conf)
7110 "purge_session_table_task"
7112 Task for cleaning old sessions
7114 Format:
7116 /"\w+"/
7117 Default:
7119 "daily"
7120 Context:
7122 site (sympa.conf)
7123 This task removes old entries in the "session_table" table.
7125 "session_table_ttl"
7127 Max age of sessions
7129 Format:
7131 Default:
7132 "2d"
7133 Context:
7135 site (sympa.conf)
7136 Session duration is controlled by "sympa_session" cookie validity
7138 attribute. However, by security reason, this delay also need to be
7139 controlled by server side. This task removes old entries in the
7140 "session_table" table.
7141 Format of values is a string without spaces including "y" for years,
7143 "m" for months, "d" for days, "h" for hours, "min" for minutes and
7144 "sec" for seconds.
7145 "anonymous_session_table_ttl"
7147 Max age of sessions for anonymous users
7149 Format:
7151 Default:
7152 "1h"
7153 Context:
7155 site (sympa.conf)
7156 "shared_feature"
7158 Enable shared repository
7160 Format:
7162 "on" - enabled
7163 "off" - disabled
7164 Default:
7165 "off"
7166 Context:
7168 domain (robot.conf), site (sympa.conf)
7169 If set to "on", list owners can open shared repository.
7171 "use_html_editor"
7173 Use HTML editor
7175 Format:
7177 "off" - disabled
7178 "on" - enabled
7179 Default:
7180 "off"
7181 Context:
7183 domain (robot.conf), site (sympa.conf)
7184 If set to "on", users will be able to post messages in HTML using a
7186 javascript WYSIWYG editor.
7187 Example:
7189 use_html_editor on
7191 "html_editor_url"
7193 URL of HTML editor
7195 Format:
7197 Default:
7198 None.
7199 Context:
7201 domain (robot.conf), site (sympa.conf)
7202 URL path to the javascript file making the WYSIWYG HTML editor
7204 available. Relative path under <static_content_url> or absolute path.
7205 Example is for TinyMCE 4 installed under
7207 <static_content_path>/js/tinymce/.
7208 Example:
7210 html_editor_url js/tinymce/tinymce.min.js
7212 "html_editor_init"
7214 HTML editor initialization
7216 Format:
7218 Default:
7219 None.
7220 Context:
7222 domain (robot.conf), site (sympa.conf)
7223 Javascript excerpt that enables and configures the WYSIWYG HTML editor.
7225 Example:
7227 html_editor_init tinymce.init({selector:"#body",language:lang.split(/[^a-zA-Z]+/).join("_")});
7229 "max_wrong_password"
7231 Count limit of wrong password submission
7233 Format:
7235 Default:
7236 19
7237 Context:
7239 domain (robot.conf), site (sympa.conf)
7240 If this limit is reached, the account is locked until the user renews
7242 their password. The default value is chosen in order to block bots
7243 trying to log in using brute force strategy. This value should never be
7244 reached by real users that will probably uses the renew password
7245 service before they performs so many tries.
7246 "password_case"
7248 Password case
7250 Format:
7252 Default:
7253 "insensitive"
7254 Context:
7256 site (sympa.conf)
7257 "insensitive" or "sensitive".
7259 If set to "insensitive", WWSympa's password check will be insensitive.
7261 This only concerns passwords stored in the Sympa database, not the ones
7262 in LDAP.
7263 Should not be changed! May invalid all user password.
7265 "password_hash"
7267 Password hashing algorithm
7269 Format:
7271 Default:
7272 "md5"
7273 Context:
7275 site (sympa.conf)
7276 "md5" or "bcrypt".
7278 If set to "md5", Sympa will use MD5 password hashes. If set to
7280 "bcrypt", bcrypt hashes will be used instead. This only concerns
7281 passwords stored in the Sympa database, not the ones in LDAP.
7282 Should not be changed! May invalid all user passwords.
7284 "password_hash_update"
7286 Update password hashing algorithm when users log in
7288 Format:
7290 Default:
7291 1
7292 Context:
7294 site (sympa.conf)
7295 On successful login, update the encrypted user password to use the
7297 algorithm specified by "password_hash". This allows for a graceful
7298 transition to a new password hash algorithm. A value of 0 disables
7299 updating of existing password hashes. New and reset passwords will use
7300 the "password_hash" setting in all cases.
7301 "bcrypt_cost"
7303 Bcrypt hash cost
7305 Format:
7307 Default:
7308 12
7309 Context:
7311 site (sympa.conf)
7312 When "password_hash" is set to "bcrypt", this sets the "cost" parameter
7314 of the bcrypt hash function. The default of 12 is expected to require
7315 approximately 250ms to calculate the password hash on a 3.2GHz CPU.
7316 This only concerns passwords stored in the Sympa database, not the ones
7317 in LDAP.
7318 Can be changed but any new cost setting will only apply to new
7320 passwords.
7321 "one_time_ticket_lifetime"
7323 Age of one time ticket
7325 Format:
7327 Default:
7328 "2d"
7329 Context:
7331 site (sympa.conf)
7332 Duration before the one time tickets are expired
7334 "one_time_ticket_lockout"
7336 Restrict access to one time ticket
7338 Format:
7340 Default:
7341 "one_time"
7342 Context:
7344 domain (robot.conf), site (sympa.conf)
7345 Is access to the one time ticket restricted, if any users previously
7347 accessed? (one_time | remote_addr | open)
7348 "purge_one_time_ticket_table_task"
7350 Task for expiring old one time tickets
7352 Format:
7354 /"\w+"/
7355 Default:
7357 "daily"
7358 Context:
7360 site (sympa.conf)
7361 "one_time_ticket_table_ttl"
7363 Expiration period of one time ticket
7365 Format:
7367 Default:
7368 "10d"
7369 Context:
7371 site (sympa.conf)
7372 "pictures_max_size"
7374 The maximum size of uploaded picture
7376 Format:
7378 Number of bytes.
7379 Default:
7381 102400 (bytes)
7382 Context:
7384 domain (robot.conf), site (sympa.conf)
7385 "spam_protection"
7387 Protect web interface against spam harvesters
7389 Format:
7391 "at" - replace @ characters
7392 "javascript" - use JavaScript
7393 "none" - do nothing
7394 Default:
7395 "javascript"
7396 Context:
7398 list (config), domain (robot.conf), site (sympa.conf)
7399 There is a need to protect Sympa web sites against spambots which
7401 collect email addresses from public web sites. Various methods are
7402 available in Sympa and you can choose to use them with the
7403 spam_protection and web_archive_spam_protection parameters. Possible
7404 value are:
7405 javascript:
7407 the address is hidden using a javascript. A user who enables javascript
7409 can see a nice mailto address where others have nothing.
7410 at:
7412 the @ char is replaced by the string " AT ".
7414 none:
7416 no protection against spammer.
7418 "reporting_spam_script_path"
7420 Script to report spam
7422 Format:
7424 Default:
7425 None.
7426 Context:
7428 domain (robot.conf), site (sympa.conf)
7429 If set, when a list moderator report undetected spams for list
7431 moderation, this external script is invoked and the message is injected
7432 into standard input of the script.
7433 "domains_blacklist"
7435 Prevent people to subscribe to a list with adresses using these domains
7437 Format:
7439 Default:
7440 None.
7441 Context:
7443 site (sympa.conf)
7444 This parameter is a comma-separated list.
7446 Example:
7448 domains_blacklist example.org,spammer.com
7450 "quiet_subscription"
7452 Quiet subscriptions policy
7454 Format:
7456 "on" - enabled
7457 "optional" - optional
7458 "off" - disabled
7459 Default:
7460 "optional"
7461 Context:
7463 site (sympa.conf)
7464 Global policy for quiet subscriptions: "on" means that subscriptions
7466 will never send a notice to the subscriber, "off" will enforce a notice
7467 sending, and "optional" (default) allows the use of the list policy.
7468 "show_report_abuse"
7470 Add a "Report abuse" link in the side menu of the lists
7472 Format:
7474 "on" - enabled
7475 "off" - disabled
7476 Default:
7477 "off"
7478 Context:
7480 site (sympa.conf)
7481 The link is a mailto link, you can change that by overriding
7483 web_tt2/report_abuse.tt2
7484 "allow_account_deletion"
7486 EXPERIMENTAL! Allow users to delete their account. If enabled, shows a
7488 "delete my account" form in user's preferences page.
7489 Format:
7491 "on" - enabled
7492 "off" - disabled
7493 Default:
7494 "off"
7495 Context:
7497 site (sympa.conf)
7498 Account deletion unsubscribes the users from his/her lists and removes
7500 him/her from lists ownership. It is only available to users using
7501 internal authentication (i.e. no LDAP, no SSO...). See
7502 https://github.com/sympa-community/sympa/issues/300 for details
7503 Renamed parameters
7505 These parameters were renamed. Though older names are still available,
7506 their use is no longer recommended.
7507 "custom-header"
7509 See "custom_header".
7511 "custom-subject"
7513 See "custom_subject".
7515 "forced_reply-to"
7517 See "forced_reply_to".
7519 "forced_replyto"
7521 See "forced_reply_to".
7523 "key_password"
7525 See "key_passwd".
7527 "max-size"
7529 See "max_size".
7531 "merge_feature"
7533 See "personalization_feature".
7535 "reply-to"
7537 See "reply_to".
7539 "replyto"
7541 See "reply_to".
7543 "subscription"
7545 See "subscribe".
7547 "unsubscription"
7549 See "unsubscribe".
7551 Obsoleted sympa.conf parameters
7553 These parameters were used in sympa.conf or robot.conf on Sympa 6.2.56
7554 or earlier and are no longer recommended.
7555 "arc_private_key_path"
7557 See "arc_parameters.arc_private_key_path".
7559 "arc_selector"
7561 See "arc_parameters.arc_selector".
7563 "arc_signer_domain"
7565 See "arc_parameters.arc_signer_domain".
7567 "archive_mail_access"
7569 See "archive.mail_access".
7571 "archive_web_access"
7573 See "archive.web_access".
7575 "bounce_halt_rate"
7577 See "bounce.halt_rate".
7579 "bounce_warn_rate"
7581 See "bounce.warn_rate".
7583 "d_edit"
7585 See "shared_doc.d_edit".
7587 "d_read"
7589 See "shared_doc.d_read".
7591 "default_archive_quota"
7593 See "archive.quota".
7595 "default_bounce_level1_rate"
7597 See "bouncers_level1.rate".
7599 "default_bounce_level2_rate"
7601 See "bouncers_level2.rate".
7603 "default_list_priority"
7605 See "priority".
7607 "default_max_list_members"
7609 See "max_list_members".
7611 "default_remind_task"
7613 See "remind_task".
7615 "default_shared_quota"
7617 See "shared_doc.quota".
7619 "default_sql_fetch_timeout"
7621 See "sql_fetch_timeout".
7623 "default_ttl"
7625 See "ttl".
7627 "dkim_header_list"
7629 See "dkim_parameters.header_list".
7631 "dkim_private_key_path"
7633 See "dkim_parameters.private_key_path".
7635 "dkim_selector"
7637 See "dkim_parameters.selector".
7639 "dkim_signer_domain"
7641 See "dkim_parameters.signer_domain".
7643 "dmarc_protection_domain_regex"
7645 See "dmarc_protection.domain_regex".
7647 "dmarc_protection_mode"
7649 See "dmarc_protection.mode".
7651 "dmarc_protection_other_email"
7653 See "dmarc_protection.other_email".
7655 "dmarc_protection_phrase"
7657 See "dmarc_protection.phrase".
7659 "tracking"
7661 See "tracking.tracking".
7663 "tracking_default_retention_period"
7665 See "tracking.retention_period".
7667 "tracking_delivery_status_notification"
7669 See "tracking.delivery_status_notification".
7671 "tracking_message_disposition_notification"
7673 See "tracking.message_disposition_notification".
7675 Deprecated parameters
7677 These parameters were deprecated. They may not be used anymore.
7678 "account"
7680 "archived_pidfile"
7682 "automatic_list_prefix"
7684 "bounced_pidfile"
7686 "clean_delay_queueother"
7688 "default_distribution_ttl"
7690 "distribution_mode"
7692 "edit_list"
7694 "editor"
7696 "email_gecos"
7698 "expire_task"
7700 "filesystem_encoding"
7702 "forced_reply_to"
7704 "host"
7706 "html_editor_file"
7708 "htmlarea_url"
7710 "http_host"
7712 "include_list"
7714 "ldap_export_connection_timeout"
7716 "ldap_export_dnmanager"
7718 "ldap_export_host"
7720 "ldap_export_name"
7722 "ldap_export_password"
7724 "ldap_export_suffix"
7726 "localedir"
7728 "lock_method"
7730 "log_condition"
7732 "log_module"
7734 "msgcat"
7736 "openssl"
7738 "owner"
7740 "pidfile"
7742 "pidfile_bulk"
7744 "pidfile_creation"
7746 "pidfile_distribute"
7748 "queuedistribute"
7750 "queueexpire"
7752 "reply_to"
7754 "sort"
7756 "task_manager_pidfile"
7758 "tri"
7760 "trusted_ca_options"
7762 "use_fast_cgi"
7764 "user_data_source"
7766 "web_archive"
7768 "web_recode_to"
7770
7772 /etc/sympa/sympa.conf
7773 Sympa main configuration file.
7774 $SYSCONFDIR/<mail domain name>/robot.conf
7776 Configuration specific to each mail domain.
7777 $EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list
7779 name>/config
7780 List main configuration file.
7781
7783 Sympa Administration Manual.
7784 <https://sympa-community.github.io/manual/>.
7785 auth.conf(5), charset.conf(5), crawlers_detection.conf(5),
7787 edit_list.conf(5), ldap_alias_manager.conf(5), nrcpt_by_domain.conf(5),
7788 sympa_scenario(5), topics.conf(5).
77896.2.60 2021-01-04 SYMPA_CONFIG(5)
