1SYMPA_CONFIG(5) sympa 6.2.68 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 /$email/
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 Available versions:
185 6.2a.34 and later.
186 This parameter is used for display name in the "From:" header field for
188 the messages sent by Sympa itself.
189 "legacy_character_support_feature"
191 Support of legacy character set
193 Format:
195 "on" - enabled
196 "off" - disabled
197 Default:
198 "off"
199 Context:
201 site (sympa.conf)
202 If set to "on", enables support of legacy character set according to
204 charset.conf(5) configuration file.
205 In some language environments, legacy encoding (character set) can be
207 preferred for e-mail messages: for example iso-2022-jp in Japanese
208 language.
209 Database related
211 "update_db_field_types"
212 Update database structure
214 Format:
216 "auto" - automatic
217 "off" - disabled
218 Default:
219 "auto"
220 Context:
222 site (sympa.conf)
223 auto: Updates database table structures automatically.
225 However, since version 5.3b.5, Sympa will not shorten field size if it
227 already have been longer than the size defined in database definition.
228 "db_type"
230 Type of the database
232 Format:
234 /"\w+"/
235 Default:
237 "mysql"
238 Context:
240 site (sympa.conf)
241 Possible types are "MySQL", "PostgreSQL", "Oracle" and "SQLite".
243 "db_host"
245 Hostname of the database server
247 Format:
249 /$host/
250 Default:
252 None.
253 Context:
255 site (sympa.conf)
256 With PostgreSQL, you can also use the path to Unix Socket Directory,
258 e.g. "/var/run/postgresql" for connection with Unix domain socket.
259 Example:
261 db_host localhost
263 "db_port"
265 Port of the database server
267 Format:
269 /"[-/\w]+"/
270 Default:
272 None.
273 Context:
275 site (sympa.conf)
276 "db_name"
278 Name of the database
280 Format:
282 /".+"/
283 Default:
285 "sympa"
286 Context:
288 site (sympa.conf)
289 With SQLite, this must be the full path to database file.
291 With Oracle Database, this must be SID, net service name or easy
293 connection identifier (to use net service name, db_host should be set
294 to "none" and HOST, PORT and SERVICE_NAME should be defined in
295 tnsnames.ora file).
296 "db_user"
298 User for the database connection
300 Format:
302 /".+"/
303 Default:
305 None.
306 Context:
308 site (sympa.conf)
309 Example:
311 db_user sympa
313 "db_passwd"
315 Password for the database connection
317 Format:
319 The value to be concealed.
320 Default:
322 None.
323 Context:
325 site (sympa.conf)
326 What ever you use a password or not, you must protect the SQL server
328 (is it not a public internet service ?)
329 Example:
331 db_passwd your_passwd
333 "db_options"
335 Database options
337 Format:
339 /".+"/
340 Default:
342 None.
343 Context:
345 site (sympa.conf)
346 If these options are defined, they will be appended to data source name
348 (DSN) fed to database driver. Check the related DBD documentation to
349 learn about the available options.
350 Example:
352 db_options mysql_read_default_file=/home/joe/my.cnf;mysql_socket=tmp/mysql.sock-test
354 "db_env"
356 Environment variables setting for database
358 Format:
360 /".+"/
361 Default:
363 None.
364 Context:
366 site (sympa.conf)
367 With Oracle Database, this is useful for defining ORACLE_HOME and
369 NLS_LANG.
370 Example:
372 db_env NLS_LANG=American_America.AL32UTF8;ORACLE_HOME=/u01/app/oracle/product/11.2.0/server
374 "db_timeout"
376 Database processing timeout
378 Format:
380 /"\d+"/
381 Default:
383 None.
384 Context:
386 site (sympa.conf)
387 Currently, this parameter may be used for SQLite only.
389 "db_additional_subscriber_fields"
391 Database private extension to subscriber table
393 Format:
395 Multiple values allowed, separated by "","".
396 /".+"/
398 Default:
400 None.
401 Context:
403 site (sympa.conf)
404 Adds more fields to "subscriber_table" table. Sympa recognizes fields
406 defined with this parameter. You will then be able to use them from
407 within templates and scenarios:
408 * for scenarios: [subscriber->field]
410 * for templates: [% subscriber.field %]
412 These fields will also appear in the list members review page and will
414 be editable by the list owner. This parameter is a comma-separated
415 list.
416 You need to extend the database format with these fields
418 Example:
420 db_additional_subscriber_fields billing_delay,subscription_expiration
422 "db_additional_user_fields"
424 Database private extension to user table
426 Format:
428 Multiple values allowed, separated by "","".
429 /".+"/
431 Default:
433 None.
434 Context:
436 site (sympa.conf)
437 Adds more fields to "user_table" table. Sympa recognizes fields defined
439 with this parameter. You will then be able to use them from within
440 templates: [% subscriber.field %]
441 This parameter is a comma-separated list.
443 You need to extend the database format with these fields
445 Example:
447 db_additional_user_fields age,address
449 System log
451 "syslog"
452 System log facility for Sympa
454 Format:
456 /"\S+"/
457 Default:
459 "LOCAL1"
460 Context:
462 site (sympa.conf)
463 Do not forget to configure syslog server.
465 "log_socket_type"
467 Communication mode with syslog server
469 Format:
471 /"\w+"/
472 Default:
474 "unix"
475 Context:
477 site (sympa.conf)
478 "log_level"
480 Log verbosity
482 Format:
484 /"\d+"/
485 Default:
487 0
488 Context:
490 domain (robot.conf), site (sympa.conf)
491 Sets the verbosity of logs.
493 0: Only main operations are logged
495 3: Almost everything is logged.
497 Example:
499 log_level 2
501 Mail server
503 "sendmail"
504 Path to sendmail
506 Format:
508 /".+"/
509 Default:
511 "/usr/sbin/sendmail"
512 Context:
514 site (sympa.conf)
515 Absolute path to sendmail command line utility (e.g.: a binary named
517 "sendmail" is distributed with Postfix).
518 Sympa expects this binary to be sendmail compatible (exim, Postfix,
520 qmail and so on provide it).
521 "sendmail_args"
523 Command line parameters passed to sendmail
525 Format:
527 /".+"/
528 Default:
530 "-oi -odi -oem"
531 Context:
533 site (sympa.conf)
534 Note that "-f", "-N" and "-V" options and recipient addresses should
536 not be included, because they will be included by Sympa.
537 "sendmail_aliases"
539 Path of the file that contains all list related aliases
541 Format:
543 /".+"/
544 Default:
546 $SENDMAIL_ALIASES
547 Context:
549 domain (robot.conf), site (sympa.conf)
550 It is recommended to create a specific alias file so that Sympa never
552 overwrites the standard alias file, but only a dedicated file.
553 Set this parameter to "none" if you want to disable alias management in
555 Sympa.
556 "aliases_program"
558 Program used to update alias database
560 Format:
562 /"makemap|newaliases|postalias|postmap|/.+|none"/
563 Default:
565 "newaliases"
566 Context:
568 domain (robot.conf), site (sympa.conf)
569 This may be "makemap", "newaliases", "postalias", "postmap" or full
571 path to custom program.
572 "aliases_wrapper"
574 Whether to use the alias wrapper
576 Format:
578 "off" - disabled
579 "on" - enabled
580 Default:
581 "on"
582 Context:
584 domain (robot.conf), site (sympa.conf)
585 Available versions:
587 6.2.59b.1 and later.
588 If the program to update alias database does not require root
590 privileges, set this parameter to "off" and remove the wrapper file
591 sympa_newaliases-wrapper.
592 "aliases_db_type"
594 Type of alias database
596 Format:
598 /"\w[-\w]*"/
599 Default:
601 "hash"
602 Context:
604 domain (robot.conf), site (sympa.conf)
605 "btree", "dbm", "hash" and so on. Available when aliases_program is
607 "makemap", "postalias" or "postmap"
608 "alias_manager"
610 Path to alias manager
612 Format:
614 /".+"/
615 Default:
617 "$SBINDIR/alias_manager.pl"
618 Context:
620 site (sympa.conf)
621 The absolute path to the script that will add/remove mail aliases
623 Example:
625 alias_manager /usr/local/libexec/ldap_alias_manager.pl
627 List definition
629 "subject"
630 Subject of the list
632 Format:
634 /".+"/
635 Default:
637 None, mandatory.
638 Context:
640 list (config)
641 This parameter indicates the subject of the list, which is sent in
643 response to the LISTS mail command. The subject is a free form text
644 limited to one line.
645 "visibility"
647 Visibility of the list
649 Format:
651 Name of "visibility" scenario:
652 "conceal" - conceal except for subscribers
654 "noconceal" - no conceal
655 "secret" - conceal even for subscribers
656 Default:
657 "conceal"
658 Context:
660 list (config), domain (robot.conf), site (sympa.conf)
661 This parameter indicates whether the list should feature in the output
663 generated in response to a LISTS command or should be shown in the list
664 overview of the web-interface.
665 "topics"
667 Topics for the list
669 Format:
671 Multiple values allowed, separated by "","".
672 List topic.
674 Default:
676 None.
677 Context:
679 list (config)
680 This parameter allows the classification of lists. You may define
682 multiple topics as well as hierarchical ones. WWSympa's list of public
683 lists uses this parameter.
684 "lang"
686 Language of the list
688 Format:
690 Language tag.
691 Default:
693 "en-US"
694 Context:
696 list (config), domain (robot.conf), site (sympa.conf)
697 This parameter defines the language used for the list. It is used to
699 initialize a user's language preference; Sympa command reports are
700 extracted from the associated message catalog.
701 "family_name"
703 Family name
705 Format:
707 /$family_name/
708 Default:
710 None.
711 Context:
713 list (config)
714 "max_list_members"
716 Maximum number of list members
718 Format:
720 Number of list members.
721 Default:
723 0 (list members)
724 Context:
726 list (config), domain (robot.conf), site (sympa.conf)
727 Available versions:
729 6.2a.5 and later.
730 limit for the number of subscribers. 0 means no limit.
732 "priority"
734 Priority
736 Format:
738 0 - 0 - highest priority
739 1 - 1
740 2 - 2
741 3 - 3
742 4 - 4
743 5 - 5
744 6 - 6
745 7 - 7
746 8 - 8
747 9 - 9 - lowest priority
748 "z" - queue messages only
749 Default:
750 5
751 Context:
753 list (config), domain (robot.conf), site (sympa.conf)
754 The priority with which Sympa will process messages for this list. This
756 level of priority is applied while the message is going through the
757 spool. The z priority will freeze the message in the spool.
758 Receiving
760 "sender_headers"
761 Header field name(s) used to determine sender of the messages
763 Format:
765 Any.
766 Default:
768 "From"
769 Context:
771 site (sympa.conf)
772 "Return-Path" means envelope sender (a.k.a. "UNIX From") which will be
774 alternative to sender of messages without "From" field. "Resent-From"
775 may also be inserted before "From", because some mailers add it into
776 redirected messages and keep original "From" field intact. In
777 particular cases, "Return-Path" can not give right sender: Several mail
778 gateway products rewrite envelope sender and add original one as non-
779 standard field such as "X-Envelope-From". If that is the case, you
780 might want to insert it in place of "Return-Path".
781 Example:
783 sender_headers Resent-From,From,Return-Path
785 "misaddressed_commands"
787 Reject misaddressed commands
789 Format:
791 Any.
792 Default:
794 "reject"
795 Context:
797 site (sympa.conf)
798 When a mail command is sent to a list, by default Sympa rejects this
800 message. This feature can be turned off by setting this parameter to
801 "ignore".
802 "misaddressed_commands_regexp"
804 Regular expression matching with misaddressed commands
806 Format:
808 Any.
809 Default:
811 "((subscribe\s+(\S+)|unsubscribe\s+(\S+)|signoff\s+(\S+)|set\s+(\S+)\s+(mail|nomail|digest))\s*)"
812 Context:
814 site (sympa.conf)
815 Perl regular expression applied on messages subject and body to detect
817 misaddressed commands.
818 "sympa_priority"
820 Priority for command messages
822 Format:
824 0 - 0 - highest priority
825 1 - 1
826 2 - 2
827 3 - 3
828 4 - 4
829 5 - 5
830 6 - 6
831 7 - 7
832 8 - 8
833 9 - 9 - lowest priority
834 "z" - queue messages only
835 Default:
836 1
837 Context:
839 domain (robot.conf), site (sympa.conf)
840 Priority applied to messages sent to Sympa command address.
842 "request_priority"
844 Priority for messages bound for list owners
846 Format:
848 0 - 0 - highest priority
849 1 - 1
850 2 - 2
851 3 - 3
852 4 - 4
853 5 - 5
854 6 - 6
855 7 - 7
856 8 - 8
857 9 - 9 - lowest priority
858 "z" - queue messages only
859 Default:
860 0
861 Context:
863 domain (robot.conf), site (sympa.conf)
864 Priority for processing of messages bound for "LIST-request" address,
866 i.e. owners of the list
867 "owner_priority"
869 Priority for non-VERP bounces
871 Format:
873 0 - 0 - highest priority
874 1 - 1
875 2 - 2
876 3 - 3
877 4 - 4
878 5 - 5
879 6 - 6
880 7 - 7
881 8 - 8
882 9 - 9 - lowest priority
883 "z" - queue messages only
884 Default:
885 9
886 Context:
888 domain (robot.conf), site (sympa.conf)
889 Priority for processing of messages bound for "LIST-owner" address,
891 i.e. non-delivery reports (bounces).
892 "incoming_max_count"
894 Max number of sympa.pl workers
896 Format:
898 /"\d+"/
899 Default:
901 1
902 Context:
904 site (sympa.conf)
905 Available versions:
907 6.2b.5 and later.
908 Max number of workers of sympa.pl daemon processing incoming spool.
910 "sleep"
912 Interval between scanning incoming message spool
914 Format:
916 Number of seconds.
917 Default:
919 5 (seconds)
920 Context:
922 site (sympa.conf)
923 Must not be 0.
925 Sending/receiving setup
927 "send"
928 Who can send messages
930 Format:
932 Name of "send" scenario:
933 "closed" - closed
935 "confidential" - restricted to subscribers, messages from others
936 are discarded
937 "editordkim" - Moderated, no authentication needed if DKIM
938 signature from moderator is OK
939 "editorkey" - Moderated
940 "editorkeyonly" - Moderated, even for moderators
941 "editorkeyonlyauth" - Moderated, need authentication from moderator
942 "newsletter" - Newsletter, restricted to moderators
943 "newsletterkeyonly" - Newsletter, restricted to moderators after
944 confirmation
945 "owner" - Restricted to list owners only
946 "ownerauth" - Restricted to list owners with previous MD5
947 authentication
948 "private" - restricted to subscribers
949 "private_smime" - restricted to subscribers and checked smime
950 signature
951 "privateandeditorkey" - Moderated, restricted to subscribers
952 "privateandnomultipartoreditorkey" - Moderated, for non subscribers
953 sending multipart messages
954 "privatekey" - restricted to subscribers with previous md5
955 authentication
956 "privatekeyandeditorkeyonly" - Moderated, for subscribers and even
957 moderators themself
958 "privateoreditorkey" - Private, moderated for non subscribers
959 "privateorpublickey" - Private, confirmation for non subscribers
960 "public" - public list
961 "public_nobcc" - public list, Bcc rejected (anti-spam)
962 "publickey" - anyone no authentication if DKIM signature is OK
963 "publicnoattachment" - public list multipart/mixed messages are
964 forwarded to moderator
965 "publicnomultipart" - public list multipart messages are rejected
966 Default:
967 "private"
968 Context:
970 list (config), domain (robot.conf), site (sympa.conf)
971 This parameter specifies who can send messages to the list.
973 "delivery_time"
975 Delivery time (hh:mm)
977 Format:
979 /"[0-2]?\d\:[0-6]\d"/
980 Default:
982 None.
983 Context:
985 list (config)
986 If this parameter is present, non-digest messages will be delivered to
988 subscribers at this time: When this time has been past, delivery is
989 postponed to the same time in next day.
990 "digest"
992 (Paragraph) Digest frequency
994 Single occurrence
996 Definition of digest mode. If this parameter is present, subscribers
998 can select the option of receiving messages in multipart/digest MIME
999 format, or as a plain text digest. Messages are then grouped together,
1000 and compiled messages are sent to subscribers according to the
1001 frequency selected with this parameter.
1002 "digest.days"
1004 days
1006 Format:
1008 Multiple occurrences allowed.
1009 Day of week, 0 - 6.
1011 Default:
1013 None, mandatory.
1014 Context:
1016 list (config)
1017 "digest.hour"
1019 hour
1021 Format:
1023 /"\d+"/
1024 Default:
1026 None, mandatory.
1027 Context:
1029 list (config)
1030 "digest.minute"
1032 minute
1034 Format:
1036 /"\d+"/
1037 Default:
1039 None, mandatory.
1040 Context:
1042 list (config)
1043 "digest_max_size"
1045 Digest maximum number of messages
1047 Format:
1049 Number of messages.
1050 Default:
1052 25 (messages)
1053 Context:
1055 list (config)
1056 "available_user_options"
1058 (Paragraph) Available subscription options
1060 Single occurrence
1062 "available_user_options.reception"
1064 reception mode
1066 Format:
1068 Multiple values allowed, separated by "","".
1069 Reception mode of list member.
1071 Default:
1073 "mail,notice,digest,digestplain,summary,nomail,txt,urlize,not_me"
1074 Context:
1076 list (config)
1077 Only these modes will be allowed for the subscribers of this list. If a
1079 subscriber has a reception mode not in the list, Sympa uses the mode
1080 specified in the default_user_options paragraph.
1081 "default_user_options"
1083 (Paragraph) Subscription profile
1085 Single occurrence
1087 Default profile for the subscribers of the list.
1089 "default_user_options.reception"
1091 reception mode
1093 Format:
1095 Reception mode of list member.
1096 Default:
1098 "mail"
1099 Context:
1101 list (config)
1102 Mail reception mode.
1104 "default_user_options.visibility"
1106 visibility
1108 Format:
1110 Visibility mode of list memeber.
1111 Default:
1113 "noconceal"
1114 Context:
1116 list (config)
1117 Visibility of the subscriber.
1119 "default_owner_options"
1121 (Paragraph) Owner profile
1123 Single occurrence
1125 Default profile for the owners of the list.
1127 "default_owner_options.profile"
1129 profile
1131 Format:
1133 "privileged" - privileged owner
1134 "normal" - normal owner
1135 Default:
1136 "normal"
1137 Context:
1139 list (config), domain (robot.conf), site (sympa.conf)
1140 "default_owner_options.reception"
1142 reception mode
1144 Format:
1146 Reception mode of list member.
1147 Default:
1149 "mail"
1150 Context:
1152 list (config), domain (robot.conf), site (sympa.conf)
1153 Mail reception mode.
1155 "default_owner_options.visibility"
1157 visibility
1159 Format:
1161 Visibility mode of list memeber.
1162 Default:
1164 "noconceal"
1165 Context:
1167 list (config), domain (robot.conf), site (sympa.conf)
1168 Visibility of the owner.
1170 "default_editor_options"
1172 (Paragraph) Moderator profile
1174 Single occurrence
1176 Default profile for the moderators of the list.
1178 "default_editor_options.reception"
1180 reception mode
1182 Format:
1184 Reception mode of list member.
1185 Default:
1187 "mail"
1188 Context:
1190 list (config), domain (robot.conf), site (sympa.conf)
1191 Mail reception mode.
1193 "default_editor_options.visibility"
1195 visibility
1197 Format:
1199 Visibility mode of list memeber.
1200 Default:
1202 "noconceal"
1203 Context:
1205 list (config), domain (robot.conf), site (sympa.conf)
1206 Visibility of the moderator.
1208 "msg_topic"
1210 (Paragraph) Topics for message categorization
1212 Multiple occurrences allowed
1214 This paragraph defines a topic used to tag a message of a list, named
1216 by msg_topic.name ("other" is a reserved word), its title is
1217 msg_topic.title. The msg_topic.keywords entry is optional and allows
1218 automatic tagging. This should be a list of keywords, separated by ','.
1219 "msg_topic.name"
1221 Message topic name
1223 Format:
1225 /"[\-\w]+"/
1226 Default:
1228 None, mandatory.
1229 Context:
1231 list (config)
1232 "msg_topic.keywords"
1234 Message topic keywords
1236 Format:
1238 /"[^,\n]+(,[^,\n]+)*"/
1239 Default:
1241 None.
1242 Context:
1244 list (config)
1245 "msg_topic.title"
1247 Message topic title
1249 Format:
1251 /".+"/
1252 Default:
1254 None, mandatory.
1255 Context:
1257 list (config)
1258 "msg_topic_keywords_apply_on"
1260 Defines to which part of messages topic keywords are applied
1262 Format:
1264 "subject" - subject field
1265 "body" - message body
1266 "subject_and_body" - subject and body
1267 Default:
1268 "subject"
1269 Context:
1271 list (config)
1272 This parameter indicates which part of the message is used to perform
1274 automatic tagging.
1275 "msg_topic_tagging"
1277 Message tagging
1279 Format:
1281 "required_sender" - required to post message
1282 "required_moderator" - required to distribute message
1283 "optional" - optional
1284 Default:
1285 "optional"
1286 Context:
1288 list (config)
1289 This parameter indicates if the tagging is optional or required for a
1291 list.
1292 "reply_to_header"
1294 (Paragraph) Reply address
1296 Single occurrence
1298 This defines what Sympa will place in the Reply-To: SMTP header field
1300 of the messages it distributes.
1301 "reply_to_header.value"
1303 value
1305 Format:
1307 "sender" - sender
1308 "list" - list
1309 "all" - all
1310 "other_email" - other email address
1311 Default:
1312 "sender"
1313 Context:
1315 list (config)
1316 This parameter indicates whether the Reply-To: field should indicate
1318 the sender of the message (sender), the list itself (list), both list
1319 and sender (all) or an arbitrary e-mail address (defined by the
1320 other_email parameter).
1321 Note: it is inadvisable to change this parameter, and particularly
1323 inadvisable to set it to list. Experience has shown it to be almost
1324 inevitable that users, mistakenly believing that they are replying only
1325 to the sender, will send private messages to a list. This can lead, at
1326 the very least, to embarrassment, and sometimes to more serious
1327 consequences.
1328 "reply_to_header.other_email"
1330 other email address
1332 Format:
1334 /$email/
1335 Default:
1337 None.
1338 Context:
1340 list (config)
1341 If value was set to other_email, this parameter defines the e-mail
1343 address used.
1344 "reply_to_header.apply"
1346 respect of existing header field
1348 Format:
1350 "forced" - overwrite Reply-To: header field
1351 "respect" - preserve existing header field
1352 Default:
1353 "respect"
1354 Context:
1356 list (config)
1357 The default is to respect (preserve) the existing Reply-To: SMTP header
1359 field in incoming messages. If set to forced, Reply-To: SMTP header
1360 field will be overwritten.
1361 "anonymous_sender"
1363 Anonymous sender
1365 Format:
1367 /".+"/
1368 Default:
1370 None.
1371 Context:
1373 list (config)
1374 To hide the sender's email address before distributing the message. It
1376 is replaced by the provided email address.
1377 "anonymous_header_fields"
1379 Header fields removed when a mailing list is setup in anonymous mode
1381 Format:
1383 Any.
1384 Default:
1386 "Authentication-Results,Disposition-Notification-To,DKIM-Signature,Fax,Injection-Info,Mailer,Organisation,Organization,Original-Recipient,Originating-Client,Originator,Path,Phone,Received,Received-SPF,Reply-To,Resent-Reply-To,Return-Receipt-To,Telefax,User-Agent,X-Envelope-From,X-Envelope-To,X-Face,X-Mailer,X-MimeOLE,X-Newsreader,X-Sender,X-X-Sender"
1387 Context:
1389 site (sympa.conf)
1390 See "anonymous_sender" list parameter.
1392 Default value prior to Sympa 6.1.19 is:
1394 Sender,X-Sender,Received,Message-id,From,X-Envelope-To,Resent-From,Reply-To,Organization,Disposition-Notification-To,X-Envelope-From,X-X-Sender
1396 "custom_header"
1398 Custom header field
1400 Format:
1402 Multiple occurrences allowed.
1403 /"\S+:\s+.*"/
1405 Default:
1407 None.
1408 Context:
1410 list (config)
1411 This parameter is optional. The headers specified will be added to the
1413 headers of messages distributed via the list. As of release 1.2.2 of
1414 Sympa, it is possible to put several custom header lines in the
1415 configuration file at the same time.
1416 "custom_subject"
1418 Subject tagging
1420 Format:
1422 /".+"/
1423 Default:
1425 None.
1426 Context:
1428 list (config)
1429 This parameter is optional. It specifies a string which is added to the
1431 subject of distributed messages (intended to help users who do not use
1432 automatic tools to sort incoming messages). This string will be
1433 surrounded by [] characters.
1434 "footer_type"
1436 Attachment type
1438 Format:
1440 "mime" - add a new MIME part
1441 "append" - append to message body
1442 Default:
1443 "mime"
1444 Context:
1446 list (config)
1447 List owners may decide to add message headers or footers to messages
1449 sent via the list. This parameter defines the way a footer/header is
1450 added to a message.
1451 mime:
1453 The default value. Sympa will add the footer/header as a new MIME part.
1455 append:
1457 Sympa will not create new MIME parts, but will try to append the
1459 header/footer to the body of the message. Predefined message-footers
1460 will be ignored.
1461 "max_size"
1463 Maximum message size
1465 Format:
1467 Number of bytes.
1468 Default:
1470 5242880 (bytes)
1471 Context:
1473 list (config), domain (robot.conf), host
1474 Maximum size of a message in 8-bit bytes.
1476 Example:
1478 max_size 2097152
1480 "personalization_feature"
1482 Allow message personalization
1484 Format:
1486 "on" - enabled
1487 "off" - disabled
1488 Default:
1489 "off"
1490 Context:
1492 list (config), domain (robot.conf), site (sympa.conf)
1493 Available versions:
1495 6.2.59b.2 and later.
1496 "personalization"
1498 (Paragraph) Message personalization
1500 Single occurrence
1502 "personalization.web_apply_on"
1504 Scope for messages from the web interface
1506 Format:
1508 "none" - do nothing
1509 "footer" - header and footer
1510 "all" - all
1511 Default:
1512 "footer"
1513 Context:
1515 list (config), domain (robot.conf), site (sympa.conf)
1516 "personalization.mail_apply_on"
1518 Scope for messages from incoming email
1520 Format:
1522 "none" - do nothing
1523 "footer" - header and footer
1524 "all" - all
1525 Default:
1526 "none"
1527 Context:
1529 list (config), domain (robot.conf), site (sympa.conf)
1530 "message_hook"
1532 (Paragraph) Hook modules for message processing
1534 Single occurrence
1536 "message_hook.pre_distribute"
1538 A hook on the messages before distribution
1540 Format:
1542 /"(::|\w)+"/
1543 Default:
1545 None.
1546 Context:
1548 list (config)
1549 "message_hook.post_archive"
1551 A hook on the messages just after archiving
1553 Format:
1555 /"(::|\w)+"/
1556 Default:
1558 None.
1559 Context:
1561 list (config)
1562 "reject_mail_from_automates_feature"
1564 Reject mail from automatic processes (crontab, etc)?
1566 Format:
1568 "on" - enabled
1569 "off" - disabled
1570 Default:
1571 "on"
1572 Context:
1574 list (config), site (sympa.conf)
1575 Available versions:
1577 6.2a.0 and later.
1578 Rejects messages that seem to be from automated services, based on a
1580 few header fields ("Content-Identifier:", "Auto-Submitted:").
1581 Sympa also can be configured to reject messages based on the "From:"
1583 header field value (see "loop_prevention_regex").
1584 "remove_headers"
1586 Header fields to be removed from incoming messages
1588 Format:
1590 Multiple values allowed, separated by "","".
1591 /"\S+"/
1593 Default:
1595 "X-Sympa-To,X-Family-To,Return-Receipt-To,Precedence,X-Sequence,Disposition-Notification-To,Sender"
1596 Context:
1598 list (config), site (sympa.conf)
1599 Use it, for example, to ensure some privacy for your users in case that
1601 "anonymous_sender" mode is inappropriate.
1602 The removal of these header fields is applied before Sympa adds its own
1604 header fields ("rfc2369_header_fields" and "custom_header").
1605 Example:
1607 remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To
1609 "remove_outgoing_headers"
1611 Header fields to be removed before message distribution
1613 Format:
1615 Multiple values allowed, separated by "","".
1616 /"\S+"/
1618 Default:
1620 "none"
1621 Context:
1623 list (config), site (sympa.conf)
1624 The removal happens after Sympa's own header fields are added;
1626 therefore, it is a convenient way to remove Sympa's own header fields
1627 (like "X-Loop:" or "X-no-archive:") if you wish.
1628 Example:
1630 remove_outgoing_headers X-no-archive
1632 "rfc2369_header_fields"
1634 RFC 2369 header fields
1636 Format:
1638 Multiple values allowed, separated by "","".
1639 "help" - help
1641 "subscribe" - subscription
1642 "unsubscribe" - unsubscription
1643 "post" - posting address
1644 "owner" - owner
1645 "archive" - list archive
1646 Default:
1647 "help,subscribe,unsubscribe,post,owner,archive"
1648 Context:
1650 list (config), site (sympa.conf)
1651 Specify which RFC 2369 mailing list header fields to be added.
1653 "List-Id:" header field defined in RFC 2919 is always added. Sympa also
1655 adds "Archived-At:" header field defined in RFC 5064.
1656 Distribution
1658 "urlize_min_size"
1659 Minimum size to be urlized
1661 Format:
1663 Number of bytes.
1664 Default:
1666 10240 (bytes)
1667 Context:
1669 domain (robot.conf), site (sympa.conf)
1670 When a subscriber chose "urlize" reception mode, attachments not
1672 smaller than this size will be urlized.
1673 "allowed_external_origin"
1675 Allowed external links in sanitized HTML
1677 Format:
1679 /"[-\w*]+(?:[.][-\w*]+)+"/
1680 Default:
1682 None.
1683 Context:
1685 domain (robot.conf), site (sympa.conf)
1686 Available versions:
1688 6.2.19b.2 and later.
1689 When the HTML content of a message must be sanitized, links ("href" or
1691 "src" attributes) with the hosts listed in this parameter will not be
1692 scrubbed. If "*" character is included, it matches any subdomains.
1693 Single "*" allows any hosts.
1694 Example:
1696 allowed_external_origin *.example.org,www.example.com
1698 "sympa_packet_priority"
1700 Default priority for a packet
1702 Format:
1704 0 - 0 - highest priority
1705 1 - 1
1706 2 - 2
1707 3 - 3
1708 4 - 4
1709 5 - 5
1710 6 - 6
1711 7 - 7
1712 8 - 8
1713 9 - 9 - lowest priority
1714 "z" - queue messages only
1715 Default:
1716 5
1717 Context:
1719 domain (robot.conf), site (sympa.conf)
1720 The default priority set to a packet to be sent by the bulk.
1722 "bulk_fork_threshold"
1724 Fork threshold of bulk daemon
1726 Format:
1728 /"\d+"/
1729 Default:
1731 1
1732 Context:
1734 site (sympa.conf)
1735 The minimum number of packets before bulk daemon forks a new worker to
1737 increase sending rate.
1738 "bulk_max_count"
1740 Maximum number of bulk workers
1742 Format:
1744 /"\d+"/
1745 Default:
1747 3
1748 Context:
1750 site (sympa.conf)
1751 "bulk_lazytime"
1753 Idle timeout of bulk workers
1755 Format:
1757 Number of seconds.
1758 Default:
1760 600 (seconds)
1761 Context:
1763 site (sympa.conf)
1764 The number of seconds a bulk worker will remain running without
1766 processing a message before it spontaneously exits.
1767 "bulk_sleep"
1769 Sleep time of bulk workers
1771 Format:
1773 Number of seconds.
1774 Default:
1776 1 (seconds)
1777 Context:
1779 site (sympa.conf)
1780 The number of seconds a bulk worker sleeps between starting a new loop
1782 if it didn't find a message to send.
1783 Keep it small if you want your server to be reactive.
1785 "bulk_wait_to_fork"
1787 Interval between checks of packet numbers
1789 Format:
1791 Number of seconds.
1792 Default:
1794 10 (seconds)
1795 Context:
1797 site (sympa.conf)
1798 Number of seconds a master bulk daemon waits between two packets number
1800 checks.
1801 Keep it small if you expect brutal increases in the message sending
1803 load.
1804 "log_smtp"
1806 Log invocation of sendmail
1808 Format:
1810 "on" - enabled
1811 "off" - disabled
1812 Default:
1813 "off"
1814 Context:
1816 domain (robot.conf), site (sympa.conf)
1817 This can be overwritten by "-m" option for sympa.pl.
1819 "maxsmtp"
1821 Maximum number of sendmail processes
1823 Format:
1825 /"\d+"/
1826 Default:
1828 40
1829 Context:
1831 site (sympa.conf)
1832 Maximum number of simultaneous child processes spawned by Sympa. This
1834 is the main load control parameter.
1835 Proposed value is quite low, but you can rise it up to 100, 200 or even
1837 300 with powerful systems.
1838 Example:
1840 maxsmtp 500
1842 "nrcpt"
1844 Maximum number of recipients per call to sendmail
1846 Format:
1848 /"\d+"/
1849 Default:
1851 25
1852 Context:
1854 site (sympa.conf)
1855 This grouping factor makes it possible for the sendmail processes to
1857 optimize the number of SMTP sessions for message distribution. If
1858 needed, you can limit the number of recipients for a particular domain.
1859 Check the "nrcpt_by_domain.conf" configuration file.
1860 "avg"
1862 Maximum number of different mail domains per call to sendmail
1864 Format:
1866 /"\d+"/
1867 Default:
1869 10
1870 Context:
1872 site (sympa.conf)
1873 Privileges
1875 "create_list"
1876 Who is able to create lists
1878 Format:
1880 Name of "create_list" scenario:
1881 "listmaster" - restricted to listmaster
1883 "public_listmaster" - anybody by validation by listmaster required
1884 Default:
1885 "public_listmaster"
1886 Context:
1888 domain (robot.conf), site (sympa.conf)
1889 Defines who can create lists (or request list creation) by creating new
1891 lists or by renaming or copying existing lists.
1892 Example:
1894 create_list listmaster
1896 "allow_subscribe_if_pending"
1898 Allow adding subscribers to a list not open
1900 Format:
1902 "on" - enabled
1903 "off" - disabled
1904 Default:
1905 "on"
1906 Context:
1908 domain (robot.conf), site (sympa.conf)
1909 If set to "off", adding subscribers to, or removing subscribers from a
1911 list with status other than "open" is forbidden.
1912 "global_remind"
1914 Who is able to send remind messages over all lists
1916 Format:
1918 Name of "global_remind" scenario:
1919 "listmaster" - only for listmaster
1921 Default:
1922 "listmaster"
1923 Context:
1925 site (sympa.conf)
1926 "move_user"
1928 Who is able to change user's email
1930 Format:
1932 Name of "move_user" scenario:
1933 "auth" - need authentication
1935 "closed" - impossible
1936 "listmaster" - listmaster only
1937 Default:
1938 "auth"
1939 Context:
1941 domain (robot.conf), site (sympa.conf)
1942 Available versions:
1944 6.2.19b.1 and later.
1945 "use_blocklist"
1947 Use blocklist
1949 Format:
1951 /"[-.\w]+"/
1952 Default:
1954 "send,create_list"
1955 Context:
1957 domain (robot.conf), site (sympa.conf)
1958 Available versions:
1960 6.2.61b.1 and later.
1961 List of operations separated by comma for which blocklist filter is
1963 applied. Setting this parameter to "none" will hide the blocklist
1964 feature.
1965 "info"
1967 Who can view list information
1969 Format:
1971 Name of "info" scenario:
1972 "conceal" - restricted to subscribers - Silent rejection otherwise.
1974 "open" - for anyone
1975 "private" - restricted to subscribers
1976 Default:
1977 "open"
1978 Context:
1980 list (config), domain (robot.conf), site (sympa.conf)
1981 "subscribe"
1983 Who can subscribe to the list
1985 Format:
1987 Name of "subscribe" scenario:
1988 "auth" - subscription request confirmed
1990 "auth_notify" - need authentication (notification is sent to
1991 owners)
1992 "auth_notifydkim" - need authentication unless DKIM signature is OK
1993 (notification is sent to owners)
1994 "auth_owner" - requires authentication then owner approval
1995 "auth_ownerdkim" - requires authentication unless DKIM signature is
1996 OK, then owner approval
1997 "authdkim" - subscription request confirmed
1998 "closed" - subscription is impossible
1999 "open" - for anyone without authentication
2000 "open_notify" - anyone, notification is sent to list owner
2001 "open_quiet" - anyone, no welcome message
2002 "owner" - owners approval
2003 "smime" - requires S/MIME signed
2004 "smimeorowner" - requires S/MIME signed or owner approval
2005 Default:
2006 "open"
2007 Context:
2009 list (config), domain (robot.conf), site (sympa.conf)
2010 The subscribe parameter defines the rules for subscribing to the list.
2012 "add"
2014 Who can add subscribers
2016 Format:
2018 Name of "add" scenario:
2019 "auth" - restricted to owner with authentication
2021 "authdkim" - restricted to owner without authentication if DKIM
2022 signature is OK.
2023 "closed" - add impossible
2024 "owner" - add performed by list owner does not need authentication
2025 "owner_notify" - add performed by owner does not need
2026 authentication (notification)
2027 "ownerdkim" - add performed by list owner does not need
2028 authentication if DKIM signature OK
2029 Default:
2030 "owner"
2031 Context:
2033 list (config), domain (robot.conf), site (sympa.conf)
2034 Privilege for adding (ADD command) a subscriber to the list
2036 "unsubscribe"
2038 Who can unsubscribe
2040 Format:
2042 Name of "unsubscribe" scenario:
2043 "auth" - need authentication
2045 "auth_notify" - authentication requested, notification sent to
2046 owner
2047 "auth_notifydkim" - authentication requested unless DKIM signature
2048 is OK, notification sent to owner
2049 "authdkim" - need authentication unless DKIM signature is OK
2050 "closed" - impossible
2051 "open" - open
2052 "open_notify" - open with mail confirmation, owner is notified
2053 "owner" - owners approval
2054 Default:
2055 "open"
2056 Context:
2058 list (config), domain (robot.conf), site (sympa.conf)
2059 This parameter specifies the unsubscription method for the list. Use
2061 open_notify or auth_notify to allow owner notification of each
2062 unsubscribe command.
2063 "del"
2065 Who can delete subscribers
2067 Format:
2069 Name of "del" scenario:
2070 "auth" - deletion performed only by list owners, need
2072 authentication
2073 "authdkim" - deletion performed only by list owners, need
2074 authentication unless DKIM signature is OK
2075 "closed" - remove subscriber impossible
2076 "owner" - by owner without authentication
2077 "owner_notify" - list owners, authentication not needed
2078 (notification)
2079 "ownerdkim" - by owner without authentication if DKIM signature OK
2080 Default:
2081 "owner"
2082 Context:
2084 list (config), domain (robot.conf), site (sympa.conf)
2085 "invite"
2087 Who can invite people
2089 Format:
2091 Name of "invite" scenario:
2092 "closed" - closed
2094 "owner" - invite perform by list owner do not need authentication
2095 "private" - restricted to subscribers
2096 "public" - public
2097 Default:
2098 "private"
2099 Context:
2101 list (config), domain (robot.conf), site (sympa.conf)
2102 "remind"
2104 Who can start a remind process
2106 Format:
2108 Name of "remind" scenario:
2109 "listmaster" - listmaster only
2111 "listmasterdkim" - listmaster only (do not require authentication
2112 if DKIM siganture is OK)
2113 "owner" - restricted to list owners
2114 "ownerdkim" - restricted to list owners (authentication is not
2115 required if a DKIM signature is OK)
2116 Default:
2117 "owner"
2118 Context:
2120 list (config), domain (robot.conf), site (sympa.conf)
2121 This parameter specifies who is authorized to use the remind command.
2123 "review"
2125 Who can review subscribers
2127 Format:
2129 Name of "review" scenario:
2130 "closed" - no one can review
2132 "listmaster" - listmaster only
2133 "owner" - only owner (and listmaster)
2134 "private" - restricted to subscribers
2135 "public" - anyone can do it!
2136 Default:
2137 "owner"
2138 Context:
2140 list (config), domain (robot.conf), site (sympa.conf)
2141 This parameter specifies who can access the list of members. Since
2143 subscriber addresses can be abused by spammers, it is strongly
2144 recommended that you only authorize owners or subscribers to access the
2145 subscriber list.
2146 "owner_domain"
2148 Required domains for list owners
2150 Format:
2152 /"$host( +$host)*"/
2153 Default:
2155 None.
2156 Context:
2158 list (config), domain (robot.conf), site (sympa.conf)
2159 Available versions:
2161 6.2.23b.3 and later.
2162 Restrict list ownership to addresses in the specified domains. This can
2164 be used to reserve list ownership to a group of trusted users from a
2165 set of domains associated with an organization, while allowing
2166 moderators and subscribers from the Internet at large.
2167 "owner_domain_min"
2169 Minimum owners in required domains
2171 Format:
2173 /"\d+"/
2174 Default:
2176 0
2177 Context:
2179 list (config), domain (robot.conf), site (sympa.conf)
2180 Available versions:
2182 6.2.23b.3 and later.
2183 Minimum number of owners for each list must satisfy the owner_domain
2185 restriction. The default of zero (0) means *all* list owners must
2186 match. Setting to 1 requires only one list owner to match owner_domain;
2187 all other owners can be from any domain. This setting can be used to
2188 ensure that there is always at least one known contact point for any
2189 mailing list.
2190 "shared_doc"
2192 (Paragraph) Shared documents
2194 Single occurrence
2196 This paragraph defines read and edit access to the shared document
2198 repository.
2199 "shared_doc.d_read"
2201 Who can view
2203 Format:
2205 Name of "d_read" scenario:
2206 "owner" - restricted to list owners
2208 "private" - restricted to subscribers
2209 "private-https" - restricted to subscribers authenticated with user
2210 cert
2211 "public" - public documents
2212 Default:
2213 "private"
2214 Context:
2216 list (config), domain (robot.conf), site (sympa.conf)
2217 "shared_doc.d_edit"
2219 Who can edit
2221 Format:
2223 Name of "d_edit" scenario:
2224 "editor" - moderated for subscribers
2226 "owner" - restricted to list owners
2227 "private" - restricted to subscribers
2228 "private-https" - restricted to subscribers authenticated with user
2229 cert
2230 "public" - public documents
2231 Default:
2232 "owner"
2233 Context:
2235 list (config), domain (robot.conf), site (sympa.conf)
2236 "shared_doc.quota"
2238 quota
2240 Format:
2242 Number of Kbytes.
2243 Default:
2245 None.
2246 Context:
2248 list (config), domain (robot.conf), site (sympa.conf)
2249 Archives
2251 "ignore_x_no_archive_header_feature"
2252 Ignore "X-no-archive:" header field
2254 Format:
2256 "on" - enabled
2257 "off" - disabled
2258 Default:
2259 "off"
2260 Context:
2262 site (sympa.conf)
2263 Sympa's default behavior is to skip archiving of incoming messages that
2265 have an "X-no-archive:" header field set. This parameter allows one to
2266 change this behavior.
2267 Example:
2269 ignore_x_no_archive_header_feature on
2271 "custom_archiver"
2273 Custom archiver
2275 Format:
2277 /".+"/
2278 Default:
2280 None.
2281 Context:
2283 site (sympa.conf)
2284 Activates a custom archiver to use instead of MHonArc. The value of
2286 this parameter is the absolute path to the executable file.
2287 Sympa invokes this file with these two arguments:
2289 --list
2291 The address of the list including domain part.
2293 --file
2295 Absolute path to the message to be archived.
2297 "process_archive"
2299 Store distributed messages into archive
2301 Format:
2303 "on" - enabled
2304 "off" - disabled
2305 Default:
2306 "off"
2307 Context:
2309 list (config), domain (robot.conf), site (sympa.conf)
2310 Available versions:
2312 6.2b.1 and later.
2313 If enabled, distributed messages via lists will be archived. Otherwise
2315 archiving is disabled.
2316 Note that even if setting this parameter disabled, past archives will
2318 not be removed and will be accessible according to access settings by
2319 each list.
2320 "archive"
2322 (Paragraph) Archives
2324 Single occurrence
2326 Privilege for reading mail archives and frequency of archiving.
2328 Defines who can access the list's web archive.
2330 "archive.period"
2332 Deprecated.
2334 Context:
2336 list (config)
2337 "archive.access"
2339 Deprecated.
2341 Context:
2343 list (config)
2344 Available versions:
2346 up to 6.2a.43.
2347 "archive.web_access"
2349 access right
2351 Format:
2353 Name of "archive_web_access" scenario:
2354 "closed" - closed
2356 "listmaster" - listmaster
2357 "owner" - by owner
2358 "private" - subscribers only
2359 "public" - public
2360 Default:
2361 "closed"
2362 Context:
2364 list (config), domain (robot.conf), site (sympa.conf)
2365 Available versions:
2367 6.2b.1 and later.
2368 "archive.mail_access"
2370 access right by mail commands
2372 Format:
2374 Name of "archive_mail_access" scenario:
2375 "closed" - closed
2377 "owner" - by owner
2378 "private" - subscribers only
2379 "public" - public
2380 Default:
2381 "closed"
2382 Context:
2384 list (config), domain (robot.conf), site (sympa.conf)
2385 Available versions:
2387 6.2b.1 and later.
2388 "archive.quota"
2390 quota
2392 Format:
2394 Number of Kbytes.
2395 Default:
2397 None.
2398 Context:
2400 list (config), site (sympa.conf)
2401 Available versions:
2403 6.2b.1 and later.
2404 "archive.max_month"
2406 Maximum number of month archived
2408 Format:
2410 Number of months.
2411 Default:
2413 None.
2414 Context:
2416 list (config)
2417 Available versions:
2419 6.2b.1 and later.
2420 "archive_crypted_msg"
2422 Archive encrypted mails as cleartext
2424 Format:
2426 "original" - original messages
2427 "decrypted" - decrypted messages
2428 Default:
2429 "original"
2430 Context:
2432 list (config)
2433 "web_archive_spam_protection"
2435 Protect web archive against spam harvesters
2437 Format:
2439 "cookie" - use HTTP cookie
2440 "javascript" - use JavaScript
2441 "at" - replace @ characters
2442 "concealed" - never show address
2443 "none" - do nothing
2444 Default:
2445 "cookie"
2446 Context:
2448 list (config), domain (robot.conf), site (sympa.conf)
2449 The same as "spam_protection", but restricted to the web archive.
2451 In addition to it:
2453 cookie: users must submit a small form in order to receive a cookie
2455 before browsing the web archive.
2456 concealed: e-mail addresses will never be displayed.
2458 Bounces
2460 "bounce"
2461 (Paragraph) Bounces management
2463 Single occurrence
2465 "bounce.warn_rate"
2467 warn rate
2469 Format:
2471 Number of %.
2472 Default:
2474 30 (%)
2475 Context:
2477 list (config), site (sympa.conf)
2478 The list owner receives a warning whenever a message is distributed and
2480 the number (percentage) of bounces exceeds this value.
2481 "bounce.halt_rate"
2483 Deprecated.
2485 Context:
2487 list (config), site (sympa.conf)
2488 "bouncers_level1"
2490 (Paragraph) Management of bouncers, 1st level
2492 Single occurrence
2494 Level 1 is the lower level of bouncing users
2496 "bouncers_level1.rate"
2498 threshold
2500 Format:
2502 Number of points.
2503 Default:
2505 45 (points)
2506 Context:
2508 list (config), domain (robot.conf), site (sympa.conf)
2509 Each bouncing user have a score (from 0 to 100).
2511 This parameter defines a lower limit for each category of bouncing
2513 users.For example, level 1 begins from 45 to level_2_treshold.
2514 "bouncers_level1.action"
2516 action for this population
2518 Format:
2520 "remove_bouncers" - remove bouncing users
2521 "notify_bouncers" - send notify to bouncing users
2522 "none" - do nothing
2523 Default:
2524 "notify_bouncers"
2525 Context:
2527 list (config)
2528 This parameter defines which task is automatically applied on level 1
2530 bouncers.
2531 "bouncers_level1.notification"
2533 notification
2535 Format:
2537 "none" - do nothing
2538 "owner" - owner
2539 "listmaster" - listmaster
2540 Default:
2541 "owner"
2542 Context:
2544 list (config)
2545 When automatic task is executed on level 1 bouncers, a notification
2547 email can be send to listowner or listmaster.
2548 "bouncers_level2"
2550 (Paragraph) Management of bouncers, 2nd level
2552 Single occurrence
2554 Level 2 is the highest level of bouncing users
2556 "bouncers_level2.rate"
2558 threshold
2560 Format:
2562 Number of points.
2563 Default:
2565 75 (points)
2566 Context:
2568 list (config), domain (robot.conf), site (sympa.conf)
2569 Each bouncing user have a score (from 0 to 100).
2571 This parameter defines the score range defining each category of
2573 bouncing users.For example, level 2 is for users with a score between
2574 80 and 100.
2575 "bouncers_level2.action"
2577 action for this population
2579 Format:
2581 "remove_bouncers" - remove bouncing users
2582 "notify_bouncers" - send notify to bouncing users
2583 "none" - do nothing
2584 Default:
2585 "remove_bouncers"
2586 Context:
2588 list (config)
2589 This parameter defines which task is automatically applied on level 2
2591 bouncers.
2592 "bouncers_level2.notification"
2594 notification
2596 Format:
2598 "none" - do nothing
2599 "owner" - owner
2600 "listmaster" - listmaster
2601 Default:
2602 "owner"
2603 Context:
2605 list (config)
2606 When automatic task is executed on level 2 bouncers, a notification
2608 email can be send to listowner or listmaster.
2609 "verp_rate"
2611 percentage of list members in VERP mode
2613 Format:
2615 "100%" - 100% - always
2616 "50%" - 50%
2617 "33%" - 33%
2618 "25%" - 25%
2619 "20%" - 20%
2620 "10%" - 10%
2621 "5%" - 5%
2622 "2%" - 2%
2623 "0%" - 0% - never
2624 Default:
2625 "0%"
2626 Context:
2628 list (config), domain (robot.conf), site (sympa.conf)
2629 Uses variable envelope return path (VERP) to detect bouncing subscriber
2631 addresses.
2632 0%: VERP is never used.
2634 100%: VERP is always in use.
2636 VERP requires address with extension to be supported by MTA. If
2638 tracking is enabled for a list or a message, VERP is applied for 100%
2639 of subscribers.
2640 "tracking"
2642 (Paragraph) Message tracking feature
2644 Single occurrence
2646 "tracking.delivery_status_notification"
2648 tracking message by delivery status notification
2650 Format:
2652 "on" - enabled
2653 "off" - disabled
2654 Default:
2655 "off"
2656 Context:
2658 list (config), site (sympa.conf)
2659 "tracking.message_disposition_notification"
2661 tracking message by message disposition notification
2663 Format:
2665 "on" - enabled
2666 "on_demand" - on demand
2667 "off" - disabled
2668 Default:
2669 "off"
2670 Context:
2672 list (config), site (sympa.conf)
2673 Available versions:
2675 6.2a.41 and later.
2676 "tracking.tracking"
2678 who can view message tracking
2680 Format:
2682 Name of "tracking" scenario:
2683 "owner" - only owner (and listmaster)
2685 "private" - restricted to subscribers
2686 Default:
2687 "owner"
2688 Context:
2690 list (config), site (sympa.conf)
2691 Available versions:
2693 6.2a.3 and later.
2694 "tracking.retention_period"
2696 Tracking datas are removed after this number of days
2698 Format:
2700 Number of days.
2701 Default:
2703 90 (days)
2704 Context:
2706 list (config), site (sympa.conf)
2707 Available versions:
2709 6.2a.3 and later.
2710 "tracking.message_delivery_notification"
2712 See "message_disposition_notification".
2714 Context:
2716 list (config)
2717 Available versions:
2719 6.2a.0 to 6.2a.40.
2720 "welcome_return_path"
2722 Welcome return-path
2724 Format:
2726 "unique" - bounce management
2727 "owner" - owner
2728 Default:
2729 "owner"
2730 Context:
2732 list (config), site (sympa.conf)
2733 If set to unique, the welcome message is sent using a unique return
2735 path in order to remove the subscriber immediately in the case of a
2736 bounce.
2737 "remind_return_path"
2739 Return-path of the REMIND command
2741 Format:
2743 "unique" - bounce management
2744 "owner" - owner
2745 Default:
2746 "owner"
2747 Context:
2749 list (config), site (sympa.conf)
2750 Same as welcome_return_path, but applied to remind messages.
2752 "expire_bounce_task"
2754 Task for expiration of old bounces
2756 Format:
2758 /"\w+"/
2759 Default:
2761 "daily"
2762 Context:
2764 site (sympa.conf)
2765 This task resets bouncing information for addresses not bouncing in the
2767 last 10 days after the latest message distribution.
2768 "purge_orphan_bounces_task"
2770 Task for cleaning invalidated bounces
2772 Format:
2774 /"\w+"/
2775 Default:
2777 "monthly"
2778 Context:
2780 site (sympa.conf)
2781 This task deletes bounce information for unsubscribed users.
2783 "eval_bouncers_task"
2785 Task for updating bounce scores
2787 Format:
2789 /"\w+"/
2790 Default:
2792 "daily"
2793 Context:
2795 site (sympa.conf)
2796 This task scans all bouncing users for all lists, and updates
2798 "bounce_score_subscriber" field in "subscriber_table" table. The scores
2799 may be used for management of bouncers.
2800 "process_bouncers_task"
2802 Task for management of bouncers
2804 Format:
2806 /"\w+"/
2807 Default:
2809 "weekly"
2810 Context:
2812 site (sympa.conf)
2813 This task executes actions on bouncing users configured by each list,
2815 according to their scores.
2816 "purge_tables_task"
2818 Task for cleaning tables
2820 Format:
2822 /"\w+"/
2823 Default:
2825 "daily"
2826 Context:
2828 site (sympa.conf)
2829 This task cleans old tracking information from "notification_table"
2831 table.
2832 "minimum_bouncing_count"
2834 Minimum number of bounces
2836 Format:
2838 /"\d+"/
2839 Default:
2841 10
2842 Context:
2844 site (sympa.conf)
2845 The minimum number of bounces received to update bounce score of a
2847 user.
2848 "minimum_bouncing_period"
2850 Minimum bouncing period
2852 Format:
2854 Number of days.
2855 Default:
2857 10 (days)
2858 Context:
2860 site (sympa.conf)
2861 The minimum period for which bouncing lasted to update bounce score of
2863 a user.
2864 "bounce_delay"
2866 Delay of bounces
2868 Format:
2870 Number of days.
2871 Default:
2873 0 (days)
2874 Context:
2876 site (sympa.conf)
2877 Average time for a bounce sent back to mailing list server after a post
2879 was sent to a list. Usually bounces are sent back on the same day as
2880 the original message.
2881 "bounce_email_prefix"
2883 Prefix of VERP return address
2885 Format:
2887 /"\S+"/
2888 Default:
2890 "bounce"
2891 Context:
2893 site (sympa.conf)
2894 The prefix to consist the return-path of probe messages used for bounce
2896 management, when variable envelope return path (VERP) is enabled. VERP
2897 requires address with extension to be supported by MTA.
2898 If you change the default value, you must modify the mail aliases too.
2900 "return_path_suffix"
2902 Suffix of list return address
2904 Format:
2906 /"\S+"/
2907 Default:
2909 "-owner"
2910 Context:
2912 site (sympa.conf)
2913 The suffix appended to the list name to form the return-path of
2915 messages distributed through the list. This address will receive all
2916 non-delivery reports (also called bounces).
2917 Loop prevention
2919 "loop_command_max"
2920 Maximum number of responses to command message
2922 Format:
2924 /"\d+"/
2925 Default:
2927 200
2928 Context:
2930 site (sympa.conf)
2931 The maximum number of command reports sent to an email address.
2933 Messages are stored in "bad" subdirectory of incoming message spool,
2934 and reports are not longer sent.
2935 "loop_command_sampling_delay"
2937 Delay before counting responses to command message
2939 Format:
2941 Number of seconds.
2942 Default:
2944 3600 (seconds)
2945 Context:
2947 site (sympa.conf)
2948 This parameter defines the delay in seconds before decrementing the
2950 counter of reports sent to an email address.
2951 "loop_command_decrease_factor"
2953 Decrementing factor of responses to command message
2955 Format:
2957 /"[.\d]+"/
2958 Default:
2960 0.5
2961 Context:
2963 site (sympa.conf)
2964 The decrementation factor (from 0 to 1), used to determine the new
2966 report counter after expiration of the delay.
2967 "msgid_table_cleanup_ttl"
2969 Expiration period of message ID table
2971 Format:
2973 Number of seconds.
2974 Default:
2976 86400 (seconds)
2977 Context:
2979 site (sympa.conf)
2980 Expiration period of entries in the table maintained by sympa_msg.pl
2982 daemon to prevent delivery of duplicate messages caused by loop.
2983 "msgid_table_cleanup_frequency"
2985 Cleanup interval of message ID table
2987 Format:
2989 Number of seconds.
2990 Default:
2992 3600 (seconds)
2993 Context:
2995 site (sympa.conf)
2996 Interval between cleanups of the table maintained by sympa_msg.pl
2998 daemon to prevent delivery of duplicate messages caused by loop.
2999 Automatic lists
3001 "automatic_list_feature"
3002 Automatic list
3004 Format:
3006 "on" - enabled
3007 "off" - disabled
3008 Default:
3009 "off"
3010 Context:
3012 domain (robot.conf), site (sympa.conf)
3013 "automatic_list_removal"
3015 Remove empty automatic list
3017 Format:
3019 "none" - do nothing
3020 "if_empty" - if_empty
3021 Default:
3022 "none"
3023 Context:
3025 domain (robot.conf), site (sympa.conf)
3026 If set to "if_empty", then Sympa will remove automatically created
3028 mailing lists just after their creation, if they contain no list
3029 member.
3030 Example:
3032 automatic_list_removal if_empty
3034 "automatic_list_creation"
3036 Who is able to create automatic list
3038 Format:
3040 Name of "automatic_list_creation" scenario:
3041 "family_owner" - Restricted to people subscribed to the list of
3043 family owners.
3044 "listmaster" - restricted to listmaster
3045 "public" - anybody. Be sure you know what you are doing
3046 Default:
3047 "public"
3048 Context:
3050 domain (robot.conf), site (sympa.conf)
3051 "automatic_list_families"
3053 Definition of automatic list families
3055 Format:
3057 /".+"/
3058 Default:
3060 None.
3061 Context:
3063 domain (robot.conf), site (sympa.conf)
3064 Defines the families the automatic lists are based on. It is a
3066 character string structured as follows:
3067 * each family is separated from the other by a semicolon (;)
3069 * inside a family definition, each field is separated from the other by
3071 a colon (:)
3072 * each field has the structure: "<field name>=<field value>"
3074 Basically, each time Sympa uses the automatic lists families, the
3076 values defined in this parameter will be available in the family
3077 object.
3078 * for scenarios: [family->name]
3080 * for templates: [% family.name %]
3082 Example:
3084 automatic_list_families name=family_one:prefix=f1:display=My automatic lists:prefix_separator=+:classes separator=-:family_owners_list=alist@domain.tld;name=family_two:prefix=f2:display=My other automatic lists:prefix_separator=+:classes separator=-:family_owners_list=anotherlist@domain.tld;
3086 "parsed_family_files"
3088 Parsed files for families
3090 Format:
3092 /"[-.\w]+"/
3093 Default:
3095 "message_header,message_header.mime,message_footer,message_footer.mime,info"
3096 Context:
3098 domain (robot.conf), site (sympa.conf)
3099 comma-separated list of files that will be parsed by Sympa when
3101 instantiating a family (no space allowed in file names)
3102 "family_signoff"
3104 Global unsubscription
3106 Format:
3108 Name of "family_signoff" scenario:
3109 "auth" - need authentication
3111 "closed" - impossible
3112 Default:
3113 "auth"
3114 Context:
3116 domain (robot.conf), site (sympa.conf)
3117 Available versions:
3119 6.2.54 and later.
3120 Tag based spam filtering
3122 "antispam_feature"
3123 Tag based spam filtering
3125 Format:
3127 "on" - enabled
3128 "off" - disabled
3129 Default:
3130 "off"
3131 Context:
3133 domain (robot.conf), site (sympa.conf)
3134 "antispam_tag_header_name"
3136 Header field to tag spams
3138 Format:
3140 /"\S+"/
3141 Default:
3143 "X-Spam-Status"
3144 Context:
3146 domain (robot.conf), site (sympa.conf)
3147 If a spam filter (like spamassassin or j-chkmail) add a header field to
3149 tag spams, name of this header field (example X-Spam-Status)
3150 "antispam_tag_header_spam_regexp"
3152 Regular expression to check header field to tag spams
3154 Format:
3156 /".+"/
3157 Default:
3159 "^\s*Yes"
3160 Context:
3162 domain (robot.conf), site (sympa.conf)
3163 Regular expression applied on this header to verify message is a spam
3165 (example Yes)
3166 "antispam_tag_header_ham_regexp"
3168 Regular expression to determine spam or ham.
3170 Format:
3172 /".+"/
3173 Default:
3175 "^\s*No"
3176 Context:
3178 domain (robot.conf), site (sympa.conf)
3179 Regular expression applied on this header field to verify message is
3181 NOT a spam (example No)
3182 "spam_status"
3184 Name of header field to inform
3186 Format:
3188 Name of "spam_status" scenario:
3189 "x-spam-status" - test x-spam-status header
3191 Default:
3192 "x-spam-status"
3193 Context:
3195 domain (robot.conf), site (sympa.conf)
3196 Messages are supposed to be filtered by an spam filter that adds them
3198 one or more headers. This parameter is used to select a special
3199 scenario in order to decide the message's spam status: ham, spam or
3200 unsure. This parameter replaces antispam_tag_header_name,
3201 antispam_tag_header_spam_regexp and antispam_tag_header_ham_regexp.
3202 Directories
3204 "home"
3205 List home
3207 Format:
3209 /".+"/
3210 Default:
3212 $EXPLDIR
3213 Context:
3215 site (sympa.conf)
3216 Base directory of list configurations.
3218 "etc"
3220 Directory for configuration files
3222 Format:
3224 /".+"/
3225 Default:
3227 $SYSCONFDIR
3228 Context:
3230 site (sympa.conf)
3231 Base directory of global configuration (except "sympa.conf").
3233 "spool"
3235 Base directory of spools
3237 Format:
3239 /".+"/
3240 Default:
3242 $SPOOLDIR
3243 Context:
3245 site (sympa.conf)
3246 Base directory of all spools which are created at runtime. This
3248 directory must be writable by Sympa user.
3249 "queue"
3251 Directory for message incoming spool
3253 Format:
3255 /".+"/
3256 Default:
3258 "$SPOOLDIR/msg"
3259 Context:
3261 site (sympa.conf)
3262 This spool is used both by "queue" program and "sympa_msg.pl" daemon.
3264 "queuemod"
3266 Directory for moderation spool
3268 Format:
3270 /".+"/
3271 Default:
3273 "$SPOOLDIR/moderation"
3274 Context:
3276 site (sympa.conf)
3277 "queuedigest"
3279 Directory for digest spool
3281 Format:
3283 /".+"/
3284 Default:
3286 "$SPOOLDIR/digest"
3287 Context:
3289 site (sympa.conf)
3290 "queueauth"
3292 Directory for held message spool
3294 Format:
3296 /".+"/
3297 Default:
3299 "$SPOOLDIR/auth"
3300 Context:
3302 site (sympa.conf)
3303 This parameter is named such by historical reason.
3305 "queueoutgoing"
3307 Directory for archive spool
3309 Format:
3311 /".+"/
3312 Default:
3314 "$SPOOLDIR/outgoing"
3315 Context:
3317 site (sympa.conf)
3318 This parameter is named such by historical reason.
3320 "queuesubscribe"
3322 Directory for held request spool
3324 Format:
3326 /".+"/
3327 Default:
3329 "$SPOOLDIR/subscribe"
3330 Context:
3332 site (sympa.conf)
3333 This parameter is named such by historical reason.
3335 "queuetopic"
3337 Directory for topic spool
3339 Format:
3341 /".+"/
3342 Default:
3344 "$SPOOLDIR/topic"
3345 Context:
3347 site (sympa.conf)
3348 "queuebounce"
3350 Directory for bounce incoming spool
3352 Format:
3354 /".+"/
3355 Default:
3357 "$SPOOLDIR/bounce"
3358 Context:
3360 site (sympa.conf)
3361 This spool is used both by "bouncequeue" program and "bounced.pl"
3363 daemon.
3364 "queuetask"
3366 Directory for task spool
3368 Format:
3370 /".+"/
3371 Default:
3373 "$SPOOLDIR/task"
3374 Context:
3376 site (sympa.conf)
3377 "queueautomatic"
3379 Directory for automatic list creation spool
3381 Format:
3383 /".+"/
3384 Default:
3386 "$SPOOLDIR/automatic"
3387 Context:
3389 site (sympa.conf)
3390 This spool is used both by "familyqueue" program and
3392 "sympa_automatic.pl" daemon.
3393 "queuebulk"
3395 Directory for message outgoing spool
3397 Format:
3399 /".+"/
3400 Default:
3402 "$SPOOLDIR/bulk"
3403 Context:
3405 site (sympa.conf)
3406 Available versions:
3408 6.2a.41 and later.
3409 This parameter is named such by historical reason.
3411 "tmpdir"
3413 Temporary directory used by external programs such as virus scanner.
3415 Also, outputs to daemons' standard error are redirected to the files
3416 under this directory.
3417 Format:
3419 /".+"/
3420 Default:
3422 "$SPOOLDIR/tmp"
3423 Context:
3425 site (sympa.conf)
3426 "viewmail_dir"
3428 Directory to cache formatted messages
3430 Format:
3432 /".+"/
3433 Default:
3435 "$SPOOLDIR/viewmail"
3436 Context:
3438 site (sympa.conf)
3439 Base directory path of directories where HTML view of messages are
3441 cached.
3442 "bounce_path"
3444 Directory for storing bounces
3446 Format:
3448 /".+"/
3449 Default:
3451 $BOUNCEDIR
3452 Context:
3454 site (sympa.conf)
3455 The directory where bounced.pl daemon will store the last bouncing
3457 message for each user. A message is stored in the file:
3458 <bounce_path>/<list name>@<mail domain name>/<email address>, or, if
3459 tracking is enabled: <bounce_path>/<list name>@<mail domain
3460 name>/<email address>_<envelope ID>.
3461 Users can access to these messages using web interface in the bounce
3463 management page.
3464 Don't confuse with "queuebounce" parameter which defines the spool
3466 where incoming error reports are stored and picked by bounced.pl
3467 daemon.
3468 "arc_path"
3470 Directory for storing archives
3472 Format:
3474 /".+"/
3475 Default:
3477 $ARCDIR
3478 Context:
3480 domain (robot.conf), site (sympa.conf)
3481 Where to store HTML archives. This parameter is used by the
3483 "archived.pl" daemon. It is a good idea to install the archive outside
3484 the web document hierarchy to prevent overcoming of WWSympa's access
3485 control.
3486 "purge_spools_task"
3488 Task for cleaning spools
3490 Format:
3492 /"\w+"/
3493 Default:
3495 "daily"
3496 Context:
3498 site (sympa.conf)
3499 Available versions:
3501 6.2b.4 and later.
3502 This task cleans old content in spools.
3504 "clean_delay_queue"
3506 Max age of incoming bad messages
3508 Format:
3510 Number of days.
3511 Default:
3513 7 (days)
3514 Context:
3516 site (sympa.conf)
3517 Number of days "bad" messages are kept in message incoming spool (as
3519 specified by "queue" parameter). Sympa keeps messages rejected for
3520 various reasons (badly formatted, looping etc.).
3521 "clean_delay_queueoutgoing"
3523 Max age of bad messages for archives
3525 Format:
3527 Number of days.
3528 Default:
3530 7 (days)
3531 Context:
3533 site (sympa.conf)
3534 Number of days "bad" messages are kept in message archive spool (as
3536 specified by "queueoutgoing" parameter). Sympa keeps messages rejected
3537 for various reasons (unable to create archive directory, to copy file
3538 etc.).
3539 "clean_delay_queuebounce"
3541 Max age of bad bounce messages
3543 Format:
3545 Number of days.
3546 Default:
3548 7 (days)
3549 Context:
3551 site (sympa.conf)
3552 Number of days "bad" messages are kept in bounce spool (as specified by
3554 "queuebounce" parameter). Sympa keeps messages rejected for various
3555 reasons (unknown original sender, unknown report type).
3556 "clean_delay_queueauth"
3558 Max age of held messages
3560 Format:
3562 Number of days.
3563 Default:
3565 30 (days)
3566 Context:
3568 site (sympa.conf)
3569 Number of days messages are kept in held message spool (as specified by
3571 "queueauth" parameter). Beyond this deadline, messages that have not
3572 been confirmed are deleted.
3573 "clean_delay_queuesubscribe"
3575 Max age of held requests
3577 Format:
3579 Number of days.
3580 Default:
3582 30 (days)
3583 Context:
3585 site (sympa.conf)
3586 Number of days requests are kept in held request spool (as specified by
3588 "queuesubscribe" parameter). Beyond this deadline, requests that have
3589 not been validated nor declined are deleted.
3590 "clean_delay_queuetopic"
3592 Max age of tagged topics
3594 Format:
3596 Number of days.
3597 Default:
3599 30 (days)
3600 Context:
3602 site (sympa.conf)
3603 Number of days (automatically or manually) tagged topics are kept in
3605 topic spool (as specified by "queuetopic" parameter). Beyond this
3606 deadline, tagging is forgotten.
3607 "clean_delay_queueautomatic"
3609 Max age of incoming bad messages in automatic list creation spool
3611 Format:
3613 Number of days.
3614 Default:
3616 10 (days)
3617 Context:
3619 site (sympa.conf)
3620 Number of days "bad" messages are kept in automatic list creation spool
3622 (as specified by "queueautomatic" parameter). Sympa keeps messages
3623 rejected for various reasons (badly formatted, looping etc.).
3624 "clean_delay_queuebulk"
3626 Max age of outgoing bad messages
3628 Format:
3630 Number of days.
3631 Default:
3633 7 (days)
3634 Context:
3636 site (sympa.conf)
3637 Number of days "bad" messages are kept in message outgoing spool (as
3639 specified by "queuebulk" parameter). Sympa keeps messages rejected for
3640 various reasons (failed personalization, bad configuration on MTA
3641 etc.).
3642 "clean_delay_queuedigest"
3644 Max age of bad messages in digest spool
3646 Format:
3648 Number of days.
3649 Default:
3651 14 (days)
3652 Context:
3654 site (sympa.conf)
3655 Available versions:
3657 6.2.6 and later.
3658 Number of days "bad" messages are kept in digest spool (as specified by
3660 "queuedigest" parameter). Sympa keeps messages rejected for various
3661 reasons (syntax errors in "digest.tt2" template etc.).
3662 "clean_delay_tmpdir"
3664 Max age of temporary files
3666 Format:
3668 Number of days.
3669 Default:
3671 7 (days)
3672 Context:
3674 site (sympa.conf)
3675 Number of days files in temporary directory (as specified by "tmpdir"
3677 parameter), including standard error logs, are kept.
3678 S/MIME and TLS
3680 S/MIME authentication, decryption and re-encryption. It requires these
3681 external modules: Crypt-OpenSSL-X509 and Crypt-SMIME.
3682 TLS client authentication. It requires an external module: IO-Socket-
3684 SSL.
3685 "cafile"
3687 File containing trusted CA certificates
3689 Format:
3691 /".+"/
3692 Default:
3694 None.
3695 Context:
3697 site (sympa.conf)
3698 Available versions:
3700 3.3.6b.1 and later.
3701 This can be used alternatively and/or additionally to "capath".
3703 "capath"
3705 Directory containing trusted CA certificates
3707 Format:
3709 /".+"/
3710 Default:
3712 None.
3713 Context:
3715 site (sympa.conf)
3716 Available versions:
3718 3.3.6b.1 and later.
3719 CA certificates in this directory are used for client authentication.
3721 The certificates need to have names including hash of subject, or
3723 symbolic links to them with such names. The links may be created by
3724 using "c_rehash" script bundled in OpenSSL.
3725 "key_passwd"
3727 Password used to crypt lists private keys
3729 Format:
3731 The value to be concealed.
3732 Default:
3734 None.
3735 Context:
3737 site (sympa.conf)
3738 If not defined, Sympa assumes that list private keys are not encrypted.
3740 Example:
3742 key_passwd your_password
3744 "ssl_cert_dir"
3746 Directory containing user certificates
3748 Format:
3750 /".+"/
3751 Default:
3753 "$EXPLDIR/X509-user-certs"
3754 Context:
3756 site (sympa.conf)
3757 Data sources setup
3759 Including subscribers, owners and moderators from data sources.
3760 Appropriate database driver (DBD) modules are required: DBD-CSV, DBD-
3761 mysql, DBD-ODBC, DBD-Oracle, DBD-Pg, DBD-SQLite and/or Net-LDAP. And
3762 also, if secure connection (LDAPS) to LDAP server is required: IO-
3763 Socket-SSL.
3764 "inclusion_notification_feature"
3766 Notify subscribers when they are included from a data source?
3768 Format:
3770 "on" - enabled
3771 "off" - disabled
3772 Default:
3773 "off"
3774 Context:
3776 list (config), site (sympa.conf)
3777 "member_include"
3779 (Paragraph) Subscribers defined in an external data source
3781 Multiple occurrences allowed
3783 "member_include.source"
3785 the data source
3787 Format:
3789 /"[\w-]+"/
3790 Default:
3792 None, mandatory.
3793 Context:
3795 list (config)
3796 "member_include.source_parameters"
3798 data source parameters
3800 Format:
3802 /".*"/
3803 Default:
3805 None.
3806 Context:
3808 list (config)
3809 "member_include.reception"
3811 reception mode
3813 Format:
3815 Reception mode of list member.
3816 Default:
3818 None.
3819 Context:
3821 list (config)
3822 Available versions:
3824 6.2.67b.2 and later.
3825 Mail reception mode.
3827 "member_include.visibility"
3829 visibility
3831 Format:
3833 Visibility mode of list memeber.
3834 Default:
3836 None.
3837 Context:
3839 list (config)
3840 Available versions:
3842 6.2.67b.2 and later.
3843 Visibility of the subscriber.
3845 "owner_include"
3847 (Paragraph) Owners defined in an external data source
3849 Multiple occurrences allowed
3851 "owner_include.source"
3853 the data source
3855 Format:
3857 /"[\w-]+"/
3858 Default:
3860 None, mandatory.
3861 Context:
3863 list (config)
3864 "owner_include.source_parameters"
3866 data source parameters
3868 Format:
3870 /".*"/
3871 Default:
3873 None.
3874 Context:
3876 list (config)
3877 Available versions:
3879 5.0a and later.
3880 "owner_include.profile"
3882 profile
3884 Format:
3886 "privileged" - privileged owner
3887 "normal" - normal owner
3888 Default:
3889 None.
3890 Context:
3892 list (config)
3893 "owner_include.reception"
3895 reception mode
3897 Format:
3899 "mail" - receive notification email
3900 "nomail" - no notifications
3901 Default:
3902 None.
3903 Context:
3905 list (config)
3906 "owner_include.visibility"
3908 visibility
3910 Format:
3912 "conceal" - concealed from list menu
3913 "noconceal" - listed on the list menu
3914 Default:
3915 None.
3916 Context:
3918 list (config)
3919 Available versions:
3921 5.4a.6 and later.
3922 "editor_include"
3924 (Paragraph) Moderators defined in an external data source
3926 Multiple occurrences allowed
3928 "editor_include.source"
3930 the data source
3932 Format:
3934 /"[\w-]+"/
3935 Default:
3937 None, mandatory.
3938 Context:
3940 list (config)
3941 "editor_include.source_parameters"
3943 data source parameters
3945 Format:
3947 /".*"/
3948 Default:
3950 None.
3951 Context:
3953 list (config)
3954 Available versions:
3956 5.0a and later.
3957 "editor_include.reception"
3959 reception mode
3961 Format:
3963 "mail" - receive notification email
3964 "nomail" - no notifications
3965 Default:
3966 None.
3967 Context:
3969 list (config)
3970 "editor_include.visibility"
3972 visibility
3974 Format:
3976 "conceal" - concealed from list menu
3977 "noconceal" - listed on the list menu
3978 Default:
3979 None.
3980 Context:
3982 list (config)
3983 Available versions:
3985 5.4a.6 and later.
3986 "sql_fetch_timeout"
3988 Timeout for fetch of include_sql_query
3990 Format:
3992 Number of seconds.
3993 Default:
3995 300 (seconds)
3996 Context:
3998 list (config), site (sympa.conf)
3999 Available versions:
4001 6.2a.0 and later.
4002 "include_file"
4004 File inclusion
4006 Format:
4008 Multiple occurrences allowed.
4009 /"\S+"/
4011 Default:
4013 None.
4014 Context:
4016 list (config)
4017 Include subscribers from this file. The file should contain one e-mail
4019 address per line (lines beginning with a "#" are ignored).
4020 "include_remote_file"
4022 (Paragraph) Remote file inclusion
4024 Multiple occurrences allowed
4026 "include_remote_file.name"
4028 short name for this source
4030 Format:
4032 /".+"/
4033 Default:
4035 None.
4036 Context:
4038 list (config)
4039 "include_remote_file.url"
4041 data location URL
4043 Format:
4045 /".+"/
4046 Default:
4048 None, mandatory.
4049 Context:
4051 list (config)
4052 "include_remote_file.user"
4054 remote user
4056 Format:
4058 /".+"/
4059 Default:
4061 None.
4062 Context:
4064 list (config)
4065 "include_remote_file.passwd"
4067 remote password
4069 Format:
4071 The value to be concealed.
4072 Default:
4074 None.
4075 Context:
4077 list (config)
4078 "include_remote_file.timeout"
4080 idle timeout
4082 Format:
4084 Number of seconds.
4085 Default:
4087 180 (seconds)
4088 Context:
4090 list (config)
4091 "include_remote_file.ssl_version"
4093 SSL version
4095 Format:
4097 "ssl_any" - any versions
4098 "sslv2" - SSL version 2
4099 "sslv3" - SSL version 3
4100 "tlsv1" - TLS version 1
4101 "tlsv1_1" - TLS version 1.1
4102 "tlsv1_2" - TLS version 1.2
4103 "tlsv1_3" - TLS version 1.3
4104 Default:
4105 "ssl_any"
4106 Context:
4108 list (config)
4109 "include_remote_file.ssl_ciphers"
4111 SSL ciphers used
4113 Format:
4115 /".+"/
4116 Default:
4118 "ALL"
4119 Context:
4121 list (config)
4122 "include_remote_file.ca_verify"
4124 Certificate verification
4126 Format:
4128 "none" - do nothing
4129 "optional" - optional
4130 "required" - required
4131 Default:
4132 "none"
4133 Context:
4135 list (config)
4136 "include_remote_file.nosync_time_ranges"
4138 Time ranges when inclusion is not allowed
4140 Format:
4142 /$time_ranges/
4143 Default:
4145 None.
4146 Context:
4148 list (config)
4149 "include_sympa_list"
4151 (Paragraph) List inclusion
4153 Multiple occurrences allowed
4155 Include subscribers from other list. All subscribers of list listname
4157 become subscribers of the current list. You may include as many lists
4158 as required, using one include_sympa_list paragraph for each included
4159 list. Any list at all may be included; you may therefore include lists
4160 which are also defined by the inclusion of other lists. Be careful,
4161 however, not to include list A in list B and then list B in list A,
4162 since this will give rise to an infinite loop.
4163 "include_sympa_list.name"
4165 short name for this source
4167 Format:
4169 /".+"/
4170 Default:
4172 None.
4173 Context:
4175 list (config)
4176 "include_sympa_list.listname"
4178 list name to include
4180 Format:
4182 /"$listname(\@$host)?"/
4183 Default:
4185 None, mandatory.
4186 Context:
4188 list (config)
4189 "include_sympa_list.filter"
4191 filter definition
4193 Format:
4195 /".*"/
4196 Default:
4198 None.
4199 Context:
4201 list (config)
4202 "include_sympa_list.nosync_time_ranges"
4204 Time ranges when inclusion is not allowed
4206 Format:
4208 /$time_ranges/
4209 Default:
4211 None.
4212 Context:
4214 list (config)
4215 "include_remote_sympa_list"
4217 (Paragraph) remote list inclusion
4219 Multiple occurrences allowed
4221 Sympa can contact another Sympa service using HTTPS to fetch a remote
4223 list in order to include each member of a remote list as subscriber.
4224 You may include as many lists as required, using one
4225 include_remote_sympa_list paragraph for each included list. Be careful,
4226 however, not to give rise to an infinite loop resulting from cross
4227 includes.
4228 For this operation, one Sympa site acts as a server while the other one
4230 acs as client. On the server side, the only setting needed is to give
4231 permission to the remote Sympa to review the list. This is controlled
4232 by the review scenario.
4233 "include_remote_sympa_list.name"
4235 short name for this source
4237 Format:
4239 /".+"/
4240 Default:
4242 None.
4243 Context:
4245 list (config)
4246 "include_remote_sympa_list.url"
4248 data location URL
4250 Format:
4252 /".+"/
4253 Default:
4255 None.
4256 Context:
4258 list (config)
4259 Available versions:
4261 6.2.45b.1 and later.
4262 "include_remote_sympa_list.user"
4264 remote user
4266 Format:
4268 /".+"/
4269 Default:
4271 None.
4272 Context:
4274 list (config)
4275 Available versions:
4277 6.2.45b.1 and later.
4278 "include_remote_sympa_list.passwd"
4280 remote password
4282 Format:
4284 The value to be concealed.
4285 Default:
4287 None.
4288 Context:
4290 list (config)
4291 Available versions:
4293 6.2.45b.1 and later.
4294 "include_remote_sympa_list.host"
4296 remote host
4298 Format:
4300 /$host/
4301 Default:
4303 None, mandatory.
4304 Context:
4306 list (config)
4307 obsoleted. Use "data location URL".
4309 "include_remote_sympa_list.port"
4311 remote port
4313 Format:
4315 /"\d+"/
4316 Default:
4318 443
4319 Context:
4321 list (config)
4322 obsoleted. Use "data location URL".
4324 "include_remote_sympa_list.path"
4326 remote path of sympa list dump
4328 Format:
4330 /"\S+"/
4331 Default:
4333 None, mandatory.
4334 Context:
4336 list (config)
4337 obsoleted. Use "data location URL".
4339 "include_remote_sympa_list.cert"
4341 Deprecated.
4343 Context:
4345 list (config)
4346 Available versions:
4348 up to 6.2.44.
4349 "include_remote_sympa_list.timeout"
4351 idle timeout
4353 Format:
4355 Number of seconds.
4356 Default:
4358 180 (seconds)
4359 Context:
4361 list (config)
4362 Available versions:
4364 6.2.45b.1 and later.
4365 "include_remote_sympa_list.ssl_version"
4367 SSL version
4369 Format:
4371 "ssl_any" - any versions
4372 "sslv2" - SSL version 2
4373 "sslv3" - SSL version 3
4374 "tlsv1" - TLS version 1
4375 "tlsv1_1" - TLS version 1.1
4376 "tlsv1_2" - TLS version 1.2
4377 "tlsv1_3" - TLS version 1.3
4378 Default:
4379 "ssl_any"
4380 Context:
4382 list (config)
4383 Available versions:
4385 6.2.45b.1 and later.
4386 "include_remote_sympa_list.ssl_ciphers"
4388 SSL ciphers used
4390 Format:
4392 /".+"/
4393 Default:
4395 "ALL"
4396 Context:
4398 list (config)
4399 Available versions:
4401 6.2.45b.1 and later.
4402 "include_remote_sympa_list.ca_verify"
4404 Certificate verification
4406 Format:
4408 "none" - do nothing
4409 "optional" - optional
4410 "required" - required
4411 Default:
4412 "optional"
4413 Context:
4415 list (config)
4416 Available versions:
4418 6.2.45b.1 and later.
4419 "include_remote_sympa_list.nosync_time_ranges"
4421 Time ranges when inclusion is not allowed
4423 Format:
4425 /$time_ranges/
4426 Default:
4428 None.
4429 Context:
4431 list (config)
4432 "include_ldap_query"
4434 (Paragraph) LDAP query inclusion
4436 Multiple occurrences allowed
4438 This paragraph defines parameters for a query returning a list of
4440 subscribers. This feature requires the Net::LDAP (perlldap) PERL
4441 module.
4442 "include_ldap_query.name"
4444 short name for this source
4446 Format:
4448 /".+"/
4449 Default:
4451 None.
4452 Context:
4454 list (config)
4455 "include_ldap_query.host"
4457 remote host
4459 Format:
4461 /$multiple_host_or_url/
4462 Default:
4464 None, mandatory.
4465 Context:
4467 list (config)
4468 "include_ldap_query.port"
4470 Deprecated.
4472 Context:
4474 list (config)
4475 "include_ldap_query.use_tls"
4477 use TLS (formerly SSL)
4479 Format:
4481 "starttls" - use STARTTLS
4482 "ldaps" - use LDAPS (LDAP over TLS)
4483 "none" - do nothing
4484 Default:
4485 "none"
4486 Context:
4488 list (config)
4489 Available versions:
4491 6.2.15 and later.
4492 "include_ldap_query.ssl_version"
4494 SSL version
4496 Format:
4498 "sslv2" - SSL version 2
4499 "sslv3" - SSL version 3
4500 "tlsv1" - TLS version 1
4501 "tlsv1_1" - TLS version 1.1
4502 "tlsv1_2" - TLS version 1.2
4503 "tlsv1_3" - TLS version 1.3
4504 Default:
4505 "tlsv1"
4506 Context:
4508 list (config)
4509 "include_ldap_query.ssl_ciphers"
4511 SSL ciphers used
4513 Format:
4515 /".+"/
4516 Default:
4518 "ALL"
4519 Context:
4521 list (config)
4522 "include_ldap_query.ca_verify"
4524 Certificate verification
4526 Format:
4528 "none" - do nothing
4529 "optional" - optional
4530 "required" - required
4531 Default:
4532 "required"
4533 Context:
4535 list (config)
4536 Available versions:
4538 6.2.13 and later.
4539 "include_ldap_query.bind_dn"
4541 remote user
4543 Format:
4545 /".+"/
4546 Default:
4548 None.
4549 Context:
4551 list (config)
4552 Available versions:
4554 6.2.57b.1 and later.
4555 "include_ldap_query.bind_password"
4557 remote password
4559 Format:
4561 The value to be concealed.
4562 Default:
4564 None.
4565 Context:
4567 list (config)
4568 Available versions:
4570 6.2.57b.1 and later.
4571 "include_ldap_query.suffix"
4573 suffix
4575 Format:
4577 /".+"/
4578 Default:
4580 None.
4581 Context:
4583 list (config)
4584 "include_ldap_query.scope"
4586 search scope
4588 Format:
4590 "base" - base
4591 "one" - one level
4592 "sub" - subtree
4593 Default:
4594 "sub"
4595 Context:
4597 list (config)
4598 "include_ldap_query.timeout"
4600 connection timeout
4602 Format:
4604 Number of seconds.
4605 Default:
4607 30 (seconds)
4608 Context:
4610 list (config)
4611 "include_ldap_query.filter"
4613 filter
4615 Format:
4617 /".+"/
4618 Default:
4620 None, mandatory.
4621 Context:
4623 list (config)
4624 "include_ldap_query.attrs"
4626 extracted attribute
4628 Format:
4630 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
4631 Default:
4633 "mail"
4634 Context:
4636 list (config)
4637 "include_ldap_query.select"
4639 selection (if multiple)
4641 Format:
4643 "all" - all
4644 "first" - first entry
4645 "regex" - entries matching regular expression
4646 Default:
4647 "first"
4648 Context:
4650 list (config)
4651 "include_ldap_query.regex"
4653 regular expression
4655 Format:
4657 /".+"/
4658 Default:
4660 ""
4661 Context:
4663 list (config)
4664 "include_ldap_query.nosync_time_ranges"
4666 Time ranges when inclusion is not allowed
4668 Format:
4670 /$time_ranges/
4671 Default:
4673 None.
4674 Context:
4676 list (config)
4677 Available versions:
4679 6.2a.16 and later.
4680 "include_ldap_query.passwd"
4682 See "bind_password".
4684 Context:
4686 list (config)
4687 Available versions:
4689 up to 6.2.56.
4690 "include_ldap_query.use_ssl"
4692 See "use_tls".
4694 Context:
4696 list (config)
4697 Available versions:
4699 5.3a.2 to 6.2.14.
4700 "include_ldap_query.user"
4702 See "bind_dn".
4704 Context:
4706 list (config)
4707 Available versions:
4709 up to 6.2.56.
4710 "include_ldap_2level_query"
4712 (Paragraph) LDAP 2-level query inclusion
4714 Multiple occurrences allowed
4716 This paragraph defines parameters for a two-level query returning a
4718 list of subscribers. Usually the first-level query returns a list of
4719 DNs and the second-level queries convert the DNs into e-mail addresses.
4720 This feature requires the Net::LDAP (perlldap) PERL module.
4721 "include_ldap_2level_query.name"
4723 short name for this source
4725 Format:
4727 /".+"/
4728 Default:
4730 None.
4731 Context:
4733 list (config)
4734 "include_ldap_2level_query.host"
4736 remote host
4738 Format:
4740 /$multiple_host_or_url/
4741 Default:
4743 None, mandatory.
4744 Context:
4746 list (config)
4747 "include_ldap_2level_query.port"
4749 Deprecated.
4751 Context:
4753 list (config)
4754 "include_ldap_2level_query.use_tls"
4756 use TLS (formerly SSL)
4758 Format:
4760 "starttls" - use STARTTLS
4761 "ldaps" - use LDAPS (LDAP over TLS)
4762 "none" - do nothing
4763 Default:
4764 "none"
4765 Context:
4767 list (config)
4768 Available versions:
4770 6.2.15 and later.
4771 "include_ldap_2level_query.ssl_version"
4773 SSL version
4775 Format:
4777 "sslv2" - SSL version 2
4778 "sslv3" - SSL version 3
4779 "tlsv1" - TLS version 1
4780 "tlsv1_1" - TLS version 1.1
4781 "tlsv1_2" - TLS version 1.2
4782 "tlsv1_3" - TLS version 1.3
4783 Default:
4784 "tlsv1"
4785 Context:
4787 list (config)
4788 "include_ldap_2level_query.ssl_ciphers"
4790 SSL ciphers used
4792 Format:
4794 /".+"/
4795 Default:
4797 "ALL"
4798 Context:
4800 list (config)
4801 "include_ldap_2level_query.ca_verify"
4803 Certificate verification
4805 Format:
4807 "none" - do nothing
4808 "optional" - optional
4809 "required" - required
4810 Default:
4811 "required"
4812 Context:
4814 list (config)
4815 Available versions:
4817 6.2.13 and later.
4818 "include_ldap_2level_query.bind_dn"
4820 remote user
4822 Format:
4824 /".+"/
4825 Default:
4827 None.
4828 Context:
4830 list (config)
4831 Available versions:
4833 6.2.57b.1 and later.
4834 "include_ldap_2level_query.bind_password"
4836 remote password
4838 Format:
4840 The value to be concealed.
4841 Default:
4843 None.
4844 Context:
4846 list (config)
4847 Available versions:
4849 6.2.57b.1 and later.
4850 "include_ldap_2level_query.suffix1"
4852 first-level suffix
4854 Format:
4856 /".+"/
4857 Default:
4859 None.
4860 Context:
4862 list (config)
4863 "include_ldap_2level_query.scope1"
4865 first-level search scope
4867 Format:
4869 "base" - base
4870 "one" - one level
4871 "sub" - subtree
4872 Default:
4873 "sub"
4874 Context:
4876 list (config)
4877 "include_ldap_2level_query.timeout1"
4879 first-level connection timeout
4881 Format:
4883 Number of seconds.
4884 Default:
4886 30 (seconds)
4887 Context:
4889 list (config)
4890 "include_ldap_2level_query.filter1"
4892 first-level filter
4894 Format:
4896 /".+"/
4897 Default:
4899 None, mandatory.
4900 Context:
4902 list (config)
4903 "include_ldap_2level_query.attrs1"
4905 first-level extracted attribute
4907 Format:
4909 /$ldap_attrdesc/
4910 Default:
4912 None.
4913 Context:
4915 list (config)
4916 "include_ldap_2level_query.select1"
4918 first-level selection
4920 Format:
4922 "all" - all
4923 "first" - first entry
4924 "regex" - entries matching regular expression
4925 Default:
4926 "first"
4927 Context:
4929 list (config)
4930 "include_ldap_2level_query.regex1"
4932 first-level regular expression
4934 Format:
4936 /".+"/
4937 Default:
4939 ""
4940 Context:
4942 list (config)
4943 "include_ldap_2level_query.suffix2"
4945 second-level suffix template
4947 Format:
4949 /".+"/
4950 Default:
4952 None.
4953 Context:
4955 list (config)
4956 "include_ldap_2level_query.scope2"
4958 second-level search scope
4960 Format:
4962 "base" - base
4963 "one" - one level
4964 "sub" - subtree
4965 Default:
4966 "sub"
4967 Context:
4969 list (config)
4970 "include_ldap_2level_query.timeout2"
4972 second-level connection timeout
4974 Format:
4976 Number of seconds.
4977 Default:
4979 30 (seconds)
4980 Context:
4982 list (config)
4983 "include_ldap_2level_query.filter2"
4985 second-level filter template
4987 Format:
4989 /".+"/
4990 Default:
4992 None, mandatory.
4993 Context:
4995 list (config)
4996 "include_ldap_2level_query.attrs2"
4998 second-level extracted attribute
5000 Format:
5002 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
5003 Default:
5005 "mail"
5006 Context:
5008 list (config)
5009 "include_ldap_2level_query.select2"
5011 second-level selection
5013 Format:
5015 "all" - all
5016 "first" - first entry
5017 "regex" - entries matching regular expression
5018 Default:
5019 "first"
5020 Context:
5022 list (config)
5023 "include_ldap_2level_query.regex2"
5025 second-level regular expression
5027 Format:
5029 /".+"/
5030 Default:
5032 ""
5033 Context:
5035 list (config)
5036 "include_ldap_2level_query.nosync_time_ranges"
5038 Time ranges when inclusion is not allowed
5040 Format:
5042 /$time_ranges/
5043 Default:
5045 None.
5046 Context:
5048 list (config)
5049 Available versions:
5051 6.2a.16 and later.
5052 "include_ldap_2level_query.passwd"
5054 See "bind_password".
5056 Context:
5058 list (config)
5059 Available versions:
5061 up to 6.2.56.
5062 "include_ldap_2level_query.use_ssl"
5064 See "use_tls".
5066 Context:
5068 list (config)
5069 Available versions:
5071 5.3a.2 to 6.2.14.
5072 "include_ldap_2level_query.user"
5074 See "bind_dn".
5076 Context:
5078 list (config)
5079 Available versions:
5081 up to 6.2.56.
5082 "include_sql_query"
5084 (Paragraph) SQL query inclusion
5086 Multiple occurrences allowed
5088 This parameter is used to define the SQL query parameters.
5090 "include_sql_query.name"
5092 short name for this source
5094 Format:
5096 /".+"/
5097 Default:
5099 None.
5100 Context:
5102 list (config)
5103 "include_sql_query.db_type"
5105 database type
5107 Format:
5109 /"\S+"/
5110 Default:
5112 None, mandatory.
5113 Context:
5115 list (config)
5116 "include_sql_query.db_host"
5118 remote host
5120 Format:
5122 /$host/
5123 Default:
5125 None.
5126 Context:
5128 list (config)
5129 Available versions:
5131 6.2.57b.1 and later.
5132 "include_sql_query.db_port"
5134 database port
5136 Format:
5138 /"\d+"/
5139 Default:
5141 None.
5142 Context:
5144 list (config)
5145 "include_sql_query.db_name"
5147 database name
5149 Format:
5151 /"\S+"/
5152 Default:
5154 None, mandatory.
5155 Context:
5157 list (config)
5158 "include_sql_query.db_options"
5160 connection options
5162 Format:
5164 /".+"/
5165 Default:
5167 None.
5168 Context:
5170 list (config)
5171 Available versions:
5173 6.2.57b.1 and later.
5174 "include_sql_query.db_env"
5176 environment variables for database connection
5178 Format:
5180 /"\w+\=\S+(;\w+\=\S+)*"/
5181 Default:
5183 None.
5184 Context:
5186 list (config)
5187 "include_sql_query.db_user"
5189 remote user
5191 Format:
5193 /"\S+"/
5194 Default:
5196 None, mandatory.
5197 Context:
5199 list (config)
5200 Available versions:
5202 6.2.57b.1 and later.
5203 "include_sql_query.db_passwd"
5205 remote password
5207 Format:
5209 The value to be concealed.
5210 Default:
5212 None.
5213 Context:
5215 list (config)
5216 Available versions:
5218 6.2.57b.1 and later.
5219 "include_sql_query.sql_query"
5221 SQL query
5223 Format:
5225 /$sql_query/
5226 Default:
5228 None, mandatory.
5229 Context:
5231 list (config)
5232 "include_sql_query.f_dir"
5234 Directory where the database is stored (used for DBD::CSV only)
5236 Format:
5238 /".+"/
5239 Default:
5241 None.
5242 Context:
5244 list (config)
5245 "include_sql_query.nosync_time_ranges"
5247 Time ranges when inclusion is not allowed
5249 Format:
5251 /$time_ranges/
5252 Default:
5254 None.
5255 Context:
5257 list (config)
5258 Available versions:
5260 6.2a.16 and later.
5261 "include_sql_query.connect_options"
5263 See "db_options".
5265 Context:
5267 list (config)
5268 Available versions:
5270 up to 6.2.56.
5271 "include_sql_query.host"
5273 See "db_host".
5275 Context:
5277 list (config)
5278 Available versions:
5280 up to 6.2.56.
5281 "include_sql_query.passwd"
5283 See "db_passwd".
5285 Context:
5287 list (config)
5288 Available versions:
5290 up to 6.2.56.
5291 "include_sql_query.user"
5293 See "db_user".
5295 Context:
5297 list (config)
5298 Available versions:
5300 up to 6.2.56.
5301 "ttl"
5303 Inclusions timeout
5305 Format:
5307 Number of seconds.
5308 Default:
5310 3600 (seconds)
5311 Context:
5313 list (config), site (sympa.conf)
5314 Sympa caches user data extracted using the include parameter. Their TTL
5316 (time-to-live) within Sympa can be controlled using this parameter. The
5317 default value is 3600
5318 "distribution_ttl"
5320 Inclusions timeout for message distribution
5322 Format:
5324 Number of seconds.
5325 Default:
5327 None.
5328 Context:
5330 list (config), site (sympa.conf)
5331 This parameter defines the delay since the last synchronization after
5333 which the user's list will be updated before performing either of
5334 following actions:
5335 * Reviewing list members
5337 * Message distribution
5339 "include_ldap_ca"
5341 (Paragraph) LDAP query custom attribute
5343 Multiple occurrences allowed
5345 "include_ldap_ca.name"
5347 short name for this source
5349 Format:
5351 /".+"/
5352 Default:
5354 None.
5355 Context:
5357 list (config)
5358 "include_ldap_ca.host"
5360 remote host
5362 Format:
5364 /$multiple_host_or_url/
5365 Default:
5367 None, mandatory.
5368 Context:
5370 list (config)
5371 "include_ldap_ca.port"
5373 Deprecated.
5375 Context:
5377 list (config)
5378 "include_ldap_ca.use_tls"
5380 use TLS (formerly SSL)
5382 Format:
5384 "starttls" - use STARTTLS
5385 "ldaps" - use LDAPS (LDAP over TLS)
5386 "none" - do nothing
5387 Default:
5388 "none"
5389 Context:
5391 list (config)
5392 Available versions:
5394 6.2.15 and later.
5395 "include_ldap_ca.ssl_version"
5397 SSL version
5399 Format:
5401 "sslv2" - SSL version 2
5402 "sslv3" - SSL version 3
5403 "tlsv1" - TLS version 1
5404 "tlsv1_1" - TLS version 1.1
5405 "tlsv1_2" - TLS version 1.2
5406 "tlsv1_3" - TLS version 1.3
5407 Default:
5408 "tlsv1"
5409 Context:
5411 list (config)
5412 "include_ldap_ca.ssl_ciphers"
5414 SSL ciphers used
5416 Format:
5418 /".+"/
5419 Default:
5421 "ALL"
5422 Context:
5424 list (config)
5425 "include_ldap_ca.ca_verify"
5427 Certificate verification
5429 Format:
5431 "none" - do nothing
5432 "optional" - optional
5433 "required" - required
5434 Default:
5435 "required"
5436 Context:
5438 list (config)
5439 Available versions:
5441 6.2.13 and later.
5442 "include_ldap_ca.bind_dn"
5444 remote user
5446 Format:
5448 /".+"/
5449 Default:
5451 None.
5452 Context:
5454 list (config)
5455 Available versions:
5457 6.2.57b.1 and later.
5458 "include_ldap_ca.bind_password"
5460 remote password
5462 Format:
5464 The value to be concealed.
5465 Default:
5467 None.
5468 Context:
5470 list (config)
5471 Available versions:
5473 6.2.57b.1 and later.
5474 "include_ldap_ca.suffix"
5476 suffix
5478 Format:
5480 /".+"/
5481 Default:
5483 None.
5484 Context:
5486 list (config)
5487 "include_ldap_ca.scope"
5489 search scope
5491 Format:
5493 "base" - base
5494 "one" - one level
5495 "sub" - subtree
5496 Default:
5497 "sub"
5498 Context:
5500 list (config)
5501 "include_ldap_ca.timeout"
5503 connection timeout
5505 Format:
5507 Number of seconds.
5508 Default:
5510 30 (seconds)
5511 Context:
5513 list (config)
5514 "include_ldap_ca.filter"
5516 filter
5518 Format:
5520 /".+"/
5521 Default:
5523 None, mandatory.
5524 Context:
5526 list (config)
5527 "include_ldap_ca.attrs"
5529 extracted attribute
5531 Format:
5533 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
5534 Default:
5536 "mail"
5537 Context:
5539 list (config)
5540 "include_ldap_ca.email_entry"
5542 Name of email entry
5544 Format:
5546 /"\S+"/
5547 Default:
5549 None, mandatory.
5550 Context:
5552 list (config)
5553 "include_ldap_ca.select"
5555 selection (if multiple)
5557 Format:
5559 "all" - all
5560 "first" - first entry
5561 "regex" - entries matching regular expression
5562 Default:
5563 "first"
5564 Context:
5566 list (config)
5567 "include_ldap_ca.regex"
5569 regular expression
5571 Format:
5573 /".+"/
5574 Default:
5576 ""
5577 Context:
5579 list (config)
5580 "include_ldap_ca.nosync_time_ranges"
5582 Time ranges when inclusion is not allowed
5584 Format:
5586 /$time_ranges/
5587 Default:
5589 None.
5590 Context:
5592 list (config)
5593 "include_ldap_ca.passwd"
5595 See "bind_password".
5597 Context:
5599 list (config)
5600 Available versions:
5602 up to 6.2.56.
5603 "include_ldap_ca.use_ssl"
5605 See "use_tls".
5607 Context:
5609 list (config)
5610 Available versions:
5612 6.2a? to 6.2.14.
5613 "include_ldap_ca.user"
5615 See "bind_dn".
5617 Context:
5619 list (config)
5620 Available versions:
5622 up to 6.2.56.
5623 "include_ldap_2level_ca"
5625 (Paragraph) LDAP 2-level query custom attribute
5627 Multiple occurrences allowed
5629 "include_ldap_2level_ca.name"
5631 short name for this source
5633 Format:
5635 /".+"/
5636 Default:
5638 None.
5639 Context:
5641 list (config)
5642 "include_ldap_2level_ca.host"
5644 remote host
5646 Format:
5648 /$multiple_host_or_url/
5649 Default:
5651 None, mandatory.
5652 Context:
5654 list (config)
5655 "include_ldap_2level_ca.port"
5657 Deprecated.
5659 Context:
5661 list (config)
5662 "include_ldap_2level_ca.use_tls"
5664 use TLS (formerly SSL)
5666 Format:
5668 "starttls" - use STARTTLS
5669 "ldaps" - use LDAPS (LDAP over TLS)
5670 "none" - do nothing
5671 Default:
5672 "none"
5673 Context:
5675 list (config)
5676 Available versions:
5678 6.2.15 and later.
5679 "include_ldap_2level_ca.ssl_version"
5681 SSL version
5683 Format:
5685 "sslv2" - SSL version 2
5686 "sslv3" - SSL version 3
5687 "tlsv1" - TLS version 1
5688 "tlsv1_1" - TLS version 1.1
5689 "tlsv1_2" - TLS version 1.2
5690 "tlsv1_3" - TLS version 1.3
5691 Default:
5692 "tlsv1"
5693 Context:
5695 list (config)
5696 "include_ldap_2level_ca.ssl_ciphers"
5698 SSL ciphers used
5700 Format:
5702 /".+"/
5703 Default:
5705 "ALL"
5706 Context:
5708 list (config)
5709 "include_ldap_2level_ca.ca_verify"
5711 Certificate verification
5713 Format:
5715 "none" - do nothing
5716 "optional" - optional
5717 "required" - required
5718 Default:
5719 "required"
5720 Context:
5722 list (config)
5723 Available versions:
5725 6.2.13 and later.
5726 "include_ldap_2level_ca.bind_dn"
5728 remote user
5730 Format:
5732 /".+"/
5733 Default:
5735 None.
5736 Context:
5738 list (config)
5739 Available versions:
5741 6.2.57b.1 and later.
5742 "include_ldap_2level_ca.bind_password"
5744 remote password
5746 Format:
5748 The value to be concealed.
5749 Default:
5751 None.
5752 Context:
5754 list (config)
5755 Available versions:
5757 6.2.57b.1 and later.
5758 "include_ldap_2level_ca.suffix1"
5760 first-level suffix
5762 Format:
5764 /".+"/
5765 Default:
5767 None.
5768 Context:
5770 list (config)
5771 "include_ldap_2level_ca.scope1"
5773 first-level search scope
5775 Format:
5777 "base" - base
5778 "one" - one level
5779 "sub" - subtree
5780 Default:
5781 "sub"
5782 Context:
5784 list (config)
5785 "include_ldap_2level_ca.timeout1"
5787 first-level connection timeout
5789 Format:
5791 Number of seconds.
5792 Default:
5794 30 (seconds)
5795 Context:
5797 list (config)
5798 "include_ldap_2level_ca.filter1"
5800 first-level filter
5802 Format:
5804 /".+"/
5805 Default:
5807 None, mandatory.
5808 Context:
5810 list (config)
5811 "include_ldap_2level_ca.attrs1"
5813 first-level extracted attribute
5815 Format:
5817 /$ldap_attrdesc/
5818 Default:
5820 None.
5821 Context:
5823 list (config)
5824 "include_ldap_2level_ca.select1"
5826 first-level selection
5828 Format:
5830 "all" - all
5831 "first" - first entry
5832 "regex" - entries matching regular expression
5833 Default:
5834 "first"
5835 Context:
5837 list (config)
5838 "include_ldap_2level_ca.regex1"
5840 first-level regular expression
5842 Format:
5844 /".+"/
5845 Default:
5847 ""
5848 Context:
5850 list (config)
5851 "include_ldap_2level_ca.suffix2"
5853 second-level suffix template
5855 Format:
5857 /".+"/
5858 Default:
5860 None.
5861 Context:
5863 list (config)
5864 "include_ldap_2level_ca.scope2"
5866 second-level search scope
5868 Format:
5870 "base" - base
5871 "one" - one level
5872 "sub" - subtree
5873 Default:
5874 "sub"
5875 Context:
5877 list (config)
5878 "include_ldap_2level_ca.timeout2"
5880 second-level connection timeout
5882 Format:
5884 Number of seconds.
5885 Default:
5887 30 (seconds)
5888 Context:
5890 list (config)
5891 "include_ldap_2level_ca.filter2"
5893 second-level filter template
5895 Format:
5897 /".+"/
5898 Default:
5900 None, mandatory.
5901 Context:
5903 list (config)
5904 "include_ldap_2level_ca.attrs2"
5906 second-level extracted attribute
5908 Format:
5910 /$ldap_attrdesc/
5911 Default:
5913 "mail"
5914 Context:
5916 list (config)
5917 "include_ldap_2level_ca.select2"
5919 second-level selection
5921 Format:
5923 "all" - all
5924 "first" - first entry
5925 "regex" - entries matching regular expression
5926 Default:
5927 "first"
5928 Context:
5930 list (config)
5931 "include_ldap_2level_ca.regex2"
5933 second-level regular expression
5935 Format:
5937 /".+"/
5938 Default:
5940 ""
5941 Context:
5943 list (config)
5944 "include_ldap_2level_ca.email_entry"
5946 Name of email entry
5948 Format:
5950 /"\S+"/
5951 Default:
5953 None, mandatory.
5954 Context:
5956 list (config)
5957 "include_ldap_2level_ca.nosync_time_ranges"
5959 Time ranges when inclusion is not allowed
5961 Format:
5963 /$time_ranges/
5964 Default:
5966 None.
5967 Context:
5969 list (config)
5970 "include_ldap_2level_ca.passwd"
5972 See "bind_password".
5974 Context:
5976 list (config)
5977 Available versions:
5979 up to 6.2.56.
5980 "include_ldap_2level_ca.use_ssl"
5982 See "use_tls".
5984 Context:
5986 list (config)
5987 Available versions:
5989 6.2a? to 6.2.14.
5990 "include_ldap_2level_ca.user"
5992 See "bind_dn".
5994 Context:
5996 list (config)
5997 Available versions:
5999 up to 6.2.56.
6000 "include_sql_ca"
6002 (Paragraph) SQL query custom attribute
6004 Multiple occurrences allowed
6006 "include_sql_ca.name"
6008 short name for this source
6010 Format:
6012 /".+"/
6013 Default:
6015 None.
6016 Context:
6018 list (config)
6019 "include_sql_ca.db_type"
6021 database type
6023 Format:
6025 /"\S+"/
6026 Default:
6028 None, mandatory.
6029 Context:
6031 list (config)
6032 "include_sql_ca.db_host"
6034 remote host
6036 Format:
6038 /$host/
6039 Default:
6041 None.
6042 Context:
6044 list (config)
6045 Available versions:
6047 6.2.57b.1 and later.
6048 "include_sql_ca.db_port"
6050 database port
6052 Format:
6054 /"\d+"/
6055 Default:
6057 None.
6058 Context:
6060 list (config)
6061 "include_sql_ca.db_name"
6063 database name
6065 Format:
6067 /"\S+"/
6068 Default:
6070 None, mandatory.
6071 Context:
6073 list (config)
6074 "include_sql_ca.db_options"
6076 connection options
6078 Format:
6080 /".+"/
6081 Default:
6083 None.
6084 Context:
6086 list (config)
6087 Available versions:
6089 6.2.57b.1 and later.
6090 "include_sql_ca.db_env"
6092 environment variables for database connection
6094 Format:
6096 /"\w+\=\S+(;\w+\=\S+)*"/
6097 Default:
6099 None.
6100 Context:
6102 list (config)
6103 "include_sql_ca.db_user"
6105 remote user
6107 Format:
6109 /"\S+"/
6110 Default:
6112 None, mandatory.
6113 Context:
6115 list (config)
6116 Available versions:
6118 6.2.57b.1 and later.
6119 "include_sql_ca.db_passwd"
6121 remote password
6123 Format:
6125 The value to be concealed.
6126 Default:
6128 None.
6129 Context:
6131 list (config)
6132 Available versions:
6134 6.2.57b.1 and later.
6135 "include_sql_ca.sql_query"
6137 SQL query
6139 Format:
6141 /$sql_query/
6142 Default:
6144 None, mandatory.
6145 Context:
6147 list (config)
6148 "include_sql_ca.f_dir"
6150 Directory where the database is stored (used for DBD::CSV only)
6152 Format:
6154 /".+"/
6155 Default:
6157 None.
6158 Context:
6160 list (config)
6161 "include_sql_ca.email_entry"
6163 Name of email entry
6165 Format:
6167 /"\S+"/
6168 Default:
6170 None, mandatory.
6171 Context:
6173 list (config)
6174 "include_sql_ca.nosync_time_ranges"
6176 Time ranges when inclusion is not allowed
6178 Format:
6180 /$time_ranges/
6181 Default:
6183 None.
6184 Context:
6186 list (config)
6187 "include_sql_ca.connect_options"
6189 See "db_options".
6191 Context:
6193 list (config)
6194 Available versions:
6196 up to 6.2.56.
6197 "include_sql_ca.host"
6199 See "db_host".
6201 Context:
6203 list (config)
6204 Available versions:
6206 up to 6.2.56.
6207 "include_sql_ca.passwd"
6209 See "db_passwd".
6211 Context:
6213 list (config)
6214 Available versions:
6216 up to 6.2.56.
6217 "include_sql_ca.user"
6219 See "db_user".
6221 Context:
6223 list (config)
6224 Available versions:
6226 up to 6.2.56.
6227 DKIM/DMARC/ARC
6229 DKIM signature verification and re-signing. It requires an external
6230 module: Mail-DKIM.
6231 ARC seals on forwarded messages. It requires an external module: Mail-
6233 DKIM.
6234 "dkim_add_signature_to"
6236 Which service messages to be signed
6238 Format:
6240 /"(?:list|robot)(?:,(?:list|robot))*"/
6241 Default:
6243 "robot,list"
6244 Context:
6246 domain (robot.conf), site (sympa.conf)
6247 Inserts a DKIM signature to service messages in context of robot, list
6249 or both
6250 "dkim_signer_identity"
6252 The "i=" tag as defined in rfc 4871
6254 Format:
6256 /"\S+"/
6257 Default:
6259 None.
6260 Context:
6262 domain (robot.conf), site (sympa.conf)
6263 Default is null.
6265 "dkim_feature"
6267 Insert DKIM signature to messages sent to the list
6269 Format:
6271 "on" - enabled
6272 "off" - disabled
6273 Default:
6274 "off"
6275 Context:
6277 domain (robot.conf), site (sympa.conf)
6278 If set to "on", Sympa may verify DKIM signatures of incoming messages
6280 and/or insert DKIM signature to outgoing messages.
6281 "dkim_parameters"
6283 (Paragraph) DKIM configuration
6285 Single occurrence
6287 A set of parameters in order to define outgoing DKIM signature
6289 "dkim_parameters.private_key_path"
6291 File path for DKIM private key
6293 Format:
6295 /"\S+"/
6296 Default:
6298 None.
6299 Context:
6301 list (config), domain (robot.conf), site (sympa.conf)
6302 The file must contain a PEM encoded private key
6304 "dkim_parameters.selector"
6306 Selector for DNS lookup of DKIM public key
6308 Format:
6310 /"\S+"/
6311 Default:
6313 None.
6314 Context:
6316 list (config), domain (robot.conf), site (sympa.conf)
6317 The selector is used in order to build the DNS query for public key. It
6319 is up to you to choose the value you want but verify that you can query
6320 the public DKIM key for "<selector>._domainkey.your_domain"
6321 "dkim_parameters.header_list"
6323 Deprecated.
6325 Context:
6327 list (config), domain (robot.conf), site (sympa.conf)
6328 "dkim_parameters.signer_domain"
6330 DKIM "d=" tag, you should probably use the default value
6332 Format:
6334 /"\S+"/
6335 Default:
6337 None.
6338 Context:
6340 list (config), domain (robot.conf), site (sympa.conf)
6341 The DKIM "d=" tag, is the domain of the signing entity. The list domain
6343 MUST be included in the "d=" domain
6344 "dkim_parameters.signer_identity"
6346 DKIM "i=" tag, you should probably leave this parameter empty
6348 Format:
6350 /"\S+"/
6351 Default:
6353 None.
6354 Context:
6356 list (config)
6357 DKIM "i=" tag, you should probably not use this parameter, as
6359 recommended by RFC 4871, default for list brodcasted messages is
6360 i=<listname>-request@<domain>
6361 "dkim_signature_apply_on"
6363 The categories of messages sent to the list that will be signed using
6365 DKIM.
6366 Format:
6368 Multiple values allowed, separated by "","".
6369 "md5_authenticated_messages" - authenticated by password
6371 "smime_authenticated_messages" - authenticated by S/MIME signature
6372 "dkim_authenticated_messages" - authenticated by DKIM signature
6373 "editor_validated_messages" - approved by moderator
6374 "none" - do nothing
6375 "any" - any messages
6376 Default:
6377 "md5_authenticated_messages,smime_authenticated_messages,dkim_authenticated_messages,editor_validated_messages"
6378 Context:
6380 list (config), domain (robot.conf), site (sympa.conf)
6381 This parameter controls in which case messages must be signed using
6383 DKIM, you may sign every message choosing 'any' or a subset. The
6384 parameter value is a comma separated list of keywords
6385 "arc_feature"
6387 Add ARC seals to messages sent to the list
6389 Format:
6391 "on" - enabled
6392 "off" - disabled
6393 Default:
6394 "off"
6395 Context:
6397 list (config), domain (robot.conf), site (sympa.conf)
6398 Available versions:
6400 6.2.37b.1 and later.
6401 Enable/Disable ARC. This feature requires Mail::DKIM::ARC to be
6403 installed, and maybe some custom scenario to be updated
6404 "arc_srvid"
6406 SRV ID for Authentication-Results used in ARC seal
6408 Format:
6410 /"\S+"/
6411 Default:
6413 None.
6414 Context:
6416 domain (robot.conf), site (sympa.conf)
6417 Available versions:
6419 6.2.37b.1 and later.
6420 Typically the domain of the mail server
6422 "arc_parameters"
6424 (Paragraph) ARC configuration
6426 Single occurrence
6428 A set of parameters in order to define outgoing ARC seal
6430 "arc_parameters.arc_private_key_path"
6432 File path for ARC private key
6434 Format:
6436 /"\S+"/
6437 Default:
6439 None.
6440 Context:
6442 list (config), domain (robot.conf), site (sympa.conf)
6443 The file must contain a PEM encoded private key. Defaults to same file
6445 as DKIM private key
6446 "arc_parameters.arc_selector"
6448 Selector for DNS lookup of ARC public key
6450 Format:
6452 /"\S+"/
6453 Default:
6455 None.
6456 Context:
6458 list (config), domain (robot.conf), site (sympa.conf)
6459 The selector is used in order to build the DNS query for public key. It
6461 is up to you to choose the value you want but verify that you can query
6462 the public DKIM key for "<selector>._domainkey.your_domain". Default is
6463 the same selector as for DKIM signatures
6464 "arc_parameters.arc_signer_domain"
6466 ARC "d=" tag, you should probably use the default value
6468 Format:
6470 /"\S+"/
6471 Default:
6473 None.
6474 Context:
6476 list (config), domain (robot.conf), site (sympa.conf)
6477 The ARC "d=" tag is the domain of the signing entity. The DKIM d=
6479 domain name is used as its default value
6480 "dmarc_protection"
6482 (Paragraph) DMARC Protection
6484 Single occurrence
6486 Parameters to define how to manage From address processing to avoid
6488 some domains' excessive DMARC protection
6489 "dmarc_protection.mode"
6491 Protection modes
6493 Format:
6495 Multiple values allowed, separated by "","".
6496 "none" - do nothing
6498 "all" - all
6499 "dkim_signature" - DKIM signature exists
6500 "dmarc_reject" - DMARC policy suggests rejection
6501 "dmarc_any" - DMARC policy exists
6502 "dmarc_quarantine" - DMARC policy suggests quarantine
6503 "domain_regex" - domain matching regular expression
6504 Default:
6505 None.
6506 Context:
6508 list (config), domain (robot.conf), site (sympa.conf)
6509 Select one or more operation modes. "Domain matching regular
6511 expression" (domain_regex) matches the specified Domain regular
6512 expression; "DKIM signature exists" (dkim_signature) matches any
6513 message with a DKIM signature header; "DMARC policy ..." (dmarc_*)
6514 matches messages from sender domains with a DMARC policy as given;
6515 "all" (all) matches all messages.
6516 Example:
6518 dmarc_protection.mode dmarc_reject,dkim_signature
6520 "dmarc_protection.domain_regex"
6522 Regular expression for domain name match
6524 Format:
6526 /".+"/
6527 Default:
6529 None.
6530 Context:
6532 list (config), domain (robot.conf), site (sympa.conf)
6533 Regular expression match pattern for From domain
6535 "dmarc_protection.other_email"
6537 New From address
6539 Format:
6541 /".+"/
6542 Default:
6544 None.
6545 Context:
6547 list (config), domain (robot.conf), site (sympa.conf)
6548 This is the email address to use when modifying the From header. It
6550 defaults to the list address. This is similar to Anonymisation but
6551 preserves the original sender details in the From address phrase.
6552 "dmarc_protection.phrase"
6554 New From name format
6556 Format:
6558 "display_name" - "Name"
6559 "name_and_email" - "Name" (e-mail)
6560 "name_via_list" - "Name" (via List)
6561 "name_email_via_list" - "Name" (e-mail via List)
6562 "list_for_email" - "List" (on behalf of e-mail)
6563 "list_for_name" - "List" (on behalf of Name)
6564 Default:
6565 "name_via_list"
6566 Context:
6568 list (config), domain (robot.conf), site (sympa.conf)
6569 This is the format to be used for the sender name part of the new From
6571 header field.
6572 List address verification
6574 Checks if an alias with the same name as the list to be created already
6575 exists on the SMTP server. This feature requires an external module:
6576 Net-SMTP.
6577 "list_check_helo"
6579 SMTP HELO (EHLO) parameter used for address verification
6581 Format:
6583 /"\S+"/
6584 Default:
6586 None.
6587 Context:
6589 domain (robot.conf), site (sympa.conf)
6590 Available versions:
6592 6.2a.0 and later.
6593 Default value is the host part of "list_check_smtp" parameter.
6595 "list_check_smtp"
6597 SMTP server to verify existence of the same addresses as the list to be
6599 created
6600 Format:
6602 /$hostport/
6603 Default:
6605 None.
6606 Context:
6608 domain (robot.conf), site (sympa.conf)
6609 This is needed if you are running Sympa on a host but you handle all
6611 your mail on a separate mail relay.
6612 Default value is real FQDN of the host. Port number may be specified as
6614 "mail.example.org:25" or "203.0.113.1:25". If port is not specified,
6615 standard port (25) will be used.
6616 "list_check_suffixes"
6618 Address suffixes to verify
6620 Format:
6622 /"\S+"/
6623 Default:
6625 "request,owner,editor,unsubscribe,subscribe"
6626 Context:
6628 domain (robot.conf), site (sympa.conf)
6629 List of suffixes you are using for list addresses, i.e. "mylist-
6631 request", "mylist-owner" and so on.
6632 This parameter is used with the "list_check_smtp" parameter. It is also
6634 used to check list names at list creation time.
6635 Antivirus plug-in
6637 "antivirus_path"
6638 Path to the antivirus scanner engine
6640 Format:
6642 /".+"/
6643 Default:
6645 None.
6646 Context:
6648 domain (robot.conf), site (sympa.conf)
6649 Supported antivirus: Clam AntiVirus/clamscan & clamdscan,
6651 McAfee/uvscan, Fsecure/fsav, Sophos, AVP and Trend Micro/VirusWall
6652 Example:
6654 antivirus_path /usr/local/bin/clamscan
6656 "antivirus_args"
6658 Antivirus plugin command line arguments
6660 Format:
6662 /".+"/
6663 Default:
6665 None.
6666 Context:
6668 domain (robot.conf), site (sympa.conf)
6669 Example:
6671 antivirus_args --no-summary --database /usr/local/share/clamav
6673 "antivirus_notify"
6675 Notify sender if virus checker detects malicious content
6677 Format:
6679 "sender" - sender
6680 "delivery_status" - send back DSN
6681 "none" - do nothing
6682 Default:
6683 "sender"
6684 Context:
6686 domain (robot.conf), site (sympa.conf)
6687 "sender" to notify originator of the message, "delivery_status" to send
6689 delivery status, or "none"
6690 Miscellaneous
6692 "email"
6693 Local part of Sympa email address
6695 Format:
6697 /"\S+"/
6698 Default:
6700 "sympa"
6701 Context:
6703 domain (robot.conf), site (sympa.conf)
6704 Local part (the part preceding the "@" sign) of the address by which
6706 mail interface of Sympa accepts mail commands.
6707 If you change the default value, you must modify the mail aliases too.
6709 "listmaster_email"
6711 Local part of listmaster email address
6713 Format:
6715 /"\S+"/
6716 Default:
6718 "listmaster"
6719 Context:
6721 domain (robot.conf), site (sympa.conf)
6722 Local part (the part preceding the "@" sign) of the address by which
6724 listmasters receive messages.
6725 If you change the default value, you must modify the mail aliases too.
6727 "custom_robot_parameter"
6729 Custom robot parameter
6731 Format:
6733 Multiple occurrences allowed.
6734 /".+"/
6736 Default:
6738 None.
6739 Context:
6741 domain (robot.conf), site (sympa.conf)
6742 Used to define a custom parameter for your server. Do not forget the
6744 semicolon between the parameter name and the parameter value.
6745 You will be able to access the custom parameter value in web templates
6747 by variable "conf.custom_robot_parameter.<param_name>"
6748 Example:
6750 custom_robot_parameter param_name ; param_value
6752 "prohibited_listnames"
6754 Prevent people to use some names for their lists names
6756 Format:
6758 Any.
6759 Default:
6761 None.
6762 Context:
6764 site (sympa.conf)
6765 Available versions:
6767 6.2.63b.1 and later.
6768 This parameter is a comma-separated list of names. You can use * as a
6770 wildcard character. To use a regex for this, please use
6771 prohibited_listnames_regex setting.
6772 Example:
6774 prohibited_listnames www,root,*master
6776 "prohibited_listnames_regex"
6778 Prevent people to use some names for their lists names, based on a
6780 regex
6781 Format:
6783 Any.
6784 Default:
6786 None.
6787 Context:
6789 site (sympa.conf)
6790 Available versions:
6792 6.2.63b.1 and later.
6793 This parameter is a regex. Please note that prohibited_listnames and
6795 prohibited_listnames_regex will both be applied if set, they are not
6796 exclusive.
6797 Example:
6799 prohibited_listnames_regex www|root|.*master
6801 "cache_list_config"
6803 Use of binary cache of list configuration
6805 Format:
6807 "binary_file" - use binary file
6808 "none" - do nothing
6809 Default:
6810 "none"
6811 Context:
6813 site (sympa.conf)
6814 binary_file: Sympa processes will maintain a binary version of the list
6816 configuration, "config.bin" file on local disk. If you manage a big
6817 amount of lists (1000+), it should make the web interface startup
6818 faster.
6819 You can recreate cache by running "sympa.pl --reload_list_config".
6821 "db_list_cache"
6823 Use database cache to search lists
6825 Format:
6827 "on" - enabled
6828 "off" - disabled
6829 Default:
6830 "off"
6831 Context:
6833 site (sympa.conf)
6834 Note that "list_table" database table should be filled at the first
6836 time by running:
6837 # sympa.pl --sync_list_db
6839 "purge_user_table_task"
6841 Task for expiring inactive users
6843 Format:
6845 /"\w+"/
6846 Default:
6848 "monthly"
6849 Context:
6851 site (sympa.conf)
6852 This task removes rows in the "user_table" table which have not
6854 corresponding entries in the "subscriber_table" table.
6855 "purge_logs_table_task"
6857 Task for cleaning tables
6859 Format:
6861 /"\w+"/
6862 Default:
6864 "daily"
6865 Context:
6867 site (sympa.conf)
6868 This task cleans old logs from "logs_table" table.
6870 "logs_expiration_period"
6872 Max age of logs in database
6874 Format:
6876 Number of months.
6877 Default:
6879 3 (months)
6880 Context:
6882 site (sympa.conf)
6883 Number of months that elapse before a log is expired
6885 "stats_expiration_period"
6887 Max age of statistics information in database
6889 Format:
6891 Number of months.
6892 Default:
6894 3 (months)
6895 Context:
6897 site (sympa.conf)
6898 Available versions:
6900 6.2b.7 and later.
6901 Number of months that elapse before statistics information are expired
6903 "umask"
6905 Umask
6907 Format:
6909 /"[0-7]+"/
6910 Default:
6912 027
6913 Context:
6915 site (sympa.conf)
6916 Default mask for file creation (see umask(2)). Note that it will be
6918 interpreted as an octal value.
6919 "clean_delay_queuemod"
6921 Max age of moderated messages
6923 Format:
6925 Number of days.
6926 Default:
6928 30 (days)
6929 Context:
6931 list (config), site (sympa.conf)
6932 Number of days messages are kept in moderation spool (as specified by
6934 "queuemod" parameter). Beyond this deadline, messages that have not
6935 been processed are deleted.
6936 "custom_attribute"
6938 (Paragraph) Custom user attributes
6940 Multiple occurrences allowed
6942 "custom_attribute.id"
6944 internal identifier
6946 Format:
6948 /"\w+"/
6949 Default:
6951 None, mandatory.
6952 Context:
6954 list (config)
6955 "custom_attribute.name"
6957 label
6959 Format:
6961 /".+"/
6962 Default:
6964 None, mandatory.
6965 Context:
6967 list (config)
6968 "custom_attribute.comment"
6970 additional comment
6972 Format:
6974 /".+"/
6975 Default:
6977 None.
6978 Context:
6980 list (config)
6981 "custom_attribute.type"
6983 type
6985 Format:
6987 "string" - string
6988 "text" - multi-line text
6989 "integer" - number
6990 "enum" - set of keywords
6991 Default:
6992 "string"
6993 Context:
6995 list (config)
6996 "custom_attribute.enum_values"
6998 possible attribute values (if enum is used)
7000 Format:
7002 /".+"/
7003 Default:
7005 None.
7006 Context:
7008 list (config)
7009 "custom_attribute.optional"
7011 is the attribute optional?
7013 Format:
7015 "required" - required
7016 "optional" - optional
7017 Default:
7018 "optional"
7019 Context:
7021 list (config)
7022 "custom_vars"
7024 (Paragraph) custom parameters
7026 Multiple occurrences allowed
7028 "custom_vars.name"
7030 var name
7032 Format:
7034 /"\S+"/
7035 Default:
7037 None, mandatory.
7038 Context:
7040 list (config)
7041 "custom_vars.value"
7043 var value
7045 Format:
7047 /".+"/
7048 Default:
7050 None, mandatory.
7051 Context:
7053 list (config)
7054 "loop_prevention_regex"
7056 Regular expression applied to prevent loops with robots
7058 Format:
7060 /"\S*"/
7061 Default:
7063 "mailer-daemon|sympa|listserv|majordomo|smartlist|mailman"
7064 Context:
7066 list (config), domain (robot.conf), site (sympa.conf)
7067 If the sender address matches the regular expression, then the message
7069 is rejected.
7070 "pictures_feature"
7072 Pictures
7074 Format:
7076 "on" - enabled
7077 "off" - disabled
7078 Default:
7079 "on"
7080 Context:
7082 list (config), domain (robot.conf), site (sympa.conf)
7083 Enables or disables the pictures feature by default. If enabled,
7085 subscribers can upload their picture (from the "Subscriber option"
7086 page) to use as an avatar.
7087 Pictures are stored in a directory specified by the
7089 "static_content_path" parameter.
7090 "remind_task"
7092 Periodical subscription reminder task
7094 Format:
7096 /"\w+"/
7097 Default:
7099 None.
7100 Context:
7102 list (config), site (sympa.conf)
7103 This parameter states which model is used to create a remind task. A
7105 remind task regularly sends subscribers a message which reminds them
7106 of their list subscriptions.
7107 "latest_instantiation"
7109 (Paragraph) Latest family instantiation
7111 Single occurrence
7113 "latest_instantiation.email"
7115 who ran the instantiation
7117 Format:
7119 /"listmaster|$email"/
7120 Default:
7122 None.
7123 Context:
7125 list (config)
7126 "latest_instantiation.date_epoch"
7128 date
7130 Format:
7132 The time in second from Unix epoch.
7133 Default:
7135 None, mandatory.
7136 Context:
7138 list (config)
7139 "latest_instantiation.date"
7141 Deprecated.
7143 Context:
7145 list (config)
7146 Available versions:
7148 up to 6.2.16.
7149 "creation"
7151 (Paragraph) Creation of the list
7153 Single occurrence
7155 "creation.email"
7157 who created the list
7159 Format:
7161 /"listmaster|$email"/
7162 Default:
7164 None, mandatory.
7165 Context:
7167 list (config)
7168 "creation.date_epoch"
7170 date
7172 Format:
7174 The time in second from Unix epoch.
7175 Default:
7177 None, mandatory.
7178 Context:
7180 list (config)
7181 "creation.date"
7183 Deprecated.
7185 Context:
7187 list (config)
7188 Available versions:
7190 up to 6.2.16.
7191 "update"
7193 (Paragraph) Last update of config
7195 Single occurrence
7197 "update.email"
7199 who updated the config
7201 Format:
7203 /"(listmaster|automatic|$email)"/
7204 Default:
7206 None.
7207 Context:
7209 list (config)
7210 "update.date_epoch"
7212 date
7214 Format:
7216 The time in second from Unix epoch.
7217 Default:
7219 None, mandatory.
7220 Context:
7222 list (config)
7223 "update.date"
7225 Deprecated.
7227 Context:
7229 list (config)
7230 Available versions:
7232 up to 6.2.16.
7233 "status"
7235 Status of the list
7237 Format:
7239 Status of list.
7240 Default:
7242 "open"
7243 Context:
7245 list (config)
7246 "serial"
7248 Serial number of the config
7250 Format:
7252 /"\d+"/
7253 Default:
7255 0
7256 Context:
7258 list (config)
7259 Web interface parameters
7261 "wwsympa_url"
7262 URL prefix of web interface
7264 Format:
7266 Any.
7267 Default:
7269 None.
7270 Context:
7272 domain (robot.conf), site (sympa.conf)
7273 This is used to construct URLs of web interface. The protocol (either
7275 https:// or http://) is required.
7276 Example:
7278 wwsympa_url https://web.example.org/sympa
7280 "wwsympa_url_local"
7282 URL prefix of WWSympa behind proxy
7284 Format:
7286 Any.
7287 Default:
7289 None.
7290 Context:
7292 domain (robot.conf), site (sympa.conf)
7293 Available versions:
7295 6.2.56 and later.
7296 "static_content_url"
7298 URL for static contents
7300 Format:
7302 Any.
7303 Default:
7305 "/static-sympa"
7306 Context:
7308 domain (robot.conf), site (sympa.conf)
7309 HTTP server have to map it with "static_content_path" directory.
7311 "static_content_path"
7313 Directory for static contents
7315 Format:
7317 Any.
7318 Default:
7320 $STATICDIR
7321 Context:
7323 domain (robot.conf), site (sympa.conf)
7324 "css_path"
7326 Directory for static style sheets (CSS)
7328 Format:
7330 Any.
7331 Default:
7333 $CSSDIR
7334 Context:
7336 site (sympa.conf)
7337 After an upgrade, static CSS files are upgraded with the newly
7339 installed "css.tt2" template. Therefore, this is not a good place to
7340 store customized CSS files.
7341 "css_url"
7343 URL for style sheets (CSS)
7345 Format:
7347 Any.
7348 Default:
7350 "/static-sympa/css"
7351 Context:
7353 site (sympa.conf)
7354 To use auto-generated static CSS, HTTP server have to map it with
7356 "css_path".
7357 "pictures_path"
7359 Directory for subscribers pictures
7361 Format:
7363 Any.
7364 Default:
7366 $PICTURESDIR
7367 Context:
7369 site (sympa.conf)
7370 Available versions:
7372 6.2.25b.2 and later.
7373 "pictures_url"
7375 URL for subscribers pictures
7377 Format:
7379 Any.
7380 Default:
7382 "/static-sympa/pictures"
7383 Context:
7385 site (sympa.conf)
7386 Available versions:
7388 6.2.25b.2 and later.
7389 HTTP server have to map it with "pictures_path" directory.
7391 "mhonarc"
7393 Path to MHonArc mail-to-HTML converter
7395 Format:
7397 Any.
7398 Default:
7400 "/usr/bin/mhonarc"
7401 Context:
7403 domain (robot.conf), site (sympa.conf)
7404 This is required for HTML mail archiving.
7406 "log_facility"
7408 System log facility for web interface
7410 Format:
7412 Any.
7413 Default:
7415 "LOCAL1"
7416 Context:
7418 site (sympa.conf)
7419 System log facility for WWSympa, archived.pl and bounced.pl. Default is
7421 to use value of "syslog" parameter.
7422 Web interface parameters: Appearances
7424 "logo_html_definition"
7425 Custom logo
7427 Format:
7429 Any.
7430 Default:
7432 None.
7433 Context:
7435 domain (robot.conf), site (sympa.conf)
7436 HTML fragment to insert a logo in the page of web interface.
7438 Example:
7440 logo_html_definition <a href="http://www.example.com"><img style="float: left; margin-top: 7px; margin-left: 37px;" src="http://www.example.com/logos/mylogo.jpg" alt="My Company" /></a>
7442 "favicon_url"
7444 Custom favicon
7446 Format:
7448 Any.
7449 Default:
7451 None.
7452 Context:
7454 domain (robot.conf), site (sympa.conf)
7455 Available versions:
7457 6.2a.5 and later.
7458 URL of favicon image
7460 "color_0", ..., "color_15"
7462 Colors for web interface
7464 Format:
7466 Any.
7467 Default:
7469 See description on web interface.
7470 Context:
7472 domain (robot.conf), site (sympa.conf)
7473 Colors are used in style sheet (CSS). They may be changed using web
7475 interface by listmasters.
7476 "dark_color", "light_color", "text_color", "bg_color", "error_color",
7478 "selected_color", "shaded_color"
7479 Colors for web interface, obsoleted
7481 Format:
7483 Any.
7484 Default:
7486 See description on web interface.
7487 Context:
7489 domain (robot.conf), site (sympa.conf)
7490 "default_home"
7492 Type of main web page
7494 Format:
7496 Any.
7497 Default:
7499 "home"
7500 Context:
7502 domain (robot.conf), site (sympa.conf)
7503 "lists" for the page of list of lists. "home" for home page.
7505 "archive_default_index"
7507 Default index organization of web archive
7509 Format:
7511 Any.
7512 Default:
7514 "thrd"
7515 Context:
7517 site (sympa.conf)
7518 thrd: Threaded index.
7520 mail: Chronological index.
7522 "review_page_size"
7524 Size of review page
7526 Format:
7528 Any.
7529 Default:
7531 25
7532 Context:
7534 domain (robot.conf), site (sympa.conf)
7535 Default number of lines of the array displaying users in the review
7537 page
7538 "viewlogs_page_size"
7540 Size of viewlogs page
7542 Format:
7544 Any.
7545 Default:
7547 25
7548 Context:
7550 domain (robot.conf), site (sympa.conf)
7551 Default number of lines of the array displaying the log entries in the
7553 logs page.
7554 "main_menu_custom_button_1_title", ...
7556 "main_menu_custom_button_3_title", "main_menu_custom_button_1_url", ...
7557 "main_menu_custom_button_3_url", "main_menu_custom_button_1_target",
7558 ... "main_menu_custom_button_3_target"
7559 Custom menus
7561 Format:
7563 Any.
7564 Default:
7566 None.
7567 Context:
7569 domain (robot.conf), site (sympa.conf)
7570 You may modify the main menu content by editing the menu.tt2 file, but
7572 you can also edit these parameters in order to add up to 3 buttons.
7573 Each button is defined by a title (the text in the button), an URL and,
7574 optionally, a target.
7575 Example:
7577 main_menu_custom_button_1_title FAQ
7579 main_menu_custom_button_1_url http://www.renater.fr/faq/universalistes/index
7580 main_menu_custom_button_1_target Help
7581 Password validation
7583 Checks if the password the user submitted has sufficient strength. This
7584 feature requires an external module: Data-Password.
7585 "password_validation"
7587 Password validation
7589 Format:
7591 Any.
7592 Default:
7594 None.
7595 Context:
7597 site (sympa.conf)
7598 Available versions:
7600 6.1.23 and later.
7601 The password validation techniques to be used against user passwords
7603 that are added to mailing lists. Options come from Data::Password
7604 (http://search.cpan.org/~razinf/Data-Password-1.07/Password.pm#VARIABLES)
7605 Example:
7607 password_validation MINLEN=8,GROUPS=3,DICTIONARY=4,DICTIONARIES=/pentest/dictionaries
7609 Authentication with LDAP
7611 Authenticates users based on the directory on LDAP server. This feature
7612 requires an external module: Net-LDAP. And also, if secure connection
7613 (LDAPS) is required: IO-Socket-SSL.
7614 "ldap_force_canonical_email"
7616 Use canonical email address for LDAP authentication
7618 Format:
7620 Any.
7621 Default:
7623 1
7624 Context:
7626 domain (robot.conf), site (sympa.conf)
7627 When using LDAP authentication, if the identifier provided by the user
7629 was a valid email, if this parameter is set to false, then the provided
7630 email will be used to authenticate the user. Otherwise, use of the
7631 first email returned by the LDAP server will be used.
7632 SOAP HTTP interface
7634 Provides some functions of Sympa through the SOAP HTTP interface. This
7635 feature requires an external module: SOAP-Lite.
7636 "soap_url"
7638 URL of SympaSOAP
7640 Format:
7642 Any.
7643 Default:
7645 None.
7646 Context:
7648 domain (robot.conf), site (sympa.conf)
7649 WSDL document of SympaSOAP refers to this URL in its service section.
7651 Example:
7653 soap_url http://web.example.org/sympasoap
7655 "soap_url_local"
7657 URL of SympaSOAP behind proxy
7659 Format:
7661 Any.
7662 Default:
7664 None.
7665 Context:
7667 domain (robot.conf), site (sympa.conf)
7668 Available versions:
7670 6.2.19b.1 and later.
7671 Web interface parameters: Miscellaneous
7673 "cookie_domain"
7674 HTTP cookies validity domain
7676 Format:
7678 Any.
7679 Default:
7681 "localhost"
7682 Context:
7684 domain (robot.conf), site (sympa.conf)
7685 If beginning with a dot ("."), the cookie is available within the
7687 specified Internet domain. Otherwise, for the specified host. The only
7688 reason for replacing the default value would be where WWSympa's
7689 authentication process is shared with an application running on another
7690 host.
7691 Example:
7693 cookie_domain .renater.fr
7695 "cookie_expire"
7697 HTTP cookies lifetime
7699 Format:
7701 Any.
7702 Default:
7704 0
7705 Context:
7707 site (sympa.conf)
7708 This is the default value when not set explicitly by users. "0" means
7710 the cookie may be retained during browser sessions.
7711 "cookie_refresh"
7713 Average interval to refresh HTTP session ID.
7715 Format:
7717 Any.
7718 Default:
7720 60
7721 Context:
7723 site (sympa.conf)
7724 "purge_session_table_task"
7726 Task for cleaning old sessions
7728 Format:
7730 /"\w+"/
7731 Default:
7733 "daily"
7734 Context:
7736 site (sympa.conf)
7737 This task removes old entries in the "session_table" table.
7739 "session_table_ttl"
7741 Max age of sessions
7743 Format:
7745 Any.
7746 Default:
7748 "2d"
7749 Context:
7751 site (sympa.conf)
7752 Session duration is controlled by "sympa_session" cookie validity
7754 attribute. However, by security reason, this delay also need to be
7755 controlled by server side. This task removes old entries in the
7756 "session_table" table.
7757 Format of values is a string without spaces including "y" for years,
7759 "m" for months, "d" for days, "h" for hours, "min" for minutes and
7760 "sec" for seconds.
7761 "anonymous_session_table_ttl"
7763 Max age of sessions for anonymous users
7765 Format:
7767 Any.
7768 Default:
7770 "1h"
7771 Context:
7773 site (sympa.conf)
7774 "shared_feature"
7776 Enable shared repository
7778 Format:
7780 "on" - enabled
7781 "off" - disabled
7782 Default:
7783 "off"
7784 Context:
7786 domain (robot.conf), site (sympa.conf)
7787 Available versions:
7789 6.2.41b.2 and later.
7790 If set to "on", list owners can open shared repository.
7792 "use_html_editor"
7794 Use HTML editor
7796 Format:
7798 "off" - disabled
7799 "on" - enabled
7800 Default:
7801 "off"
7802 Context:
7804 domain (robot.conf), site (sympa.conf)
7805 Available versions:
7807 6.2a.0 and later.
7808 If set to "on", users will be able to post messages in HTML using a
7810 javascript WYSIWYG editor.
7811 Example:
7813 use_html_editor on
7815 "html_editor_url"
7817 URL of HTML editor
7819 Format:
7821 Any.
7822 Default:
7824 None.
7825 Context:
7827 domain (robot.conf), site (sympa.conf)
7828 Available versions:
7830 6.2a.34 and later.
7831 URL path to the javascript file making the WYSIWYG HTML editor
7833 available. Relative path under <static_content_url> or absolute path.
7834 Example is for TinyMCE 4 installed under
7836 <static_content_path>/js/tinymce/.
7837 Example:
7839 html_editor_url js/tinymce/tinymce.min.js
7841 "html_editor_init"
7843 HTML editor initialization
7845 Format:
7847 Any.
7848 Default:
7850 None.
7851 Context:
7853 domain (robot.conf), site (sympa.conf)
7854 Available versions:
7856 6.2a.0 and later.
7857 Javascript excerpt that enables and configures the WYSIWYG HTML editor.
7859 Example:
7861 html_editor_init tinymce.init({selector:"#body",language:lang.split(/[^a-zA-Z]+/).join("_")});
7863 "max_wrong_password"
7865 Count limit of wrong password submission
7867 Format:
7869 Any.
7870 Default:
7872 19
7873 Context:
7875 domain (robot.conf), site (sympa.conf)
7876 If this limit is reached, the account is locked until the user renews
7878 their password. The default value is chosen in order to block bots
7879 trying to log in using brute force strategy. This value should never be
7880 reached by real users that will probably uses the renew password
7881 service before they performs so many tries.
7882 "password_case"
7884 Password case
7886 Format:
7888 Any.
7889 Default:
7891 "insensitive"
7892 Context:
7894 site (sympa.conf)
7895 "insensitive" or "sensitive".
7897 If set to "insensitive", WWSympa's password check will be insensitive.
7899 This only concerns passwords stored in the Sympa database, not the ones
7900 in LDAP.
7901 Should not be changed! May invalid all user password.
7903 "password_hash"
7905 Password hashing algorithm
7907 Format:
7909 Any.
7910 Default:
7912 "md5"
7913 Context:
7915 site (sympa.conf)
7916 Available versions:
7918 6.2.25b.3 and later.
7919 "md5" or "bcrypt".
7921 If set to "md5", Sympa will use MD5 password hashes. If set to
7923 "bcrypt", bcrypt hashes will be used instead. This only concerns
7924 passwords stored in the Sympa database, not the ones in LDAP.
7925 "password_hash_update"
7927 Update password hashing algorithm when users log in
7929 Format:
7931 Any.
7932 Default:
7934 1
7935 Context:
7937 site (sympa.conf)
7938 Available versions:
7940 6.2.25b.3 and later.
7941 On successful login, update the encrypted user password to use the
7943 algorithm specified by "password_hash". This allows for a graceful
7944 transition to a new password hash algorithm. A value of 0 disables
7945 updating of existing password hashes. New and reset passwords will use
7946 the "password_hash" setting in all cases.
7947 "bcrypt_cost"
7949 Bcrypt hash cost
7951 Format:
7953 Any.
7954 Default:
7956 12
7957 Context:
7959 site (sympa.conf)
7960 Available versions:
7962 6.2.25b.3 and later.
7963 When "password_hash" is set to "bcrypt", this sets the "cost" parameter
7965 of the bcrypt hash function. The default of 12 is expected to require
7966 approximately 250ms to calculate the password hash on a 3.2GHz CPU.
7967 This only concerns passwords stored in the Sympa database, not the ones
7968 in LDAP.
7969 Can be changed but any new cost setting will only apply to new
7971 passwords.
7972 "one_time_ticket_lifetime"
7974 Age of one time ticket
7976 Format:
7978 Any.
7979 Default:
7981 "2d"
7982 Context:
7984 site (sympa.conf)
7985 Duration before the one time tickets are expired
7987 "one_time_ticket_lockout"
7989 Restrict access to one time ticket
7991 Format:
7993 Any.
7994 Default:
7996 "one_time"
7997 Context:
7999 domain (robot.conf), site (sympa.conf)
8000 Is access to the one time ticket restricted, if any users previously
8002 accessed? (one_time | remote_addr | open)
8003 "purge_one_time_ticket_table_task"
8005 Task for expiring old one time tickets
8007 Format:
8009 /"\w+"/
8010 Default:
8012 "daily"
8013 Context:
8015 site (sympa.conf)
8016 "one_time_ticket_table_ttl"
8018 Expiration period of one time ticket
8020 Format:
8022 Any.
8023 Default:
8025 "10d"
8026 Context:
8028 site (sympa.conf)
8029 "pictures_max_size"
8031 The maximum size of uploaded picture
8033 Format:
8035 Number of bytes.
8036 Default:
8038 102400 (bytes)
8039 Context:
8041 domain (robot.conf), site (sympa.conf)
8042 "spam_protection"
8044 Protect web interface against spam harvesters
8046 Format:
8048 "at" - replace @ characters
8049 "javascript" - use JavaScript
8050 "none" - do nothing
8051 Default:
8052 "javascript"
8053 Context:
8055 list (config), domain (robot.conf), site (sympa.conf)
8056 There is a need to protect Sympa web sites against spambots which
8058 collect email addresses from public web sites. Various methods are
8059 available in Sympa and you can choose to use them with the
8060 spam_protection and web_archive_spam_protection parameters. Possible
8061 value are:
8062 javascript:
8064 the address is hidden using a javascript. A user who enables javascript
8066 can see a nice mailto address where others have nothing.
8067 at:
8069 the @ char is replaced by the string " AT ".
8071 none:
8073 no protection against spammer.
8075 "reporting_spam_script_path"
8077 Script to report spam
8079 Format:
8081 Any.
8082 Default:
8084 None.
8085 Context:
8087 domain (robot.conf), site (sympa.conf)
8088 Available versions:
8090 6.2a.0 and later.
8091 If set, when a list moderator report undetected spams for list
8093 moderation, this external script is invoked and the message is injected
8094 into standard input of the script.
8095 "domains_blocklist"
8097 Prevent people to subscribe to a list with adresses using these domains
8099 Format:
8101 Any.
8102 Default:
8104 None.
8105 Context:
8107 site (sympa.conf)
8108 Available versions:
8110 6.2.61b.1 and later.
8111 This parameter is a comma-separated list.
8113 Example:
8115 domains_blocklist example.org,spammer.com
8117 "quiet_subscription"
8119 Quiet subscriptions policy
8121 Format:
8123 "on" - enabled
8124 "optional" - optional
8125 "off" - disabled
8126 Default:
8127 "optional"
8128 Context:
8130 site (sympa.conf)
8131 Available versions:
8133 6.2.41b.1 and later.
8134 Global policy for quiet subscriptions: "on" means that subscriptions
8136 will never send a notice to the subscriber, "off" will enforce a notice
8137 sending, and "optional" (default) allows the use of the list policy.
8138 "show_report_abuse"
8140 Add a "Report abuse" link in the side menu of the lists
8142 Format:
8144 "on" - enabled
8145 "off" - disabled
8146 Default:
8147 "off"
8148 Context:
8150 site (sympa.conf)
8151 Available versions:
8153 6.2.37b.3 and later.
8154 The link is a mailto link, you can change that by overriding
8156 web_tt2/report_abuse.tt2
8157 "allow_account_deletion"
8159 EXPERIMENTAL! Allow users to delete their account. If enabled, shows a
8161 "delete my account" form in user's preferences page.
8162 Format:
8164 "on" - enabled
8165 "off" - disabled
8166 Default:
8167 "off"
8168 Context:
8170 site (sympa.conf)
8171 Available versions:
8173 6.2.41b.1 and later.
8174 Account deletion unsubscribes the users from his/her lists and removes
8176 him/her from lists ownership. It is only available to users using
8177 internal authentication (i.e. no LDAP, no SSO...). See
8178 https://github.com/sympa-community/sympa/issues/300 for details
8179 Renamed parameters
8181 These parameters were renamed. Though older names are still available,
8182 their use is no longer recommended.
8183 "arc_private_key_path"
8185 See "arc_parameters.arc_private_key_path".
8187 Context:
8189 domain (robot.conf), site (sympa.conf)
8190 Available versions:
8192 6.2.37b.1 to 6.2.56.
8193 "arc_selector"
8195 See "arc_parameters.arc_selector".
8197 Context:
8199 domain (robot.conf), site (sympa.conf)
8200 Available versions:
8202 6.2.37b.1 to 6.2.56.
8203 "arc_signer_domain"
8205 See "arc_parameters.arc_signer_domain".
8207 Context:
8209 domain (robot.conf), site (sympa.conf)
8210 Available versions:
8212 6.2.37b.1 to 6.2.56.
8213 "archive_mail_access"
8215 See "archive.mail_access".
8217 Context:
8219 domain (robot.conf), site (sympa.conf)
8220 Available versions:
8222 up to 6.2.56.
8223 "archive_web_access"
8225 See "archive.web_access".
8227 Context:
8229 domain (robot.conf), site (sympa.conf)
8230 Available versions:
8232 up to 6.2.56.
8233 "bounce_halt_rate"
8235 See "bounce.halt_rate".
8237 Context:
8239 site (sympa.conf)
8240 Available versions:
8242 up to 6.2.56.
8243 "bounce_warn_rate"
8245 See "bounce.warn_rate".
8247 Context:
8249 site (sympa.conf)
8250 Available versions:
8252 up to 6.2.56.
8253 "custom-header"
8255 See "custom_header".
8257 Context:
8259 Unknown.
8260 "custom-subject"
8262 See "custom_subject".
8264 Context:
8266 Unknown.
8267 "d_edit"
8269 See "shared_doc.d_edit".
8271 Context:
8273 domain (robot.conf), site (sympa.conf)
8274 Available versions:
8276 up to 6.2.56.
8277 "d_read"
8279 See "shared_doc.d_read".
8281 Context:
8283 domain (robot.conf), site (sympa.conf)
8284 Available versions:
8286 up to 6.2.56.
8287 "default_archive_quota"
8289 See "archive.quota".
8291 Context:
8293 site (sympa.conf)
8294 Available versions:
8296 up to 6.2.56.
8297 "default_bounce_level1_rate"
8299 See "bouncers_level1.rate".
8301 Context:
8303 domain (robot.conf), site (sympa.conf)
8304 Available versions:
8306 up to 6.2.56.
8307 "default_bounce_level2_rate"
8309 See "bouncers_level2.rate".
8311 Context:
8313 domain (robot.conf), site (sympa.conf)
8314 Available versions:
8316 up to 6.2.56.
8317 "default_list_priority"
8319 See "priority".
8321 Context:
8323 domain (robot.conf), site (sympa.conf)
8324 Available versions:
8326 up to 6.2.56.
8327 "default_max_list_members"
8329 See "max_list_members".
8331 Context:
8333 domain (robot.conf), site (sympa.conf)
8334 Available versions:
8336 up to 6.2.56.
8337 "default_remind_task"
8339 See "remind_task".
8341 Context:
8343 site (sympa.conf)
8344 Available versions:
8346 up to 6.2.56.
8347 "default_shared_quota"
8349 See "shared_doc.quota".
8351 Context:
8353 domain (robot.conf), site (sympa.conf)
8354 Available versions:
8356 up to 6.2.56.
8357 "default_sql_fetch_timeout"
8359 See "sql_fetch_timeout".
8361 Context:
8363 site (sympa.conf)
8364 Available versions:
8366 6.2a.0 to 6.2.56.
8367 "default_ttl"
8369 See "ttl".
8371 Context:
8373 site (sympa.conf)
8374 Available versions:
8376 up to 6.2.56.
8377 "dkim_private_key_path"
8379 See "dkim_parameters.private_key_path".
8381 Context:
8383 domain (robot.conf), site (sympa.conf)
8384 Available versions:
8386 up to 6.2.56.
8387 "dkim_selector"
8389 See "dkim_parameters.selector".
8391 Context:
8393 domain (robot.conf), site (sympa.conf)
8394 Available versions:
8396 up to 6.2.56.
8397 "dkim_signer_domain"
8399 See "dkim_parameters.signer_domain".
8401 Context:
8403 domain (robot.conf), site (sympa.conf)
8404 Available versions:
8406 up to 6.2.56.
8407 "dmarc_protection_domain_regex"
8409 See "dmarc_protection.domain_regex".
8411 Context:
8413 domain (robot.conf), site (sympa.conf)
8414 Available versions:
8416 up to 6.2.56.
8417 "dmarc_protection_mode"
8419 See "dmarc_protection.mode".
8421 Context:
8423 domain (robot.conf), site (sympa.conf)
8424 Available versions:
8426 up to 6.2.56.
8427 "dmarc_protection_other_email"
8429 See "dmarc_protection.other_email".
8431 Context:
8433 domain (robot.conf), site (sympa.conf)
8434 Available versions:
8436 up to 6.2.56.
8437 "dmarc_protection_phrase"
8439 See "dmarc_protection.phrase".
8441 Context:
8443 domain (robot.conf), site (sympa.conf)
8444 Available versions:
8446 up to 6.2.56.
8447 "domains_blacklist"
8449 See "domains_blocklist".
8451 Context:
8453 site (sympa.conf)
8454 Available versions:
8456 6.2.41b.1 to 6.2.60.
8457 "email_gecos"
8459 See "gecos".
8461 Context:
8463 site (sympa.conf)
8464 Available versions:
8466 6.2a.5 to 6.2a.33.
8467 "forced_reply-to"
8469 See "forced_reply_to".
8471 Context:
8473 Unknown.
8474 "forced_replyto"
8476 See "forced_reply_to".
8478 Context:
8480 Unknown.
8481 "key_password"
8483 See "key_passwd".
8485 Context:
8487 site (sympa.conf)
8488 "max-size"
8490 See "max_size".
8492 Context:
8494 Unknown.
8495 "merge_feature"
8497 See "personalization_feature".
8499 Context:
8501 Unknown.
8502 Available versions:
8504 6.0b.2 to 6.2.59b.1.
8505 "reply-to"
8507 See "reply_to".
8509 Context:
8511 Unknown.
8512 "replyto"
8514 See "reply_to".
8516 Context:
8518 Unknown.
8519 "subscription"
8521 See "subscribe".
8523 Context:
8525 Unknown.
8526 "tracking_default_retention_period"
8528 See "tracking.retention_period".
8530 Context:
8532 site (sympa.conf)
8533 Available versions:
8535 6.2a.3 to 6.2.56.
8536 "tracking_delivery_status_notification"
8538 See "tracking.delivery_status_notification".
8540 Context:
8542 site (sympa.conf)
8543 Available versions:
8545 6.2a.0 to 6.2.56.
8546 "tracking_message_delivery_notification"
8548 See "tracking_message_disposition_notification".
8550 Context:
8552 site (sympa.conf)
8553 Available versions:
8555 6.2a.0 to 6.2a.40.
8556 "tracking_message_disposition_notification"
8558 See "tracking.message_disposition_notification".
8560 Context:
8562 site (sympa.conf)
8563 Available versions:
8565 6.2a.41 to 6.2.56.
8566 "unsubscription"
8568 See "unsubscribe".
8570 Context:
8572 Unknown.
8573 "use_blacklist"
8575 See "use_blocklist".
8577 Context:
8579 domain (robot.conf), site (sympa.conf)
8580 Available versions:
8582 5.3a.4 to 6.2.60.
8583 Deprecated parameters
8585 These parameters were deprecated. They may not be used anymore.
8586 "account"
8588 Deprecated.
8590 Context:
8592 list (config)
8593 "archived_pidfile"
8595 Deprecated.
8597 Context:
8599 site (sympa.conf)
8600 Available versions:
8602 up to 6.1.17.
8603 "automatic_list_prefix"
8605 Deprecated.
8607 Context:
8609 site (sympa.conf)
8610 "bounced_pidfile"
8612 Deprecated.
8614 Context:
8616 site (sympa.conf)
8617 Available versions:
8619 up to 6.1.17.
8620 "clean_delay_queueother"
8622 Deprecated.
8624 Context:
8626 site (sympa.conf)
8627 Available versions:
8629 5.4a.9 to 5.4.7.
8630 "cookie"
8632 Deprecated.
8634 Context:
8636 list (config), site (sympa.conf)
8637 Available versions:
8639 up to 6.2.60.
8640 "default_distribution_ttl"
8642 Deprecated.
8644 Context:
8646 site (sympa.conf)
8647 "distribution_mode"
8649 Deprecated.
8651 Context:
8653 site (sympa.conf)
8654 Available versions:
8656 5.0a.1 to 6.2a.40.
8657 "edit_list"
8659 Deprecated.
8661 Context:
8663 site (sympa.conf)
8664 "editor"
8666 Deprecated.
8668 Context:
8670 list (config)
8671 Available versions:
8673 up to 6.2.32.
8674 "expire_task"
8676 Deprecated.
8678 Context:
8680 list (config)
8681 "filesystem_encoding"
8683 Deprecated.
8685 Context:
8687 site (sympa.conf)
8688 Available versions:
8690 5.3a.7 to 6.2.52.
8691 "forced_reply_to"
8693 Deprecated.
8695 Context:
8697 list (config)
8698 "host"
8700 Deprecated.
8702 Context:
8704 list (config), domain (robot.conf), site (sympa.conf)
8705 "html_editor_file"
8707 Deprecated.
8709 Context:
8711 site (sympa.conf)
8712 Available versions:
8714 6.0a.0 to 6.2a.33.
8715 "htmlarea_url"
8717 Deprecated.
8719 Context:
8721 site (sympa.conf)
8722 Available versions:
8724 up to 6.2.35b.1.
8725 "http_host"
8727 Deprecated.
8729 Context:
8731 domain (robot.conf), site (sympa.conf)
8732 Available versions:
8734 up to 6.2.54.
8735 "include_list"
8737 Deprecated.
8739 Context:
8741 list (config)
8742 Available versions:
8744 2.2.6 to 6.2.15.
8745 "ldap_export_connection_timeout"
8747 Deprecated.
8749 Context:
8751 site (sympa.conf)
8752 Available versions:
8754 3.3b.3 to 4.1?.
8755 "ldap_export_dnmanager"
8757 Deprecated.
8759 Context:
8761 site (sympa.conf)
8762 Available versions:
8764 3.3b.3 to 4.1?.
8765 "ldap_export_host"
8767 Deprecated.
8769 Context:
8771 site (sympa.conf)
8772 Available versions:
8774 3.3b.3 to 4.1?.
8775 "ldap_export_name"
8777 Deprecated.
8779 Context:
8781 site (sympa.conf)
8782 Available versions:
8784 3.3b.3 to 4.1?.
8785 "ldap_export_password"
8787 Deprecated.
8789 Context:
8791 site (sympa.conf)
8792 Available versions:
8794 3.3b.3 to 4.1?.
8795 "ldap_export_suffix"
8797 Deprecated.
8799 Context:
8801 site (sympa.conf)
8802 Available versions:
8804 3.3b.3 to 4.1?.
8805 "localedir"
8807 Deprecated.
8809 Context:
8811 site (sympa.conf)
8812 Available versions:
8814 4.2b.2 to 6.2a.32.
8815 "lock_method"
8817 Deprecated.
8819 Context:
8821 site (sympa.conf)
8822 Available versions:
8824 5.3b.3 to 6.2a.33.
8825 "log_condition"
8827 Deprecated.
8829 Context:
8831 domain (robot.conf), site (sympa.conf)
8832 Available versions:
8834 6.2a.29 to 6.2.41b.1.
8835 "log_module"
8837 Deprecated.
8839 Context:
8841 domain (robot.conf), site (sympa.conf)
8842 Available versions:
8844 6.2a.29 to 6.2.41b.1.
8845 "msgcat"
8847 Deprecated.
8849 Context:
8851 site (sympa.conf)
8852 Available versions:
8854 up to 4.2b.1.
8855 "openssl"
8857 Deprecated.
8859 Context:
8861 site (sympa.conf)
8862 Available versions:
8864 up to 6.2a.40.
8865 "owner"
8867 Deprecated.
8869 Context:
8871 list (config)
8872 Available versions:
8874 up to 6.2.32.
8875 "pidfile"
8877 Deprecated.
8879 Context:
8881 site (sympa.conf)
8882 Available versions:
8884 up to 6.1.17.
8885 "pidfile_bulk"
8887 Deprecated.
8889 Context:
8891 site (sympa.conf)
8892 Available versions:
8894 up to 6.1.17.
8895 "pidfile_creation"
8897 Deprecated.
8899 Context:
8901 site (sympa.conf)
8902 Available versions:
8904 up to 6.1.17.
8905 "pidfile_distribute"
8907 Deprecated.
8909 Context:
8911 site (sympa.conf)
8912 Available versions:
8914 up to 6.1.17.
8915 "queuedistribute"
8917 Deprecated.
8919 Context:
8921 site (sympa.conf)
8922 Available versions:
8924 5.0a.1 to 6.2a.40.
8925 "queueexpire"
8927 Deprecated.
8929 Context:
8931 site (sympa.conf)
8932 Available versions:
8934 up to 5.1.2.
8935 "reply_to"
8937 Deprecated.
8939 Context:
8941 list (config)
8942 "sort"
8944 Deprecated.
8946 Context:
8948 site (sympa.conf)
8949 Available versions:
8951 1.4.0 and later.
8952 "task_manager_pidfile"
8954 Deprecated.
8956 Context:
8958 site (sympa.conf)
8959 Available versions:
8961 up to 6.1.17.
8962 "tracking" (domain and site)
8964 See "tracking.tracking".
8966 Context:
8968 domain (robot.conf), site (sympa.conf)
8969 Available versions:
8971 up to 6.2.56.
8972 "tri"
8974 Deprecated.
8976 Context:
8978 site (sympa.conf)
8979 Available versions:
8981 up to 1.3.4-1.
8982 "trusted_ca_options"
8984 Deprecated.
8986 Context:
8988 site (sympa.conf)
8989 Available versions:
8991 up to 3.3.5.
8992 "use_fast_cgi"
8994 Deprecated.
8996 Context:
8998 site (sympa.conf)
8999 Available versions:
9001 up to 6.2.22.
9002 "user_data_source"
9004 Deprecated.
9006 Context:
9008 list (config)
9009 "web_archive"
9011 Deprecated.
9013 Context:
9015 list (config), domain (robot.conf), site (sympa.conf)
9016 Available versions:
9018 up to 6.2a.43.
9019 "web_recode_to"
9021 Deprecated.
9023 Context:
9025 site (sympa.conf)
9026 Available versions:
9028 up to 5.2.
9029
9031 /etc/sympa/sympa.conf
9032 Sympa main configuration file.
9033 $SYSCONFDIR/<mail domain name>/robot.conf
9035 Configuration specific to each mail domain.
9036 $EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list
9038 name>/config
9039 List main configuration file.
9040
9042 Sympa Administration Manual.
9043 <https://sympa-community.github.io/manual/>.
9044 auth.conf(5), charset.conf(5), crawlers_detection.conf(5),
9046 edit_list.conf(5), ldap_alias_manager.conf(5), nrcpt_by_domain.conf(5),
9047 sympa_scenario(5), topics.conf(5).
90486.2.68 2022-01-25 SYMPA_CONFIG(5)
