1LIST_CONFIG(5) sympa 6.2.48 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 "intranet" - intranet access
71 "noconceal" - no conceal
72 "secret" - conceal even for subscribers
73 Default:
74 Value of "visibility" parameter in sympa.conf or robot.conf.
75 This parameter indicates whether the list should feature in the output
77 generated in response to a LISTS command or should be shown in the list
78 overview of the web-interface.
79 "topics"
81 Topics for the list
83 Format:
85 Multiple values allowed, separated by ",".
86 List topic.
88 Default:
90 None.
91 This parameter allows the classification of lists. You may define
93 multiple topics as well as hierarchical ones. WWSympa's list of public
94 lists uses this parameter.
95 "host"
97 Deprecated.
99 "lang"
101 Language of the list
103 Format:
105 Language tag.
106 Default:
108 Value of "lang" parameter in sympa.conf or robot.conf.
109 This parameter defines the language used for the list. It is used to
111 initialize a user's language preference; Sympa command reports are
112 extracted from the associated message catalog.
113 "family_name"
115 Family name
117 Format:
119 /$family_name/
120 Default:
122 None.
123 "max_list_members"
125 Maximum number of list members
127 Format:
129 Number of list members.
130 Default:
132 Value of "default_max_list_members" parameter in sympa.conf or
133 robot.conf.
134 limit for the number of subscribers. 0 means no limit.
136 "priority"
138 Priority
140 Format:
142 0 - 0 - highest priority
143 1 - 1
144 2 - 2
145 3 - 3
146 4 - 4
147 5 - 5
148 6 - 6
149 7 - 7
150 8 - 8
151 9 - 9 - lowest priority
152 "z" - queue messages only
153 Default:
154 Value of "default_list_priority" parameter in sympa.conf or
155 robot.conf.
156 The priority with which Sympa will process messages for this list. This
158 level of priority is applied while the message is going through the
159 spool. The z priority will freeze the message in the spool.
160 Sending/receiving setup
162 "send"
163 Who can send messages
165 Format:
167 Name of "send" scenario:
168 "closed" - closed
170 "confidential" - restricted to subscribers, messages from others
171 are discarded
172 "editordkim" - Moderated, no authentication needed if DKIM
173 signature from moderator is OK
174 "editorkey" - Moderated
175 "editorkeyonly" - Moderated, even for moderators
176 "editorkeyonlyauth" - Moderated, need authentication from moderator
177 "intranet" - restricted to local domain
178 "intranetorprivate" - restricted to local domain and subscribers
179 "newsletter" - Newsletter, restricted to moderators
180 "newsletterkeyonly" - Newsletter, restricted to moderators after
181 confirmation
182 "owner" - Restricted to list owners only
183 "ownerauth" - Restricted to list owners with previous MD5
184 authentication
185 "private" - restricted to subscribers
186 "private_smime" - restricted to subscribers and checked smime
187 signature
188 "privateandeditorkey" - Moderated, restricted to subscribers
189 "privateandnomultipartoreditorkey" - Moderated, for non subscribers
190 sending multipart messages
191 "privatekey" - restricted to subscribers with previous md5
192 authentication
193 "privatekeyandeditorkeyonly" - Moderated, for subscribers and even
194 moderators themself
195 "privateoreditorkey" - Private, moderated for non subscribers
196 "privateorpublickey" - Private, confirmation for non subscribers
197 "public" - public list
198 "public_nobcc" - public list, Bcc rejected (anti-spam)
199 "publickey" - anyone no authentication if DKIM signature is OK
200 "publicnoattachment" - public list multipart/mixed messages are
201 forwarded to moderator
202 "publicnomultipart" - public list multipart messages are rejected
203 Default:
204 Value of "send" parameter in sympa.conf or robot.conf.
205 This parameter specifies who can send messages to the list.
207 "delivery_time"
209 Delivery time (hh:mm)
211 Format:
213 /"[0-2]?\d\:[0-6]\d"/
214 Default:
216 None.
217 If this parameter is present, non-digest messages will be delivered to
219 subscribers at this time: When this time has been past, delivery is
220 postponed to the same time in next day.
221 "digest"
223 Digest frequency
225 Single occurrence
227 Definition of digest mode. If this parameter is present, subscribers
229 can select the option of receiving messages in multipart/digest MIME
230 format, or as a plain text digest. Messages are then grouped together,
231 and compiled messages are sent to subscribers according to the
232 frequency selected with this parameter.
233 "digest.days"
235 days
237 Format:
239 Multiple occurrences allowed.
240 Day of week, 0 - 6.
242 Default:
244 None, mandatory.
245 "digest.hour"
247 hour
249 Format:
251 /"\d+"/
252 Default:
254 None, mandatory.
255 "digest.minute"
257 minute
259 Format:
261 /"\d+"/
262 Default:
264 None, mandatory.
265 "digest_max_size"
267 Digest maximum number of messages
269 Format:
271 Number of messages.
272 Default:
274 25
275 "available_user_options"
277 Available subscription options
279 Single occurrence
281 "available_user_options.reception"
283 reception mode
285 Format:
287 Multiple values allowed, separated by ",".
288 Reception mode of list member.
290 Default:
292 "mail,notice,digest,digestplain,summary,nomail,txt,urlize,not_me"
293 Only these modes will be allowed for the subscribers of this list. If a
295 subscriber has a reception mode not in the list, Sympa uses the mode
296 specified in the default_user_options paragraph.
297 "default_user_options"
299 Subscription profile
301 Single occurrence
303 Default profile for the subscribers of the list.
305 "default_user_options.reception"
307 reception mode
309 Format:
311 Reception mode of list member.
312 Default:
314 "mail"
315 Mail reception mode.
317 "default_user_options.visibility"
319 visibility
321 Format:
323 Visibility mode of list memeber.
324 Default:
326 "noconceal"
327 Visibility of the subscriber.
329 "msg_topic"
331 Topics for message categorization
333 Multiple occurrences allowed
335 This paragraph defines a topic used to tag a message of a list, named
337 by msg_topic.name ("other" is a reserved word), its title is
338 msg_topic.title. The msg_topic.keywords entry is optional and allows
339 automatic tagging. This should be a list of keywords, separated by ','.
340 "msg_topic.name"
342 Message topic name
344 Format:
346 /"[\-\w]+"/
347 Default:
349 None, mandatory.
350 "msg_topic.keywords"
352 Message topic keywords
354 Format:
356 /"[^,\n]+(,[^,\n]+)*"/
357 Default:
359 None.
360 "msg_topic.title"
362 Message topic title
364 Format:
366 /".+"/
367 Default:
369 None, mandatory.
370 "msg_topic_keywords_apply_on"
372 Defines to which part of messages topic keywords are applied
374 Format:
376 "subject" - subject field
377 "body" - message body
378 "subject_and_body" - subject and body
379 Default:
380 "subject"
381 This parameter indicates which part of the message is used to perform
383 automatic tagging.
384 "msg_topic_tagging"
386 Message tagging
388 Format:
390 "required_sender" - required to post message
391 "required_moderator" - required to distribute message
392 "optional" - optional
393 Default:
394 "optional"
395 This parameter indicates if the tagging is optional or required for a
397 list.
398 "reply_to_header"
400 Reply address
402 Single occurrence
404 This defines what Sympa will place in the Reply-To: SMTP header field
406 of the messages it distributes.
407 "reply_to_header.value"
409 value
411 Format:
413 "sender" - sender
414 "list" - list
415 "all" - all
416 "other_email" - other email address
417 Default:
418 "sender"
419 This parameter indicates whether the Reply-To: field should indicate
421 the sender of the message (sender), the list itself (list), both list
422 and sender (all) or an arbitrary e-mail address (defined by the
423 other_email parameter).
424 Note: it is inadvisable to change this parameter, and particularly
426 inadvisable to set it to list. Experience has shown it to be almost
427 inevitable that users, mistakenly believing that they are replying only
428 to the sender, will send private messages to a list. This can lead, at
429 the very least, to embarrassment, and sometimes to more serious
430 consequences.
431 "reply_to_header.other_email"
433 other email address
435 Format:
437 /$email/
438 Default:
440 None.
441 If value was set to other_email, this parameter defines the e-mail
443 address used.
444 "reply_to_header.apply"
446 respect of existing header field
448 Format:
450 "forced" - overwrite Reply-To: header field
451 "respect" - preserve existing header field
452 Default:
453 "respect"
454 The default is to respect (preserve) the existing Reply-To: SMTP header
456 field in incoming messages. If set to forced, Reply-To: SMTP header
457 field will be overwritten.
458 "anonymous_sender"
460 Anonymous sender
462 Format:
464 /".+"/
465 Default:
467 None.
468 To hide the sender's email address before distributing the message. It
470 is replaced by the provided email address.
471 "custom_header"
473 Custom header field
475 Format:
477 Multiple occurrences allowed.
478 /"\S+:\s+.*"/
480 Default:
482 None.
483 This parameter is optional. The headers specified will be added to the
485 headers of messages distributed via the list. As of release 1.2.2 of
486 Sympa, it is possible to put several custom header lines in the
487 configuration file at the same time.
488 "custom_subject"
490 Subject tagging
492 Format:
494 /".+"/
495 Default:
497 None.
498 This parameter is optional. It specifies a string which is added to the
500 subject of distributed messages (intended to help users who do not use
501 automatic tools to sort incoming messages). This string will be
502 surrounded by [] characters.
503 "footer_type"
505 Attachment type
507 Format:
509 "mime" - add a new MIME part
510 "append" - append to message body
511 Default:
512 "mime"
513 List owners may decide to add message headers or footers to messages
515 sent via the list. This parameter defines the way a footer/header is
516 added to a message.
517 mime:
519 The default value. Sympa will add the footer/header as a new MIME part.
521 append:
523 Sympa will not create new MIME parts, but will try to append the
525 header/footer to the body of the message. Predefined message-footers
526 will be ignored. Headers/footers may be appended to text/plain messages
527 only.
528 "max_size"
530 Maximum message size
532 Format:
534 Number of bytes.
535 Default:
537 Value of "max_size" parameter in sympa.conf or robot.conf.
538 Maximum size of a message in 8-bit bytes.
540 "merge_feature"
542 Allow message personalization
544 Format:
546 "on" - enabled
547 "off" - disabled
548 Default:
549 Value of "merge_feature" parameter in sympa.conf.
550 "message_hook"
552 Hook modules for message processing
554 Single occurrence
556 "message_hook.pre_distribute"
558 A hook on the messages before distribution
560 Format:
562 /"(::|\w)+"/
563 Default:
565 None.
566 "message_hook.post_archive"
568 A hook on the messages just after archiving
570 Format:
572 /"(::|\w)+"/
573 Default:
575 None.
576 "reject_mail_from_automates_feature"
578 Reject mail from automatic processes (crontab, etc)?
580 Format:
582 "on" - enabled
583 "off" - disabled
584 Default:
585 Value of "reject_mail_from_automates_feature" parameter in
586 sympa.conf.
587 "remove_headers"
589 Incoming SMTP header fields to be removed
591 Format:
593 Multiple values allowed, separated by ",".
594 /"\S+"/
596 Default:
598 Value of "remove_headers" parameter in sympa.conf.
599 "remove_outgoing_headers"
601 Outgoing SMTP header fields to be removed
603 Format:
605 Multiple values allowed, separated by ",".
606 /"\S+"/
608 Default:
610 Value of "remove_outgoing_headers" parameter in sympa.conf.
611 "rfc2369_header_fields"
613 RFC 2369 Header fields
615 Format:
617 Multiple values allowed, separated by ",".
618 "help" - help
620 "subscribe" - subscription
621 "unsubscribe" - unsubscription
622 "post" - posting address
623 "owner" - owner
624 "archive" - list archive
625 Default:
626 Value of "rfc2369_header_fields" parameter in sympa.conf.
627 "forced_reply_to"
629 Deprecated.
631 "reply_to"
633 Deprecated.
635 Privileges
637 "info"
638 Who can view list information
640 Format:
642 Name of "info" scenario:
643 "conceal" - restricted to subscribers - Silent rejection otherwise.
645 "open" - for anyone
646 "private" - restricted to subscribers
647 Default:
648 Value of "info" parameter in sympa.conf or robot.conf.
649 "subscribe"
651 Who can subscribe to the list
653 Format:
655 Name of "subscribe" scenario:
656 "auth" - subscription request confirmed
658 "auth_notify" - need authentication (notification is sent to
659 owners)
660 "auth_notifydkim" - need authentication unless DKIM signature is OK
661 (notification is sent to owners)
662 "auth_owner" - requires authentication then owner approval
663 "auth_ownerdkim" - requires authentication unless DKIM signature is
664 OK, then owner approval
665 "authdkim" - subscription request confirmed
666 "closed" - subscription is impossible
667 "intranet" - restricted to local domain users
668 "intranetorowner" - local domain users or owner approval
669 "open" - for anyone without authentication
670 "open_notify" - anyone, notification is sent to list owner
671 "open_quiet" - anyone, no welcome message
672 "owner" - owners approval
673 "smime" - requires S/MIME signed
674 "smimeorowner" - requires S/MIME signed or owner approval
675 Default:
676 Value of "subscribe" parameter in sympa.conf or robot.conf.
677 The subscribe parameter defines the rules for subscribing to the list.
679 "add"
681 Who can add subscribers
683 Format:
685 Name of "add" scenario:
686 "auth" - restricted to owner with authentication
688 "authdkim" - restricted to owner without authentication if DKIM
689 signature is OK.
690 "closed" - add impossible
691 "owner" - add performed by list owner does not need authentication
692 "owner_notify" - add performed by owner does not need
693 authentication (notification)
694 "ownerdkim" - add performed by list owner does not need
695 authentication if DKIM signature OK
696 Default:
697 Value of "add" parameter in sympa.conf or robot.conf.
698 Privilege for adding (ADD command) a subscriber to the list
700 "unsubscribe"
702 Who can unsubscribe
704 Format:
706 Name of "unsubscribe" scenario:
707 "auth" - need authentication
709 "auth_notify" - authentication requested, notification sent to
710 owner
711 "auth_notifydkim" - authentication requested unless DKIM signature
712 is OK, notification sent to owner
713 "authdkim" - need authentication unless DKIM signature is OK
714 "closed" - impossible
715 "open" - open
716 "open_notify" - open with mail confirmation, owner is notified
717 "owner" - owners approval
718 Default:
719 Value of "unsubscribe" parameter in sympa.conf or robot.conf.
720 This parameter specifies the unsubscription method for the list. Use
722 open_notify or auth_notify to allow owner notification of each
723 unsubscribe command.
724 "del"
726 Who can delete subscribers
728 Format:
730 Name of "del" scenario:
731 "auth" - deletion performed only by list owners, need
733 authentication
734 "authdkim" - deletion performed only by list owners, need
735 authentication unless DKIM signature is OK
736 "closed" - remove subscriber impossible
737 "owner" - by owner without authentication
738 "owner_notify" - list owners, authentication not needed
739 (notification)
740 "ownerdkim" - by owner without authentication if DKIM signature OK
741 Default:
742 Value of "del" parameter in sympa.conf or robot.conf.
743 "invite"
745 Who can invite people
747 Format:
749 Name of "invite" scenario:
750 "closed" - closed
752 "owner" - invite perform by list owner do not need authentication
753 "private" - restricted to subscribers
754 "public" - public
755 Default:
756 Value of "invite" parameter in sympa.conf or robot.conf.
757 "remind"
759 Who can start a remind process
761 Format:
763 Name of "remind" scenario:
764 "listmaster" - listmaster only
766 "listmasterdkim" - listmaster only (do not require authentication
767 if DKIM siganture is OK)
768 "owner" - restricted to list owners
769 "ownerdkim" - restricted to list owners (authentication is not
770 required if a DKIM signature is OK)
771 Default:
772 Value of "remind" parameter in sympa.conf or robot.conf.
773 This parameter specifies who is authorized to use the remind command.
775 "review"
777 Who can review subscribers
779 Format:
781 Name of "review" scenario:
782 "closed" - no one can review
784 "intranet" - restricted to subscribers or local domain users
785 "listmaster" - listmaster only
786 "owner" - only owner (and listmaster)
787 "private" - restricted to subscribers
788 "public" - anyone can do it!
789 Default:
790 Value of "review" parameter in sympa.conf or robot.conf.
791 This parameter specifies who can access the list of members. Since
793 subscriber addresses can be abused by spammers, it is strongly
794 recommended that you only authorize owners or subscribers to access the
795 subscriber list.
796 "owner_domain"
798 Required domains for list owners
800 Format:
802 /"$host( +$host)*"/
803 Default:
805 Value of "owner_domain" parameter in sympa.conf or robot.conf.
806 Restrict list ownership to addresses in the specified domains.
808 "owner_domain_min"
810 Minimum owners in required domains
812 Format:
814 /"\d+"/
815 Default:
817 Value of "owner_domain_min" parameter in sympa.conf or robot.conf.
818 Require list ownership by a minimum number of addresses in the
820 specified domains.
821 "shared_doc"
823 Shared documents
825 Single occurrence
827 This paragraph defines read and edit access to the shared document
829 repository.
830 "shared_doc.d_read"
832 Who can view
834 Format:
836 Name of "d_read" scenario:
837 "owner" - restricted to list owners
839 "private" - restricted to subscribers
840 "private-https" - restricted to subscribers authenticated with user
841 cert
842 "public" - public documents
843 Default:
844 Value of "d_read" parameter in sympa.conf or robot.conf.
845 "shared_doc.d_edit"
847 Who can edit
849 Format:
851 Name of "d_edit" scenario:
852 "editor" - moderated for subscribers
854 "owner" - restricted to list owners
855 "private" - restricted to subscribers
856 "private-https" - restricted to subscribers authenticated with user
857 cert
858 "public" - public documents
859 Default:
860 Value of "d_edit" parameter in sympa.conf or robot.conf.
861 "shared_doc.quota"
863 quota
865 Format:
867 Number of Kbytes.
868 Default:
870 Value of "default_shared_quota" parameter in sympa.conf or
871 robot.conf.
872 Archives
874 "process_archive"
875 Store distributed messages into archive
877 Format:
879 "on" - enabled
880 "off" - disabled
881 Default:
882 Value of "process_archive" parameter in sympa.conf or robot.conf.
883 "archive"
885 Archives
887 Single occurrence
889 Privilege for reading mail archives and frequency of archiving.
891 Defines who can access the list's web archive.
893 "archive.period"
895 Deprecated.
897 "archive.access"
899 Deprecated.
901 "archive.web_access"
903 access right
905 Format:
907 Name of "archive_web_access" scenario:
908 "closed" - closed
910 "intranet" - restricted to local domain users
911 "listmaster" - listmaster
912 "owner" - by owner
913 "private" - subscribers only
914 "public" - public
915 Default:
916 Value of "archive_web_access" parameter in sympa.conf or
917 robot.conf.
918 "archive.mail_access"
920 access right by mail commands
922 Format:
924 Name of "archive_mail_access" scenario:
925 "closed" - closed
927 "owner" - by owner
928 "private" - subscribers only
929 "public" - public
930 Default:
931 Value of "archive_mail_access" parameter in sympa.conf or
932 robot.conf.
933 "archive.quota"
935 quota
937 Format:
939 Number of Kbytes.
940 Default:
942 Value of "default_archive_quota" parameter in sympa.conf.
943 "archive.max_month"
945 Maximum number of month archived
947 Format:
949 Number of months.
950 Default:
952 None.
953 "archive_crypted_msg"
955 Archive encrypted mails as cleartext
957 Format:
959 "original" - original messages
960 "decrypted" - decrypted messages
961 Default:
962 "original"
963 "web_archive_spam_protection"
965 email address protection method
967 Format:
969 "cookie" - use HTTP cookie
970 "javascript" - use JavaScript
971 "at" - replace @ characters
972 "gecos" - only show gecos
973 "none" - do nothing
974 Default:
975 Value of "web_archive_spam_protection" parameter in sympa.conf or
976 robot.conf.
977 Idem spam_protection is provided but it can be used only for web
979 archives. Access requires a cookie, and users must submit a small form
980 in order to receive a cookie before browsing the archives. This blocks
981 all robot, even google and co.
982 "web_archive"
984 Deprecated.
986 Bounces
988 "bounce"
989 Bounces management
991 Single occurrence
993 "bounce.warn_rate"
995 warn rate
997 Format:
999 Number of %.
1000 Default:
1002 Value of "bounce_warn_rate" parameter in sympa.conf.
1003 The list owner receives a warning whenever a message is distributed and
1005 the number (percentage) of bounces exceeds this value.
1006 "bounce.halt_rate"
1008 Deprecated.
1010 "bouncers_level1"
1012 Management of bouncers, 1st level
1014 Single occurrence
1016 Level 1 is the lower level of bouncing users
1018 "bouncers_level1.rate"
1020 threshold
1022 Format:
1024 Number of points.
1025 Default:
1027 Value of "default_bounce_level1_rate" parameter in sympa.conf or
1028 robot.conf.
1029 Each bouncing user have a score (from 0 to 100).
1031 This parameter defines a lower limit for each category of bouncing
1033 users.For example, level 1 begins from 45 to level_2_treshold.
1034 "bouncers_level1.action"
1036 action for this population
1038 Format:
1040 "remove_bouncers" - remove bouncing users
1041 "notify_bouncers" - send notify to bouncing users
1042 "none" - do nothing
1043 Default:
1044 "notify_bouncers"
1045 This parameter defines which task is automatically applied on level 1
1047 bouncers.
1048 "bouncers_level1.notification"
1050 notification
1052 Format:
1054 "none" - do nothing
1055 "owner" - owner
1056 "listmaster" - listmaster
1057 Default:
1058 "owner"
1059 When automatic task is executed on level 1 bouncers, a notification
1061 email can be send to listowner or listmaster.
1062 "bouncers_level2"
1064 Management of bouncers, 2nd level
1066 Single occurrence
1068 Level 2 is the highest level of bouncing users
1070 "bouncers_level2.rate"
1072 threshold
1074 Format:
1076 Number of points.
1077 Default:
1079 Value of "default_bounce_level2_rate" parameter in sympa.conf or
1080 robot.conf.
1081 Each bouncing user have a score (from 0 to 100).
1083 This parameter defines the score range defining each category of
1085 bouncing users.For example, level 2 is for users with a score between
1086 80 and 100.
1087 "bouncers_level2.action"
1089 action for this population
1091 Format:
1093 "remove_bouncers" - remove bouncing users
1094 "notify_bouncers" - send notify to bouncing users
1095 "none" - do nothing
1096 Default:
1097 "remove_bouncers"
1098 This parameter defines which task is automatically applied on level 2
1100 bouncers.
1101 "bouncers_level2.notification"
1103 notification
1105 Format:
1107 "none" - do nothing
1108 "owner" - owner
1109 "listmaster" - listmaster
1110 Default:
1111 "owner"
1112 When automatic task is executed on level 2 bouncers, a notification
1114 email can be send to listowner or listmaster.
1115 "verp_rate"
1117 percentage of list members in VERP mode
1119 Format:
1121 "100%" - 100% - always
1122 "50%" - 50%
1123 "33%" - 33%
1124 "25%" - 25%
1125 "20%" - 20%
1126 "10%" - 10%
1127 "5%" - 5%
1128 "2%" - 2%
1129 "0%" - 0% - never
1130 Default:
1131 Value of "verp_rate" parameter in sympa.conf or robot.conf.
1132 "tracking"
1134 Message tracking feature
1136 Single occurrence
1138 "tracking.delivery_status_notification"
1140 tracking message by delivery status notification
1142 Format:
1144 "on" - enabled
1145 "off" - disabled
1146 Default:
1147 Value of "tracking_delivery_status_notification" parameter in
1148 sympa.conf.
1149 "tracking.message_disposition_notification"
1151 tracking message by message disposition notification
1153 Format:
1155 "on" - enabled
1156 "on_demand" - on demand
1157 "off" - disabled
1158 Default:
1159 Value of "tracking_message_disposition_notification" parameter in
1160 sympa.conf.
1161 "tracking.tracking"
1163 who can view message tracking
1165 Format:
1167 Name of "tracking" scenario:
1168 "owner" - only owner (and listmaster)
1170 "private" - restricted to subscribers
1171 Default:
1172 Value of "tracking" parameter in sympa.conf or robot.conf.
1173 "tracking.retention_period"
1175 Tracking datas are removed after this number of days
1177 Format:
1179 Number of days.
1180 Default:
1182 Value of "tracking_default_retention_period" parameter in
1183 sympa.conf.
1184 "welcome_return_path"
1186 Welcome return-path
1188 Format:
1190 "unique" - bounce management
1191 "owner" - owner
1192 Default:
1193 Value of "welcome_return_path" parameter in sympa.conf.
1194 If set to unique, the welcome message is sent using a unique return
1196 path in order to remove the subscriber immediately in the case of a
1197 bounce.
1198 "remind_return_path"
1200 Return-path of the REMIND command
1202 Format:
1204 "unique" - bounce management
1205 "owner" - owner
1206 Default:
1207 Value of "remind_return_path" parameter in sympa.conf.
1208 Same as welcome_return_path, but applied to remind messages.
1210 Data sources setup
1212 "inclusion_notification_feature"
1213 Notify subscribers when they are included from a data source?
1215 Format:
1217 "on" - enabled
1218 "off" - disabled
1219 Default:
1220 "off"
1221 "member_include"
1223 Subscribers defined in an external data source
1225 Multiple occurrences allowed
1227 "member_include.source"
1229 the data source
1231 Format:
1233 /"[\w-]+"/
1234 Default:
1236 None, mandatory.
1237 "member_include.source_parameters"
1239 data source parameters
1241 Format:
1243 /".*"/
1244 Default:
1246 None.
1247 "owner_include"
1249 Owners defined in an external data source
1251 Multiple occurrences allowed
1253 "owner_include.source"
1255 the data source
1257 Format:
1259 /"[\w-]+"/
1260 Default:
1262 None, mandatory.
1263 "owner_include.source_parameters"
1265 data source parameters
1267 Format:
1269 /".*"/
1270 Default:
1272 None.
1273 "owner_include.profile"
1275 profile
1277 Format:
1279 "privileged" - privileged owner
1280 "normal" - normal owner
1281 Default:
1282 "normal"
1283 "owner_include.reception"
1285 reception mode
1287 Format:
1289 "mail" - receive notification email
1290 "nomail" - no notifications
1291 Default:
1292 "mail"
1293 "owner_include.visibility"
1295 visibility
1297 Format:
1299 "conceal" - concealed from list menu
1300 "noconceal" - listed on the list menu
1301 Default:
1302 "noconceal"
1303 "editor_include"
1305 Moderators defined in an external data source
1307 Multiple occurrences allowed
1309 "editor_include.source"
1311 the data source
1313 Format:
1315 /"[\w-]+"/
1316 Default:
1318 None, mandatory.
1319 "editor_include.source_parameters"
1321 data source parameters
1323 Format:
1325 /".*"/
1326 Default:
1328 None.
1329 "editor_include.reception"
1331 reception mode
1333 Format:
1335 "mail" - receive notification email
1336 "nomail" - no notifications
1337 Default:
1338 "mail"
1339 "editor_include.visibility"
1341 visibility
1343 Format:
1345 "conceal" - concealed from list menu
1346 "noconceal" - listed on the list menu
1347 Default:
1348 "noconceal"
1349 "sql_fetch_timeout"
1351 Timeout for fetch of include_sql_query
1353 Format:
1355 Number of seconds.
1356 Default:
1358 Value of "default_sql_fetch_timeout" parameter in sympa.conf.
1359 "include_file"
1361 File inclusion
1363 Format:
1365 Multiple occurrences allowed.
1366 /"\S+"/
1368 Default:
1370 None.
1371 Include subscribers from this file. The file should contain one e-mail
1373 address per line (lines beginning with a "#" are ignored).
1374 "include_remote_file"
1376 Remote file inclusion
1378 Multiple occurrences allowed
1380 "include_remote_file.name"
1382 short name for this source
1384 Format:
1386 /".+"/
1387 Default:
1389 None.
1390 "include_remote_file.url"
1392 data location URL
1394 Format:
1396 /".+"/
1397 Default:
1399 None, mandatory.
1400 "include_remote_file.user"
1402 remote user
1404 Format:
1406 /".+"/
1407 Default:
1409 None.
1410 "include_remote_file.passwd"
1412 remote password
1414 Format:
1416 The value to be concealed.
1417 Default:
1419 None.
1420 "include_remote_file.timeout"
1422 idle timeout
1424 Format:
1426 Number of seconds.
1427 Default:
1429 180
1430 "include_remote_file.ssl_version"
1432 SSL version
1434 Format:
1436 "ssl_any" - any versions
1437 "sslv2" - SSL version 2
1438 "sslv3" - SSL version 3
1439 "tlsv1" - TLS version 1
1440 "tlsv1_1" - TLS version 1.1
1441 "tlsv1_2" - TLS version 1.2
1442 "tlsv1_3" - TLS version 1.3
1443 Default:
1444 "ssl_any"
1445 "include_remote_file.ssl_ciphers"
1447 SSL ciphers used
1449 Format:
1451 /".+"/
1452 Default:
1454 "ALL"
1455 "include_remote_file.ca_verify"
1457 Certificate verification
1459 Format:
1461 "none" - do nothing
1462 "optional" - optional
1463 "required" - required
1464 Default:
1465 "none"
1466 "include_remote_file.nosync_time_ranges"
1468 Time ranges when inclusion is not allowed
1470 Format:
1472 /$time_ranges/
1473 Default:
1475 None.
1476 "include_sympa_list"
1478 List inclusion
1480 Multiple occurrences allowed
1482 Include subscribers from other list. All subscribers of list listname
1484 become subscribers of the current list. You may include as many lists
1485 as required, using one include_sympa_list paragraph for each included
1486 list. Any list at all may be included; you may therefore include lists
1487 which are also defined by the inclusion of other lists. Be careful,
1488 however, not to include list A in list B and then list B in list A,
1489 since this will give rise to an infinite loop.
1490 "include_sympa_list.name"
1492 short name for this source
1494 Format:
1496 /".+"/
1497 Default:
1499 None.
1500 "include_sympa_list.listname"
1502 list name to include
1504 Format:
1506 /"$listname(\@$host)?"/
1507 Default:
1509 None, mandatory.
1510 "include_sympa_list.filter"
1512 filter definition
1514 Format:
1516 /".*"/
1517 Default:
1519 None.
1520 "include_sympa_list.nosync_time_ranges"
1522 Time ranges when inclusion is not allowed
1524 Format:
1526 /$time_ranges/
1527 Default:
1529 None.
1530 "include_remote_sympa_list"
1532 remote list inclusion
1534 Multiple occurrences allowed
1536 Sympa can contact another Sympa service using HTTPS to fetch a remote
1538 list in order to include each member of a remote list as subscriber.
1539 You may include as many lists as required, using one
1540 include_remote_sympa_list paragraph for each included list. Be careful,
1541 however, not to give rise to an infinite loop resulting from cross
1542 includes.
1543 For this operation, one Sympa site acts as a server while the other one
1545 acs as client. On the server side, the only setting needed is to give
1546 permission to the remote Sympa to review the list. This is controlled
1547 by the review scenario.
1548 "include_remote_sympa_list.name"
1550 short name for this source
1552 Format:
1554 /".+"/
1555 Default:
1557 None.
1558 "include_remote_sympa_list.url"
1560 data location URL
1562 Format:
1564 /".+"/
1565 Default:
1567 None.
1568 "include_remote_sympa_list.user"
1570 remote user
1572 Format:
1574 /".+"/
1575 Default:
1577 None.
1578 "include_remote_sympa_list.passwd"
1580 remote password
1582 Format:
1584 The value to be concealed.
1585 Default:
1587 None.
1588 "include_remote_sympa_list.host"
1590 remote host
1592 Format:
1594 /$host/
1595 Default:
1597 None, mandatory.
1598 obsoleted. Use "data location URL".
1600 "include_remote_sympa_list.port"
1602 remote port
1604 Format:
1606 /"\d+"/
1607 Default:
1609 443
1610 obsoleted. Use "data location URL".
1612 "include_remote_sympa_list.path"
1614 remote path of sympa list dump
1616 Format:
1618 /"\S+"/
1619 Default:
1621 None, mandatory.
1622 obsoleted. Use "data location URL".
1624 "include_remote_sympa_list.cert"
1626 Deprecated.
1628 "include_remote_sympa_list.timeout"
1630 idle timeout
1632 Format:
1634 Number of seconds.
1635 Default:
1637 180
1638 "include_remote_sympa_list.ssl_version"
1640 SSL version
1642 Format:
1644 "ssl_any" - any versions
1645 "sslv2" - SSL version 2
1646 "sslv3" - SSL version 3
1647 "tlsv1" - TLS version 1
1648 "tlsv1_1" - TLS version 1.1
1649 "tlsv1_2" - TLS version 1.2
1650 "tlsv1_3" - TLS version 1.3
1651 Default:
1652 "ssl_any"
1653 "include_remote_sympa_list.ssl_ciphers"
1655 SSL ciphers used
1657 Format:
1659 /".+"/
1660 Default:
1662 "ALL"
1663 "include_remote_sympa_list.ca_verify"
1665 Certificate verification
1667 Format:
1669 "none" - do nothing
1670 "optional" - optional
1671 "required" - required
1672 Default:
1673 "optional"
1674 "include_remote_sympa_list.nosync_time_ranges"
1676 Time ranges when inclusion is not allowed
1678 Format:
1680 /$time_ranges/
1681 Default:
1683 None.
1684 "include_ldap_query"
1686 LDAP query inclusion
1688 Multiple occurrences allowed
1690 This paragraph defines parameters for a query returning a list of
1692 subscribers. This feature requires the Net::LDAP (perlldap) PERL
1693 module.
1694 "include_ldap_query.name"
1696 short name for this source
1698 Format:
1700 /".+"/
1701 Default:
1703 None.
1704 "include_ldap_query.host"
1706 remote host
1708 Format:
1710 /$multiple_host_or_url/
1711 Default:
1713 None, mandatory.
1714 "include_ldap_query.port"
1716 Deprecated.
1718 "include_ldap_query.use_tls"
1720 use TLS (formerly SSL)
1722 Format:
1724 "starttls" - use STARTTLS
1725 "ldaps" - use LDAPS (LDAP over TLS)
1726 "none" - do nothing
1727 Default:
1728 "none"
1729 "include_ldap_query.ssl_version"
1731 SSL version
1733 Format:
1735 "sslv2" - SSL version 2
1736 "sslv3" - SSL version 3
1737 "tlsv1" - TLS version 1
1738 "tlsv1_1" - TLS version 1.1
1739 "tlsv1_2" - TLS version 1.2
1740 "tlsv1_3" - TLS version 1.3
1741 Default:
1742 "tlsv1"
1743 "include_ldap_query.ssl_ciphers"
1745 SSL ciphers used
1747 Format:
1749 /".+"/
1750 Default:
1752 "ALL"
1753 "include_ldap_query.ca_verify"
1755 Certificate verification
1757 Format:
1759 "none" - do nothing
1760 "optional" - optional
1761 "required" - required
1762 Default:
1763 "required"
1764 "include_ldap_query.bind_dn"
1766 remote user
1768 Format:
1770 /".+"/
1771 Default:
1773 None.
1774 "include_ldap_query.bind_password"
1776 remote password
1778 Format:
1780 The value to be concealed.
1781 Default:
1783 None.
1784 "include_ldap_query.suffix"
1786 suffix
1788 Format:
1790 /".+"/
1791 Default:
1793 None.
1794 "include_ldap_query.scope"
1796 search scope
1798 Format:
1800 "base" - base
1801 "one" - one level
1802 "sub" - subtree
1803 Default:
1804 "sub"
1805 "include_ldap_query.timeout"
1807 connection timeout
1809 Format:
1811 Number of seconds.
1812 Default:
1814 30
1815 "include_ldap_query.filter"
1817 filter
1819 Format:
1821 /".+"/
1822 Default:
1824 None, mandatory.
1825 "include_ldap_query.attrs"
1827 extracted attribute
1829 Format:
1831 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
1832 Default:
1834 "mail"
1835 "include_ldap_query.select"
1837 selection (if multiple)
1839 Format:
1841 "all" - all
1842 "first" - first entry
1843 "regex" - entries matching regular expression
1844 Default:
1845 "first"
1846 "include_ldap_query.regex"
1848 regular expression
1850 Format:
1852 /".+"/
1853 Default:
1855 ""
1856 "include_ldap_query.nosync_time_ranges"
1858 Time ranges when inclusion is not allowed
1860 Format:
1862 /$time_ranges/
1863 Default:
1865 None.
1866 "include_ldap_query.passwd"
1868 Obsoleted. Use "bind_password".
1870 "include_ldap_query.use_ssl"
1872 Obsoleted. Use "use_tls".
1874 "include_ldap_query.user"
1876 Obsoleted. Use "bind_dn".
1878 "include_ldap_2level_query"
1880 LDAP 2-level query inclusion
1882 Multiple occurrences allowed
1884 This paragraph defines parameters for a two-level query returning a
1886 list of subscribers. Usually the first-level query returns a list of
1887 DNs and the second-level queries convert the DNs into e-mail addresses.
1888 This feature requires the Net::LDAP (perlldap) PERL module.
1889 "include_ldap_2level_query.name"
1891 short name for this source
1893 Format:
1895 /".+"/
1896 Default:
1898 None.
1899 "include_ldap_2level_query.host"
1901 remote host
1903 Format:
1905 /$multiple_host_or_url/
1906 Default:
1908 None, mandatory.
1909 "include_ldap_2level_query.port"
1911 Deprecated.
1913 "include_ldap_2level_query.use_tls"
1915 use TLS (formerly SSL)
1917 Format:
1919 "starttls" - use STARTTLS
1920 "ldaps" - use LDAPS (LDAP over TLS)
1921 "none" - do nothing
1922 Default:
1923 "none"
1924 "include_ldap_2level_query.ssl_version"
1926 SSL version
1928 Format:
1930 "sslv2" - SSL version 2
1931 "sslv3" - SSL version 3
1932 "tlsv1" - TLS version 1
1933 "tlsv1_1" - TLS version 1.1
1934 "tlsv1_2" - TLS version 1.2
1935 "tlsv1_3" - TLS version 1.3
1936 Default:
1937 "tlsv1"
1938 "include_ldap_2level_query.ssl_ciphers"
1940 SSL ciphers used
1942 Format:
1944 /".+"/
1945 Default:
1947 "ALL"
1948 "include_ldap_2level_query.ca_verify"
1950 Certificate verification
1952 Format:
1954 "none" - do nothing
1955 "optional" - optional
1956 "required" - required
1957 Default:
1958 "required"
1959 "include_ldap_2level_query.bind_dn"
1961 remote user
1963 Format:
1965 /".+"/
1966 Default:
1968 None.
1969 "include_ldap_2level_query.bind_password"
1971 remote password
1973 Format:
1975 The value to be concealed.
1976 Default:
1978 None.
1979 "include_ldap_2level_query.suffix1"
1981 first-level suffix
1983 Format:
1985 /".+"/
1986 Default:
1988 None.
1989 "include_ldap_2level_query.scope1"
1991 first-level search scope
1993 Format:
1995 "base" - base
1996 "one" - one level
1997 "sub" - subtree
1998 Default:
1999 "sub"
2000 "include_ldap_2level_query.timeout1"
2002 first-level connection timeout
2004 Format:
2006 Number of seconds.
2007 Default:
2009 30
2010 "include_ldap_2level_query.filter1"
2012 first-level filter
2014 Format:
2016 /".+"/
2017 Default:
2019 None, mandatory.
2020 "include_ldap_2level_query.attrs1"
2022 first-level extracted attribute
2024 Format:
2026 /$ldap_attrdesc/
2027 Default:
2029 None.
2030 "include_ldap_2level_query.select1"
2032 first-level selection
2034 Format:
2036 "all" - all
2037 "first" - first entry
2038 "regex" - entries matching regular expression
2039 Default:
2040 "first"
2041 "include_ldap_2level_query.regex1"
2043 first-level regular expression
2045 Format:
2047 /".+"/
2048 Default:
2050 ""
2051 "include_ldap_2level_query.suffix2"
2053 second-level suffix template
2055 Format:
2057 /".+"/
2058 Default:
2060 None.
2061 "include_ldap_2level_query.scope2"
2063 second-level search scope
2065 Format:
2067 "base" - base
2068 "one" - one level
2069 "sub" - subtree
2070 Default:
2071 "sub"
2072 "include_ldap_2level_query.timeout2"
2074 second-level connection timeout
2076 Format:
2078 Number of seconds.
2079 Default:
2081 30
2082 "include_ldap_2level_query.filter2"
2084 second-level filter template
2086 Format:
2088 /".+"/
2089 Default:
2091 None, mandatory.
2092 "include_ldap_2level_query.attrs2"
2094 second-level extracted attribute
2096 Format:
2098 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
2099 Default:
2101 "mail"
2102 "include_ldap_2level_query.select2"
2104 second-level selection
2106 Format:
2108 "all" - all
2109 "first" - first entry
2110 "regex" - entries matching regular expression
2111 Default:
2112 "first"
2113 "include_ldap_2level_query.regex2"
2115 second-level regular expression
2117 Format:
2119 /".+"/
2120 Default:
2122 ""
2123 "include_ldap_2level_query.nosync_time_ranges"
2125 Time ranges when inclusion is not allowed
2127 Format:
2129 /$time_ranges/
2130 Default:
2132 None.
2133 "include_ldap_2level_query.passwd"
2135 Obsoleted. Use "bind_password".
2137 "include_ldap_2level_query.use_ssl"
2139 Obsoleted. Use "use_tls".
2141 "include_ldap_2level_query.user"
2143 Obsoleted. Use "bind_dn".
2145 "include_sql_query"
2147 SQL query inclusion
2149 Multiple occurrences allowed
2151 This parameter is used to define the SQL query parameters.
2153 "include_sql_query.name"
2155 short name for this source
2157 Format:
2159 /".+"/
2160 Default:
2162 None.
2163 "include_sql_query.db_type"
2165 database type
2167 Format:
2169 /"\S+"/
2170 Default:
2172 None, mandatory.
2173 "include_sql_query.db_host"
2175 remote host
2177 Format:
2179 /$host/
2180 Default:
2182 None.
2183 "include_sql_query.db_port"
2185 database port
2187 Format:
2189 /"\d+"/
2190 Default:
2192 None.
2193 "include_sql_query.db_name"
2195 database name
2197 Format:
2199 /"\S+"/
2200 Default:
2202 None, mandatory.
2203 "include_sql_query.db_options"
2205 connection options
2207 Format:
2209 /".+"/
2210 Default:
2212 None.
2213 "include_sql_query.db_env"
2215 environment variables for database connection
2217 Format:
2219 /"\w+\=\S+(;\w+\=\S+)*"/
2220 Default:
2222 None.
2223 "include_sql_query.db_user"
2225 remote user
2227 Format:
2229 /"\S+"/
2230 Default:
2232 None, mandatory.
2233 "include_sql_query.db_passwd"
2235 remote password
2237 Format:
2239 The value to be concealed.
2240 Default:
2242 None.
2243 "include_sql_query.sql_query"
2245 SQL query
2247 Format:
2249 /$sql_query/
2250 Default:
2252 None, mandatory.
2253 "include_sql_query.f_dir"
2255 Directory where the database is stored (used for DBD::CSV only)
2257 Format:
2259 /".+"/
2260 Default:
2262 None.
2263 "include_sql_query.nosync_time_ranges"
2265 Time ranges when inclusion is not allowed
2267 Format:
2269 /$time_ranges/
2270 Default:
2272 None.
2273 "include_sql_query.connect_options"
2275 Obsoleted. Use "db_options".
2277 "include_sql_query.host"
2279 Obsoleted. Use "db_host".
2281 "include_sql_query.passwd"
2283 Obsoleted. Use "db_passwd".
2285 "include_sql_query.user"
2287 Obsoleted. Use "db_user".
2289 "ttl"
2291 Inclusions timeout
2293 Format:
2295 Number of seconds.
2296 Default:
2298 Value of "default_ttl" parameter in sympa.conf.
2299 Sympa caches user data extracted using the include parameter. Their TTL
2301 (time-to-live) within Sympa can be controlled using this parameter. The
2302 default value is 3600
2303 "distribution_ttl"
2305 Inclusions timeout for message distribution
2307 Format:
2309 Number of seconds.
2310 Default:
2312 None.
2313 This parameter defines the delay since the last synchronization after
2315 which the user's list will be updated before performing either of
2316 following actions:
2317 * Reviewing list members
2319 * Message distribution
2321 "include_ldap_ca"
2323 LDAP query custom attribute
2325 Multiple occurrences allowed
2327 "include_ldap_ca.name"
2329 short name for this source
2331 Format:
2333 /".+"/
2334 Default:
2336 None.
2337 "include_ldap_ca.host"
2339 remote host
2341 Format:
2343 /$multiple_host_or_url/
2344 Default:
2346 None, mandatory.
2347 "include_ldap_ca.port"
2349 Deprecated.
2351 "include_ldap_ca.use_tls"
2353 use TLS (formerly SSL)
2355 Format:
2357 "starttls" - use STARTTLS
2358 "ldaps" - use LDAPS (LDAP over TLS)
2359 "none" - do nothing
2360 Default:
2361 "none"
2362 "include_ldap_ca.ssl_version"
2364 SSL version
2366 Format:
2368 "sslv2" - SSL version 2
2369 "sslv3" - SSL version 3
2370 "tlsv1" - TLS version 1
2371 "tlsv1_1" - TLS version 1.1
2372 "tlsv1_2" - TLS version 1.2
2373 "tlsv1_3" - TLS version 1.3
2374 Default:
2375 "tlsv1"
2376 "include_ldap_ca.ssl_ciphers"
2378 SSL ciphers used
2380 Format:
2382 /".+"/
2383 Default:
2385 "ALL"
2386 "include_ldap_ca.ca_verify"
2388 Certificate verification
2390 Format:
2392 "none" - do nothing
2393 "optional" - optional
2394 "required" - required
2395 Default:
2396 "required"
2397 "include_ldap_ca.bind_dn"
2399 remote user
2401 Format:
2403 /".+"/
2404 Default:
2406 None.
2407 "include_ldap_ca.bind_password"
2409 remote password
2411 Format:
2413 The value to be concealed.
2414 Default:
2416 None.
2417 "include_ldap_ca.suffix"
2419 suffix
2421 Format:
2423 /".+"/
2424 Default:
2426 None.
2427 "include_ldap_ca.scope"
2429 search scope
2431 Format:
2433 "base" - base
2434 "one" - one level
2435 "sub" - subtree
2436 Default:
2437 "sub"
2438 "include_ldap_ca.timeout"
2440 connection timeout
2442 Format:
2444 Number of seconds.
2445 Default:
2447 30
2448 "include_ldap_ca.filter"
2450 filter
2452 Format:
2454 /".+"/
2455 Default:
2457 None, mandatory.
2458 "include_ldap_ca.attrs"
2460 extracted attribute
2462 Format:
2464 /"$ldap_attrdesc(\s*,\s*$ldap_attrdesc)?"/
2465 Default:
2467 "mail"
2468 "include_ldap_ca.email_entry"
2470 Name of email entry
2472 Format:
2474 /"\S+"/
2475 Default:
2477 None, mandatory.
2478 "include_ldap_ca.select"
2480 selection (if multiple)
2482 Format:
2484 "all" - all
2485 "first" - first entry
2486 "regex" - entries matching regular expression
2487 Default:
2488 "first"
2489 "include_ldap_ca.regex"
2491 regular expression
2493 Format:
2495 /".+"/
2496 Default:
2498 ""
2499 "include_ldap_ca.nosync_time_ranges"
2501 Time ranges when inclusion is not allowed
2503 Format:
2505 /$time_ranges/
2506 Default:
2508 None.
2509 "include_ldap_ca.passwd"
2511 Obsoleted. Use "bind_password".
2513 "include_ldap_ca.use_ssl"
2515 Obsoleted. Use "use_tls".
2517 "include_ldap_ca.user"
2519 Obsoleted. Use "bind_dn".
2521 "include_ldap_2level_ca"
2523 LDAP 2-level query custom attribute
2525 Multiple occurrences allowed
2527 "include_ldap_2level_ca.host"
2529 remote host
2531 Format:
2533 /$multiple_host_or_url/
2534 Default:
2536 None, mandatory.
2537 "include_ldap_2level_ca.name"
2539 short name for this source
2541 Format:
2543 /".+"/
2544 Default:
2546 None.
2547 "include_ldap_2level_ca.port"
2549 Deprecated.
2551 "include_ldap_2level_ca.use_tls"
2553 use TLS (formerly SSL)
2555 Format:
2557 "starttls" - use STARTTLS
2558 "ldaps" - use LDAPS (LDAP over TLS)
2559 "none" - do nothing
2560 Default:
2561 "none"
2562 "include_ldap_2level_ca.ssl_version"
2564 SSL version
2566 Format:
2568 "sslv2" - SSL version 2
2569 "sslv3" - SSL version 3
2570 "tlsv1" - TLS version 1
2571 "tlsv1_1" - TLS version 1.1
2572 "tlsv1_2" - TLS version 1.2
2573 "tlsv1_3" - TLS version 1.3
2574 Default:
2575 "tlsv1"
2576 "include_ldap_2level_ca.ssl_ciphers"
2578 SSL ciphers used
2580 Format:
2582 /".+"/
2583 Default:
2585 "ALL"
2586 "include_ldap_2level_ca.ca_verify"
2588 Certificate verification
2590 Format:
2592 "none" - do nothing
2593 "optional" - optional
2594 "required" - required
2595 Default:
2596 "required"
2597 "include_ldap_2level_ca.bind_dn"
2599 remote user
2601 Format:
2603 /".+"/
2604 Default:
2606 None.
2607 "include_ldap_2level_ca.bind_password"
2609 remote password
2611 Format:
2613 The value to be concealed.
2614 Default:
2616 None.
2617 "include_ldap_2level_ca.suffix1"
2619 first-level suffix
2621 Format:
2623 /".+"/
2624 Default:
2626 None.
2627 "include_ldap_2level_ca.scope1"
2629 first-level search scope
2631 Format:
2633 "base" - base
2634 "one" - one level
2635 "sub" - subtree
2636 Default:
2637 "sub"
2638 "include_ldap_2level_ca.timeout1"
2640 first-level connection timeout
2642 Format:
2644 Number of seconds.
2645 Default:
2647 30
2648 "include_ldap_2level_ca.filter1"
2650 first-level filter
2652 Format:
2654 /".+"/
2655 Default:
2657 None, mandatory.
2658 "include_ldap_2level_ca.attrs1"
2660 first-level extracted attribute
2662 Format:
2664 /$ldap_attrdesc/
2665 Default:
2667 None.
2668 "include_ldap_2level_ca.select1"
2670 first-level selection
2672 Format:
2674 "all" - all
2675 "first" - first entry
2676 "regex" - entries matching regular expression
2677 Default:
2678 "first"
2679 "include_ldap_2level_ca.regex1"
2681 first-level regular expression
2683 Format:
2685 /".+"/
2686 Default:
2688 ""
2689 "include_ldap_2level_ca.suffix2"
2691 second-level suffix template
2693 Format:
2695 /".+"/
2696 Default:
2698 None.
2699 "include_ldap_2level_ca.scope2"
2701 second-level search scope
2703 Format:
2705 "base" - base
2706 "one" - one level
2707 "sub" - subtree
2708 Default:
2709 "sub"
2710 "include_ldap_2level_ca.timeout2"
2712 second-level connection timeout
2714 Format:
2716 Number of seconds.
2717 Default:
2719 30
2720 "include_ldap_2level_ca.filter2"
2722 second-level filter template
2724 Format:
2726 /".+"/
2727 Default:
2729 None, mandatory.
2730 "include_ldap_2level_ca.attrs2"
2732 second-level extracted attribute
2734 Format:
2736 /$ldap_attrdesc/
2737 Default:
2739 "mail"
2740 "include_ldap_2level_ca.select2"
2742 second-level selection
2744 Format:
2746 "all" - all
2747 "first" - first entry
2748 "regex" - entries matching regular expression
2749 Default:
2750 "first"
2751 "include_ldap_2level_ca.regex2"
2753 second-level regular expression
2755 Format:
2757 /".+"/
2758 Default:
2760 ""
2761 "include_ldap_2level_ca.email_entry"
2763 Name of email entry
2765 Format:
2767 /"\S+"/
2768 Default:
2770 None, mandatory.
2771 "include_ldap_2level_ca.nosync_time_ranges"
2773 Time ranges when inclusion is not allowed
2775 Format:
2777 /$time_ranges/
2778 Default:
2780 None.
2781 "include_ldap_2level_ca.passwd"
2783 Obsoleted. Use "bind_password".
2785 "include_ldap_2level_ca.use_ssl"
2787 Obsoleted. Use "use_tls".
2789 "include_ldap_2level_ca.user"
2791 Obsoleted. Use "bind_dn".
2793 "include_sql_ca"
2795 SQL query custom attribute
2797 Multiple occurrences allowed
2799 "include_sql_ca.name"
2801 short name for this source
2803 Format:
2805 /".+"/
2806 Default:
2808 None.
2809 "include_sql_ca.db_type"
2811 database type
2813 Format:
2815 /"\S+"/
2816 Default:
2818 None, mandatory.
2819 "include_sql_ca.db_host"
2821 remote host
2823 Format:
2825 /$host/
2826 Default:
2828 None.
2829 "include_sql_ca.db_port"
2831 database port
2833 Format:
2835 /"\d+"/
2836 Default:
2838 None.
2839 "include_sql_ca.db_name"
2841 database name
2843 Format:
2845 /"\S+"/
2846 Default:
2848 None, mandatory.
2849 "include_sql_ca.db_options"
2851 connection options
2853 Format:
2855 /".+"/
2856 Default:
2858 None.
2859 "include_sql_ca.db_env"
2861 environment variables for database connection
2863 Format:
2865 /"\w+\=\S+(;\w+\=\S+)*"/
2866 Default:
2868 None.
2869 "include_sql_ca.db_user"
2871 remote user
2873 Format:
2875 /"\S+"/
2876 Default:
2878 None, mandatory.
2879 "include_sql_ca.db_passwd"
2881 remote password
2883 Format:
2885 The value to be concealed.
2886 Default:
2888 None.
2889 "include_sql_ca.sql_query"
2891 SQL query
2893 Format:
2895 /$sql_query/
2896 Default:
2898 None, mandatory.
2899 "include_sql_ca.f_dir"
2901 Directory where the database is stored (used for DBD::CSV only)
2903 Format:
2905 /".+"/
2906 Default:
2908 None.
2909 "include_sql_ca.email_entry"
2911 Name of email entry
2913 Format:
2915 /"\S+"/
2916 Default:
2918 None, mandatory.
2919 "include_sql_ca.nosync_time_ranges"
2921 Time ranges when inclusion is not allowed
2923 Format:
2925 /$time_ranges/
2926 Default:
2928 None.
2929 "include_sql_ca.connect_options"
2931 Obsoleted. Use "db_options".
2933 "include_sql_ca.host"
2935 Obsoleted. Use "db_host".
2937 "include_sql_ca.passwd"
2939 Format:
2941 Default:
2942 None.
2943 "include_sql_ca.user"
2945 Obsoleted. Use "db_user".
2947 "include_list"
2949 Deprecated.
2951 "user_data_source"
2953 Deprecated.
2955 DKIM
2957 "dkim_feature"
2958 Insert DKIM signature to messages sent to the list
2960 Format:
2962 "on" - enabled
2963 "off" - disabled
2964 Default:
2965 Value of "dkim_feature" parameter in sympa.conf or robot.conf.
2966 Enable/Disable DKIM. This feature requires Mail::DKIM to be installed,
2968 and maybe some custom scenario to be updated
2969 "dkim_parameters"
2971 DKIM configuration
2973 Single occurrence
2975 A set of parameters in order to define outgoing DKIM signature
2977 "dkim_parameters.private_key_path"
2979 File path for list DKIM private key
2981 Format:
2983 /"\S+"/
2984 Default:
2986 Value of "dkim_private_key_path" parameter in sympa.conf or
2987 robot.conf.
2988 The file must contain a RSA pem encoded private key
2990 "dkim_parameters.selector"
2992 Selector for DNS lookup of DKIM public key
2994 Format:
2996 /"\S+"/
2997 Default:
2999 Value of "dkim_selector" parameter in sympa.conf or robot.conf.
3000 The selector is used in order to build the DNS query for public key. It
3002 is up to you to choose the value you want but verify that you can query
3003 the public DKIM key for <selector>._domainkey.your_domain
3004 "dkim_parameters.header_list"
3006 Deprecated.
3008 "dkim_parameters.signer_domain"
3010 DKIM "d=" tag, you should probably use the default value
3012 Format:
3014 /"\S+"/
3015 Default:
3017 Value of "dkim_signer_domain" parameter in sympa.conf or
3018 robot.conf.
3019 The DKIM "d=" tag, is the domain of the signing entity. The list domain
3021 MUST be included in the "d=" domain
3022 "dkim_parameters.signer_identity"
3024 DKIM "i=" tag, you should probably leave this parameter empty
3026 Format:
3028 /"\S+"/
3029 Default:
3031 None.
3032 DKIM "i=" tag, you should probably not use this parameter, as
3034 recommended by RFC 4871, default for list brodcasted messages is
3035 i=<listname>-request@<domain>
3036 "dkim_signature_apply_on"
3038 The categories of messages sent to the list that will be signed using
3040 DKIM.
3041 Format:
3043 Multiple values allowed, separated by ",".
3044 "md5_authenticated_messages" - authenticated by password
3046 "smime_authenticated_messages" - authenticated by S/MIME signature
3047 "dkim_authenticated_messages" - authenticated by DKIM signature
3048 "editor_validated_messages" - approved by moderator
3049 "none" - do nothing
3050 "any" - any messages
3051 Default:
3052 Value of "dkim_signature_apply_on" parameter in sympa.conf or
3053 robot.conf.
3054 This parameter controls in which case messages must be signed using
3056 DKIM, you may sign every message choosing 'any' or a subset. The
3057 parameter value is a comma separated list of keywords
3058 "arc_feature"
3060 Add ARC seals to messages sent to the list
3062 Format:
3064 "on" - enabled
3065 "off" - disabled
3066 Default:
3067 Value of "arc_feature" parameter in sympa.conf or robot.conf.
3068 Enable/Disable ARC. This feature requires Mail::DKIM::ARC to be
3070 installed, and maybe some custom scenario to be updated
3071 "arc_parameters"
3073 ARC configuration
3075 Single occurrence
3077 A set of parameters in order to define outgoing ARC seal
3079 "arc_parameters.arc_private_key_path"
3081 File path for list ARC private key
3083 Format:
3085 /"\S+"/
3086 Default:
3088 Value of "arc_private_key_path" parameter in sympa.conf or
3089 robot.conf.
3090 The file must contain a RSA pem encoded private key. Default is DKIM
3092 private key.
3093 "arc_parameters.arc_selector"
3095 Selector for DNS lookup of ARC public key
3097 Format:
3099 /"\S+"/
3100 Default:
3102 Value of "arc_selector" parameter in sympa.conf or robot.conf.
3103 The selector is used in order to build the DNS query for public key. It
3105 is up to you to choose the value you want but verify that you can query
3106 the public DKIM key for <selector>._domainkey.your_domain. Default is
3107 selector for DKIM signature
3108 "arc_parameters.arc_signer_domain"
3110 ARC "d=" tag, you should probably use the default value
3112 Format:
3114 /"\S+"/
3115 Default:
3117 Value of "arc_signer_domain" parameter in sympa.conf or robot.conf.
3118 The ARC "d=" tag, is the domain of the sealing entity. The list domain
3120 MUST be included in the "d=" domain
3121 "dmarc_protection"
3123 DMARC Protection
3125 Single occurrence
3127 Parameters to define how to manage From address processing to avoid
3129 some domains' excessive DMARC protection
3130 "dmarc_protection.mode"
3132 Protection modes
3134 Format:
3136 Multiple values allowed, separated by ",".
3137 "none" - do nothing
3139 "all" - all
3140 "dkim_signature" - DKIM signature exists
3141 "dmarc_reject" - DMARC policy suggests rejection
3142 "dmarc_any" - DMARC policy exists
3143 "dmarc_quarantine" - DMARC policy suggests quarantine
3144 "domain_regex" - domain matching regular expression
3145 Default:
3146 Value of "dmarc_protection_mode" parameter in sympa.conf or
3147 robot.conf.
3148 Select one or more operation modes. "Domain matching regular
3150 expression" (domain_regex) matches the specified Domain regular
3151 expression; "DKIM signature exists" (dkim_signature) matches any
3152 message with a DKIM signature header; "DMARC policy ..." (dmarc_*)
3153 matches messages from sender domains with a DMARC policy as given;
3154 "all" (all) matches all messages.
3155 "dmarc_protection.domain_regex"
3157 Match domain regular expression
3159 Format:
3161 /".+"/
3162 Default:
3164 Value of "dmarc_protection_domain_regex" parameter in sympa.conf or
3165 robot.conf.
3166 Regular expression match pattern for From domain
3168 "dmarc_protection.other_email"
3170 New From address
3172 Format:
3174 /".+"/
3175 Default:
3177 Value of "dmarc_protection_other_email" parameter in sympa.conf or
3178 robot.conf.
3179 This is the email address to use when modifying the From header. It
3181 defaults to the list address. This is similar to Anonymisation but
3182 preserves the original sender details in the From address phrase.
3183 "dmarc_protection.phrase"
3185 New From name format
3187 Format:
3189 "display_name" - "Name"
3190 "name_and_email" - "Name" (e-mail)
3191 "name_via_list" - "Name" (via List)
3192 "name_email_via_list" - "Name" (e-mail via List)
3193 "list_for_email" - "List" (on behalf of e-mail)
3194 "list_for_name" - "List" (on behalf of Name)
3195 Default:
3196 Value of "dmarc_protection_phrase" parameter in sympa.conf or
3197 robot.conf.
3198 This is the format to be used for the sender name part of the new From
3200 header.
3201 Miscellaneous
3203 "clean_delay_queuemod"
3204 Expiration of unmoderated messages
3206 Format:
3208 Number of days.
3209 Default:
3211 Value of "clean_delay_queuemod" parameter in sympa.conf.
3212 "cookie"
3214 Secret string for generating unique keys
3216 Format:
3218 The value to be concealed.
3219 Default:
3221 Value of "cookie" parameter in sympa.conf.
3222 This parameter is a confidential item for generating authentication
3224 keys for administrative commands (ADD, DELETE, etc.). This parameter
3225 should remain concealed, even for owners. The cookie is applied to all
3226 list owners, and is only taken into account when the owner has the auth
3227 parameter.
3228 "custom_attribute"
3230 Custom user attributes
3232 Multiple occurrences allowed
3234 "custom_attribute.id"
3236 internal identifier
3238 Format:
3240 /"\w+"/
3241 Default:
3243 None, mandatory.
3244 "custom_attribute.name"
3246 label
3248 Format:
3250 /".+"/
3251 Default:
3253 None, mandatory.
3254 "custom_attribute.comment"
3256 additional comment
3258 Format:
3260 /".+"/
3261 Default:
3263 None.
3264 "custom_attribute.type"
3266 type
3268 Format:
3270 "string" - string
3271 "text" - multi-line text
3272 "integer" - number
3273 "enum" - set of keywords
3274 Default:
3275 "string"
3276 "custom_attribute.enum_values"
3278 possible attribute values (if enum is used)
3280 Format:
3282 /".+"/
3283 Default:
3285 None.
3286 "custom_attribute.optional"
3288 is the attribute optional?
3290 Format:
3292 "required" - required
3293 "optional" - optional
3294 Default:
3295 "optional"
3296 "custom_vars"
3298 custom parameters
3300 Multiple occurrences allowed
3302 "custom_vars.name"
3304 var name
3306 Format:
3308 /"\S+"/
3309 Default:
3311 None, mandatory.
3312 "custom_vars.value"
3314 var value
3316 Format:
3318 /".+"/
3319 Default:
3321 None, mandatory.
3322 "expire_task"
3324 Deprecated.
3326 "loop_prevention_regex"
3328 Regular expression applied to prevent loops with robots
3330 Format:
3332 /"\S*"/
3333 Default:
3335 Value of "loop_prevention_regex" parameter in sympa.conf or
3336 robot.conf.
3337 "pictures_feature"
3339 Allow picture display? (must be enabled for the current robot)
3341 Format:
3343 "on" - enabled
3344 "off" - disabled
3345 Default:
3346 Value of "pictures_feature" parameter in sympa.conf or robot.conf.
3347 "remind_task"
3349 Periodical subscription reminder task
3351 Format:
3353 /"\w+"/
3354 Default:
3356 Value of "default_remind_task" parameter in sympa.conf.
3357 This parameter states which model is used to create a remind task. A
3359 remind task regularly sends subscribers a message which reminds them
3360 of their list subscriptions.
3361 "spam_protection"
3363 email address protection method
3365 Format:
3367 "at" - replace @ characters
3368 "javascript" - use JavaScript
3369 "none" - do nothing
3370 Default:
3371 "javascript"
3372 There is a need to protect Sympa web sites against spambots which
3374 collect email addresses from public web sites. Various methods are
3375 available in Sympa and you can choose to use them with the
3376 spam_protection and web_archive_spam_protection parameters. Possible
3377 value are:
3378 javascript:
3380 the address is hidden using a javascript. A user who enables javascript
3382 can see a nice mailto address where others have nothing.
3383 at:
3385 the @ char is replaced by the string " AT ".
3387 none:
3389 no protection against spammer.
3391 "latest_instantiation"
3393 Latest family instantiation
3395 Single occurrence
3397 "latest_instantiation.email"
3399 who ran the instantiation
3401 Format:
3403 /"listmaster|$email"/
3404 Default:
3406 None.
3407 "latest_instantiation.date_epoch"
3409 date
3411 Format:
3413 The time in second from Unix epoch.
3414 Default:
3416 None, mandatory.
3417 "latest_instantiation.date"
3419 Deprecated.
3421 "creation"
3423 Creation of the list
3425 Single occurrence
3427 "creation.email"
3429 who created the list
3431 Format:
3433 /"listmaster|$email"/
3434 Default:
3436 None, mandatory.
3437 "creation.date_epoch"
3439 date
3441 Format:
3443 The time in second from Unix epoch.
3444 Default:
3446 None, mandatory.
3447 "creation.date"
3449 Deprecated.
3451 "update"
3453 Last update of config
3455 Single occurrence
3457 "update.email"
3459 who updated the config
3461 Format:
3463 /"(listmaster|automatic|$email)"/
3464 Default:
3466 None.
3467 "update.date_epoch"
3469 date
3471 Format:
3473 The time in second from Unix epoch.
3474 Default:
3476 None, mandatory.
3477 "update.date"
3479 Deprecated.
3481 "status"
3483 Status of the list
3485 Format:
3487 Status of list.
3488 Default:
3490 "open"
3491 "serial"
3493 Serial number of the config
3495 Format:
3497 /"\d+"/
3498 Default:
3500 0
3501 "account"
3503 Deprecated.
3505
3507 $EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list
3508 name>/config
3509 List main configuration file.
3510
3512 sympa.conf(5).
3513 Sympa Administration Manual.
3515 <https://sympa-community.github.io/manual/>.
35166.2.48 2019-11-29 LIST_CONFIG(5)