1LIST_CONFIG(5) sympa 6.2.54 LIST_CONFIG(5)
2
6 list_config - Configuration file for mailing list
7
9 config is main configuration file of the mailing list.
10 Format of config is as following:
12 · Lines beginning with "#" and containing only spaces are ignored.
14 · There are parameters with single line and multiple lines:
16 · On single line parameters, each line has the form "parameter
18 value". value may contain spaces but may not contain newlines.
19 Several parameters may have multiple values. If it's the case,
21 values may be separated by comma (",") or parameter lines may
22 be repeated. Some of parameters must have one or more of
23 limited values.
24 Example:
26 subject This is subject of my list
28 remove_headers User-Agent,Importance
30 custom_headers X-List: mylist
32 custom_headers X-Face: %`-W7!?^]Sg'I-K>P<cdn&k:~A^{x>(]Gc{V...
33 rfc2369_header_fields post,owner
35 · A multiple line parameter, so-called "paragraph", consists of
37 the first line specifying parameter name and subsequent one or
38 more sub-parameter lines. Paragraph must be separated by one
39 or more empty lines from the other parameters.
40 Several multiple line parameters may occur multiple times.
42
44 Below is entire list of configuration parameters. "Default" is built-
45 in default value if any.
46 List definition
48 "subject"
49 Subject of the list
51 Format:
53 /".+"/
54 Default:
56 None, mandatory.
57 This parameter indicates the subject of the list, which is sent in
59 response to the LISTS mail command. The subject is a free form text
60 limited to one line.
61 "visibility"
63 Visibility of the list
65 Format:
67 Name of "visibility" scenario:
68 "conceal" - conceal except for subscribers
70 "noconceal" - no conceal
71 "secret" - conceal even for subscribers
72 Default:
73 Value of "visibility" parameter in sympa.conf or robot.conf.
74 This parameter indicates whether the list should feature in the output
76 generated in response to a LISTS command or should be shown in the list
77 overview of the web-interface.
78 "topics"
80 Topics for the list
82 Format:
84 Multiple values allowed, separated by ",".
85 List topic.
87 Default:
89 None.
90 This parameter allows the classification of lists. You may define
92 multiple topics as well as hierarchical ones. WWSympa's list of public
93 lists uses this parameter.
94 "host"
96 Deprecated.
98 "lang"
100 Language of the list
102 Format:
104 Language tag.
105 Default:
107 Value of "lang" parameter in sympa.conf or robot.conf.
108 This parameter defines the language used for the list. It is used to
110 initialize a user's language preference; Sympa command reports are
111 extracted from the associated message catalog.
112 "family_name"
114 Family name
116 Format:
118 /$family_name/
119 Default:
121 None.
122 "max_list_members"
124 Maximum number of list members
126 Format:
128 Number of list members.
129 Default:
131 Value of "default_max_list_members" parameter in sympa.conf or
132 robot.conf.
133 limit for the number of subscribers. 0 means no limit.
135 "priority"
137 Priority
139 Format:
141 0 - 0 - highest priority
142 1 - 1
143 2 - 2
144 3 - 3
145 4 - 4
146 5 - 5
147 6 - 6
148 7 - 7
149 8 - 8
150 9 - 9 - lowest priority
151 "z" - queue messages only
152 Default:
153 Value of "default_list_priority" parameter in sympa.conf or
154 robot.conf.
155 The priority with which Sympa will process messages for this list. This
157 level of priority is applied while the message is going through the
158 spool. The z priority will freeze the message in the spool.
159 Sending/receiving setup
161 "send"
162 Who can send messages
164 Format:
166 Name of "send" scenario:
167 "closed" - closed
169 "confidential" - restricted to subscribers, messages from others
170 are discarded
171 "editordkim" - Moderated, no authentication needed if DKIM
172 signature from moderator is OK
173 "editorkey" - Moderated
174 "editorkeyonly" - Moderated, even for moderators
175 "editorkeyonlyauth" - Moderated, need authentication from moderator
176 "newsletter" - Newsletter, restricted to moderators
177 "newsletterkeyonly" - Newsletter, restricted to moderators after
178 confirmation
179 "owner" - Restricted to list owners only
180 "ownerauth" - Restricted to list owners with previous MD5
181 authentication
182 "private" - restricted to subscribers
183 "private_smime" - restricted to subscribers and checked smime
184 signature
185 "privateandeditorkey" - Moderated, restricted to subscribers
186 "privateandnomultipartoreditorkey" - Moderated, for non subscribers
187 sending multipart messages
188 "privatekey" - restricted to subscribers with previous md5
189 authentication
190 "privatekeyandeditorkeyonly" - Moderated, for subscribers and even
191 moderators themself
192 "privateoreditorkey" - Private, moderated for non subscribers
193 "privateorpublickey" - Private, confirmation for non subscribers
194 "public" - public list
195 "public_nobcc" - public list, Bcc rejected (anti-spam)
196 "publickey" - anyone no authentication if DKIM signature is OK
197 "publicnoattachment" - public list multipart/mixed messages are
198 forwarded to moderator
199 "publicnomultipart" - public list multipart messages are rejected
200 Default:
201 Value of "send" parameter in sympa.conf or robot.conf.
202 This parameter specifies who can send messages to the list.
204 "delivery_time"
206 Delivery time (hh:mm)
208 Format:
210 /"[0-2]?\d\:[0-6]\d"/
211 Default:
213 None.
214 If this parameter is present, non-digest messages will be delivered to
216 subscribers at this time: When this time has been past, delivery is
217 postponed to the same time in next day.
218 "digest"
220 Digest frequency
222 Single occurrence
224 Definition of digest mode. If this parameter is present, subscribers
226 can select the option of receiving messages in multipart/digest MIME
227 format, or as a plain text digest. Messages are then grouped together,
228 and compiled messages are sent to subscribers according to the
229 frequency selected with this parameter.
230 "digest.days"
232 days
234 Format:
236 Multiple occurrences allowed.
237 Day of week, 0 - 6.
239 Default:
241 None, mandatory.
242 "digest.hour"
244 hour
246 Format:
248 /"\d+"/
249 Default:
251 None, mandatory.
252 "digest.minute"
254 minute
256 Format:
258 /"\d+"/
259 Default:
261 None, mandatory.
262 "digest_max_size"
264 Digest maximum number of messages
266 Format:
268 Number of messages.
269 Default:
271 25
272 "available_user_options"
274 Available subscription options
276 Single occurrence
278 "available_user_options.reception"
280 reception mode
282 Format:
284 Multiple values allowed, separated by ",".
285 Reception mode of list member.
287 Default:
289 "mail,notice,digest,digestplain,summary,nomail,txt,urlize,not_me"
290 Only these modes will be allowed for the subscribers of this list. If a
292 subscriber has a reception mode not in the list, Sympa uses the mode
293 specified in the default_user_options paragraph.
294 "default_user_options"
296 Subscription profile
298 Single occurrence
300 Default profile for the subscribers of the list.
302 "default_user_options.reception"
304 reception mode
306 Format:
308 Reception mode of list member.
309 Default:
311 "mail"
312 Mail reception mode.
314 "default_user_options.visibility"
316 visibility
318 Format:
320 Visibility mode of list memeber.
321 Default:
323 "noconceal"
324 Visibility of the subscriber.
326 "msg_topic"
328 Topics for message categorization
330 Multiple occurrences allowed
332 This paragraph defines a topic used to tag a message of a list, named
334 by msg_topic.name ("other" is a reserved word), its title is
335 msg_topic.title. The msg_topic.keywords entry is optional and allows
336 automatic tagging. This should be a list of keywords, separated by ','.
337 "msg_topic.name"
339 Message topic name
341 Format:
343 /"[\-\w]+"/
344 Default:
346 None, mandatory.
347 "msg_topic.keywords"
349 Message topic keywords
351 Format:
353 /"[^,\n]+(,[^,\n]+)*"/
354 Default:
356 None.
357 "msg_topic.title"
359 Message topic title
361 Format:
363 /".+"/
364 Default:
366 None, mandatory.
367 "msg_topic_keywords_apply_on"
369 Defines to which part of messages topic keywords are applied
371 Format:
373 "subject" - subject field
374 "body" - message body
375 "subject_and_body" - subject and body
376 Default:
377 "subject"
378 This parameter indicates which part of the message is used to perform
380 automatic tagging.
381 "msg_topic_tagging"
383 Message tagging
385 Format:
387 "required_sender" - required to post message
388 "required_moderator" - required to distribute message
389 "optional" - optional
390 Default:
391 "optional"
392 This parameter indicates if the tagging is optional or required for a
394 list.
395 "reply_to_header"
397 Reply address
399 Single occurrence
401 This defines what Sympa will place in the Reply-To: SMTP header field
403 of the messages it distributes.
404 "reply_to_header.value"
406 value
408 Format:
410 "sender" - sender
411 "list" - list
412 "all" - all
413 "other_email" - other email address
414 Default:
415 "sender"
416 This parameter indicates whether the Reply-To: field should indicate
418 the sender of the message (sender), the list itself (list), both list
419 and sender (all) or an arbitrary e-mail address (defined by the
420 other_email parameter).
421 Note: it is inadvisable to change this parameter, and particularly
423 inadvisable to set it to list. Experience has shown it to be almost
424 inevitable that users, mistakenly believing that they are replying only
425 to the sender, will send private messages to a list. This can lead, at
426 the very least, to embarrassment, and sometimes to more serious
427 consequences.
428 "reply_to_header.other_email"
430 other email address
432 Format:
434 /$email/
435 Default:
437 None.
438 If value was set to other_email, this parameter defines the e-mail
440 address used.
441 "reply_to_header.apply"
443 respect of existing header field
445 Format:
447 "forced" - overwrite Reply-To: header field
448 "respect" - preserve existing header field
449 Default:
450 "respect"
451 The default is to respect (preserve) the existing Reply-To: SMTP header
453 field in incoming messages. If set to forced, Reply-To: SMTP header
454 field will be overwritten.
455 "anonymous_sender"
457 Anonymous sender
459 Format:
461 /".+"/
462 Default:
464 None.
465 To hide the sender's email address before distributing the message. It
467 is replaced by the provided email address.
468 "custom_header"
470 Custom header field
472 Format:
474 Multiple occurrences allowed.
475 /"\S+:\s+.*"/
477 Default:
479 None.
480 This parameter is optional. The headers specified will be added to the
482 headers of messages distributed via the list. As of release 1.2.2 of
483 Sympa, it is possible to put several custom header lines in the
484 configuration file at the same time.
485 "custom_subject"
487 Subject tagging
489 Format:
491 /".+"/
492 Default:
494 None.
495 This parameter is optional. It specifies a string which is added to the
497 subject of distributed messages (intended to help users who do not use
498 automatic tools to sort incoming messages). This string will be
499 surrounded by [] characters.
500 "footer_type"
502 Attachment type
504 Format:
506 "mime" - add a new MIME part
507 "append" - append to message body
508 Default:
509 "mime"
510 List owners may decide to add message headers or footers to messages
512 sent via the list. This parameter defines the way a footer/header is
513 added to a message.
514 mime:
516 The default value. Sympa will add the footer/header as a new MIME part.
518 append:
520 Sympa will not create new MIME parts, but will try to append the
522 header/footer to the body of the message. Predefined message-footers
523 will be ignored. Headers/footers may be appended to text/plain messages
524 only.
525 "max_size"
527 Maximum message size
529 Format:
531 Number of bytes.
532 Default:
534 Value of "max_size" parameter in sympa.conf or robot.conf.
535 Maximum size of a message in 8-bit bytes.
537 "merge_feature"
539 Allow message personalization
541 Format:
543 "on" - enabled
544 "off" - disabled
545 Default:
546 Value of "merge_feature" parameter in sympa.conf.
547 "message_hook"
549 Hook modules for message processing
551 Single occurrence
553 "message_hook.pre_distribute"
555 A hook on the messages before distribution
557 Format:
559 /"(::|\w)+"/
560 Default:
562 None.
563 "message_hook.post_archive"
565 A hook on the messages just after archiving
567 Format:
569 /"(::|\w)+"/
570 Default:
572 None.
573 "reject_mail_from_automates_feature"
575 Reject mail from automatic processes (crontab, etc)?
577 Format:
579 "on" - enabled
580 "off" - disabled
581 Default:
582 Value of "reject_mail_from_automates_feature" parameter in
583 sympa.conf.
584 "remove_headers"
586 Incoming SMTP header fields to be removed
588 Format:
590 Multiple values allowed, separated by ",".
591 /"\S+"/
593 Default:
595 Value of "remove_headers" parameter in sympa.conf.
596 "remove_outgoing_headers"
598 Outgoing SMTP header fields to be removed
600 Format:
602 Multiple values allowed, separated by ",".
603 /"\S+"/
605 Default:
607 Value of "remove_outgoing_headers" parameter in sympa.conf.
608 "rfc2369_header_fields"
610 RFC 2369 Header fields
612 Format:
614 Multiple values allowed, separated by ",".
615 "help" - help
617 "subscribe" - subscription
618 "unsubscribe" - unsubscription
619 "post" - posting address
620 "owner" - owner
621 "archive" - list archive
622 Default:
623 Value of "rfc2369_header_fields" parameter in sympa.conf.
624 "forced_reply_to"
626 Deprecated.
628 "reply_to"
630 Deprecated.
632 Privileges
634 "info"
635 Who can view list information
637 Format:
639 Name of "info" scenario:
640 "conceal" - restricted to subscribers - Silent rejection otherwise.
642 "open" - for anyone
643 "private" - restricted to subscribers
644 Default:
645 Value of "info" parameter in sympa.conf or robot.conf.
646 "subscribe"
648 Who can subscribe to the list
650 Format:
652 Name of "subscribe" scenario:
653 "auth" - subscription request confirmed
655 "auth_notify" - need authentication (notification is sent to
656 owners)
657 "auth_notifydkim" - need authentication unless DKIM signature is OK
658 (notification is sent to owners)
659 "auth_owner" - requires authentication then owner approval
660 "auth_ownerdkim" - requires authentication unless DKIM signature is
661 OK, then owner approval
662 "authdkim" - subscription request confirmed
663 "closed" - subscription is impossible
664 "open" - for anyone without authentication
665 "open_notify" - anyone, notification is sent to list owner
666 "open_quiet" - anyone, no welcome message
667 "owner" - owners approval
668 "smime" - requires S/MIME signed
669 "smimeorowner" - requires S/MIME signed or owner approval
670 Default:
671 Value of "subscribe" parameter in sympa.conf or robot.conf.
672 The subscribe parameter defines the rules for subscribing to the list.
674 "add"
676 Who can add subscribers
678 Format:
680 Name of "add" scenario:
681 "auth" - restricted to owner with authentication
683 "authdkim" - restricted to owner without authentication if DKIM
684 signature is OK.
685 "closed" - add impossible
686 "owner" - add performed by list owner does not need authentication
687 "owner_notify" - add performed by owner does not need
688 authentication (notification)
689 "ownerdkim" - add performed by list owner does not need
690 authentication if DKIM signature OK
691 Default:
692 Value of "add" parameter in sympa.conf or robot.conf.
693 Privilege for adding (ADD command) a subscriber to the list
695 "unsubscribe"
697 Who can unsubscribe
699 Format:
701 Name of "unsubscribe" scenario:
702 "auth" - need authentication
704 "auth_notify" - authentication requested, notification sent to
705 owner
706 "auth_notifydkim" - authentication requested unless DKIM signature
707 is OK, notification sent to owner
708 "authdkim" - need authentication unless DKIM signature is OK
709 "closed" - impossible
710 "open" - open
711 "open_notify" - open with mail confirmation, owner is notified
712 "owner" - owners approval
713 Default:
714 Value of "unsubscribe" parameter in sympa.conf or robot.conf.
715 This parameter specifies the unsubscription method for the list. Use
717 open_notify or auth_notify to allow owner notification of each
718 unsubscribe command.
719 "del"
721 Who can delete subscribers
723 Format:
725 Name of "del" scenario:
726 "auth" - deletion performed only by list owners, need
728 authentication
729 "authdkim" - deletion performed only by list owners, need
730 authentication unless DKIM signature is OK
731 "closed" - remove subscriber impossible
732 "owner" - by owner without authentication
733 "owner_notify" - list owners, authentication not needed
734 (notification)
735 "ownerdkim" - by owner without authentication if DKIM signature OK
736 Default:
737 Value of "del" parameter in sympa.conf or robot.conf.
738 "invite"
740 Who can invite people
742 Format:
744 Name of "invite" scenario:
745 "closed" - closed
747 "owner" - invite perform by list owner do not need authentication
748 "private" - restricted to subscribers
749 "public" - public
750 Default:
751 Value of "invite" parameter in sympa.conf or robot.conf.
752 "remind"
754 Who can start a remind process
756 Format:
758 Name of "remind" scenario:
759 "listmaster" - listmaster only
761 "listmasterdkim" - listmaster only (do not require authentication
762 if DKIM siganture is OK)
763 "owner" - restricted to list owners
764 "ownerdkim" - restricted to list owners (authentication is not
765 required if a DKIM signature is OK)
766 Default:
767 Value of "remind" parameter in sympa.conf or robot.conf.
768 This parameter specifies who is authorized to use the remind command.
770 "review"
772 Who can review subscribers
774 Format:
776 Name of "review" scenario:
777 "closed" - no one can review
779 "listmaster" - listmaster only
780 "owner" - only owner (and listmaster)
781 "private" - restricted to subscribers
782 "public" - anyone can do it!
783 Default:
784 Value of "review" parameter in sympa.conf or robot.conf.
785 This parameter specifies who can access the list of members. Since
787 subscriber addresses can be abused by spammers, it is strongly
788 recommended that you only authorize owners or subscribers to access the
789 subscriber list.
790 "owner_domain"
792 Required domains for list owners
794 Format:
796 /"$host( +$host)*"/
797 Default:
799 Value of "owner_domain" parameter in sympa.conf or robot.conf.
800 Restrict list ownership to addresses in the specified domains.
802 "owner_domain_min"
804 Minimum owners in required domains
806 Format:
808 /"\d+"/
809 Default:
811 Value of "owner_domain_min" parameter in sympa.conf or robot.conf.
812 Require list ownership by a minimum number of addresses in the
814 specified domains.
815 "shared_doc"
817 Shared documents
819 Single occurrence
821 This paragraph defines read and edit access to the shared document
823 repository.
824 "shared_doc.d_read"
826 Who can view
828 Format:
830 Name of "d_read" scenario:
831 "owner" - restricted to list owners
833 "private" - restricted to subscribers
834 "private-https" - restricted to subscribers authenticated with user
835 cert
836 "public" - public documents
837 Default:
838 Value of "d_read" parameter in sympa.conf or robot.conf.
839 "shared_doc.d_edit"
841 Who can edit
843 Format:
845 Name of "d_edit" scenario:
846 "editor" - moderated for subscribers
848 "owner" - restricted to list owners
849 "private" - restricted to subscribers
850 "private-https" - restricted to subscribers authenticated with user
851 cert
852 "public" - public documents
853 Default:
854 Value of "d_edit" parameter in sympa.conf or robot.conf.
855 "shared_doc.quota"
857 quota
859 Format:
861 Number of Kbytes.
862 Default:
864 Value of "default_shared_quota" parameter in sympa.conf or
865 robot.conf.
866 Archives
868 "process_archive"
869 Store distributed messages into archive
871 Format:
873 "on" - enabled
874 "off" - disabled
875 Default:
876 Value of "process_archive" parameter in sympa.conf or robot.conf.
877 "archive"
879 Archives
881 Single occurrence
883 Privilege for reading mail archives and frequency of archiving.
885 Defines who can access the list's web archive.
887 "archive.period"
889 Deprecated.
891 "archive.access"
893 Deprecated.
895 "archive.web_access"
897 access right
899 Format:
901 Name of "archive_web_access" scenario:
902 "closed" - closed
904 "listmaster" - listmaster
905 "owner" - by owner
906 "private" - subscribers only
907 "public" - public
908 Default:
909 Value of "archive_web_access" parameter in sympa.conf or
910 robot.conf.
911 "archive.mail_access"
913 access right by mail commands
915 Format:
917 Name of "archive_mail_access" scenario:
918 "closed" - closed
920 "owner" - by owner
921 "private" - subscribers only
922 "public" - public
923 Default:
924 Value of "archive_mail_access" parameter in sympa.conf or
925 robot.conf.
926 "archive.quota"
928 quota
930 Format:
932 Number of Kbytes.
933 Default:
935 Value of "default_archive_quota" parameter in sympa.conf.
936 "archive.max_month"
938 Maximum number of month archived
940 Format:
942 Number of months.
943 Default:
945 None.
946 "archive_crypted_msg"
948 Archive encrypted mails as cleartext
950 Format:
952 "original" - original messages
953 "decrypted" - decrypted messages
954 Default:
955 "original"
956 "web_archive_spam_protection"
958 email address protection method
960 Format:
962 "cookie" - use HTTP cookie
963 "javascript" - use JavaScript
964 "at" - replace @ characters
965 "gecos" - only show gecos
966 "none" - do nothing
967 Default:
968 Value of "web_archive_spam_protection" parameter in sympa.conf or
969 robot.conf.
970 Idem spam_protection is provided but it can be used only for web
972 archives. Access requires a cookie, and users must submit a small form
973 in order to receive a cookie before browsing the archives. This blocks
974 all robot, even google and co.
975 "web_archive"
977 Deprecated.
979 Bounces
981 "bounce"
982 Bounces management
984 Single occurrence
986 "bounce.warn_rate"
988 warn rate
990 Format:
992 Number of %.
993 Default:
995 Value of "bounce_warn_rate" parameter in sympa.conf.
996 The list owner receives a warning whenever a message is distributed and
998 the number (percentage) of bounces exceeds this value.
999 "bounce.halt_rate"
1001 Deprecated.
1003 "bouncers_level1"
1005 Management of bouncers, 1st level
1007 Single occurrence
1009 Level 1 is the lower level of bouncing users
1011 "bouncers_level1.rate"
1013 threshold
1015 Format:
1017 Number of points.
1018 Default:
1020 Value of "default_bounce_level1_rate" parameter in sympa.conf or
1021 robot.conf.
1022 Each bouncing user have a score (from 0 to 100).
1024 This parameter defines a lower limit for each category of bouncing
1026 users.For example, level 1 begins from 45 to level_2_treshold.
1027 "bouncers_level1.action"
1029 action for this population
1031 Format:
1033 "remove_bouncers" - remove bouncing users
1034 "notify_bouncers" - send notify to bouncing users
1035 "none" - do nothing
1036 Default:
1037 "notify_bouncers"
1038 This parameter defines which task is automatically applied on level 1
1040 bouncers.
1041 "bouncers_level1.notification"
1043 notification
1045 Format:
1047 "none" - do nothing
1048 "owner" - owner
1049 "listmaster" - listmaster
1050 Default:
1051 "owner"
1052 When automatic task is executed on level 1 bouncers, a notification
1054 email can be send to listowner or listmaster.
1055 "bouncers_level2"
1057 Management of bouncers, 2nd level
1059 Single occurrence
1061 Level 2 is the highest level of bouncing users
1063 "bouncers_level2.rate"
1065 threshold
1067 Format:
1069 Number of points.
1070 Default:
1072 Value of "default_bounce_level2_rate" parameter in sympa.conf or
1073 robot.conf.
1074 Each bouncing user have a score (from 0 to 100).
1076 This parameter defines the score range defining each category of
1078 bouncing users.For example, level 2 is for users with a score between
1079 80 and 100.
1080 "bouncers_level2.action"
1082 action for this population
1084 Format:
1086 "remove_bouncers" - remove bouncing users
1087 "notify_bouncers" - send notify to bouncing users
1088 "none" - do nothing
1089 Default:
1090 "remove_bouncers"
1091 This parameter defines which task is automatically applied on level 2
1093 bouncers.
1094 "bouncers_level2.notification"
1096 notification
1098 Format:
1100 "none" - do nothing
1101 "owner" - owner
1102 "listmaster" - listmaster
1103 Default:
1104 "owner"
1105 When automatic task is executed on level 2 bouncers, a notification
1107 email can be send to listowner or listmaster.
1108 "verp_rate"
1110 percentage of list members in VERP mode
1112 Format:
1114 "100%" - 100% - always
1115 "50%" - 50%
1116 "33%" - 33%
1117 "25%" - 25%
1118 "20%" - 20%
1119 "10%" - 10%
1120 "5%" - 5%
1121 "2%" - 2%
1122 "0%" - 0% - never
1123 Default:
1124 Value of "verp_rate" parameter in sympa.conf or robot.conf.
1125 "tracking"
1127 Message tracking feature
1129 Single occurrence
1131 "tracking.delivery_status_notification"
1133 tracking message by delivery status notification
1135 Format:
1137 "on" - enabled
1138 "off" - disabled
1139 Default:
1140 Value of "tracking_delivery_status_notification" parameter in
1141 sympa.conf.
1142 "tracking.message_disposition_notification"
1144 tracking message by message disposition notification
1146 Format:
1148 "on" - enabled
1149 "on_demand" - on demand
1150 "off" - disabled
1151 Default:
1152 Value of "tracking_message_disposition_notification" parameter in
1153 sympa.conf.
1154 "tracking.tracking"
1156 who can view message tracking
1158 Format:
1160 Name of "tracking" scenario:
1161 "owner" - only owner (and listmaster)
1163 "private" - restricted to subscribers
1164 Default:
1165 Value of "tracking" parameter in sympa.conf or robot.conf.
1166 "tracking.retention_period"
1168 Tracking datas are removed after this number of days
1170 Format:
1172 Number of days.
1173 Default:
1175 Value of "tracking_default_retention_period" parameter in
1176 sympa.conf.
1177 "welcome_return_path"
1179 Welcome return-path
1181 Format:
1183 "unique" - bounce management
1184 "owner" - owner
1185 Default:
1186 Value of "welcome_return_path" parameter in sympa.conf.
1187 If set to unique, the welcome message is sent using a unique return
1189 path in order to remove the subscriber immediately in the case of a
1190 bounce.
1191 "remind_return_path"
1193 Return-path of the REMIND command
1195 Format:
1197 "unique" - bounce management
1198 "owner" - owner
1199 Default:
1200 Value of "remind_return_path" parameter in sympa.conf.
1201 Same as welcome_return_path, but applied to remind messages.
1203 Data sources setup
1205 "inclusion_notification_feature"
1206 Notify subscribers when they are included from a data source?
1208 Format:
1210 "on" - enabled
1211 "off" - disabled
1212 Default:
1213 "off"
1214 "member_include"
1216 Subscribers defined in an external data source
1218 Multiple occurrences allowed
1220 "member_include.source"
1222 the data source
1224 Format:
1226 /"[\w-]+"/
1227 Default:
1229 None, mandatory.
1230 "member_include.source_parameters"
1232 data source parameters
1234 Format:
1236 /".*"/
1237 Default:
1239 None.
1240 "owner_include"
1242 Owners defined in an external data source
1244 Multiple occurrences allowed
1246 "owner_include.source"
1248 the data source
1250 Format:
1252 /"[\w-]+"/
1253 Default:
1255 None, mandatory.
1256 "owner_include.source_parameters"
1258 data source parameters
1260 Format:
1262 /".*"/
1263 Default:
1265 None.
1266 "owner_include.profile"
1268 profile
1270 Format:
1272 "privileged" - privileged owner
1273 "normal" - normal owner
1274 Default:
1275 "normal"
1276 "owner_include.reception"
1278 reception mode
1280 Format:
1282 "mail" - receive notification email
1283 "nomail" - no notifications
1284 Default:
1285 "mail"
1286 "owner_include.visibility"
1288 visibility
1290 Format:
1292 "conceal" - concealed from list menu
1293 "noconceal" - listed on the list menu
1294 Default:
1295 "noconceal"
1296 "editor_include"
1298 Moderators defined in an external data source
1300 Multiple occurrences allowed
1302 "editor_include.source"
1304 the data source
1306 Format:
1308 /"[\w-]+"/
1309 Default:
1311 None, mandatory.
1312 "editor_include.source_parameters"
1314 data source parameters
1316 Format:
1318 /".*"/
1319 Default:
1321 None.
1322 "editor_include.reception"
1324 reception mode
1326 Format:
1328 "mail" - receive notification email
1329 "nomail" - no notifications
1330 Default:
1331 "mail"
1332 "editor_include.visibility"
1334 visibility
1336 Format:
1338 "conceal" - concealed from list menu
1339 "noconceal" - listed on the list menu
1340 Default:
1341 "noconceal"
1342 "sql_fetch_timeout"
1344 Timeout for fetch of include_sql_query
1346 Format:
1348 Number of seconds.
1349 Default:
1351 Value of "default_sql_fetch_timeout" parameter in sympa.conf.
1352 "include_file"
1354 File inclusion
1356 Format:
1358 Multiple occurrences allowed.
1359 /"\S+"/
1361 Default:
1363 None.
1364 Include subscribers from this file. The file should contain one e-mail
1366 address per line (lines beginning with a "#" are ignored).
1367 "include_remote_file"
1369 Remote file inclusion
1371 Multiple occurrences allowed
1373 "include_remote_file.name"
1375 short name for this source
1377 Format:
1379 /".+"/
1380 Default:
1382 None.
1383 "include_remote_file.url"
1385 data location URL
1387 Format:
1389 /".+"/
1390 Default:
1392 None, mandatory.
1393 "include_remote_file.user"
1395 remote user
1397 Format:
1399 /".+"/
1400 Default:
1402 None.
1403 "include_remote_file.passwd"
1405 remote password
1407 Format:
1409 The value to be concealed.
1410 Default:
1412 None.
1413 "include_remote_file.timeout"
1415 idle timeout
1417 Format:
1419 Number of seconds.
1420 Default:
1422 180
1423 "include_remote_file.ssl_version"
1425 SSL version
1427 Format:
1429 "ssl_any" - any versions
1430 "sslv2" - SSL version 2
1431 "sslv3" - SSL version 3
1432 "tlsv1" - TLS version 1
1433 "tlsv1_1" - TLS version 1.1
1434 "tlsv1_2" - TLS version 1.2
1435 "tlsv1_3" - TLS version 1.3
1436 Default:
1437 "ssl_any"
1438 "include_remote_file.ssl_ciphers"
1440 SSL ciphers used
1442 Format:
1444 /".+"/
1445 Default:
1447 "ALL"
1448 "include_remote_file.ca_verify"
1450 Certificate verification
1452 Format:
1454 "none" - do nothing
1455 "optional" - optional
1456 "required" - required
1457 Default:
1458 "none"
1459 "include_remote_file.nosync_time_ranges"
1461 Time ranges when inclusion is not allowed
1463 Format:
1465 /$time_ranges/
1466 Default:
1468 None.
1469 "include_sympa_list"
1471 List inclusion
1473 Multiple occurrences allowed
1475 Include subscribers from other list. All subscribers of list listname
1477 become subscribers of the current list. You may include as many lists
1478 as required, using one include_sympa_list paragraph for each included
1479 list. Any list at all may be included; you may therefore include lists
1480 which are also defined by the inclusion of other lists. Be careful,
1481 however, not to include list A in list B and then list B in list A,
1482 since this will give rise to an infinite loop.
1483 "include_sympa_list.name"
1485 short name for this source
1487 Format:
1489 /".+"/
1490 Default:
1492 None.
1493 "include_sympa_list.listname"
1495 list name to include
1497 Format:
1499 /"$listname(\@$host)?"/
1500 Default:
1502 None, mandatory.
1503 "include_sympa_list.filter"
1505 filter definition
1507 Format:
1509 /".*"/
1510 Default:
1512 None.
1513 "include_sympa_list.nosync_time_ranges"
1515 Time ranges when inclusion is not allowed
1517 Format:
1519 /$time_ranges/
1520 Default:
1522 None.
1523 "include_remote_sympa_list"
1525 remote list inclusion
1527 Multiple occurrences allowed
1529 Sympa can contact another Sympa service using HTTPS to fetch a remote
1531 list in order to include each member of a remote list as subscriber.
1532 You may include as many lists as required, using one
1533 include_remote_sympa_list paragraph for each included list. Be careful,
1534 however, not to give rise to an infinite loop resulting from cross
1535 includes.
1536 For this operation, one Sympa site acts as a server while the other one
1538 acs as client. On the server side, the only setting needed is to give
1539 permission to the remote Sympa to review the list. This is controlled
1540 by the review scenario.
1541 "include_remote_sympa_list.name"
1543 short name for this source
1545 Format:
1547 /".+"/
1548 Default:
1550 None.
1551 "include_remote_sympa_list.url"
1553 data location URL
1555 Format:
1557 /".+"/
1558 Default:
1560 None.
1561 "include_remote_sympa_list.user"
1563 remote user
1565 Format:
1567 /".+"/
1568 Default:
1570 None.
1571 "include_remote_sympa_list.passwd"
1573 remote password
1575 Format:
1577 The value to be concealed.
1578 Default:
1580 None.
1581 "include_remote_sympa_list.host"
1583 remote host
1585 Format:
1587 /$host/
1588 Default:
1590 None, mandatory.
1591 obsoleted. Use "data location URL".
1593 "include_remote_sympa_list.port"
1595 remote port
1597 Format:
1599 /"\d+"/
1600 Default:
1602 443
1603 obsoleted. Use "data location URL".
1605 "include_remote_sympa_list.path"
1607 remote path of sympa list dump
1609 Format:
1611 /"\S+"/
1612 Default:
1614 None, mandatory.
1615 obsoleted. Use "data location URL".
1617 "include_remote_sympa_list.cert"
1619 Deprecated.
1621 "include_remote_sympa_list.timeout"
1623 idle timeout
1625 Format:
1627 Number of seconds.
1628 Default:
1630 180
1631 "include_remote_sympa_list.ssl_version"
1633 SSL version
1635 Format:
1637 "ssl_any" - any versions
1638 "sslv2" - SSL version 2
1639 "sslv3" - SSL version 3
1640 "tlsv1" - TLS version 1
1641 "tlsv1_1" - TLS version 1.1
1642 "tlsv1_2" - TLS version 1.2
1643 "tlsv1_3" - TLS version 1.3
1644 Default:
1645 "ssl_any"
1646 "include_remote_sympa_list.ssl_ciphers"
1648 SSL ciphers used
1650 Format:
1652 /".+"/
1653 Default:
1655 "ALL"
1656 "include_remote_sympa_list.ca_verify"
1658 Certificate verification
1660 Format:
1662 "none" - do nothing
1663 "optional" - optional
1664 "required" - required
1665 Default:
1666 "optional"
1667 "include_remote_sympa_list.nosync_time_ranges"
1669 Time ranges when inclusion is not allowed
1671 Format:
1673 /$time_ranges/
1674 Default:
1676 None.
1677 "include_ldap_query"
1679 LDAP query inclusion
1681 Multiple occurrences allowed
1683 This paragraph defines parameters for a query returning a list of
1685 subscribers. This feature requires the Net::LDAP (perlldap) PERL
1686 module.
1687 "include_ldap_query.name"
1689 short name for this source
1691 Format:
1693 /".+"/
1694 Default:
1696 None.
1697 "include_ldap_query.host"
1699 remote host
1701 Format:
1703 /$multiple_host_or_url/
1704 Default:
1706 None, mandatory.
1707 "include_ldap_query.port"
1709 Deprecated.
1711 "include_ldap_query.use_tls"
1713 use TLS (formerly SSL)
1715 Format:
1717 "starttls" - use STARTTLS
1718 "ldaps" - use LDAPS (LDAP over TLS)
1719 "none" - do nothing
1720 Default:
1721 "none"
1722 "include_ldap_query.ssl_version"
1724 SSL version
1726 Format:
1728 "sslv2" - SSL version 2
1729 "sslv3" - SSL version 3
1730 "tlsv1" - TLS version 1
1731 "tlsv1_1" - TLS version 1.1
1732 "tlsv1_2" - TLS version 1.2
1733 "tlsv1_3" - TLS version 1.3
1734 Default:
1735 "tlsv1"
1736 "include_ldap_query.ssl_ciphers"
1738 SSL ciphers used
1740 Format:
1742 /".+"/
1743 Default:
1745 "ALL"
1746 "include_ldap_query.ca_verify"
1748 Certificate verification
1750 Format:
1752 "none" - do nothing
1753 "optional" - optional
1754 "required" - required
1755 Default:
1756 "required"
1757 "include_ldap_query.bind_dn"
1759 remote user
1761 Format:
1763 /".+"/
1764 Default:
1766 None.
1767 "include_ldap_query.bind_password"
1769 remote password
1771 Format:
1773 The value to be concealed.
1774 Default:
1776 None.
1777 "include_ldap_query.suffix"
1779 suffix
1781 Format:
1783 /".+"/
1784 Default:
1786 None.
1787 "include_ldap_query.scope"
1789 search scope
1791 Format:
1793 "base" - base
1794 "one" - one level
1795 "sub" - subtree
1796 Default:
1797 "sub"
1798 "include_ldap_query.timeout"
1800 connection timeout
1802 Format:
1804 Number of seconds.
1805 Default:
1807 30
1808 "include_ldap_query.filter"
1810 filter
1812 Format:
1814 /".+"/
1815 Default:
1817 None, mandatory.
1818 "include_ldap_query.attrs"
1820 extracted attribute
1822 Format:
1824 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
1825 Default:
1827 "mail"
1828 "include_ldap_query.select"
1830 selection (if multiple)
1832 Format:
1834 "all" - all
1835 "first" - first entry
1836 "regex" - entries matching regular expression
1837 Default:
1838 "first"
1839 "include_ldap_query.regex"
1841 regular expression
1843 Format:
1845 /".+"/
1846 Default:
1848 ""
1849 "include_ldap_query.nosync_time_ranges"
1851 Time ranges when inclusion is not allowed
1853 Format:
1855 /$time_ranges/
1856 Default:
1858 None.
1859 "include_ldap_query.passwd"
1861 Obsoleted. Use "bind_password".
1863 "include_ldap_query.use_ssl"
1865 Obsoleted. Use "use_tls".
1867 "include_ldap_query.user"
1869 Obsoleted. Use "bind_dn".
1871 "include_ldap_2level_query"
1873 LDAP 2-level query inclusion
1875 Multiple occurrences allowed
1877 This paragraph defines parameters for a two-level query returning a
1879 list of subscribers. Usually the first-level query returns a list of
1880 DNs and the second-level queries convert the DNs into e-mail addresses.
1881 This feature requires the Net::LDAP (perlldap) PERL module.
1882 "include_ldap_2level_query.name"
1884 short name for this source
1886 Format:
1888 /".+"/
1889 Default:
1891 None.
1892 "include_ldap_2level_query.host"
1894 remote host
1896 Format:
1898 /$multiple_host_or_url/
1899 Default:
1901 None, mandatory.
1902 "include_ldap_2level_query.port"
1904 Deprecated.
1906 "include_ldap_2level_query.use_tls"
1908 use TLS (formerly SSL)
1910 Format:
1912 "starttls" - use STARTTLS
1913 "ldaps" - use LDAPS (LDAP over TLS)
1914 "none" - do nothing
1915 Default:
1916 "none"
1917 "include_ldap_2level_query.ssl_version"
1919 SSL version
1921 Format:
1923 "sslv2" - SSL version 2
1924 "sslv3" - SSL version 3
1925 "tlsv1" - TLS version 1
1926 "tlsv1_1" - TLS version 1.1
1927 "tlsv1_2" - TLS version 1.2
1928 "tlsv1_3" - TLS version 1.3
1929 Default:
1930 "tlsv1"
1931 "include_ldap_2level_query.ssl_ciphers"
1933 SSL ciphers used
1935 Format:
1937 /".+"/
1938 Default:
1940 "ALL"
1941 "include_ldap_2level_query.ca_verify"
1943 Certificate verification
1945 Format:
1947 "none" - do nothing
1948 "optional" - optional
1949 "required" - required
1950 Default:
1951 "required"
1952 "include_ldap_2level_query.bind_dn"
1954 remote user
1956 Format:
1958 /".+"/
1959 Default:
1961 None.
1962 "include_ldap_2level_query.bind_password"
1964 remote password
1966 Format:
1968 The value to be concealed.
1969 Default:
1971 None.
1972 "include_ldap_2level_query.suffix1"
1974 first-level suffix
1976 Format:
1978 /".+"/
1979 Default:
1981 None.
1982 "include_ldap_2level_query.scope1"
1984 first-level search scope
1986 Format:
1988 "base" - base
1989 "one" - one level
1990 "sub" - subtree
1991 Default:
1992 "sub"
1993 "include_ldap_2level_query.timeout1"
1995 first-level connection timeout
1997 Format:
1999 Number of seconds.
2000 Default:
2002 30
2003 "include_ldap_2level_query.filter1"
2005 first-level filter
2007 Format:
2009 /".+"/
2010 Default:
2012 None, mandatory.
2013 "include_ldap_2level_query.attrs1"
2015 first-level extracted attribute
2017 Format:
2019 /$ldap_attrdesc/
2020 Default:
2022 None.
2023 "include_ldap_2level_query.select1"
2025 first-level selection
2027 Format:
2029 "all" - all
2030 "first" - first entry
2031 "regex" - entries matching regular expression
2032 Default:
2033 "first"
2034 "include_ldap_2level_query.regex1"
2036 first-level regular expression
2038 Format:
2040 /".+"/
2041 Default:
2043 ""
2044 "include_ldap_2level_query.suffix2"
2046 second-level suffix template
2048 Format:
2050 /".+"/
2051 Default:
2053 None.
2054 "include_ldap_2level_query.scope2"
2056 second-level search scope
2058 Format:
2060 "base" - base
2061 "one" - one level
2062 "sub" - subtree
2063 Default:
2064 "sub"
2065 "include_ldap_2level_query.timeout2"
2067 second-level connection timeout
2069 Format:
2071 Number of seconds.
2072 Default:
2074 30
2075 "include_ldap_2level_query.filter2"
2077 second-level filter template
2079 Format:
2081 /".+"/
2082 Default:
2084 None, mandatory.
2085 "include_ldap_2level_query.attrs2"
2087 second-level extracted attribute
2089 Format:
2091 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
2092 Default:
2094 "mail"
2095 "include_ldap_2level_query.select2"
2097 second-level selection
2099 Format:
2101 "all" - all
2102 "first" - first entry
2103 "regex" - entries matching regular expression
2104 Default:
2105 "first"
2106 "include_ldap_2level_query.regex2"
2108 second-level regular expression
2110 Format:
2112 /".+"/
2113 Default:
2115 ""
2116 "include_ldap_2level_query.nosync_time_ranges"
2118 Time ranges when inclusion is not allowed
2120 Format:
2122 /$time_ranges/
2123 Default:
2125 None.
2126 "include_ldap_2level_query.passwd"
2128 Obsoleted. Use "bind_password".
2130 "include_ldap_2level_query.use_ssl"
2132 Obsoleted. Use "use_tls".
2134 "include_ldap_2level_query.user"
2136 Obsoleted. Use "bind_dn".
2138 "include_sql_query"
2140 SQL query inclusion
2142 Multiple occurrences allowed
2144 This parameter is used to define the SQL query parameters.
2146 "include_sql_query.name"
2148 short name for this source
2150 Format:
2152 /".+"/
2153 Default:
2155 None.
2156 "include_sql_query.db_type"
2158 database type
2160 Format:
2162 /"\S+"/
2163 Default:
2165 None, mandatory.
2166 "include_sql_query.db_host"
2168 remote host
2170 Format:
2172 /$host/
2173 Default:
2175 None.
2176 "include_sql_query.db_port"
2178 database port
2180 Format:
2182 /"\d+"/
2183 Default:
2185 None.
2186 "include_sql_query.db_name"
2188 database name
2190 Format:
2192 /"\S+"/
2193 Default:
2195 None, mandatory.
2196 "include_sql_query.db_options"
2198 connection options
2200 Format:
2202 /".+"/
2203 Default:
2205 None.
2206 "include_sql_query.db_env"
2208 environment variables for database connection
2210 Format:
2212 /"\w+\=\S+(;\w+\=\S+)*"/
2213 Default:
2215 None.
2216 "include_sql_query.db_user"
2218 remote user
2220 Format:
2222 /"\S+"/
2223 Default:
2225 None, mandatory.
2226 "include_sql_query.db_passwd"
2228 remote password
2230 Format:
2232 The value to be concealed.
2233 Default:
2235 None.
2236 "include_sql_query.sql_query"
2238 SQL query
2240 Format:
2242 /$sql_query/
2243 Default:
2245 None, mandatory.
2246 "include_sql_query.f_dir"
2248 Directory where the database is stored (used for DBD::CSV only)
2250 Format:
2252 /".+"/
2253 Default:
2255 None.
2256 "include_sql_query.nosync_time_ranges"
2258 Time ranges when inclusion is not allowed
2260 Format:
2262 /$time_ranges/
2263 Default:
2265 None.
2266 "include_sql_query.connect_options"
2268 Obsoleted. Use "db_options".
2270 "include_sql_query.host"
2272 Obsoleted. Use "db_host".
2274 "include_sql_query.passwd"
2276 Obsoleted. Use "db_passwd".
2278 "include_sql_query.user"
2280 Obsoleted. Use "db_user".
2282 "ttl"
2284 Inclusions timeout
2286 Format:
2288 Number of seconds.
2289 Default:
2291 Value of "default_ttl" parameter in sympa.conf.
2292 Sympa caches user data extracted using the include parameter. Their TTL
2294 (time-to-live) within Sympa can be controlled using this parameter. The
2295 default value is 3600
2296 "distribution_ttl"
2298 Inclusions timeout for message distribution
2300 Format:
2302 Number of seconds.
2303 Default:
2305 None.
2306 This parameter defines the delay since the last synchronization after
2308 which the user's list will be updated before performing either of
2309 following actions:
2310 * Reviewing list members
2312 * Message distribution
2314 "include_ldap_ca"
2316 LDAP query custom attribute
2318 Multiple occurrences allowed
2320 "include_ldap_ca.name"
2322 short name for this source
2324 Format:
2326 /".+"/
2327 Default:
2329 None.
2330 "include_ldap_ca.host"
2332 remote host
2334 Format:
2336 /$multiple_host_or_url/
2337 Default:
2339 None, mandatory.
2340 "include_ldap_ca.port"
2342 Deprecated.
2344 "include_ldap_ca.use_tls"
2346 use TLS (formerly SSL)
2348 Format:
2350 "starttls" - use STARTTLS
2351 "ldaps" - use LDAPS (LDAP over TLS)
2352 "none" - do nothing
2353 Default:
2354 "none"
2355 "include_ldap_ca.ssl_version"
2357 SSL version
2359 Format:
2361 "sslv2" - SSL version 2
2362 "sslv3" - SSL version 3
2363 "tlsv1" - TLS version 1
2364 "tlsv1_1" - TLS version 1.1
2365 "tlsv1_2" - TLS version 1.2
2366 "tlsv1_3" - TLS version 1.3
2367 Default:
2368 "tlsv1"
2369 "include_ldap_ca.ssl_ciphers"
2371 SSL ciphers used
2373 Format:
2375 /".+"/
2376 Default:
2378 "ALL"
2379 "include_ldap_ca.ca_verify"
2381 Certificate verification
2383 Format:
2385 "none" - do nothing
2386 "optional" - optional
2387 "required" - required
2388 Default:
2389 "required"
2390 "include_ldap_ca.bind_dn"
2392 remote user
2394 Format:
2396 /".+"/
2397 Default:
2399 None.
2400 "include_ldap_ca.bind_password"
2402 remote password
2404 Format:
2406 The value to be concealed.
2407 Default:
2409 None.
2410 "include_ldap_ca.suffix"
2412 suffix
2414 Format:
2416 /".+"/
2417 Default:
2419 None.
2420 "include_ldap_ca.scope"
2422 search scope
2424 Format:
2426 "base" - base
2427 "one" - one level
2428 "sub" - subtree
2429 Default:
2430 "sub"
2431 "include_ldap_ca.timeout"
2433 connection timeout
2435 Format:
2437 Number of seconds.
2438 Default:
2440 30
2441 "include_ldap_ca.filter"
2443 filter
2445 Format:
2447 /".+"/
2448 Default:
2450 None, mandatory.
2451 "include_ldap_ca.attrs"
2453 extracted attribute
2455 Format:
2457 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
2458 Default:
2460 "mail"
2461 "include_ldap_ca.email_entry"
2463 Name of email entry
2465 Format:
2467 /"\S+"/
2468 Default:
2470 None, mandatory.
2471 "include_ldap_ca.select"
2473 selection (if multiple)
2475 Format:
2477 "all" - all
2478 "first" - first entry
2479 "regex" - entries matching regular expression
2480 Default:
2481 "first"
2482 "include_ldap_ca.regex"
2484 regular expression
2486 Format:
2488 /".+"/
2489 Default:
2491 ""
2492 "include_ldap_ca.nosync_time_ranges"
2494 Time ranges when inclusion is not allowed
2496 Format:
2498 /$time_ranges/
2499 Default:
2501 None.
2502 "include_ldap_ca.passwd"
2504 Obsoleted. Use "bind_password".
2506 "include_ldap_ca.use_ssl"
2508 Obsoleted. Use "use_tls".
2510 "include_ldap_ca.user"
2512 Obsoleted. Use "bind_dn".
2514 "include_ldap_2level_ca"
2516 LDAP 2-level query custom attribute
2518 Multiple occurrences allowed
2520 "include_ldap_2level_ca.host"
2522 remote host
2524 Format:
2526 /$multiple_host_or_url/
2527 Default:
2529 None, mandatory.
2530 "include_ldap_2level_ca.name"
2532 short name for this source
2534 Format:
2536 /".+"/
2537 Default:
2539 None.
2540 "include_ldap_2level_ca.port"
2542 Deprecated.
2544 "include_ldap_2level_ca.use_tls"
2546 use TLS (formerly SSL)
2548 Format:
2550 "starttls" - use STARTTLS
2551 "ldaps" - use LDAPS (LDAP over TLS)
2552 "none" - do nothing
2553 Default:
2554 "none"
2555 "include_ldap_2level_ca.ssl_version"
2557 SSL version
2559 Format:
2561 "sslv2" - SSL version 2
2562 "sslv3" - SSL version 3
2563 "tlsv1" - TLS version 1
2564 "tlsv1_1" - TLS version 1.1
2565 "tlsv1_2" - TLS version 1.2
2566 "tlsv1_3" - TLS version 1.3
2567 Default:
2568 "tlsv1"
2569 "include_ldap_2level_ca.ssl_ciphers"
2571 SSL ciphers used
2573 Format:
2575 /".+"/
2576 Default:
2578 "ALL"
2579 "include_ldap_2level_ca.ca_verify"
2581 Certificate verification
2583 Format:
2585 "none" - do nothing
2586 "optional" - optional
2587 "required" - required
2588 Default:
2589 "required"
2590 "include_ldap_2level_ca.bind_dn"
2592 remote user
2594 Format:
2596 /".+"/
2597 Default:
2599 None.
2600 "include_ldap_2level_ca.bind_password"
2602 remote password
2604 Format:
2606 The value to be concealed.
2607 Default:
2609 None.
2610 "include_ldap_2level_ca.suffix1"
2612 first-level suffix
2614 Format:
2616 /".+"/
2617 Default:
2619 None.
2620 "include_ldap_2level_ca.scope1"
2622 first-level search scope
2624 Format:
2626 "base" - base
2627 "one" - one level
2628 "sub" - subtree
2629 Default:
2630 "sub"
2631 "include_ldap_2level_ca.timeout1"
2633 first-level connection timeout
2635 Format:
2637 Number of seconds.
2638 Default:
2640 30
2641 "include_ldap_2level_ca.filter1"
2643 first-level filter
2645 Format:
2647 /".+"/
2648 Default:
2650 None, mandatory.
2651 "include_ldap_2level_ca.attrs1"
2653 first-level extracted attribute
2655 Format:
2657 /$ldap_attrdesc/
2658 Default:
2660 None.
2661 "include_ldap_2level_ca.select1"
2663 first-level selection
2665 Format:
2667 "all" - all
2668 "first" - first entry
2669 "regex" - entries matching regular expression
2670 Default:
2671 "first"
2672 "include_ldap_2level_ca.regex1"
2674 first-level regular expression
2676 Format:
2678 /".+"/
2679 Default:
2681 ""
2682 "include_ldap_2level_ca.suffix2"
2684 second-level suffix template
2686 Format:
2688 /".+"/
2689 Default:
2691 None.
2692 "include_ldap_2level_ca.scope2"
2694 second-level search scope
2696 Format:
2698 "base" - base
2699 "one" - one level
2700 "sub" - subtree
2701 Default:
2702 "sub"
2703 "include_ldap_2level_ca.timeout2"
2705 second-level connection timeout
2707 Format:
2709 Number of seconds.
2710 Default:
2712 30
2713 "include_ldap_2level_ca.filter2"
2715 second-level filter template
2717 Format:
2719 /".+"/
2720 Default:
2722 None, mandatory.
2723 "include_ldap_2level_ca.attrs2"
2725 second-level extracted attribute
2727 Format:
2729 /$ldap_attrdesc/
2730 Default:
2732 "mail"
2733 "include_ldap_2level_ca.select2"
2735 second-level selection
2737 Format:
2739 "all" - all
2740 "first" - first entry
2741 "regex" - entries matching regular expression
2742 Default:
2743 "first"
2744 "include_ldap_2level_ca.regex2"
2746 second-level regular expression
2748 Format:
2750 /".+"/
2751 Default:
2753 ""
2754 "include_ldap_2level_ca.email_entry"
2756 Name of email entry
2758 Format:
2760 /"\S+"/
2761 Default:
2763 None, mandatory.
2764 "include_ldap_2level_ca.nosync_time_ranges"
2766 Time ranges when inclusion is not allowed
2768 Format:
2770 /$time_ranges/
2771 Default:
2773 None.
2774 "include_ldap_2level_ca.passwd"
2776 Obsoleted. Use "bind_password".
2778 "include_ldap_2level_ca.use_ssl"
2780 Obsoleted. Use "use_tls".
2782 "include_ldap_2level_ca.user"
2784 Obsoleted. Use "bind_dn".
2786 "include_sql_ca"
2788 SQL query custom attribute
2790 Multiple occurrences allowed
2792 "include_sql_ca.name"
2794 short name for this source
2796 Format:
2798 /".+"/
2799 Default:
2801 None.
2802 "include_sql_ca.db_type"
2804 database type
2806 Format:
2808 /"\S+"/
2809 Default:
2811 None, mandatory.
2812 "include_sql_ca.db_host"
2814 remote host
2816 Format:
2818 /$host/
2819 Default:
2821 None.
2822 "include_sql_ca.db_port"
2824 database port
2826 Format:
2828 /"\d+"/
2829 Default:
2831 None.
2832 "include_sql_ca.db_name"
2834 database name
2836 Format:
2838 /"\S+"/
2839 Default:
2841 None, mandatory.
2842 "include_sql_ca.db_options"
2844 connection options
2846 Format:
2848 /".+"/
2849 Default:
2851 None.
2852 "include_sql_ca.db_env"
2854 environment variables for database connection
2856 Format:
2858 /"\w+\=\S+(;\w+\=\S+)*"/
2859 Default:
2861 None.
2862 "include_sql_ca.db_user"
2864 remote user
2866 Format:
2868 /"\S+"/
2869 Default:
2871 None, mandatory.
2872 "include_sql_ca.db_passwd"
2874 remote password
2876 Format:
2878 The value to be concealed.
2879 Default:
2881 None.
2882 "include_sql_ca.sql_query"
2884 SQL query
2886 Format:
2888 /$sql_query/
2889 Default:
2891 None, mandatory.
2892 "include_sql_ca.f_dir"
2894 Directory where the database is stored (used for DBD::CSV only)
2896 Format:
2898 /".+"/
2899 Default:
2901 None.
2902 "include_sql_ca.email_entry"
2904 Name of email entry
2906 Format:
2908 /"\S+"/
2909 Default:
2911 None, mandatory.
2912 "include_sql_ca.nosync_time_ranges"
2914 Time ranges when inclusion is not allowed
2916 Format:
2918 /$time_ranges/
2919 Default:
2921 None.
2922 "include_sql_ca.connect_options"
2924 Obsoleted. Use "db_options".
2926 "include_sql_ca.host"
2928 Obsoleted. Use "db_host".
2930 "include_sql_ca.passwd"
2932 Format:
2934 Default:
2935 None.
2936 "include_sql_ca.user"
2938 Obsoleted. Use "db_user".
2940 "include_list"
2942 Deprecated.
2944 "user_data_source"
2946 Deprecated.
2948 DKIM
2950 "dkim_feature"
2951 Insert DKIM signature to messages sent to the list
2953 Format:
2955 "on" - enabled
2956 "off" - disabled
2957 Default:
2958 Value of "dkim_feature" parameter in sympa.conf or robot.conf.
2959 Enable/Disable DKIM. This feature requires Mail::DKIM to be installed,
2961 and maybe some custom scenario to be updated
2962 "dkim_parameters"
2964 DKIM configuration
2966 Single occurrence
2968 A set of parameters in order to define outgoing DKIM signature
2970 "dkim_parameters.private_key_path"
2972 File path for list DKIM private key
2974 Format:
2976 /"\S+"/
2977 Default:
2979 Value of "dkim_private_key_path" parameter in sympa.conf or
2980 robot.conf.
2981 The file must contain a RSA pem encoded private key
2983 "dkim_parameters.selector"
2985 Selector for DNS lookup of DKIM public key
2987 Format:
2989 /"\S+"/
2990 Default:
2992 Value of "dkim_selector" parameter in sympa.conf or robot.conf.
2993 The selector is used in order to build the DNS query for public key. It
2995 is up to you to choose the value you want but verify that you can query
2996 the public DKIM key for <selector>._domainkey.your_domain
2997 "dkim_parameters.header_list"
2999 Deprecated.
3001 "dkim_parameters.signer_domain"
3003 DKIM "d=" tag, you should probably use the default value
3005 Format:
3007 /"\S+"/
3008 Default:
3010 Value of "dkim_signer_domain" parameter in sympa.conf or
3011 robot.conf.
3012 The DKIM "d=" tag, is the domain of the signing entity. The list domain
3014 MUST be included in the "d=" domain
3015 "dkim_parameters.signer_identity"
3017 DKIM "i=" tag, you should probably leave this parameter empty
3019 Format:
3021 /"\S+"/
3022 Default:
3024 None.
3025 DKIM "i=" tag, you should probably not use this parameter, as
3027 recommended by RFC 4871, default for list brodcasted messages is
3028 i=<listname>-request@<domain>
3029 "dkim_signature_apply_on"
3031 The categories of messages sent to the list that will be signed using
3033 DKIM.
3034 Format:
3036 Multiple values allowed, separated by ",".
3037 "md5_authenticated_messages" - authenticated by password
3039 "smime_authenticated_messages" - authenticated by S/MIME signature
3040 "dkim_authenticated_messages" - authenticated by DKIM signature
3041 "editor_validated_messages" - approved by moderator
3042 "none" - do nothing
3043 "any" - any messages
3044 Default:
3045 Value of "dkim_signature_apply_on" parameter in sympa.conf or
3046 robot.conf.
3047 This parameter controls in which case messages must be signed using
3049 DKIM, you may sign every message choosing 'any' or a subset. The
3050 parameter value is a comma separated list of keywords
3051 "arc_feature"
3053 Add ARC seals to messages sent to the list
3055 Format:
3057 "on" - enabled
3058 "off" - disabled
3059 Default:
3060 Value of "arc_feature" parameter in sympa.conf or robot.conf.
3061 Enable/Disable ARC. This feature requires Mail::DKIM::ARC to be
3063 installed, and maybe some custom scenario to be updated
3064 "arc_parameters"
3066 ARC configuration
3068 Single occurrence
3070 A set of parameters in order to define outgoing ARC seal
3072 "arc_parameters.arc_private_key_path"
3074 File path for list ARC private key
3076 Format:
3078 /"\S+"/
3079 Default:
3081 Value of "arc_private_key_path" parameter in sympa.conf or
3082 robot.conf.
3083 The file must contain a RSA pem encoded private key. Default is DKIM
3085 private key.
3086 "arc_parameters.arc_selector"
3088 Selector for DNS lookup of ARC public key
3090 Format:
3092 /"\S+"/
3093 Default:
3095 Value of "arc_selector" parameter in sympa.conf or robot.conf.
3096 The selector is used in order to build the DNS query for public key. It
3098 is up to you to choose the value you want but verify that you can query
3099 the public DKIM key for <selector>._domainkey.your_domain. Default is
3100 selector for DKIM signature
3101 "arc_parameters.arc_signer_domain"
3103 ARC "d=" tag, you should probably use the default value
3105 Format:
3107 /"\S+"/
3108 Default:
3110 Value of "arc_signer_domain" parameter in sympa.conf or robot.conf.
3111 The ARC "d=" tag, is the domain of the sealing entity. The list domain
3113 MUST be included in the "d=" domain
3114 "dmarc_protection"
3116 DMARC Protection
3118 Single occurrence
3120 Parameters to define how to manage From address processing to avoid
3122 some domains' excessive DMARC protection
3123 "dmarc_protection.mode"
3125 Protection modes
3127 Format:
3129 Multiple values allowed, separated by ",".
3130 "none" - do nothing
3132 "all" - all
3133 "dkim_signature" - DKIM signature exists
3134 "dmarc_reject" - DMARC policy suggests rejection
3135 "dmarc_any" - DMARC policy exists
3136 "dmarc_quarantine" - DMARC policy suggests quarantine
3137 "domain_regex" - domain matching regular expression
3138 Default:
3139 Value of "dmarc_protection_mode" parameter in sympa.conf or
3140 robot.conf.
3141 Select one or more operation modes. "Domain matching regular
3143 expression" (domain_regex) matches the specified Domain regular
3144 expression; "DKIM signature exists" (dkim_signature) matches any
3145 message with a DKIM signature header; "DMARC policy ..." (dmarc_*)
3146 matches messages from sender domains with a DMARC policy as given;
3147 "all" (all) matches all messages.
3148 "dmarc_protection.domain_regex"
3150 Match domain regular expression
3152 Format:
3154 /".+"/
3155 Default:
3157 Value of "dmarc_protection_domain_regex" parameter in sympa.conf or
3158 robot.conf.
3159 Regular expression match pattern for From domain
3161 "dmarc_protection.other_email"
3163 New From address
3165 Format:
3167 /".+"/
3168 Default:
3170 Value of "dmarc_protection_other_email" parameter in sympa.conf or
3171 robot.conf.
3172 This is the email address to use when modifying the From header. It
3174 defaults to the list address. This is similar to Anonymisation but
3175 preserves the original sender details in the From address phrase.
3176 "dmarc_protection.phrase"
3178 New From name format
3180 Format:
3182 "display_name" - "Name"
3183 "name_and_email" - "Name" (e-mail)
3184 "name_via_list" - "Name" (via List)
3185 "name_email_via_list" - "Name" (e-mail via List)
3186 "list_for_email" - "List" (on behalf of e-mail)
3187 "list_for_name" - "List" (on behalf of Name)
3188 Default:
3189 Value of "dmarc_protection_phrase" parameter in sympa.conf or
3190 robot.conf.
3191 This is the format to be used for the sender name part of the new From
3193 header.
3194 Miscellaneous
3196 "clean_delay_queuemod"
3197 Expiration of unmoderated messages
3199 Format:
3201 Number of days.
3202 Default:
3204 Value of "clean_delay_queuemod" parameter in sympa.conf.
3205 "cookie"
3207 Secret string for generating unique keys
3209 Format:
3211 The value to be concealed.
3212 Default:
3214 Value of "cookie" parameter in sympa.conf.
3215 This parameter is a confidential item for generating authentication
3217 keys for administrative commands (ADD, DELETE, etc.). This parameter
3218 should remain concealed, even for owners. The cookie is applied to all
3219 list owners, and is only taken into account when the owner has the auth
3220 parameter.
3221 "custom_attribute"
3223 Custom user attributes
3225 Multiple occurrences allowed
3227 "custom_attribute.id"
3229 internal identifier
3231 Format:
3233 /"\w+"/
3234 Default:
3236 None, mandatory.
3237 "custom_attribute.name"
3239 label
3241 Format:
3243 /".+"/
3244 Default:
3246 None, mandatory.
3247 "custom_attribute.comment"
3249 additional comment
3251 Format:
3253 /".+"/
3254 Default:
3256 None.
3257 "custom_attribute.type"
3259 type
3261 Format:
3263 "string" - string
3264 "text" - multi-line text
3265 "integer" - number
3266 "enum" - set of keywords
3267 Default:
3268 "string"
3269 "custom_attribute.enum_values"
3271 possible attribute values (if enum is used)
3273 Format:
3275 /".+"/
3276 Default:
3278 None.
3279 "custom_attribute.optional"
3281 is the attribute optional?
3283 Format:
3285 "required" - required
3286 "optional" - optional
3287 Default:
3288 "optional"
3289 "custom_vars"
3291 custom parameters
3293 Multiple occurrences allowed
3295 "custom_vars.name"
3297 var name
3299 Format:
3301 /"\S+"/
3302 Default:
3304 None, mandatory.
3305 "custom_vars.value"
3307 var value
3309 Format:
3311 /".+"/
3312 Default:
3314 None, mandatory.
3315 "expire_task"
3317 Deprecated.
3319 "loop_prevention_regex"
3321 Regular expression applied to prevent loops with robots
3323 Format:
3325 /"\S*"/
3326 Default:
3328 Value of "loop_prevention_regex" parameter in sympa.conf or
3329 robot.conf.
3330 "pictures_feature"
3332 Allow picture display? (must be enabled for the current robot)
3334 Format:
3336 "on" - enabled
3337 "off" - disabled
3338 Default:
3339 Value of "pictures_feature" parameter in sympa.conf or robot.conf.
3340 "remind_task"
3342 Periodical subscription reminder task
3344 Format:
3346 /"\w+"/
3347 Default:
3349 Value of "default_remind_task" parameter in sympa.conf.
3350 This parameter states which model is used to create a remind task. A
3352 remind task regularly sends subscribers a message which reminds them
3353 of their list subscriptions.
3354 "spam_protection"
3356 email address protection method
3358 Format:
3360 "at" - replace @ characters
3361 "javascript" - use JavaScript
3362 "none" - do nothing
3363 Default:
3364 "javascript"
3365 There is a need to protect Sympa web sites against spambots which
3367 collect email addresses from public web sites. Various methods are
3368 available in Sympa and you can choose to use them with the
3369 spam_protection and web_archive_spam_protection parameters. Possible
3370 value are:
3371 javascript:
3373 the address is hidden using a javascript. A user who enables javascript
3375 can see a nice mailto address where others have nothing.
3376 at:
3378 the @ char is replaced by the string " AT ".
3380 none:
3382 no protection against spammer.
3384 "latest_instantiation"
3386 Latest family instantiation
3388 Single occurrence
3390 "latest_instantiation.email"
3392 who ran the instantiation
3394 Format:
3396 /"listmaster|$email"/
3397 Default:
3399 None.
3400 "latest_instantiation.date_epoch"
3402 date
3404 Format:
3406 The time in second from Unix epoch.
3407 Default:
3409 None, mandatory.
3410 "latest_instantiation.date"
3412 Deprecated.
3414 "creation"
3416 Creation of the list
3418 Single occurrence
3420 "creation.email"
3422 who created the list
3424 Format:
3426 /"listmaster|$email"/
3427 Default:
3429 None, mandatory.
3430 "creation.date_epoch"
3432 date
3434 Format:
3436 The time in second from Unix epoch.
3437 Default:
3439 None, mandatory.
3440 "creation.date"
3442 Deprecated.
3444 "update"
3446 Last update of config
3448 Single occurrence
3450 "update.email"
3452 who updated the config
3454 Format:
3456 /"(listmaster|automatic|$email)"/
3457 Default:
3459 None.
3460 "update.date_epoch"
3462 date
3464 Format:
3466 The time in second from Unix epoch.
3467 Default:
3469 None, mandatory.
3470 "update.date"
3472 Deprecated.
3474 "status"
3476 Status of the list
3478 Format:
3480 Status of list.
3481 Default:
3483 "open"
3484 "serial"
3486 Serial number of the config
3488 Format:
3490 /"\d+"/
3491 Default:
3493 0
3494 "account"
3496 Deprecated.
3498
3500 $EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list
3501 name>/config
3502 List main configuration file.
3503
3505 sympa.conf(5).
3506 Sympa Administration Manual.
3508 <https://sympa-community.github.io/manual/>.
35096.2.54 2020-03-02 LIST_CONFIG(5)