.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LIST_CONFIG 5"
.TH LIST_CONFIG 5 "2020-12-10" "6.2.40" "sympa 6.2.40"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
list_config \- Configuration file for mailing list
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIconfig\fR is main configuration file of the mailing list.
.PP
Format of \fIconfig\fR is as following:
.IP "\(bu" 4
Lines beginning with \f(CW\*(C`#\*(C'\fR and containing only spaces are ignored.
.IP "\(bu" 4
There are parameters with single line and multiple lines:
.RS 4
.IP "\(bu" 4
On single line parameters,
each line has the form "\fIparameter\fR \fIvalue\fR".
\&\fIvalue\fR may contain spaces but may not contain newlines.
.Sp
Several parameters may have multiple values.
If it's the case, values may be separated by comma (\f(CW\*(C`,\*(C'\fR)
or parameter lines may be repeated.
Some of parameters must have one or more of limited values.
.Sp
Example:
.Sp
.Vb 1
\&  subject This is subject of my list
\&  
\&  remove_headers User\-Agent,Importance
\&  
\&  custom_headers X\-List: mylist
\&  custom_headers X\-Face: %\`\-W7!?^]Sg\*(AqI\-K>P<cdn&k:~A^{x>(]Gc{V...
\&  
\&  rfc2369_header_fields post,owner
.Ve
.IP "\(bu" 4
A multiple line parameter, so-called \*(L"paragraph\*(R", consists of
the first line specifying parameter name and subsequent one or more
sub-parameter lines.  Paragraph must be separated by one or more empty lines
from the other parameters.
.Sp
Several multiple line parameters may occur multiple times.
.RE
.RS 4
.RE
.SH "PARAMETERS"
.IX Header "PARAMETERS"
Below is entire list of configuration parameters.
\&\*(L"Default\*(R" is built-in default value if any.
.SS "List definition"
.IX Subsection "List definition"
\fI\f(CI\*(C`subject\*(C'\fI\fR
.IX Subsection "subject"
.PP
Subject of the list
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
This parameter indicates the subject of the list, which is sent in response to the \s-1LISTS\s0 mail command. The subject is a free form text limited to one line.
.PP
\fI\f(CI\*(C`visibility\*(C'\fI\fR
.IX Subsection "visibility"
.PP
Visibility of the list
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`visibility\*(C'\fR scenario:
.RS 4
.ie n .IP """conceal"" \- conceal except for subscribers" 4
.el .IP "\f(CWconceal\fR \- conceal except for subscribers" 4
.IX Item "conceal - conceal except for subscribers"
.PD 0
.ie n .IP """intranet"" \- intranet access" 4
.el .IP "\f(CWintranet\fR \- intranet access" 4
.IX Item "intranet - intranet access"
.ie n .IP """noconceal"" \- no conceal" 4
.el .IP "\f(CWnoconceal\fR \- no conceal" 4
.IX Item "noconceal - no conceal"
.ie n .IP """secret"" \- conceal even for subscribers" 4
.el .IP "\f(CWsecret\fR \- conceal even for subscribers" 4
.IX Item "secret - conceal even for subscribers"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
This parameter indicates whether the list should feature in the output generated in response to a \s-1LISTS\s0 command or should be shown in the list overview of the web-interface.
.PP
\fI\f(CI\*(C`topics\*(C'\fI\fR
.IX Subsection "topics"
.PP
Topics for the list
.IP "Format:" 4
.IX Item "Format:"
Multiple values allowed, separated by \f(CW\*(C`,\*(C'\fR.
.Sp
List topic.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
This parameter allows the classification of lists. You may define multiple topics as well as hierarchical ones. WWSympa's list of public lists uses this parameter.
.PP
\fI\f(CI\*(C`host\*(C'\fI\fR
.IX Subsection "host"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`lang\*(C'\fI\fR
.IX Subsection "lang"
.PP
Language of the list
.IP "Format:" 4
.IX Item "Format:"
Language tag.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`lang\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
This parameter defines the language used for the list. It is used to initialize a user's language preference; Sympa command reports are extracted from the associated message catalog.
.PP
\fI\f(CI\*(C`family_name\*(C'\fI\fR
.IX Subsection "family_name"
.PP
Family name
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$family_name\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`max_list_members\*(C'\fI\fR
.IX Subsection "max_list_members"
.PP
Maximum number of list members
.IP "Format:" 4
.IX Item "Format:"
Number of list members.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_max_list_members\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
limit for the number of subscribers. 0 means no limit.
.PP
\fI\f(CI\*(C`priority\*(C'\fI\fR
.IX Subsection "priority"
.PP
Priority
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP "0 \- 0 \- highest priority" 4
.el .IP "\f(CW0\fR \- 0 \- highest priority" 4
.IX Item "0 - 0 - highest priority"
.ie n .IP "1 \- 1" 4
.el .IP "\f(CW1\fR \- 1" 4
.IX Item "1 - 1"
.ie n .IP "2 \- 2" 4
.el .IP "\f(CW2\fR \- 2" 4
.IX Item "2 - 2"
.ie n .IP "3 \- 3" 4
.el .IP "\f(CW3\fR \- 3" 4
.IX Item "3 - 3"
.ie n .IP "4 \- 4" 4
.el .IP "\f(CW4\fR \- 4" 4
.IX Item "4 - 4"
.ie n .IP "5 \- 5" 4
.el .IP "\f(CW5\fR \- 5" 4
.IX Item "5 - 5"
.ie n .IP "6 \- 6" 4
.el .IP "\f(CW6\fR \- 6" 4
.IX Item "6 - 6"
.ie n .IP "7 \- 7" 4
.el .IP "\f(CW7\fR \- 7" 4
.IX Item "7 - 7"
.ie n .IP "8 \- 8" 4
.el .IP "\f(CW8\fR \- 8" 4
.IX Item "8 - 8"
.ie n .IP "9 \- 9 \- lowest priority" 4
.el .IP "\f(CW9\fR \- 9 \- lowest priority" 4
.IX Item "9 - 9 - lowest priority"
.ie n .IP """z"" \- queue messages only" 4
.el .IP "\f(CWz\fR \- queue messages only" 4
.IX Item "z - queue messages only"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`default_list_priority\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
The priority with which Sympa will process messages for this list. This level of priority is applied while the message is going through the spool. The z priority will freeze the message in the spool.
.SS "Sending/receiving setup"
.IX Subsection "Sending/receiving setup"
\fI\f(CI\*(C`send\*(C'\fI\fR
.IX Subsection "send"
.PP
Who can send messages
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`send\*(C'\fR scenario:
.RS 4
.ie n .IP """closed"" \- closed" 4
.el .IP "\f(CWclosed\fR \- closed" 4
.IX Item "closed - closed"
.PD 0
.ie n .IP """confidential"" \- restricted to subscribers, messages from others are discarded" 4
.el .IP "\f(CWconfidential\fR \- restricted to subscribers, messages from others are discarded" 4
.IX Item "confidential - restricted to subscribers, messages from others are discarded"
.ie n .IP """editordkim"" \- Moderated, no authentication needed if \s-1DKIM\s0 signature from moderator is \s-1OK\s0" 4
.el .IP "\f(CWeditordkim\fR \- Moderated, no authentication needed if \s-1DKIM\s0 signature from moderator is \s-1OK\s0" 4
.IX Item "editordkim - Moderated, no authentication needed if DKIM signature from moderator is OK"
.ie n .IP """editorkey"" \- Moderated" 4
.el .IP "\f(CWeditorkey\fR \- Moderated" 4
.IX Item "editorkey - Moderated"
.ie n .IP """editorkeyonly"" \- Moderated, even for moderators" 4
.el .IP "\f(CWeditorkeyonly\fR \- Moderated, even for moderators" 4
.IX Item "editorkeyonly - Moderated, even for moderators"
.ie n .IP """editorkeyonlyauth"" \- Moderated, need authentication from moderator" 4
.el .IP "\f(CWeditorkeyonlyauth\fR \- Moderated, need authentication from moderator" 4
.IX Item "editorkeyonlyauth - Moderated, need authentication from moderator"
.ie n .IP """intranet"" \- restricted to local domain" 4
.el .IP "\f(CWintranet\fR \- restricted to local domain" 4
.IX Item "intranet - restricted to local domain"
.ie n .IP """intranetorprivate"" \- restricted to local domain and subscribers" 4
.el .IP "\f(CWintranetorprivate\fR \- restricted to local domain and subscribers" 4
.IX Item "intranetorprivate - restricted to local domain and subscribers"
.ie n .IP """newsletter"" \- Newsletter, restricted to moderators" 4
.el .IP "\f(CWnewsletter\fR \- Newsletter, restricted to moderators" 4
.IX Item "newsletter - Newsletter, restricted to moderators"
.ie n .IP """newsletterkeyonly"" \- Newsletter, restricted to moderators after confirmation" 4
.el .IP "\f(CWnewsletterkeyonly\fR \- Newsletter, restricted to moderators after confirmation" 4
.IX Item "newsletterkeyonly - Newsletter, restricted to moderators after confirmation"
.ie n .IP """owner"" \- Restricted to list owners only" 4
.el .IP "\f(CWowner\fR \- Restricted to list owners only" 4
.IX Item "owner - Restricted to list owners only"
.ie n .IP """ownerauth"" \- Restricted to list owners with previous \s-1MD5\s0 authentication" 4
.el .IP "\f(CWownerauth\fR \- Restricted to list owners with previous \s-1MD5\s0 authentication" 4
.IX Item "ownerauth - Restricted to list owners with previous MD5 authentication"
.ie n .IP """private"" \- restricted to subscribers" 4
.el .IP "\f(CWprivate\fR \- restricted to subscribers" 4
.IX Item "private - restricted to subscribers"
.ie n .IP """private_smime"" \- restricted to subscribers and checked smime signature" 4
.el .IP "\f(CWprivate_smime\fR \- restricted to subscribers and checked smime signature" 4
.IX Item "private_smime - restricted to subscribers and checked smime signature"
.ie n .IP """privateandeditorkey"" \- Moderated, restricted to subscribers" 4
.el .IP "\f(CWprivateandeditorkey\fR \- Moderated, restricted to subscribers" 4
.IX Item "privateandeditorkey - Moderated, restricted to subscribers"
.ie n .IP """privateandnomultipartoreditorkey"" \- Moderated, for non subscribers sending multipart messages" 4
.el .IP "\f(CWprivateandnomultipartoreditorkey\fR \- Moderated, for non subscribers sending multipart messages" 4
.IX Item "privateandnomultipartoreditorkey - Moderated, for non subscribers sending multipart messages"
.ie n .IP """privatekey"" \- restricted to subscribers with previous md5 authentication" 4
.el .IP "\f(CWprivatekey\fR \- restricted to subscribers with previous md5 authentication" 4
.IX Item "privatekey - restricted to subscribers with previous md5 authentication"
.ie n .IP """privatekeyandeditorkeyonly"" \- Moderated, for subscribers and even moderators themself" 4
.el .IP "\f(CWprivatekeyandeditorkeyonly\fR \- Moderated, for subscribers and even moderators themself" 4
.IX Item "privatekeyandeditorkeyonly - Moderated, for subscribers and even moderators themself"
.ie n .IP """privateoreditorkey"" \- Private, moderated for non subscribers" 4
.el .IP "\f(CWprivateoreditorkey\fR \- Private, moderated for non subscribers" 4
.IX Item "privateoreditorkey - Private, moderated for non subscribers"
.ie n .IP """privateorpublickey"" \- Private, confirmation for non subscribers" 4
.el .IP "\f(CWprivateorpublickey\fR \- Private, confirmation for non subscribers" 4
.IX Item "privateorpublickey - Private, confirmation for non subscribers"
.ie n .IP """public"" \- public list" 4
.el .IP "\f(CWpublic\fR \- public list" 4
.IX Item "public - public list"
.ie n .IP """public_nobcc"" \- public list, Bcc rejected (anti-spam)" 4
.el .IP "\f(CWpublic_nobcc\fR \- public list, Bcc rejected (anti-spam)" 4
.IX Item "public_nobcc - public list, Bcc rejected (anti-spam)"
.ie n .IP """publickey"" \- anyone no authentication if \s-1DKIM\s0 signature is \s-1OK\s0" 4
.el .IP "\f(CWpublickey\fR \- anyone no authentication if \s-1DKIM\s0 signature is \s-1OK\s0" 4
.IX Item "publickey - anyone no authentication if DKIM signature is OK"
.ie n .IP """publicnoattachment"" \- public list multipart/mixed messages are forwarded to moderator" 4
.el .IP "\f(CWpublicnoattachment\fR \- public list multipart/mixed messages are forwarded to moderator" 4
.IX Item "publicnoattachment - public list multipart/mixed messages are forwarded to moderator"
.ie n .IP """publicnomultipart"" \- public list multipart messages are rejected" 4
.el .IP "\f(CWpublicnomultipart\fR \- public list multipart messages are rejected" 4
.IX Item "publicnomultipart - public list multipart messages are rejected"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
This parameter specifies who can send messages to the list.
.PP
\fI\f(CI\*(C`delivery_time\*(C'\fI\fR
.IX Subsection "delivery_time"
.PP
Delivery time (hh:mm)
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`[0\-2]?\ed\e:[0\-6]\ed\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
If this parameter is present, non-digest messages will be delivered to subscribers at this time: When this time has been past, delivery is postponed to the same time in next day.
.PP
\fI\f(CI\*(C`digest\*(C'\fI\fR
.IX Subsection "digest"
.PP
Digest frequency
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
Definition of digest mode. If this parameter is present, subscribers can select the option of receiving messages in multipart/digest \s-1MIME\s0 format, or as a plain text digest. Messages are then grouped together, and compiled messages are sent to subscribers according to the frequency selected with this parameter.
.PP
\f(CW\*(C`digest.days\*(C'\fR
.IX Subsection "digest.days"
.PP
days
.IP "Format:" 4
.IX Item "Format:"
Multiple occurrences allowed.
.Sp
Day of week, \f(CW0\fR \- \f(CW6\fR.
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`digest.hour\*(C'\fR
.IX Subsection "digest.hour"
.PP
hour
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ed+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`digest.minute\*(C'\fR
.IX Subsection "digest.minute"
.PP
minute
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ed+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\fI\f(CI\*(C`digest_max_size\*(C'\fI\fR
.IX Subsection "digest_max_size"
.PP
Digest maximum number of messages
.IP "Format:" 4
.IX Item "Format:"
Number of messages.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW25\fR
.PP
\fI\f(CI\*(C`available_user_options\*(C'\fI\fR
.IX Subsection "available_user_options"
.PP
Available subscription options
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
\f(CW\*(C`available_user_options.reception\*(C'\fR
.IX Subsection "available_user_options.reception"
.PP
reception mode
.IP "Format:" 4
.IX Item "Format:"
Multiple values allowed, separated by \f(CW\*(C`,\*(C'\fR.
.Sp
Reception mode of list member.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`mail,notice,digest,digestplain,summary,nomail,txt,urlize,not_me\*(C'\fR
.PP
Only these modes will be allowed for the subscribers of this list. If a subscriber has a reception mode not in the list, Sympa uses the mode specified in the default_user_options paragraph.
.PP
\fI\f(CI\*(C`default_user_options\*(C'\fI\fR
.IX Subsection "default_user_options"
.PP
Subscription profile
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
Default profile for the subscribers of the list.
.PP
\f(CW\*(C`default_user_options.reception\*(C'\fR
.IX Subsection "default_user_options.reception"
.PP
reception mode
.IP "Format:" 4
.IX Item "Format:"
Reception mode of list member.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`mail\*(C'\fR
.PP
Mail reception mode.
.PP
\f(CW\*(C`default_user_options.visibility\*(C'\fR
.IX Subsection "default_user_options.visibility"
.PP
visibility
.IP "Format:" 4
.IX Item "Format:"
Visibility mode of list memeber.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`noconceal\*(C'\fR
.PP
Visibility of the subscriber.
.PP
\fI\f(CI\*(C`msg_topic\*(C'\fI\fR
.IX Subsection "msg_topic"
.PP
Topics for message categorization
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
This paragraph defines a topic used to tag a message of a list, named by msg_topic.name (\*(L"other\*(R" is a reserved word), its title is msg_topic.title. The msg_topic.keywords entry is optional and allows automatic tagging. This should be a list of keywords, separated by ','.
.PP
\f(CW\*(C`msg_topic.name\*(C'\fR
.IX Subsection "msg_topic.name"
.PP
Message topic name
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`[\e\-\ew]+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`msg_topic.keywords\*(C'\fR
.IX Subsection "msg_topic.keywords"
.PP
Message topic keywords
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`[^,\en]+(,[^,\en]+)*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`msg_topic.title\*(C'\fR
.IX Subsection "msg_topic.title"
.PP
Message topic title
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\fI\f(CI\*(C`msg_topic_keywords_apply_on\*(C'\fI\fR
.IX Subsection "msg_topic_keywords_apply_on"
.PP
Defines to which part of messages topic keywords are applied
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """subject"" \- subject field" 4
.el .IP "\f(CWsubject\fR \- subject field" 4
.IX Item "subject - subject field"
.ie n .IP """body"" \- message body" 4
.el .IP "\f(CWbody\fR \- message body" 4
.IX Item "body - message body"
.ie n .IP """subject_and_body"" \- subject and body" 4
.el .IP "\f(CWsubject_and_body\fR \- subject and body" 4
.IX Item "subject_and_body - subject and body"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`subject\*(C'\fR
.PP
This parameter indicates which part of the message is used to perform automatic tagging.
.PP
\fI\f(CI\*(C`msg_topic_tagging\*(C'\fI\fR
.IX Subsection "msg_topic_tagging"
.PP
Message tagging
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """required_sender"" \- required to post message" 4
.el .IP "\f(CWrequired_sender\fR \- required to post message" 4
.IX Item "required_sender - required to post message"
.ie n .IP """required_moderator"" \- required to distribute message" 4
.el .IP "\f(CWrequired_moderator\fR \- required to distribute message" 4
.IX Item "required_moderator - required to distribute message"
.ie n .IP """optional"" \- optional" 4
.el .IP "\f(CWoptional\fR \- optional" 4
.IX Item "optional - optional"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`optional\*(C'\fR
.PP
This parameter indicates if the tagging is optional or required for a list.
.PP
\fI\f(CI\*(C`reply_to_header\*(C'\fI\fR
.IX Subsection "reply_to_header"
.PP
Reply address
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
This defines what Sympa will place in the Reply-To: \s-1SMTP\s0 header field of the messages it distributes.
.PP
\f(CW\*(C`reply_to_header.value\*(C'\fR
.IX Subsection "reply_to_header.value"
.PP
value
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """sender"" \- sender" 4
.el .IP "\f(CWsender\fR \- sender" 4
.IX Item "sender - sender"
.ie n .IP """list"" \- list" 4
.el .IP "\f(CWlist\fR \- list" 4
.IX Item "list - list"
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """other_email"" \- other email address" 4
.el .IP "\f(CWother_email\fR \- other email address" 4
.IX Item "other_email - other email address"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`sender\*(C'\fR
.PP
This parameter indicates whether the Reply-To: field should indicate the sender of the message (sender), the list itself (list), both list and sender (all) or an arbitrary e\-mail address (defined by the other_email parameter).
.PP
Note: it is inadvisable to change this parameter, and particularly inadvisable to set it to list. Experience has shown it to be almost inevitable that users, mistakenly believing that they are replying only to the sender, will send private messages to a list. This can lead, at the very least, to embarrassment, and sometimes to more serious consequences.
.PP
\f(CW\*(C`reply_to_header.other_email\*(C'\fR
.IX Subsection "reply_to_header.other_email"
.PP
other email address
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$email\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
If value was set to other_email, this parameter defines the e\-mail address used.
.PP
\f(CW\*(C`reply_to_header.apply\*(C'\fR
.IX Subsection "reply_to_header.apply"
.PP
respect of existing header field
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """forced"" \- overwrite Reply-To: header field" 4
.el .IP "\f(CWforced\fR \- overwrite Reply-To: header field" 4
.IX Item "forced - overwrite Reply-To: header field"
.ie n .IP """respect"" \- preserve existing header field" 4
.el .IP "\f(CWrespect\fR \- preserve existing header field" 4
.IX Item "respect - preserve existing header field"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`respect\*(C'\fR
.PP
The default is to respect (preserve) the existing Reply-To: \s-1SMTP\s0 header field in incoming messages. If set to forced, Reply-To: \s-1SMTP\s0 header field will be overwritten.
.PP
\fI\f(CI\*(C`anonymous_sender\*(C'\fI\fR
.IX Subsection "anonymous_sender"
.PP
Anonymous sender
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
To hide the sender's email address before distributing the message. It is replaced by the provided email address.
.PP
\fI\f(CI\*(C`custom_header\*(C'\fI\fR
.IX Subsection "custom_header"
.PP
Custom header field
.IP "Format:" 4
.IX Item "Format:"
Multiple occurrences allowed.
.Sp
/\f(CW\*(C`\eS+:\es+.*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
This parameter is optional. The headers specified will be added to the headers of messages distributed via the list. As of release 1.2.2 of Sympa, it is possible to put several custom header lines in the configuration file at the same time.
.PP
\fI\f(CI\*(C`custom_subject\*(C'\fI\fR
.IX Subsection "custom_subject"
.PP
Subject tagging
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
This parameter is optional. It specifies a string which is added to the subject of distributed messages (intended to help users who do not use automatic tools to sort incoming messages). This string will be surrounded by [] characters.
.PP
\fI\f(CI\*(C`footer_type\*(C'\fI\fR
.IX Subsection "footer_type"
.PP
Attachment type
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """mime"" \- add a new \s-1MIME\s0 part" 4
.el .IP "\f(CWmime\fR \- add a new \s-1MIME\s0 part" 4
.IX Item "mime - add a new MIME part"
.ie n .IP """append"" \- append to message body" 4
.el .IP "\f(CWappend\fR \- append to message body" 4
.IX Item "append - append to message body"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`mime\*(C'\fR
.PP
List owners may decide to add message headers or footers to messages sent via the list. This parameter defines the way a footer/header is added to a message.
.PP
mime:
.PP
The default value. Sympa will add the footer/header as a new \s-1MIME\s0 part.
.PP
append:
.PP
Sympa will not create new \s-1MIME\s0 parts, but will try to append the header/footer to the body of the message. Predefined message-footers will be ignored. Headers/footers may be appended to text/plain messages only.
.PP
\fI\f(CI\*(C`max_size\*(C'\fI\fR
.IX Subsection "max_size"
.PP
Maximum message size
.IP "Format:" 4
.IX Item "Format:"
Number of bytes.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`max_size\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Maximum size of a message in 8\-bit bytes.
.PP
\fI\f(CI\*(C`merge_feature\*(C'\fI\fR
.IX Subsection "merge_feature"
.PP
Allow message personalization
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`merge_feature\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`message_hook\*(C'\fI\fR
.IX Subsection "message_hook"
.PP
Hook modules for message processing
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
\f(CW\*(C`message_hook.pre_distribute\*(C'\fR
.IX Subsection "message_hook.pre_distribute"
.PP
A hook on the messages before distribution
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`(::|\ew)+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`message_hook.post_archive\*(C'\fR
.IX Subsection "message_hook.post_archive"
.PP
A hook on the messages just after archiving
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`(::|\ew)+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`reject_mail_from_automates_feature\*(C'\fI\fR
.IX Subsection "reject_mail_from_automates_feature"
.PP
Reject mail from automatic processes (crontab, etc)?
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`reject_mail_from_automates_feature\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`remove_headers\*(C'\fI\fR
.IX Subsection "remove_headers"
.PP
Incoming \s-1SMTP\s0 header fields to be removed
.IP "Format:" 4
.IX Item "Format:"
Multiple values allowed, separated by \f(CW\*(C`,\*(C'\fR.
.Sp
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`remove_headers\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`remove_outgoing_headers\*(C'\fI\fR
.IX Subsection "remove_outgoing_headers"
.PP
Outgoing \s-1SMTP\s0 header fields to be removed
.IP "Format:" 4
.IX Item "Format:"
Multiple values allowed, separated by \f(CW\*(C`,\*(C'\fR.
.Sp
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`remove_outgoing_headers\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`rfc2369_header_fields\*(C'\fI\fR
.IX Subsection "rfc2369_header_fields"
.PP
\&\s-1RFC 2369\s0 Header fields
.IP "Format:" 4
.IX Item "Format:"
Multiple values allowed, separated by \f(CW\*(C`,\*(C'\fR.
.RS 4
.ie n .IP """help"" \- help" 4
.el .IP "\f(CWhelp\fR \- help" 4
.IX Item "help - help"
.PD 0
.ie n .IP """subscribe"" \- subscription" 4
.el .IP "\f(CWsubscribe\fR \- subscription" 4
.IX Item "subscribe - subscription"
.ie n .IP """unsubscribe"" \- unsubscription" 4
.el .IP "\f(CWunsubscribe\fR \- unsubscription" 4
.IX Item "unsubscribe - unsubscription"
.ie n .IP """post"" \- posting address" 4
.el .IP "\f(CWpost\fR \- posting address" 4
.IX Item "post - posting address"
.ie n .IP """owner"" \- owner" 4
.el .IP "\f(CWowner\fR \- owner" 4
.IX Item "owner - owner"
.ie n .IP """archive"" \- list archive" 4
.el .IP "\f(CWarchive\fR \- list archive" 4
.IX Item "archive - list archive"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`rfc2369_header_fields\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`forced_reply_to\*(C'\fI\fR
.IX Subsection "forced_reply_to"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`reply_to\*(C'\fI\fR
.IX Subsection "reply_to"
.PP
Deprecated.
.SS "Privileges"
.IX Subsection "Privileges"
\fI\f(CI\*(C`info\*(C'\fI\fR
.IX Subsection "info"
.PP
Who can view list information
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`info\*(C'\fR scenario:
.RS 4
.ie n .IP """conceal"" \- restricted to subscribers \- Silent rejection otherwise." 4
.el .IP "\f(CWconceal\fR \- restricted to subscribers \- Silent rejection otherwise." 4
.IX Item "conceal - restricted to subscribers - Silent rejection otherwise."
.PD 0
.ie n .IP """open"" \- for anyone" 4
.el .IP "\f(CWopen\fR \- for anyone" 4
.IX Item "open - for anyone"
.ie n .IP """private"" \- restricted to subscribers" 4
.el .IP "\f(CWprivate\fR \- restricted to subscribers" 4
.IX Item "private - restricted to subscribers"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
\fI\f(CI\*(C`subscribe\*(C'\fI\fR
.IX Subsection "subscribe"
.PP
Who can subscribe to the list
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`subscribe\*(C'\fR scenario:
.RS 4
.ie n .IP """auth"" \- subscription request confirmed" 4
.el .IP "\f(CWauth\fR \- subscription request confirmed" 4
.IX Item "auth - subscription request confirmed"
.PD 0
.ie n .IP """auth_notify"" \- need authentication (notification is sent to owners)" 4
.el .IP "\f(CWauth_notify\fR \- need authentication (notification is sent to owners)" 4
.IX Item "auth_notify - need authentication (notification is sent to owners)"
.ie n .IP """auth_notifydkim"" \- need authentication unless \s-1DKIM\s0 signature is \s-1OK\s0 (notification is sent to owners)" 4
.el .IP "\f(CWauth_notifydkim\fR \- need authentication unless \s-1DKIM\s0 signature is \s-1OK\s0 (notification is sent to owners)" 4
.IX Item "auth_notifydkim - need authentication unless DKIM signature is OK (notification is sent to owners)"
.ie n .IP """auth_owner"" \- requires authentication then owner approval" 4
.el .IP "\f(CWauth_owner\fR \- requires authentication then owner approval" 4
.IX Item "auth_owner - requires authentication then owner approval"
.ie n .IP """auth_ownerdkim"" \- requires authentication unless \s-1DKIM\s0 signature is \s-1OK,\s0 then owner approval" 4
.el .IP "\f(CWauth_ownerdkim\fR \- requires authentication unless \s-1DKIM\s0 signature is \s-1OK,\s0 then owner approval" 4
.IX Item "auth_ownerdkim - requires authentication unless DKIM signature is OK, then owner approval"
.ie n .IP """authdkim"" \- subscription request confirmed" 4
.el .IP "\f(CWauthdkim\fR \- subscription request confirmed" 4
.IX Item "authdkim - subscription request confirmed"
.ie n .IP """closed"" \- subscription is impossible" 4
.el .IP "\f(CWclosed\fR \- subscription is impossible" 4
.IX Item "closed - subscription is impossible"
.ie n .IP """intranet"" \- restricted to local domain users" 4
.el .IP "\f(CWintranet\fR \- restricted to local domain users" 4
.IX Item "intranet - restricted to local domain users"
.ie n .IP """intranetorowner"" \- local domain users or owner approval" 4
.el .IP "\f(CWintranetorowner\fR \- local domain users or owner approval" 4
.IX Item "intranetorowner - local domain users or owner approval"
.ie n .IP """open"" \- for anyone without authentication" 4
.el .IP "\f(CWopen\fR \- for anyone without authentication" 4
.IX Item "open - for anyone without authentication"
.ie n .IP """open_notify"" \- anyone, notification is sent to list owner" 4
.el .IP "\f(CWopen_notify\fR \- anyone, notification is sent to list owner" 4
.IX Item "open_notify - anyone, notification is sent to list owner"
.ie n .IP """open_quiet"" \- anyone, no welcome message" 4
.el .IP "\f(CWopen_quiet\fR \- anyone, no welcome message" 4
.IX Item "open_quiet - anyone, no welcome message"
.ie n .IP """owner"" \- owners approval" 4
.el .IP "\f(CWowner\fR \- owners approval" 4
.IX Item "owner - owners approval"
.ie n .IP """smime"" \- requires S/MIME signed" 4
.el .IP "\f(CWsmime\fR \- requires S/MIME signed" 4
.IX Item "smime - requires S/MIME signed"
.ie n .IP """smimeorowner"" \- requires S/MIME signed or owner approval" 4
.el .IP "\f(CWsmimeorowner\fR \- requires S/MIME signed or owner approval" 4
.IX Item "smimeorowner - requires S/MIME signed or owner approval"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
The subscribe parameter defines the rules for subscribing to the list.
.PP
\fI\f(CI\*(C`add\*(C'\fI\fR
.IX Subsection "add"
.PP
Who can add subscribers
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`add\*(C'\fR scenario:
.RS 4
.ie n .IP """auth"" \- restricted to owner with authentication" 4
.el .IP "\f(CWauth\fR \- restricted to owner with authentication" 4
.IX Item "auth - restricted to owner with authentication"
.PD 0
.ie n .IP """authdkim"" \- restricted to owner without authentication if \s-1DKIM\s0 signature is \s-1OK.\s0" 4
.el .IP "\f(CWauthdkim\fR \- restricted to owner without authentication if \s-1DKIM\s0 signature is \s-1OK.\s0" 4
.IX Item "authdkim - restricted to owner without authentication if DKIM signature is OK."
.ie n .IP """closed"" \- add impossible" 4
.el .IP "\f(CWclosed\fR \- add impossible" 4
.IX Item "closed - add impossible"
.ie n .IP """owner"" \- add performed by list owner does not need authentication" 4
.el .IP "\f(CWowner\fR \- add performed by list owner does not need authentication" 4
.IX Item "owner - add performed by list owner does not need authentication"
.ie n .IP """owner_notify"" \- add performed by owner does not need authentication (notification)" 4
.el .IP "\f(CWowner_notify\fR \- add performed by owner does not need authentication (notification)" 4
.IX Item "owner_notify - add performed by owner does not need authentication (notification)"
.ie n .IP """ownerdkim"" \- add performed by list owner does not need authentication if \s-1DKIM\s0 signature \s-1OK\s0" 4
.el .IP "\f(CWownerdkim\fR \- add performed by list owner does not need authentication if \s-1DKIM\s0 signature \s-1OK\s0" 4
.IX Item "ownerdkim - add performed by list owner does not need authentication if DKIM signature OK"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
Privilege for adding (\s-1ADD\s0 command) a subscriber to the list
.PP
\fI\f(CI\*(C`unsubscribe\*(C'\fI\fR
.IX Subsection "unsubscribe"
.PP
Who can unsubscribe
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`unsubscribe\*(C'\fR scenario:
.RS 4
.ie n .IP """auth"" \- need authentication" 4
.el .IP "\f(CWauth\fR \- need authentication" 4
.IX Item "auth - need authentication"
.PD 0
.ie n .IP """auth_notify"" \- authentication requested, notification sent to owner" 4
.el .IP "\f(CWauth_notify\fR \- authentication requested, notification sent to owner" 4
.IX Item "auth_notify - authentication requested, notification sent to owner"
.ie n .IP """auth_notifydkim"" \- authentication requested unless \s-1DKIM\s0 signature is \s-1OK,\s0 notification sent to owner" 4
.el .IP "\f(CWauth_notifydkim\fR \- authentication requested unless \s-1DKIM\s0 signature is \s-1OK,\s0 notification sent to owner" 4
.IX Item "auth_notifydkim - authentication requested unless DKIM signature is OK, notification sent to owner"
.ie n .IP """authdkim"" \- need authentication unless \s-1DKIM\s0 signature is \s-1OK\s0" 4
.el .IP "\f(CWauthdkim\fR \- need authentication unless \s-1DKIM\s0 signature is \s-1OK\s0" 4
.IX Item "authdkim - need authentication unless DKIM signature is OK"
.ie n .IP """closed"" \- impossible" 4
.el .IP "\f(CWclosed\fR \- impossible" 4
.IX Item "closed - impossible"
.ie n .IP """open"" \- open" 4
.el .IP "\f(CWopen\fR \- open" 4
.IX Item "open - open"
.ie n .IP """open_notify"" \- open with mail confirmation, owner is notified" 4
.el .IP "\f(CWopen_notify\fR \- open with mail confirmation, owner is notified" 4
.IX Item "open_notify - open with mail confirmation, owner is notified"
.ie n .IP """owner"" \- owners approval" 4
.el .IP "\f(CWowner\fR \- owners approval" 4
.IX Item "owner - owners approval"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
This parameter specifies the unsubscription method for the list. Use open_notify or auth_notify to allow owner notification of each unsubscribe command.
.PP
\fI\f(CI\*(C`del\*(C'\fI\fR
.IX Subsection "del"
.PP
Who can delete subscribers
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`del\*(C'\fR scenario:
.RS 4
.ie n .IP """auth"" \- deletion performed only by list owners, need authentication" 4
.el .IP "\f(CWauth\fR \- deletion performed only by list owners, need authentication" 4
.IX Item "auth - deletion performed only by list owners, need authentication"
.PD 0
.ie n .IP """authdkim"" \- deletion performed only by list owners, need authentication unless \s-1DKIM\s0 signature is \s-1OK\s0" 4
.el .IP "\f(CWauthdkim\fR \- deletion performed only by list owners, need authentication unless \s-1DKIM\s0 signature is \s-1OK\s0" 4
.IX Item "authdkim - deletion performed only by list owners, need authentication unless DKIM signature is OK"
.ie n .IP """closed"" \- remove subscriber impossible" 4
.el .IP "\f(CWclosed\fR \- remove subscriber impossible" 4
.IX Item "closed - remove subscriber impossible"
.ie n .IP """owner"" \- by owner without authentication" 4
.el .IP "\f(CWowner\fR \- by owner without authentication" 4
.IX Item "owner - by owner without authentication"
.ie n .IP """owner_notify"" \- list owners, authentication not needed (notification)" 4
.el .IP "\f(CWowner_notify\fR \- list owners, authentication not needed (notification)" 4
.IX Item "owner_notify - list owners, authentication not needed (notification)"
.ie n .IP """ownerdkim"" \- by owner without authentication if \s-1DKIM\s0 signature \s-1OK\s0" 4
.el .IP "\f(CWownerdkim\fR \- by owner without authentication if \s-1DKIM\s0 signature \s-1OK\s0" 4
.IX Item "ownerdkim - by owner without authentication if DKIM signature OK"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
\fI\f(CI\*(C`invite\*(C'\fI\fR
.IX Subsection "invite"
.PP
Who can invite people
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`invite\*(C'\fR scenario:
.RS 4
.ie n .IP """closed"" \- closed" 4
.el .IP "\f(CWclosed\fR \- closed" 4
.IX Item "closed - closed"
.PD 0
.ie n .IP """owner"" \- invite perform by list owner do not need authentication" 4
.el .IP "\f(CWowner\fR \- invite perform by list owner do not need authentication" 4
.IX Item "owner - invite perform by list owner do not need authentication"
.ie n .IP """private"" \- restricted to subscribers" 4
.el .IP "\f(CWprivate\fR \- restricted to subscribers" 4
.IX Item "private - restricted to subscribers"
.ie n .IP """public"" \- public" 4
.el .IP "\f(CWpublic\fR \- public" 4
.IX Item "public - public"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
\fI\f(CI\*(C`remind\*(C'\fI\fR
.IX Subsection "remind"
.PP
Who can start a remind process
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`remind\*(C'\fR scenario:
.RS 4
.ie n .IP """listmaster"" \- listmaster only" 4
.el .IP "\f(CWlistmaster\fR \- listmaster only" 4
.IX Item "listmaster - listmaster only"
.PD 0
.ie n .IP """listmasterdkim"" \- listmaster only (do not require authentication if \s-1DKIM\s0 siganture is \s-1OK\s0)" 4
.el .IP "\f(CWlistmasterdkim\fR \- listmaster only (do not require authentication if \s-1DKIM\s0 siganture is \s-1OK\s0)" 4
.IX Item "listmasterdkim - listmaster only (do not require authentication if DKIM siganture is OK)"
.ie n .IP """owner"" \- restricted to list owners" 4
.el .IP "\f(CWowner\fR \- restricted to list owners" 4
.IX Item "owner - restricted to list owners"
.ie n .IP """ownerdkim"" \- restricted to list owners (authentication is not required if a \s-1DKIM\s0 signature is \s-1OK\s0)" 4
.el .IP "\f(CWownerdkim\fR \- restricted to list owners (authentication is not required if a \s-1DKIM\s0 signature is \s-1OK\s0)" 4
.IX Item "ownerdkim - restricted to list owners (authentication is not required if a DKIM signature is OK)"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
This parameter specifies who is authorized to use the remind command.
.PP
\fI\f(CI\*(C`review\*(C'\fI\fR
.IX Subsection "review"
.PP
Who can review subscribers
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`review\*(C'\fR scenario:
.RS 4
.ie n .IP """closed"" \- no one can review" 4
.el .IP "\f(CWclosed\fR \- no one can review" 4
.IX Item "closed - no one can review"
.PD 0
.ie n .IP """intranet"" \- restricted to subscribers or local domain users" 4
.el .IP "\f(CWintranet\fR \- restricted to subscribers or local domain users" 4
.IX Item "intranet - restricted to subscribers or local domain users"
.ie n .IP """listmaster"" \- listmaster only" 4
.el .IP "\f(CWlistmaster\fR \- listmaster only" 4
.IX Item "listmaster - listmaster only"
.ie n .IP """owner"" \- only owner (and listmaster)" 4
.el .IP "\f(CWowner\fR \- only owner (and listmaster)" 4
.IX Item "owner - only owner (and listmaster)"
.ie n .IP """private"" \- restricted to subscribers" 4
.el .IP "\f(CWprivate\fR \- restricted to subscribers" 4
.IX Item "private - restricted to subscribers"
.ie n .IP """public"" \- anyone can do it!" 4
.el .IP "\f(CWpublic\fR \- anyone can do it!" 4
.IX Item "public - anyone can do it!"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
This parameter specifies who can access the list of members. Since subscriber addresses can be abused by spammers, it is strongly recommended that you only authorize owners or subscribers to access the subscriber list.
.PP
\fI\f(CI\*(C`owner_domain\*(C'\fI\fR
.IX Subsection "owner_domain"
.PP
Required domains for list owners
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`$host( +$host)*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`owner_domain\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Restrict list ownership to addresses in the specified domains.
.PP
\fI\f(CI\*(C`owner_domain_min\*(C'\fI\fR
.IX Subsection "owner_domain_min"
.PP
Minimum owners in required domains
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ed+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`owner_domain_min\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Require list ownership by a minimum number of addresses in the specified domains.
.PP
\fI\f(CI\*(C`shared_doc\*(C'\fI\fR
.IX Subsection "shared_doc"
.PP
Shared documents
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
This paragraph defines read and edit access to the shared document repository.
.PP
\f(CW\*(C`shared_doc.d_read\*(C'\fR
.IX Subsection "shared_doc.d_read"
.PP
Who can view
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`d_read\*(C'\fR scenario:
.RS 4
.ie n .IP """owner"" \- restricted to list owners" 4
.el .IP "\f(CWowner\fR \- restricted to list owners" 4
.IX Item "owner - restricted to list owners"
.PD 0
.ie n .IP """private"" \- restricted to subscribers" 4
.el .IP "\f(CWprivate\fR \- restricted to subscribers" 4
.IX Item "private - restricted to subscribers"
.ie n .IP """private\-https"" \- restricted to subscribers authenticated with user cert" 4
.el .IP "\f(CWprivate\-https\fR \- restricted to subscribers authenticated with user cert" 4
.IX Item "private-https - restricted to subscribers authenticated with user cert"
.ie n .IP """public"" \- public documents" 4
.el .IP "\f(CWpublic\fR \- public documents" 4
.IX Item "public - public documents"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
\f(CW\*(C`shared_doc.d_edit\*(C'\fR
.IX Subsection "shared_doc.d_edit"
.PP
Who can edit
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`d_edit\*(C'\fR scenario:
.RS 4
.ie n .IP """editor"" \- moderated for subscribers" 4
.el .IP "\f(CWeditor\fR \- moderated for subscribers" 4
.IX Item "editor - moderated for subscribers"
.PD 0
.ie n .IP """owner"" \- restricted to list owners" 4
.el .IP "\f(CWowner\fR \- restricted to list owners" 4
.IX Item "owner - restricted to list owners"
.ie n .IP """private"" \- restricted to subscribers" 4
.el .IP "\f(CWprivate\fR \- restricted to subscribers" 4
.IX Item "private - restricted to subscribers"
.ie n .IP """private\-https"" \- restricted to subscribers authenticated with user cert" 4
.el .IP "\f(CWprivate\-https\fR \- restricted to subscribers authenticated with user cert" 4
.IX Item "private-https - restricted to subscribers authenticated with user cert"
.ie n .IP """public"" \- public documents" 4
.el .IP "\f(CWpublic\fR \- public documents" 4
.IX Item "public - public documents"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
\f(CW\*(C`shared_doc.quota\*(C'\fR
.IX Subsection "shared_doc.quota"
.PP
quota
.IP "Format:" 4
.IX Item "Format:"
Number of Kbytes.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_shared_quota\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.SS "Archives"
.IX Subsection "Archives"
\fI\f(CI\*(C`process_archive\*(C'\fI\fR
.IX Subsection "process_archive"
.PP
Store distributed messages into archive
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`process_archive\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
\fI\f(CI\*(C`archive\*(C'\fI\fR
.IX Subsection "archive"
.PP
Archives
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
Privilege for reading mail archives and frequency of archiving.
.PP
Defines who can access the list's web archive.
.PP
\f(CW\*(C`archive.period\*(C'\fR
.IX Subsection "archive.period"
.PP
Deprecated.
.PP
\f(CW\*(C`archive.access\*(C'\fR
.IX Subsection "archive.access"
.PP
Deprecated.
.PP
\f(CW\*(C`archive.web_access\*(C'\fR
.IX Subsection "archive.web_access"
.PP
access right
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`archive_web_access\*(C'\fR scenario:
.RS 4
.ie n .IP """closed"" \- closed" 4
.el .IP "\f(CWclosed\fR \- closed" 4
.IX Item "closed - closed"
.PD 0
.ie n .IP """intranet"" \- restricted to local domain users" 4
.el .IP "\f(CWintranet\fR \- restricted to local domain users" 4
.IX Item "intranet - restricted to local domain users"
.ie n .IP """listmaster"" \- listmaster" 4
.el .IP "\f(CWlistmaster\fR \- listmaster" 4
.IX Item "listmaster - listmaster"
.ie n .IP """owner"" \- by owner" 4
.el .IP "\f(CWowner\fR \- by owner" 4
.IX Item "owner - by owner"
.ie n .IP """private"" \- subscribers only" 4
.el .IP "\f(CWprivate\fR \- subscribers only" 4
.IX Item "private - subscribers only"
.ie n .IP """public"" \- public" 4
.el .IP "\f(CWpublic\fR \- public" 4
.IX Item "public - public"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
None.
.PP
\f(CW\*(C`archive.mail_access\*(C'\fR
.IX Subsection "archive.mail_access"
.PP
access right by mail commands
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`archive_mail_access\*(C'\fR scenario:
.RS 4
.ie n .IP """closed"" \- closed" 4
.el .IP "\f(CWclosed\fR \- closed" 4
.IX Item "closed - closed"
.PD 0
.ie n .IP """owner"" \- by owner" 4
.el .IP "\f(CWowner\fR \- by owner" 4
.IX Item "owner - by owner"
.ie n .IP """private"" \- subscribers only" 4
.el .IP "\f(CWprivate\fR \- subscribers only" 4
.IX Item "private - subscribers only"
.ie n .IP """public"" \- public" 4
.el .IP "\f(CWpublic\fR \- public" 4
.IX Item "public - public"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
\f(CW\*(C`archive.quota\*(C'\fR
.IX Subsection "archive.quota"
.PP
quota
.IP "Format:" 4
.IX Item "Format:"
Number of Kbytes.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_archive_quota\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\f(CW\*(C`archive.max_month\*(C'\fR
.IX Subsection "archive.max_month"
.PP
Maximum number of month archived
.IP "Format:" 4
.IX Item "Format:"
Number of months.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`archive_crypted_msg\*(C'\fI\fR
.IX Subsection "archive_crypted_msg"
.PP
Archive encrypted mails as cleartext
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """original"" \- original messages" 4
.el .IP "\f(CWoriginal\fR \- original messages" 4
.IX Item "original - original messages"
.ie n .IP """decrypted"" \- decrypted messages" 4
.el .IP "\f(CWdecrypted\fR \- decrypted messages" 4
.IX Item "decrypted - decrypted messages"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`original\*(C'\fR
.PP
\fI\f(CI\*(C`web_archive_spam_protection\*(C'\fI\fR
.IX Subsection "web_archive_spam_protection"
.PP
email address protection method
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """cookie"" \- use \s-1HTTP\s0 cookie" 4
.el .IP "\f(CWcookie\fR \- use \s-1HTTP\s0 cookie" 4
.IX Item "cookie - use HTTP cookie"
.ie n .IP """javascript"" \- use JavaScript" 4
.el .IP "\f(CWjavascript\fR \- use JavaScript" 4
.IX Item "javascript - use JavaScript"
.ie n .IP """at"" \- replace @ characters" 4
.el .IP "\f(CWat\fR \- replace @ characters" 4
.IX Item "at - replace @ characters"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`web_archive_spam_protection\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Idem spam_protection is provided but it can be used only for web archives. Access requires a cookie, and users must submit a small form in order to receive a cookie before browsing the archives. This blocks all robot, even google and co.
.PP
\fI\f(CI\*(C`web_archive\*(C'\fI\fR
.IX Subsection "web_archive"
.PP
Deprecated.
.SS "Bounces"
.IX Subsection "Bounces"
\fI\f(CI\*(C`bounce\*(C'\fI\fR
.IX Subsection "bounce"
.PP
Bounces management
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
\f(CW\*(C`bounce.warn_rate\*(C'\fR
.IX Subsection "bounce.warn_rate"
.PP
warn rate
.IP "Format:" 4
.IX Item "Format:"
Number of %.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`bounce_warn_rate\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
The list owner receives a warning whenever a message is distributed and the number (percentage) of bounces exceeds this value.
.PP
\f(CW\*(C`bounce.halt_rate\*(C'\fR
.IX Subsection "bounce.halt_rate"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`bouncers_level1\*(C'\fI\fR
.IX Subsection "bouncers_level1"
.PP
Management of bouncers, 1st level
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
Level 1 is the lower level of bouncing users
.PP
\f(CW\*(C`bouncers_level1.rate\*(C'\fR
.IX Subsection "bouncers_level1.rate"
.PP
threshold
.IP "Format:" 4
.IX Item "Format:"
Number of points.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_bounce_level1_rate\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Each bouncing user have a score (from 0 to 100).
.PP
This parameter defines a lower limit for each category of bouncing users.For example, level 1 begins from 45 to level_2_treshold.
.PP
\f(CW\*(C`bouncers_level1.action\*(C'\fR
.IX Subsection "bouncers_level1.action"
.PP
action for this population
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """remove_bouncers"" \- remove bouncing users" 4
.el .IP "\f(CWremove_bouncers\fR \- remove bouncing users" 4
.IX Item "remove_bouncers - remove bouncing users"
.ie n .IP """notify_bouncers"" \- send notify to bouncing users" 4
.el .IP "\f(CWnotify_bouncers\fR \- send notify to bouncing users" 4
.IX Item "notify_bouncers - send notify to bouncing users"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`notify_bouncers\*(C'\fR
.PP
This parameter defines which task is automatically applied on level 1 bouncers.
.PP
\f(CW\*(C`bouncers_level1.notification\*(C'\fR
.IX Subsection "bouncers_level1.notification"
.PP
notification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.ie n .IP """owner"" \- owner" 4
.el .IP "\f(CWowner\fR \- owner" 4
.IX Item "owner - owner"
.ie n .IP """listmaster"" \- listmaster" 4
.el .IP "\f(CWlistmaster\fR \- listmaster" 4
.IX Item "listmaster - listmaster"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`owner\*(C'\fR
.PP
When automatic task is executed on level 1 bouncers, a notification email can be send to listowner or listmaster.
.PP
\fI\f(CI\*(C`bouncers_level2\*(C'\fI\fR
.IX Subsection "bouncers_level2"
.PP
Management of bouncers, 2nd level
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
Level 2 is the highest level of bouncing users
.PP
\f(CW\*(C`bouncers_level2.rate\*(C'\fR
.IX Subsection "bouncers_level2.rate"
.PP
threshold
.IP "Format:" 4
.IX Item "Format:"
Number of points.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_bounce_level2_rate\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Each bouncing user have a score (from 0 to 100).
.PP
This parameter defines the score range defining each category of bouncing users.For example, level 2 is for users with a score between 80 and 100.
.PP
\f(CW\*(C`bouncers_level2.action\*(C'\fR
.IX Subsection "bouncers_level2.action"
.PP
action for this population
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """remove_bouncers"" \- remove bouncing users" 4
.el .IP "\f(CWremove_bouncers\fR \- remove bouncing users" 4
.IX Item "remove_bouncers - remove bouncing users"
.ie n .IP """notify_bouncers"" \- send notify to bouncing users" 4
.el .IP "\f(CWnotify_bouncers\fR \- send notify to bouncing users" 4
.IX Item "notify_bouncers - send notify to bouncing users"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`remove_bouncers\*(C'\fR
.PP
This parameter defines which task is automatically applied on level 2 bouncers.
.PP
\f(CW\*(C`bouncers_level2.notification\*(C'\fR
.IX Subsection "bouncers_level2.notification"
.PP
notification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.ie n .IP """owner"" \- owner" 4
.el .IP "\f(CWowner\fR \- owner" 4
.IX Item "owner - owner"
.ie n .IP """listmaster"" \- listmaster" 4
.el .IP "\f(CWlistmaster\fR \- listmaster" 4
.IX Item "listmaster - listmaster"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`owner\*(C'\fR
.PP
When automatic task is executed on level 2 bouncers, a notification email can be send to listowner or listmaster.
.PP
\fI\f(CI\*(C`verp_rate\*(C'\fI\fR
.IX Subsection "verp_rate"
.PP
percentage of list members in \s-1VERP\s0 mode
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """100%"" \- 100% \- always" 4
.el .IP "\f(CW100%\fR \- 100% \- always" 4
.IX Item "100% - 100% - always"
.ie n .IP """50%"" \- 50%" 4
.el .IP "\f(CW50%\fR \- 50%" 4
.IX Item "50% - 50%"
.ie n .IP """33%"" \- 33%" 4
.el .IP "\f(CW33%\fR \- 33%" 4
.IX Item "33% - 33%"
.ie n .IP """25%"" \- 25%" 4
.el .IP "\f(CW25%\fR \- 25%" 4
.IX Item "25% - 25%"
.ie n .IP """20%"" \- 20%" 4
.el .IP "\f(CW20%\fR \- 20%" 4
.IX Item "20% - 20%"
.ie n .IP """10%"" \- 10%" 4
.el .IP "\f(CW10%\fR \- 10%" 4
.IX Item "10% - 10%"
.ie n .IP """5%"" \- 5%" 4
.el .IP "\f(CW5%\fR \- 5%" 4
.IX Item "5% - 5%"
.ie n .IP """2%"" \- 2%" 4
.el .IP "\f(CW2%\fR \- 2%" 4
.IX Item "2% - 2%"
.ie n .IP """0%"" \- 0% \- never" 4
.el .IP "\f(CW0%\fR \- 0% \- never" 4
.IX Item "0% - 0% - never"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`verp_rate\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
\fI\f(CI\*(C`tracking\*(C'\fI\fR
.IX Subsection "tracking"
.PP
Message tracking feature
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
\f(CW\*(C`tracking.delivery_status_notification\*(C'\fR
.IX Subsection "tracking.delivery_status_notification"
.PP
tracking message by delivery status notification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`tracking_delivery_status_notification\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\f(CW\*(C`tracking.message_disposition_notification\*(C'\fR
.IX Subsection "tracking.message_disposition_notification"
.PP
tracking message by message disposition notification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """on_demand"" \- on demand" 4
.el .IP "\f(CWon_demand\fR \- on demand" 4
.IX Item "on_demand - on demand"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`tracking_message_disposition_notification\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\f(CW\*(C`tracking.tracking\*(C'\fR
.IX Subsection "tracking.tracking"
.PP
who can view message tracking
.IP "Format:" 4
.IX Item "Format:"
Name of \f(CW\*(C`tracking\*(C'\fR scenario:
.RS 4
.ie n .IP """owner"" \- only owner (and listmaster)" 4
.el .IP "\f(CWowner\fR \- only owner (and listmaster)" 4
.IX Item "owner - only owner (and listmaster)"
.PD 0
.ie n .IP """private"" \- restricted to subscribers" 4
.el .IP "\f(CWprivate\fR \- restricted to subscribers" 4
.IX Item "private - restricted to subscribers"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`default\*(C'\fR
.PP
\f(CW\*(C`tracking.retention_period\*(C'\fR
.IX Subsection "tracking.retention_period"
.PP
Tracking datas are removed after this number of days
.IP "Format:" 4
.IX Item "Format:"
Number of days.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`tracking_default_retention_period\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`welcome_return_path\*(C'\fI\fR
.IX Subsection "welcome_return_path"
.PP
Welcome return-path
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """unique"" \- bounce management" 4
.el .IP "\f(CWunique\fR \- bounce management" 4
.IX Item "unique - bounce management"
.ie n .IP """owner"" \- owner" 4
.el .IP "\f(CWowner\fR \- owner" 4
.IX Item "owner - owner"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`welcome_return_path\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
If set to unique, the welcome message is sent using a unique return path in order to remove the subscriber immediately in the case of a bounce.
.PP
\fI\f(CI\*(C`remind_return_path\*(C'\fI\fR
.IX Subsection "remind_return_path"
.PP
Return-path of the \s-1REMIND\s0 command
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """unique"" \- bounce management" 4
.el .IP "\f(CWunique\fR \- bounce management" 4
.IX Item "unique - bounce management"
.ie n .IP """owner"" \- owner" 4
.el .IP "\f(CWowner\fR \- owner" 4
.IX Item "owner - owner"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`remind_return_path\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
Same as welcome_return_path, but applied to remind messages.
.SS "Data sources setup"
.IX Subsection "Data sources setup"
\fI\f(CI\*(C`inclusion_notification_feature\*(C'\fI\fR
.IX Subsection "inclusion_notification_feature"
.PP
Notify subscribers when they are included from a data source?
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`off\*(C'\fR
.PP
\fI\f(CI\*(C`member_include\*(C'\fI\fR
.IX Subsection "member_include"
.PP
Subscribers defined in an external data source
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`member_include.source\*(C'\fR
.IX Subsection "member_include.source"
.PP
the data source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`[\ew\-]+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`member_include.source_parameters\*(C'\fR
.IX Subsection "member_include.source_parameters"
.PP
data source parameters
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`owner_include\*(C'\fI\fR
.IX Subsection "owner_include"
.PP
Owners defined in an external data source
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`owner_include.source\*(C'\fR
.IX Subsection "owner_include.source"
.PP
the data source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`[\ew\-]+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`owner_include.source_parameters\*(C'\fR
.IX Subsection "owner_include.source_parameters"
.PP
data source parameters
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`owner_include.profile\*(C'\fR
.IX Subsection "owner_include.profile"
.PP
profile
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """privileged"" \- privileged owner" 4
.el .IP "\f(CWprivileged\fR \- privileged owner" 4
.IX Item "privileged - privileged owner"
.ie n .IP """normal"" \- normal owner" 4
.el .IP "\f(CWnormal\fR \- normal owner" 4
.IX Item "normal - normal owner"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`normal\*(C'\fR
.PP
\f(CW\*(C`owner_include.reception\*(C'\fR
.IX Subsection "owner_include.reception"
.PP
reception mode
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """mail"" \- receive notification email" 4
.el .IP "\f(CWmail\fR \- receive notification email" 4
.IX Item "mail - receive notification email"
.ie n .IP """nomail"" \- no notifications" 4
.el .IP "\f(CWnomail\fR \- no notifications" 4
.IX Item "nomail - no notifications"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`mail\*(C'\fR
.PP
\f(CW\*(C`owner_include.visibility\*(C'\fR
.IX Subsection "owner_include.visibility"
.PP
visibility
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """conceal"" \- concealed from list menu" 4
.el .IP "\f(CWconceal\fR \- concealed from list menu" 4
.IX Item "conceal - concealed from list menu"
.ie n .IP """noconceal"" \- listed on the list menu" 4
.el .IP "\f(CWnoconceal\fR \- listed on the list menu" 4
.IX Item "noconceal - listed on the list menu"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`noconceal\*(C'\fR
.PP
\fI\f(CI\*(C`editor_include\*(C'\fI\fR
.IX Subsection "editor_include"
.PP
Moderators defined in an external data source
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`editor_include.source\*(C'\fR
.IX Subsection "editor_include.source"
.PP
the data source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`[\ew\-]+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`editor_include.source_parameters\*(C'\fR
.IX Subsection "editor_include.source_parameters"
.PP
data source parameters
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`editor_include.reception\*(C'\fR
.IX Subsection "editor_include.reception"
.PP
reception mode
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """mail"" \- receive notification email" 4
.el .IP "\f(CWmail\fR \- receive notification email" 4
.IX Item "mail - receive notification email"
.ie n .IP """nomail"" \- no notifications" 4
.el .IP "\f(CWnomail\fR \- no notifications" 4
.IX Item "nomail - no notifications"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`mail\*(C'\fR
.PP
\f(CW\*(C`editor_include.visibility\*(C'\fR
.IX Subsection "editor_include.visibility"
.PP
visibility
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """conceal"" \- concealed from list menu" 4
.el .IP "\f(CWconceal\fR \- concealed from list menu" 4
.IX Item "conceal - concealed from list menu"
.ie n .IP """noconceal"" \- listed on the list menu" 4
.el .IP "\f(CWnoconceal\fR \- listed on the list menu" 4
.IX Item "noconceal - listed on the list menu"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`noconceal\*(C'\fR
.PP
\fI\f(CI\*(C`sql_fetch_timeout\*(C'\fI\fR
.IX Subsection "sql_fetch_timeout"
.PP
Timeout for fetch of include_sql_query
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_sql_fetch_timeout\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`include_file\*(C'\fI\fR
.IX Subsection "include_file"
.PP
File inclusion
.IP "Format:" 4
.IX Item "Format:"
Multiple occurrences allowed.
.Sp
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
Include subscribers from this file.  The file should contain one e\-mail address per line (lines beginning with a \*(L"#\*(R" are ignored).
.PP
\fI\f(CI\*(C`include_remote_file\*(C'\fI\fR
.IX Subsection "include_remote_file"
.PP
Remote file inclusion
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`include_remote_file.name\*(C'\fR
.IX Subsection "include_remote_file.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_remote_file.url\*(C'\fR
.IX Subsection "include_remote_file.url"
.PP
data location \s-1URL\s0
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_remote_file.user\*(C'\fR
.IX Subsection "include_remote_file.user"
.PP
remote user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_remote_file.passwd\*(C'\fR
.IX Subsection "include_remote_file.passwd"
.PP
remote password
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`include_sympa_list\*(C'\fI\fR
.IX Subsection "include_sympa_list"
.PP
List inclusion
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
Include subscribers from other list. All subscribers of list listname become subscribers of the current list. You may include as many lists as required, using one include_sympa_list paragraph for each included list. Any list at all may be included; you may therefore include lists which are also defined by the inclusion of other lists. Be careful, however, not to include list A in list B and then list B in list A, since this will give rise to an infinite loop.
.PP
\f(CW\*(C`include_sympa_list.name\*(C'\fR
.IX Subsection "include_sympa_list.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sympa_list.listname\*(C'\fR
.IX Subsection "include_sympa_list.listname"
.PP
list name to include
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`$listname(\e@$host)?\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sympa_list.filter\*(C'\fR
.IX Subsection "include_sympa_list.filter"
.PP
filter definition
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`include_remote_sympa_list\*(C'\fI\fR
.IX Subsection "include_remote_sympa_list"
.PP
remote list inclusion
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
Sympa can contact another Sympa service using \s-1HTTPS\s0 to fetch a remote list in order to include each member of a remote list as subscriber. You may include as many lists as required, using one include_remote_sympa_list paragraph for each included list. Be careful, however, not to give rise to an infinite loop resulting from cross includes.
.PP
For this operation, one Sympa site acts as a server while the other one acs as client. On the server side, the only setting needed is to give permission to the remote Sympa to review the list. This is controlled by the review scenario.
.PP
\f(CW\*(C`include_remote_sympa_list.name\*(C'\fR
.IX Subsection "include_remote_sympa_list.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_remote_sympa_list.host\*(C'\fR
.IX Subsection "include_remote_sympa_list.host"
.PP
remote host
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$host\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_remote_sympa_list.port\*(C'\fR
.IX Subsection "include_remote_sympa_list.port"
.PP
remote port
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ed+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW443\fR
.PP
\f(CW\*(C`include_remote_sympa_list.path\*(C'\fR
.IX Subsection "include_remote_sympa_list.path"
.PP
remote path of sympa list dump
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_remote_sympa_list.cert\*(C'\fR
.IX Subsection "include_remote_sympa_list.cert"
.PP
certificate for authentication by remote Sympa
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """robot"" \- robot" 4
.el .IP "\f(CWrobot\fR \- robot" 4
.IX Item "robot - robot"
.ie n .IP """list"" \- list" 4
.el .IP "\f(CWlist\fR \- list" 4
.IX Item "list - list"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`list\*(C'\fR
.PP
\fI\f(CI\*(C`include_ldap_query\*(C'\fI\fR
.IX Subsection "include_ldap_query"
.PP
\&\s-1LDAP\s0 query inclusion
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
This paragraph defines parameters for a query returning a list of subscribers. This feature requires the Net::LDAP (perlldap) \s-1PERL\s0 module.
.PP
\f(CW\*(C`include_ldap_query.name\*(C'\fR
.IX Subsection "include_ldap_query.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_query.host\*(C'\fR
.IX Subsection "include_ldap_query.host"
.PP
remote host
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$multiple_host_or_url\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_query.port\*(C'\fR
.IX Subsection "include_ldap_query.port"
.PP
Deprecated.
.PP
\f(CW\*(C`include_ldap_query.use_tls\*(C'\fR
.IX Subsection "include_ldap_query.use_tls"
.PP
use \s-1TLS\s0 (formerly \s-1SSL\s0)
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """starttls"" \- use \s-1STARTTLS\s0" 4
.el .IP "\f(CWstarttls\fR \- use \s-1STARTTLS\s0" 4
.IX Item "starttls - use STARTTLS"
.ie n .IP """ldaps"" \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.el .IP "\f(CWldaps\fR \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.IX Item "ldaps - use LDAPS (LDAP over TLS)"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`none\*(C'\fR
.PP
\f(CW\*(C`include_ldap_query.ssl_version\*(C'\fR
.IX Subsection "include_ldap_query.ssl_version"
.PP
\&\s-1SSL\s0 version
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """sslv2"" \- \s-1SSL\s0 version 2" 4
.el .IP "\f(CWsslv2\fR \- \s-1SSL\s0 version 2" 4
.IX Item "sslv2 - SSL version 2"
.ie n .IP """sslv3"" \- \s-1SSL\s0 version 3" 4
.el .IP "\f(CWsslv3\fR \- \s-1SSL\s0 version 3" 4
.IX Item "sslv3 - SSL version 3"
.ie n .IP """tlsv1"" \- \s-1TLS\s0 version 1" 4
.el .IP "\f(CWtlsv1\fR \- \s-1TLS\s0 version 1" 4
.IX Item "tlsv1 - TLS version 1"
.ie n .IP """tlsv1_1"" \- \s-1TLS\s0 version 1.1" 4
.el .IP "\f(CWtlsv1_1\fR \- \s-1TLS\s0 version 1.1" 4
.IX Item "tlsv1_1 - TLS version 1.1"
.ie n .IP """tlsv1_2"" \- \s-1TLS\s0 version 1.2" 4
.el .IP "\f(CWtlsv1_2\fR \- \s-1TLS\s0 version 1.2" 4
.IX Item "tlsv1_2 - TLS version 1.2"
.ie n .IP """tlsv1_3"" \- \s-1TLS\s0 version 1.3" 4
.el .IP "\f(CWtlsv1_3\fR \- \s-1TLS\s0 version 1.3" 4
.IX Item "tlsv1_3 - TLS version 1.3"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`tlsv1\*(C'\fR
.PP
\f(CW\*(C`include_ldap_query.ssl_ciphers\*(C'\fR
.IX Subsection "include_ldap_query.ssl_ciphers"
.PP
\&\s-1SSL\s0 ciphers used
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`ALL\*(C'\fR
.PP
\f(CW\*(C`include_ldap_query.ca_verify\*(C'\fR
.IX Subsection "include_ldap_query.ca_verify"
.PP
Certificate verification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.ie n .IP """optional"" \- optional" 4
.el .IP "\f(CWoptional\fR \- optional" 4
.IX Item "optional - optional"
.ie n .IP """required"" \- required" 4
.el .IP "\f(CWrequired\fR \- required" 4
.IX Item "required - required"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`required\*(C'\fR
.PP
\f(CW\*(C`include_ldap_query.user\*(C'\fR
.IX Subsection "include_ldap_query.user"
.PP
remote user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_query.passwd\*(C'\fR
.IX Subsection "include_ldap_query.passwd"
.PP
remote password
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_query.suffix\*(C'\fR
.IX Subsection "include_ldap_query.suffix"
.PP
suffix
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_query.scope\*(C'\fR
.IX Subsection "include_ldap_query.scope"
.PP
search scope
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """base"" \- base" 4
.el .IP "\f(CWbase\fR \- base" 4
.IX Item "base - base"
.ie n .IP """one"" \- one level" 4
.el .IP "\f(CWone\fR \- one level" 4
.IX Item "one - one level"
.ie n .IP """sub"" \- subtree" 4
.el .IP "\f(CWsub\fR \- subtree" 4
.IX Item "sub - subtree"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`sub\*(C'\fR
.PP
\f(CW\*(C`include_ldap_query.timeout\*(C'\fR
.IX Subsection "include_ldap_query.timeout"
.PP
connection timeout
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW30\fR
.PP
\f(CW\*(C`include_ldap_query.filter\*(C'\fR
.IX Subsection "include_ldap_query.filter"
.PP
filter
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_query.attrs\*(C'\fR
.IX Subsection "include_ldap_query.attrs"
.PP
extracted attribute
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`$ldap_attrdesc(\es*,\es*$ldap_attrdesc)?\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`mail\*(C'\fR
.PP
\f(CW\*(C`include_ldap_query.select\*(C'\fR
.IX Subsection "include_ldap_query.select"
.PP
selection (if multiple)
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """first"" \- first entry" 4
.el .IP "\f(CWfirst\fR \- first entry" 4
.IX Item "first - first entry"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`first\*(C'\fR
.PP
\f(CW\*(C`include_ldap_query.nosync_time_ranges\*(C'\fR
.IX Subsection "include_ldap_query.nosync_time_ranges"
.PP
Time ranges when inclusion is not allowed
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$time_ranges\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_query.use_ssl\*(C'\fR
.IX Subsection "include_ldap_query.use_ssl"
.PP
Obsoleted. Use \f(CW\*(C`use_tls\*(C'\fR.
.PP
\fI\f(CI\*(C`include_ldap_2level_query\*(C'\fI\fR
.IX Subsection "include_ldap_2level_query"
.PP
\&\s-1LDAP\s0 2\-level query inclusion
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
This paragraph defines parameters for a two-level query returning a list of subscribers. Usually the first-level query returns a list of DNs and the second-level queries convert the DNs into e\-mail addresses. This feature requires the Net::LDAP (perlldap) \s-1PERL\s0 module.
.PP
\f(CW\*(C`include_ldap_2level_query.name\*(C'\fR
.IX Subsection "include_ldap_2level_query.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_query.host\*(C'\fR
.IX Subsection "include_ldap_2level_query.host"
.PP
remote host
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$multiple_host_or_url\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_2level_query.port\*(C'\fR
.IX Subsection "include_ldap_2level_query.port"
.PP
Deprecated.
.PP
\f(CW\*(C`include_ldap_2level_query.use_tls\*(C'\fR
.IX Subsection "include_ldap_2level_query.use_tls"
.PP
use \s-1TLS\s0 (formerly \s-1SSL\s0)
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """starttls"" \- use \s-1STARTTLS\s0" 4
.el .IP "\f(CWstarttls\fR \- use \s-1STARTTLS\s0" 4
.IX Item "starttls - use STARTTLS"
.ie n .IP """ldaps"" \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.el .IP "\f(CWldaps\fR \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.IX Item "ldaps - use LDAPS (LDAP over TLS)"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`none\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.ssl_version\*(C'\fR
.IX Subsection "include_ldap_2level_query.ssl_version"
.PP
\&\s-1SSL\s0 version
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """sslv2"" \- \s-1SSL\s0 version 2" 4
.el .IP "\f(CWsslv2\fR \- \s-1SSL\s0 version 2" 4
.IX Item "sslv2 - SSL version 2"
.ie n .IP """sslv3"" \- \s-1SSL\s0 version 3" 4
.el .IP "\f(CWsslv3\fR \- \s-1SSL\s0 version 3" 4
.IX Item "sslv3 - SSL version 3"
.ie n .IP """tlsv1"" \- \s-1TLS\s0 version 1" 4
.el .IP "\f(CWtlsv1\fR \- \s-1TLS\s0 version 1" 4
.IX Item "tlsv1 - TLS version 1"
.ie n .IP """tlsv1_1"" \- \s-1TLS\s0 version 1.1" 4
.el .IP "\f(CWtlsv1_1\fR \- \s-1TLS\s0 version 1.1" 4
.IX Item "tlsv1_1 - TLS version 1.1"
.ie n .IP """tlsv1_2"" \- \s-1TLS\s0 version 1.2" 4
.el .IP "\f(CWtlsv1_2\fR \- \s-1TLS\s0 version 1.2" 4
.IX Item "tlsv1_2 - TLS version 1.2"
.ie n .IP """tlsv1_3"" \- \s-1TLS\s0 version 1.3" 4
.el .IP "\f(CWtlsv1_3\fR \- \s-1TLS\s0 version 1.3" 4
.IX Item "tlsv1_3 - TLS version 1.3"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`tlsv1\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.ssl_ciphers\*(C'\fR
.IX Subsection "include_ldap_2level_query.ssl_ciphers"
.PP
\&\s-1SSL\s0 ciphers used
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`ALL\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.ca_verify\*(C'\fR
.IX Subsection "include_ldap_2level_query.ca_verify"
.PP
Certificate verification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.ie n .IP """optional"" \- optional" 4
.el .IP "\f(CWoptional\fR \- optional" 4
.IX Item "optional - optional"
.ie n .IP """required"" \- required" 4
.el .IP "\f(CWrequired\fR \- required" 4
.IX Item "required - required"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`required\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.user\*(C'\fR
.IX Subsection "include_ldap_2level_query.user"
.PP
remote user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_query.passwd\*(C'\fR
.IX Subsection "include_ldap_2level_query.passwd"
.PP
remote password
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_query.suffix1\*(C'\fR
.IX Subsection "include_ldap_2level_query.suffix1"
.PP
first-level suffix
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_query.scope1\*(C'\fR
.IX Subsection "include_ldap_2level_query.scope1"
.PP
first-level search scope
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """base"" \- base" 4
.el .IP "\f(CWbase\fR \- base" 4
.IX Item "base - base"
.ie n .IP """one"" \- one level" 4
.el .IP "\f(CWone\fR \- one level" 4
.IX Item "one - one level"
.ie n .IP """sub"" \- subtree" 4
.el .IP "\f(CWsub\fR \- subtree" 4
.IX Item "sub - subtree"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`sub\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.timeout1\*(C'\fR
.IX Subsection "include_ldap_2level_query.timeout1"
.PP
first-level connection timeout
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW30\fR
.PP
\f(CW\*(C`include_ldap_2level_query.filter1\*(C'\fR
.IX Subsection "include_ldap_2level_query.filter1"
.PP
first-level filter
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_2level_query.attrs1\*(C'\fR
.IX Subsection "include_ldap_2level_query.attrs1"
.PP
first-level extracted attribute
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$ldap_attrdesc\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_query.select1\*(C'\fR
.IX Subsection "include_ldap_2level_query.select1"
.PP
first-level selection
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """first"" \- first entry" 4
.el .IP "\f(CWfirst\fR \- first entry" 4
.IX Item "first - first entry"
.ie n .IP """regex"" \- entries matching regular expression" 4
.el .IP "\f(CWregex\fR \- entries matching regular expression" 4
.IX Item "regex - entries matching regular expression"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`first\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.regex1\*(C'\fR
.IX Subsection "include_ldap_2level_query.regex1"
.PP
first-level regular expression
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.suffix2\*(C'\fR
.IX Subsection "include_ldap_2level_query.suffix2"
.PP
second-level suffix template
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_query.scope2\*(C'\fR
.IX Subsection "include_ldap_2level_query.scope2"
.PP
second-level search scope
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """base"" \- base" 4
.el .IP "\f(CWbase\fR \- base" 4
.IX Item "base - base"
.ie n .IP """one"" \- one level" 4
.el .IP "\f(CWone\fR \- one level" 4
.IX Item "one - one level"
.ie n .IP """sub"" \- subtree" 4
.el .IP "\f(CWsub\fR \- subtree" 4
.IX Item "sub - subtree"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`sub\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.timeout2\*(C'\fR
.IX Subsection "include_ldap_2level_query.timeout2"
.PP
second-level connection timeout
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW30\fR
.PP
\f(CW\*(C`include_ldap_2level_query.filter2\*(C'\fR
.IX Subsection "include_ldap_2level_query.filter2"
.PP
second-level filter template
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_2level_query.attrs2\*(C'\fR
.IX Subsection "include_ldap_2level_query.attrs2"
.PP
second-level extracted attribute
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`$ldap_attrdesc(\es*,\es*$ldap_attrdesc)?\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`mail\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.select2\*(C'\fR
.IX Subsection "include_ldap_2level_query.select2"
.PP
second-level selection
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """first"" \- first entry" 4
.el .IP "\f(CWfirst\fR \- first entry" 4
.IX Item "first - first entry"
.ie n .IP """regex"" \- entries matching regular expression" 4
.el .IP "\f(CWregex\fR \- entries matching regular expression" 4
.IX Item "regex - entries matching regular expression"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`first\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.regex2\*(C'\fR
.IX Subsection "include_ldap_2level_query.regex2"
.PP
second-level regular expression
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_query.nosync_time_ranges\*(C'\fR
.IX Subsection "include_ldap_2level_query.nosync_time_ranges"
.PP
Time ranges when inclusion is not allowed
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$time_ranges\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_query.use_ssl\*(C'\fR
.IX Subsection "include_ldap_2level_query.use_ssl"
.PP
Obsoleted. Use \f(CW\*(C`use_tls\*(C'\fR.
.PP
\fI\f(CI\*(C`include_sql_query\*(C'\fI\fR
.IX Subsection "include_sql_query"
.PP
\&\s-1SQL\s0 query inclusion
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
This parameter is used to define the \s-1SQL\s0 query parameters.
.PP
\f(CW\*(C`include_sql_query.name\*(C'\fR
.IX Subsection "include_sql_query.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_query.db_type\*(C'\fR
.IX Subsection "include_sql_query.db_type"
.PP
database type
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_query.host\*(C'\fR
.IX Subsection "include_sql_query.host"
.PP
remote host
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$host\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_query.db_port\*(C'\fR
.IX Subsection "include_sql_query.db_port"
.PP
database port
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ed+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_query.connect_options\*(C'\fR
.IX Subsection "include_sql_query.connect_options"
.PP
connection options
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_query.db_name\*(C'\fR
.IX Subsection "include_sql_query.db_name"
.PP
database name
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_query.db_env\*(C'\fR
.IX Subsection "include_sql_query.db_env"
.PP
environment variables for database connection
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ew+\e=\eS+(;\ew+\e=\eS+)*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_query.user\*(C'\fR
.IX Subsection "include_sql_query.user"
.PP
remote user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_query.passwd\*(C'\fR
.IX Subsection "include_sql_query.passwd"
.PP
remote password
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_query.sql_query\*(C'\fR
.IX Subsection "include_sql_query.sql_query"
.PP
\&\s-1SQL\s0 query
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$sql_query\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_query.f_dir\*(C'\fR
.IX Subsection "include_sql_query.f_dir"
.PP
Directory where the database is stored (used for \s-1DBD::CSV\s0 only)
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_query.nosync_time_ranges\*(C'\fR
.IX Subsection "include_sql_query.nosync_time_ranges"
.PP
Time ranges when inclusion is not allowed
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$time_ranges\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`include_voot_group\*(C'\fI\fR
.IX Subsection "include_voot_group"
.PP
\&\s-1VOOT\s0 group inclusion
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`include_voot_group.name\*(C'\fR
.IX Subsection "include_voot_group.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_voot_group.user\*(C'\fR
.IX Subsection "include_voot_group.user"
.PP
user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_voot_group.provider\*(C'\fR
.IX Subsection "include_voot_group.provider"
.PP
provider
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_voot_group.group\*(C'\fR
.IX Subsection "include_voot_group.group"
.PP
group
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\fI\f(CI\*(C`ttl\*(C'\fI\fR
.IX Subsection "ttl"
.PP
Inclusions timeout
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_ttl\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
Sympa caches user data extracted using the include parameter. Their \s-1TTL\s0 (time-to-live) within Sympa can be controlled using this parameter. The default value is 3600
.PP
\fI\f(CI\*(C`distribution_ttl\*(C'\fI\fR
.IX Subsection "distribution_ttl"
.PP
Inclusions timeout for message distribution
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
This parameter defines the delay since the last synchronization after which the user's list will be updated before performing either of following actions:
.PP
* Reviewing list members
.PP
* Message distribution
.PP
\fI\f(CI\*(C`include_ldap_ca\*(C'\fI\fR
.IX Subsection "include_ldap_ca"
.PP
\&\s-1LDAP\s0 query custom attribute
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`include_ldap_ca.name\*(C'\fR
.IX Subsection "include_ldap_ca.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_ca.host\*(C'\fR
.IX Subsection "include_ldap_ca.host"
.PP
remote host
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$multiple_host_or_url\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_ca.port\*(C'\fR
.IX Subsection "include_ldap_ca.port"
.PP
Deprecated.
.PP
\f(CW\*(C`include_ldap_ca.use_tls\*(C'\fR
.IX Subsection "include_ldap_ca.use_tls"
.PP
use \s-1TLS\s0 (formerly \s-1SSL\s0)
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """starttls"" \- use \s-1STARTTLS\s0" 4
.el .IP "\f(CWstarttls\fR \- use \s-1STARTTLS\s0" 4
.IX Item "starttls - use STARTTLS"
.ie n .IP """ldaps"" \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.el .IP "\f(CWldaps\fR \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.IX Item "ldaps - use LDAPS (LDAP over TLS)"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`none\*(C'\fR
.PP
\f(CW\*(C`include_ldap_ca.ssl_version\*(C'\fR
.IX Subsection "include_ldap_ca.ssl_version"
.PP
\&\s-1SSL\s0 version
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """sslv2"" \- \s-1SSL\s0 version 2" 4
.el .IP "\f(CWsslv2\fR \- \s-1SSL\s0 version 2" 4
.IX Item "sslv2 - SSL version 2"
.ie n .IP """sslv3"" \- \s-1SSL\s0 version 3" 4
.el .IP "\f(CWsslv3\fR \- \s-1SSL\s0 version 3" 4
.IX Item "sslv3 - SSL version 3"
.ie n .IP """tlsv1"" \- \s-1TLS\s0 version 1" 4
.el .IP "\f(CWtlsv1\fR \- \s-1TLS\s0 version 1" 4
.IX Item "tlsv1 - TLS version 1"
.ie n .IP """tlsv1_1"" \- \s-1TLS\s0 version 1.1" 4
.el .IP "\f(CWtlsv1_1\fR \- \s-1TLS\s0 version 1.1" 4
.IX Item "tlsv1_1 - TLS version 1.1"
.ie n .IP """tlsv1_2"" \- \s-1TLS\s0 version 1.2" 4
.el .IP "\f(CWtlsv1_2\fR \- \s-1TLS\s0 version 1.2" 4
.IX Item "tlsv1_2 - TLS version 1.2"
.ie n .IP """tlsv1_3"" \- \s-1TLS\s0 version 1.3" 4
.el .IP "\f(CWtlsv1_3\fR \- \s-1TLS\s0 version 1.3" 4
.IX Item "tlsv1_3 - TLS version 1.3"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`tlsv1\*(C'\fR
.PP
\f(CW\*(C`include_ldap_ca.ssl_ciphers\*(C'\fR
.IX Subsection "include_ldap_ca.ssl_ciphers"
.PP
\&\s-1SSL\s0 ciphers used
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`ALL\*(C'\fR
.PP
\f(CW\*(C`include_ldap_ca.ca_verify\*(C'\fR
.IX Subsection "include_ldap_ca.ca_verify"
.PP
Certificate verification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.ie n .IP """optional"" \- optional" 4
.el .IP "\f(CWoptional\fR \- optional" 4
.IX Item "optional - optional"
.ie n .IP """required"" \- required" 4
.el .IP "\f(CWrequired\fR \- required" 4
.IX Item "required - required"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`required\*(C'\fR
.PP
\f(CW\*(C`include_ldap_ca.user\*(C'\fR
.IX Subsection "include_ldap_ca.user"
.PP
remote user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_ca.passwd\*(C'\fR
.IX Subsection "include_ldap_ca.passwd"
.PP
remote password
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_ca.suffix\*(C'\fR
.IX Subsection "include_ldap_ca.suffix"
.PP
suffix
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_ca.scope\*(C'\fR
.IX Subsection "include_ldap_ca.scope"
.PP
search scope
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """base"" \- base" 4
.el .IP "\f(CWbase\fR \- base" 4
.IX Item "base - base"
.ie n .IP """one"" \- one level" 4
.el .IP "\f(CWone\fR \- one level" 4
.IX Item "one - one level"
.ie n .IP """sub"" \- subtree" 4
.el .IP "\f(CWsub\fR \- subtree" 4
.IX Item "sub - subtree"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`sub\*(C'\fR
.PP
\f(CW\*(C`include_ldap_ca.timeout\*(C'\fR
.IX Subsection "include_ldap_ca.timeout"
.PP
connection timeout
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW30\fR
.PP
\f(CW\*(C`include_ldap_ca.filter\*(C'\fR
.IX Subsection "include_ldap_ca.filter"
.PP
filter
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_ca.attrs\*(C'\fR
.IX Subsection "include_ldap_ca.attrs"
.PP
extracted attribute
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`$ldap_attrdesc(\es*,\es*$ldap_attrdesc)?\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`mail\*(C'\fR
.PP
\f(CW\*(C`include_ldap_ca.email_entry\*(C'\fR
.IX Subsection "include_ldap_ca.email_entry"
.PP
Name of email entry
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_ca.select\*(C'\fR
.IX Subsection "include_ldap_ca.select"
.PP
selection (if multiple)
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """first"" \- first entry" 4
.el .IP "\f(CWfirst\fR \- first entry" 4
.IX Item "first - first entry"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`first\*(C'\fR
.PP
\f(CW\*(C`include_ldap_ca.nosync_time_ranges\*(C'\fR
.IX Subsection "include_ldap_ca.nosync_time_ranges"
.PP
Time ranges when inclusion is not allowed
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$time_ranges\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_ca.use_ssl\*(C'\fR
.IX Subsection "include_ldap_ca.use_ssl"
.PP
Obsoleted. Use \f(CW\*(C`use_tls\*(C'\fR.
.PP
\fI\f(CI\*(C`include_ldap_2level_ca\*(C'\fI\fR
.IX Subsection "include_ldap_2level_ca"
.PP
\&\s-1LDAP\s0 2\-level query custom attribute
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`include_ldap_2level_ca.host\*(C'\fR
.IX Subsection "include_ldap_2level_ca.host"
.PP
remote host
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$multiple_host_or_url\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_2level_ca.name\*(C'\fR
.IX Subsection "include_ldap_2level_ca.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_ca.port\*(C'\fR
.IX Subsection "include_ldap_2level_ca.port"
.PP
Deprecated.
.PP
\f(CW\*(C`include_ldap_2level_ca.use_tls\*(C'\fR
.IX Subsection "include_ldap_2level_ca.use_tls"
.PP
use \s-1TLS\s0 (formerly \s-1SSL\s0)
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """starttls"" \- use \s-1STARTTLS\s0" 4
.el .IP "\f(CWstarttls\fR \- use \s-1STARTTLS\s0" 4
.IX Item "starttls - use STARTTLS"
.ie n .IP """ldaps"" \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.el .IP "\f(CWldaps\fR \- use \s-1LDAPS\s0 (\s-1LDAP\s0 over \s-1TLS\s0)" 4
.IX Item "ldaps - use LDAPS (LDAP over TLS)"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`none\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.ssl_version\*(C'\fR
.IX Subsection "include_ldap_2level_ca.ssl_version"
.PP
\&\s-1SSL\s0 version
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """sslv2"" \- \s-1SSL\s0 version 2" 4
.el .IP "\f(CWsslv2\fR \- \s-1SSL\s0 version 2" 4
.IX Item "sslv2 - SSL version 2"
.ie n .IP """sslv3"" \- \s-1SSL\s0 version 3" 4
.el .IP "\f(CWsslv3\fR \- \s-1SSL\s0 version 3" 4
.IX Item "sslv3 - SSL version 3"
.ie n .IP """tlsv1"" \- \s-1TLS\s0 version 1" 4
.el .IP "\f(CWtlsv1\fR \- \s-1TLS\s0 version 1" 4
.IX Item "tlsv1 - TLS version 1"
.ie n .IP """tlsv1_1"" \- \s-1TLS\s0 version 1.1" 4
.el .IP "\f(CWtlsv1_1\fR \- \s-1TLS\s0 version 1.1" 4
.IX Item "tlsv1_1 - TLS version 1.1"
.ie n .IP """tlsv1_2"" \- \s-1TLS\s0 version 1.2" 4
.el .IP "\f(CWtlsv1_2\fR \- \s-1TLS\s0 version 1.2" 4
.IX Item "tlsv1_2 - TLS version 1.2"
.ie n .IP """tlsv1_3"" \- \s-1TLS\s0 version 1.3" 4
.el .IP "\f(CWtlsv1_3\fR \- \s-1TLS\s0 version 1.3" 4
.IX Item "tlsv1_3 - TLS version 1.3"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`tlsv1\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.ssl_ciphers\*(C'\fR
.IX Subsection "include_ldap_2level_ca.ssl_ciphers"
.PP
\&\s-1SSL\s0 ciphers used
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`ALL\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.ca_verify\*(C'\fR
.IX Subsection "include_ldap_2level_ca.ca_verify"
.PP
Certificate verification
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.ie n .IP """optional"" \- optional" 4
.el .IP "\f(CWoptional\fR \- optional" 4
.IX Item "optional - optional"
.ie n .IP """required"" \- required" 4
.el .IP "\f(CWrequired\fR \- required" 4
.IX Item "required - required"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`required\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.user\*(C'\fR
.IX Subsection "include_ldap_2level_ca.user"
.PP
remote user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_ca.passwd\*(C'\fR
.IX Subsection "include_ldap_2level_ca.passwd"
.PP
remote password
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_ca.suffix1\*(C'\fR
.IX Subsection "include_ldap_2level_ca.suffix1"
.PP
first-level suffix
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_ca.scope1\*(C'\fR
.IX Subsection "include_ldap_2level_ca.scope1"
.PP
first-level search scope
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """base"" \- base" 4
.el .IP "\f(CWbase\fR \- base" 4
.IX Item "base - base"
.ie n .IP """one"" \- one level" 4
.el .IP "\f(CWone\fR \- one level" 4
.IX Item "one - one level"
.ie n .IP """sub"" \- subtree" 4
.el .IP "\f(CWsub\fR \- subtree" 4
.IX Item "sub - subtree"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`sub\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.timeout1\*(C'\fR
.IX Subsection "include_ldap_2level_ca.timeout1"
.PP
first-level connection timeout
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW30\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.filter1\*(C'\fR
.IX Subsection "include_ldap_2level_ca.filter1"
.PP
first-level filter
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_2level_ca.attrs1\*(C'\fR
.IX Subsection "include_ldap_2level_ca.attrs1"
.PP
first-level extracted attribute
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$ldap_attrdesc\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_ca.select1\*(C'\fR
.IX Subsection "include_ldap_2level_ca.select1"
.PP
first-level selection
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """first"" \- first entry" 4
.el .IP "\f(CWfirst\fR \- first entry" 4
.IX Item "first - first entry"
.ie n .IP """regex"" \- entries matching regular expression" 4
.el .IP "\f(CWregex\fR \- entries matching regular expression" 4
.IX Item "regex - entries matching regular expression"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`first\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.regex1\*(C'\fR
.IX Subsection "include_ldap_2level_ca.regex1"
.PP
first-level regular expression
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.suffix2\*(C'\fR
.IX Subsection "include_ldap_2level_ca.suffix2"
.PP
second-level suffix template
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_ca.scope2\*(C'\fR
.IX Subsection "include_ldap_2level_ca.scope2"
.PP
second-level search scope
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """base"" \- base" 4
.el .IP "\f(CWbase\fR \- base" 4
.IX Item "base - base"
.ie n .IP """one"" \- one level" 4
.el .IP "\f(CWone\fR \- one level" 4
.IX Item "one - one level"
.ie n .IP """sub"" \- subtree" 4
.el .IP "\f(CWsub\fR \- subtree" 4
.IX Item "sub - subtree"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`sub\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.timeout2\*(C'\fR
.IX Subsection "include_ldap_2level_ca.timeout2"
.PP
second-level connection timeout
.IP "Format:" 4
.IX Item "Format:"
Number of seconds.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW30\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.filter2\*(C'\fR
.IX Subsection "include_ldap_2level_ca.filter2"
.PP
second-level filter template
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_2level_ca.attrs2\*(C'\fR
.IX Subsection "include_ldap_2level_ca.attrs2"
.PP
second-level extracted attribute
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$ldap_attrdesc\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`mail\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.select2\*(C'\fR
.IX Subsection "include_ldap_2level_ca.select2"
.PP
second-level selection
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """first"" \- first entry" 4
.el .IP "\f(CWfirst\fR \- first entry" 4
.IX Item "first - first entry"
.ie n .IP """regex"" \- entries matching regular expression" 4
.el .IP "\f(CWregex\fR \- entries matching regular expression" 4
.IX Item "regex - entries matching regular expression"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`first\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.regex2\*(C'\fR
.IX Subsection "include_ldap_2level_ca.regex2"
.PP
second-level regular expression
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`\*(C'\fR
.PP
\f(CW\*(C`include_ldap_2level_ca.email_entry\*(C'\fR
.IX Subsection "include_ldap_2level_ca.email_entry"
.PP
Name of email entry
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_ldap_2level_ca.nosync_time_ranges\*(C'\fR
.IX Subsection "include_ldap_2level_ca.nosync_time_ranges"
.PP
Time ranges when inclusion is not allowed
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$time_ranges\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_ldap_2level_ca.use_ssl\*(C'\fR
.IX Subsection "include_ldap_2level_ca.use_ssl"
.PP
Obsoleted. Use \f(CW\*(C`use_tls\*(C'\fR.
.PP
\fI\f(CI\*(C`include_sql_ca\*(C'\fI\fR
.IX Subsection "include_sql_ca"
.PP
\&\s-1SQL\s0 query custom attribute
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`include_sql_ca.name\*(C'\fR
.IX Subsection "include_sql_ca.name"
.PP
short name for this source
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_ca.db_type\*(C'\fR
.IX Subsection "include_sql_ca.db_type"
.PP
database type
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_ca.host\*(C'\fR
.IX Subsection "include_sql_ca.host"
.PP
remote host
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$host\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_ca.db_port\*(C'\fR
.IX Subsection "include_sql_ca.db_port"
.PP
database port
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ed+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_ca.db_name\*(C'\fR
.IX Subsection "include_sql_ca.db_name"
.PP
database name
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_ca.connect_options\*(C'\fR
.IX Subsection "include_sql_ca.connect_options"
.PP
connection options
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_ca.db_env\*(C'\fR
.IX Subsection "include_sql_ca.db_env"
.PP
environment variables for database connection
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ew+\e=\eS+(;\ew+\e=\eS+)*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_ca.user\*(C'\fR
.IX Subsection "include_sql_ca.user"
.PP
remote user
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_ca.passwd\*(C'\fR
.IX Subsection "include_sql_ca.passwd"
.PP
remote password
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_ca.sql_query\*(C'\fR
.IX Subsection "include_sql_ca.sql_query"
.PP
\&\s-1SQL\s0 query
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$sql_query\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_ca.f_dir\*(C'\fR
.IX Subsection "include_sql_ca.f_dir"
.PP
Directory where the database is stored (used for \s-1DBD::CSV\s0 only)
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`include_sql_ca.email_entry\*(C'\fR
.IX Subsection "include_sql_ca.email_entry"
.PP
Name of email entry
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`include_sql_ca.nosync_time_ranges\*(C'\fR
.IX Subsection "include_sql_ca.nosync_time_ranges"
.PP
Time ranges when inclusion is not allowed
.IP "Format:" 4
.IX Item "Format:"
/\f(CW$time_ranges\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\fI\f(CI\*(C`include_list\*(C'\fI\fR
.IX Subsection "include_list"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`user_data_source\*(C'\fI\fR
.IX Subsection "user_data_source"
.PP
Deprecated.
.SS "\s-1DKIM\s0"
.IX Subsection "DKIM"
\fI\f(CI\*(C`dkim_feature\*(C'\fI\fR
.IX Subsection "dkim_feature"
.PP
Insert \s-1DKIM\s0 signature to messages sent to the list
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`dkim_feature\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Enable/Disable \s-1DKIM.\s0 This feature requires Mail::DKIM to be installed, and maybe some custom scenario to be updated
.PP
\fI\f(CI\*(C`dkim_parameters\*(C'\fI\fR
.IX Subsection "dkim_parameters"
.PP
\&\s-1DKIM\s0 configuration
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
A set of parameters in order to define outgoing \s-1DKIM\s0 signature
.PP
\f(CW\*(C`dkim_parameters.private_key_path\*(C'\fR
.IX Subsection "dkim_parameters.private_key_path"
.PP
File path for list \s-1DKIM\s0 private key
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`dkim_private_key_path\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
The file must contain a \s-1RSA\s0 pem encoded private key
.PP
\f(CW\*(C`dkim_parameters.selector\*(C'\fR
.IX Subsection "dkim_parameters.selector"
.PP
Selector for \s-1DNS\s0 lookup of \s-1DKIM\s0 public key
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`dkim_selector\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
The selector is used in order to build the \s-1DNS\s0 query for public key. It is up to you to choose the value you want but verify that you can query the public \s-1DKIM\s0 key for <selector>._domainkey.your_domain
.PP
\f(CW\*(C`dkim_parameters.header_list\*(C'\fR
.IX Subsection "dkim_parameters.header_list"
.PP
Deprecated.
.PP
\f(CW\*(C`dkim_parameters.signer_domain\*(C'\fR
.IX Subsection "dkim_parameters.signer_domain"
.PP
\&\s-1DKIM\s0 \*(L"d=\*(R" tag, you should probably use the default value
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`dkim_signer_domain\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
The \s-1DKIM\s0 \*(L"d=\*(R" tag, is the domain of the signing entity. The list domain \s-1MUST\s0 be included in the \*(L"d=\*(R" domain
.PP
\f(CW\*(C`dkim_parameters.signer_identity\*(C'\fR
.IX Subsection "dkim_parameters.signer_identity"
.PP
\&\s-1DKIM\s0 \*(L"i=\*(R" tag, you should probably leave this parameter empty
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\&\s-1DKIM\s0 \*(L"i=\*(R" tag, you should probably not use this parameter, as recommended by \s-1RFC 4871,\s0 default for list brodcasted messages is i=<listname>\-request@<domain>
.PP
\fI\f(CI\*(C`dkim_signature_apply_on\*(C'\fI\fR
.IX Subsection "dkim_signature_apply_on"
.PP
The categories of messages sent to the list that will be signed using \s-1DKIM.\s0
.IP "Format:" 4
.IX Item "Format:"
Multiple values allowed, separated by \f(CW\*(C`,\*(C'\fR.
.RS 4
.ie n .IP """md5_authenticated_messages"" \- authenticated by password" 4
.el .IP "\f(CWmd5_authenticated_messages\fR \- authenticated by password" 4
.IX Item "md5_authenticated_messages - authenticated by password"
.PD 0
.ie n .IP """smime_authenticated_messages"" \- authenticated by S/MIME signature" 4
.el .IP "\f(CWsmime_authenticated_messages\fR \- authenticated by S/MIME signature" 4
.IX Item "smime_authenticated_messages - authenticated by S/MIME signature"
.ie n .IP """dkim_authenticated_messages"" \- authenticated by \s-1DKIM\s0 signature" 4
.el .IP "\f(CWdkim_authenticated_messages\fR \- authenticated by \s-1DKIM\s0 signature" 4
.IX Item "dkim_authenticated_messages - authenticated by DKIM signature"
.ie n .IP """editor_validated_messages"" \- approved by moderator" 4
.el .IP "\f(CWeditor_validated_messages\fR \- approved by moderator" 4
.IX Item "editor_validated_messages - approved by moderator"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.ie n .IP """any"" \- any messages" 4
.el .IP "\f(CWany\fR \- any messages" 4
.IX Item "any - any messages"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`dkim_signature_apply_on\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
This parameter controls in which case messages must be signed using \s-1DKIM,\s0 you may sign every message choosing 'any' or a subset. The parameter value is a comma separated list of keywords
.PP
\fI\f(CI\*(C`arc_feature\*(C'\fI\fR
.IX Subsection "arc_feature"
.PP
Add \s-1ARC\s0 seals to messages sent to the list
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`arc_feature\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Enable/Disable \s-1ARC.\s0 This feature requires Mail::DKIM::ARC to be installed, and maybe some custom scenario to be updated
.PP
\fI\f(CI\*(C`arc_parameters\*(C'\fI\fR
.IX Subsection "arc_parameters"
.PP
\&\s-1ARC\s0 configuration
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
A set of parameters in order to define outgoing \s-1ARC\s0 seal
.PP
\f(CW\*(C`arc_parameters.arc_private_key_path\*(C'\fR
.IX Subsection "arc_parameters.arc_private_key_path"
.PP
File path for list \s-1ARC\s0 private key
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`arc_private_key_path\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
The file must contain a \s-1RSA\s0 pem encoded private key. Default is \s-1DKIM\s0 private key.
.PP
\f(CW\*(C`arc_parameters.arc_selector\*(C'\fR
.IX Subsection "arc_parameters.arc_selector"
.PP
Selector for \s-1DNS\s0 lookup of \s-1ARC\s0 public key
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`arc_selector\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
The selector is used in order to build the \s-1DNS\s0 query for public key. It is up to you to choose the value you want but verify that you can query the public \s-1DKIM\s0 key for <selector>._domainkey.your_domain.  Default is selector for \s-1DKIM\s0 signature
.PP
\f(CW\*(C`arc_parameters.arc_signer_domain\*(C'\fR
.IX Subsection "arc_parameters.arc_signer_domain"
.PP
\&\s-1ARC\s0 \*(L"d=\*(R" tag, you should probably use the default value
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`arc_signer_domain\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
The \s-1ARC\s0 \*(L"d=\*(R" tag, is the domain of the sealing entity. The list domain \s-1MUST\s0 be included in the \*(L"d=\*(R" domain
.PP
\fI\f(CI\*(C`dmarc_protection\*(C'\fI\fR
.IX Subsection "dmarc_protection"
.PP
\&\s-1DMARC\s0 Protection
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
Parameters to define how to manage From address processing to avoid some domains' excessive \s-1DMARC\s0 protection
.PP
\f(CW\*(C`dmarc_protection.mode\*(C'\fR
.IX Subsection "dmarc_protection.mode"
.PP
Protection modes
.IP "Format:" 4
.IX Item "Format:"
Multiple values allowed, separated by \f(CW\*(C`,\*(C'\fR.
.RS 4
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.PD 0
.ie n .IP """all"" \- all" 4
.el .IP "\f(CWall\fR \- all" 4
.IX Item "all - all"
.ie n .IP """dkim_signature"" \- \s-1DKIM\s0 signature exists" 4
.el .IP "\f(CWdkim_signature\fR \- \s-1DKIM\s0 signature exists" 4
.IX Item "dkim_signature - DKIM signature exists"
.ie n .IP """dmarc_reject"" \- \s-1DMARC\s0 policy suggests rejection" 4
.el .IP "\f(CWdmarc_reject\fR \- \s-1DMARC\s0 policy suggests rejection" 4
.IX Item "dmarc_reject - DMARC policy suggests rejection"
.ie n .IP """dmarc_any"" \- \s-1DMARC\s0 policy exists" 4
.el .IP "\f(CWdmarc_any\fR \- \s-1DMARC\s0 policy exists" 4
.IX Item "dmarc_any - DMARC policy exists"
.ie n .IP """dmarc_quarantine"" \- \s-1DMARC\s0 policy suggests quarantine" 4
.el .IP "\f(CWdmarc_quarantine\fR \- \s-1DMARC\s0 policy suggests quarantine" 4
.IX Item "dmarc_quarantine - DMARC policy suggests quarantine"
.ie n .IP """domain_regex"" \- domain matching regular expression" 4
.el .IP "\f(CWdomain_regex\fR \- domain matching regular expression" 4
.IX Item "domain_regex - domain matching regular expression"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`dmarc_protection_mode\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Select one or more operation modes.  \*(L"Domain matching regular expression\*(R" (domain_regex) matches the specified Domain regular expression; \*(L"\s-1DKIM\s0 signature exists\*(R" (dkim_signature) matches any message with a \s-1DKIM\s0 signature header; \*(L"\s-1DMARC\s0 policy ...\*(R" (dmarc_*) matches messages from sender domains with a \s-1DMARC\s0 policy as given; \*(L"all\*(R" (all) matches all messages.
.PP
\f(CW\*(C`dmarc_protection.domain_regex\*(C'\fR
.IX Subsection "dmarc_protection.domain_regex"
.PP
Match domain regular expression
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`dmarc_protection_domain_regex\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
Regular expression match pattern for From domain
.PP
\f(CW\*(C`dmarc_protection.other_email\*(C'\fR
.IX Subsection "dmarc_protection.other_email"
.PP
New From address
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`dmarc_protection_other_email\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
This is the email address to use when modifying the From header.  It defaults to the list address.  This is similar to Anonymisation but preserves the original sender details in the From address phrase.
.PP
\f(CW\*(C`dmarc_protection.phrase\*(C'\fR
.IX Subsection "dmarc_protection.phrase"
.PP
New From name format
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """display_name"" \- ""Name""" 4
.el .IP "\f(CWdisplay_name\fR \- ``Name''" 4
.IX Item "display_name - Name"
.ie n .IP """name_and_email"" \- ""Name"" (e\-mail)" 4
.el .IP "\f(CWname_and_email\fR \- ``Name'' (e\-mail)" 4
.IX Item "name_and_email - Name (e-mail)"
.ie n .IP """name_via_list"" \- ""Name"" (via List)" 4
.el .IP "\f(CWname_via_list\fR \- ``Name'' (via List)" 4
.IX Item "name_via_list - Name (via List)"
.ie n .IP """name_email_via_list"" \- ""Name"" (e\-mail via List)" 4
.el .IP "\f(CWname_email_via_list\fR \- ``Name'' (e\-mail via List)" 4
.IX Item "name_email_via_list - Name (e-mail via List)"
.ie n .IP """list_for_email"" \- ""List"" (on behalf of e\-mail)" 4
.el .IP "\f(CWlist_for_email\fR \- ``List'' (on behalf of e\-mail)" 4
.IX Item "list_for_email - List (on behalf of e-mail)"
.ie n .IP """list_for_name"" \- ""List"" (on behalf of Name)" 4
.el .IP "\f(CWlist_for_name\fR \- ``List'' (on behalf of Name)" 4
.IX Item "list_for_name - List (on behalf of Name)"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`dmarc_protection_phrase\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
This is the format to be used for the sender name part of the new From header.
.SS "Miscellaneous"
.IX Subsection "Miscellaneous"
\fI\f(CI\*(C`clean_delay_queuemod\*(C'\fI\fR
.IX Subsection "clean_delay_queuemod"
.PP
Expiration of unmoderated messages
.IP "Format:" 4
.IX Item "Format:"
Number of days.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`clean_delay_queuemod\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
\fI\f(CI\*(C`cookie\*(C'\fI\fR
.IX Subsection "cookie"
.PP
Secret string for generating unique keys
.IP "Format:" 4
.IX Item "Format:"
The value to be concealed.
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`cookie\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
This parameter is a confidential item for generating authentication keys for administrative commands (\s-1ADD, DELETE,\s0 etc.). This parameter should remain concealed, even for owners. The cookie is applied to all list owners, and is only taken into account when the owner has the auth parameter.
.PP
\fI\f(CI\*(C`custom_attribute\*(C'\fI\fR
.IX Subsection "custom_attribute"
.PP
Custom user attributes
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`custom_attribute.id\*(C'\fR
.IX Subsection "custom_attribute.id"
.PP
internal identifier
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ew+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`custom_attribute.name\*(C'\fR
.IX Subsection "custom_attribute.name"
.PP
label
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`custom_attribute.comment\*(C'\fR
.IX Subsection "custom_attribute.comment"
.PP
additional comment
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`custom_attribute.type\*(C'\fR
.IX Subsection "custom_attribute.type"
.PP
type
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """string"" \- string" 4
.el .IP "\f(CWstring\fR \- string" 4
.IX Item "string - string"
.ie n .IP """text"" \- multi-line text" 4
.el .IP "\f(CWtext\fR \- multi-line text" 4
.IX Item "text - multi-line text"
.ie n .IP """integer"" \- number" 4
.el .IP "\f(CWinteger\fR \- number" 4
.IX Item "integer - number"
.ie n .IP """enum"" \- set of keywords" 4
.el .IP "\f(CWenum\fR \- set of keywords" 4
.IX Item "enum - set of keywords"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`string\*(C'\fR
.PP
\f(CW\*(C`custom_attribute.enum_values\*(C'\fR
.IX Subsection "custom_attribute.enum_values"
.PP
possible attribute values (if enum is used)
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`custom_attribute.optional\*(C'\fR
.IX Subsection "custom_attribute.optional"
.PP
is the attribute optional?
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """required"" \- required" 4
.el .IP "\f(CWrequired\fR \- required" 4
.IX Item "required - required"
.ie n .IP """optional"" \- optional" 4
.el .IP "\f(CWoptional\fR \- optional" 4
.IX Item "optional - optional"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`optional\*(C'\fR
.PP
\fI\f(CI\*(C`custom_vars\*(C'\fI\fR
.IX Subsection "custom_vars"
.PP
custom parameters
.IP "Multiple occurrences allowed" 4
.IX Item "Multiple occurrences allowed"
.PP
\f(CW\*(C`custom_vars.name\*(C'\fR
.IX Subsection "custom_vars.name"
.PP
var name
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`custom_vars.value\*(C'\fR
.IX Subsection "custom_vars.value"
.PP
var value
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`.+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\fI\f(CI\*(C`expire_task\*(C'\fI\fR
.IX Subsection "expire_task"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`loop_prevention_regex\*(C'\fI\fR
.IX Subsection "loop_prevention_regex"
.PP
Regular expression applied to prevent loops with robots
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\eS*\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`loop_prevention_regex\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
\fI\f(CI\*(C`pictures_feature\*(C'\fI\fR
.IX Subsection "pictures_feature"
.PP
Allow picture display? (must be enabled for the current robot)
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """on"" \- enabled" 4
.el .IP "\f(CWon\fR \- enabled" 4
.IX Item "on - enabled"
.ie n .IP """off"" \- disabled" 4
.el .IP "\f(CWoff\fR \- disabled" 4
.IX Item "off - disabled"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
Value of \f(CW\*(C`pictures_feature\*(C'\fR parameter in \fIsympa.conf\fR or \fIrobot.conf\fR.
.PP
\fI\f(CI\*(C`remind_task\*(C'\fI\fR
.IX Subsection "remind_task"
.PP
Periodical subscription reminder task
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ew+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
Value of \f(CW\*(C`default_remind_task\*(C'\fR parameter in \fIsympa.conf\fR.
.PP
This parameter states which model is used to create a remind task. A remind task regularly sends  subscribers a message which reminds them of their list subscriptions.
.PP
\fI\f(CI\*(C`spam_protection\*(C'\fI\fR
.IX Subsection "spam_protection"
.PP
email address protection method
.IP "Format:" 4
.IX Item "Format:"
.RS 4
.PD 0
.ie n .IP """at"" \- replace @ characters" 4
.el .IP "\f(CWat\fR \- replace @ characters" 4
.IX Item "at - replace @ characters"
.ie n .IP """javascript"" \- use JavaScript" 4
.el .IP "\f(CWjavascript\fR \- use JavaScript" 4
.IX Item "javascript - use JavaScript"
.ie n .IP """none"" \- do nothing" 4
.el .IP "\f(CWnone\fR \- do nothing" 4
.IX Item "none - do nothing"
.RE
.RS 4
.RE
.IP "Default:" 4
.IX Item "Default:"
.PD
\&\f(CW\*(C`javascript\*(C'\fR
.PP
There is a need to protect Sympa web sites against spambots which collect email addresses from public web sites. Various methods are available in Sympa and you can choose to use them with the spam_protection and web_archive_spam_protection parameters. Possible value are:
.PP
javascript:
.PP
the address is hidden using a javascript. A user who enables javascript can see a nice mailto address where others have nothing.
.PP
at:
.PP
the @ char is replaced by the string \*(L" \s-1AT \*(R".\s0
.PP
none:
.PP
no protection against spammer.
.PP
\fI\f(CI\*(C`latest_instantiation\*(C'\fI\fR
.IX Subsection "latest_instantiation"
.PP
Latest family instantiation
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
\f(CW\*(C`latest_instantiation.email\*(C'\fR
.IX Subsection "latest_instantiation.email"
.PP
who ran the instantiation
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`listmaster|$email\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`latest_instantiation.date_epoch\*(C'\fR
.IX Subsection "latest_instantiation.date_epoch"
.PP
date
.IP "Format:" 4
.IX Item "Format:"
The time in second from Unix epoch.
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`latest_instantiation.date\*(C'\fR
.IX Subsection "latest_instantiation.date"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`creation\*(C'\fI\fR
.IX Subsection "creation"
.PP
Creation of the list
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
\f(CW\*(C`creation.email\*(C'\fR
.IX Subsection "creation.email"
.PP
who created the list
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`listmaster|$email\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`creation.date_epoch\*(C'\fR
.IX Subsection "creation.date_epoch"
.PP
date
.IP "Format:" 4
.IX Item "Format:"
The time in second from Unix epoch.
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`creation.date\*(C'\fR
.IX Subsection "creation.date"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`update\*(C'\fI\fR
.IX Subsection "update"
.PP
Last update of config
.IP "Single occurrence" 4
.IX Item "Single occurrence"
.PP
\f(CW\*(C`update.email\*(C'\fR
.IX Subsection "update.email"
.PP
who updated the config
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`(listmaster|automatic|$email)\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
None.
.PP
\f(CW\*(C`update.date_epoch\*(C'\fR
.IX Subsection "update.date_epoch"
.PP
date
.IP "Format:" 4
.IX Item "Format:"
The time in second from Unix epoch.
.IP "Default:" 4
.IX Item "Default:"
None, \fImandatory\fR.
.PP
\f(CW\*(C`update.date\*(C'\fR
.IX Subsection "update.date"
.PP
Deprecated.
.PP
\fI\f(CI\*(C`status\*(C'\fI\fR
.IX Subsection "status"
.PP
Status of the list
.IP "Format:" 4
.IX Item "Format:"
Status of list.
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW\*(C`open\*(C'\fR
.PP
\fI\f(CI\*(C`serial\*(C'\fI\fR
.IX Subsection "serial"
.PP
Serial number of the config
.IP "Format:" 4
.IX Item "Format:"
/\f(CW\*(C`\ed+\*(C'\fR/
.IP "Default:" 4
.IX Item "Default:"
\&\f(CW0\fR
.PP
\fI\f(CI\*(C`account\*(C'\fI\fR
.IX Subsection "account"
.PP
Deprecated.
.SH "FILES"
.IX Header "FILES"
.IP "\fI\f(CI$EXPLDIR\fI/<list name>/config\fR or \fI\f(CI$EXPLDIR\fI/<mail domain name>/<list name>/config\fR" 4
.IX Item "$EXPLDIR/<list name>/config or $EXPLDIR/<mail domain name>/<list name>/config"
List main configuration file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBsympa.conf\fR\|(5).
.PP
\&\fISympa Administration Manual\fR.
<https://sympa\-community.github.io/manual/>.