The configuration file is made up of paragraphs separated by empty lines and introduced by a keyword.
However the number of parameters is important, the minimal list definition is very short, only owner and subject parameter are needed because all the other parameter have a default value.
keyword value
WARNING: configuration parameters must be separated by empty lines and EMPTY LINES ONLY !
This parameter indicates the subject of the list, which is sent in response to the LISTS mail command. The subject is a free form text limited to one line. This parameter is not used by Sympa if ~sympa/expl/lists file exists (e.g. static list of lists).
(Default value: conceal)
visibility parameter is defined by scenario (see 6.4, page )
visibility conceal | noconceal
This parameter indicates whether the list should be listed when replying to LISTS command. This parameter is not used by Sympa if ~sympa/expl/lists file exists (e.g. static list of lists).
(Default value: lang robot parameter)
Example:
\lparam {lang} cn-big5
This parameter defines the language used for the list. It is exploited to initialize user's lang preference ; Sympa command reports are extracted from the associated messages catalog.
See 6.3, page
for available langages.
(Default value: host robot parameter)
host fully-qualified-domain-name
Domain name hosting the list (used for From: , for example).Default value is set in /etc/sympa.conf file.
The config file contains one owner paragraph per owner.
Example:
owner email serge.aumont@cru.fr gecos C.R.U. info Tel: 02 99 76 45 34 reception nomail
The list owner is usually the person who has the authorization to send
ADD (see 9.2, page ) and
DELETE (see 9.2, page
)
commands on behalf of other users.
When the subscribe parameter (see 8.3.1,
page ) specifies a restricted list, the
owner is the only one who has the capability to subscribe users.
In this case, SUBSCRIBE requests are forwarded to him.
There may be several owners of a single list; in this case, each owner is defined by a paragraph introduced by the owner keyword.
The owner directive is followed by one or several lines giving details regarding the owner's characteristics:
Owner's email address
Optional attribute for an owner who don't want to receive mails. Useful to define an owner with multiple email addresses: they are all recognized when Sympa receives mail, but only some of them are recipient of administrative mail from Sympa.
Public information on the owner
Available since release 2.3
Private information on the owner
Available since release 2.3.5
Profile of the owner. This is currently used to restrict access to some feature in WWSympa such as adding new owners to a list.
The config file contains one editor paragraph per moderator (or editor).
Example:
editor email Pierre.David@prism.uvsq.fr gecos Pierre (Université de Versaille St Quentin)
The editor of a list is the only one authorized to send messages
in the list when the send parameter (see 8.3.6,
page ) is set to editor.editorkey or editorkeyonly
This parameter is used also to redistribute mail in some other situation
( privateoreditorkey ).
The syntax of this directive is the same as that of the owner parameter (see 8.1.5, page ),
even when several moderators are defined.
(Default value: file|database, if using a DBMS)
user_data_source file | database | include
Sympa allows the mailing list manager to choose how Sympa loads subscribers' data. Subscriber's informations can be stored in a text file, in a RDBMS or included from various external sources (list, flat file, LDAP directory, RDBMS).
When this value is used subscribers data are stored in a file which name is define sympa.conf, parameter subscribers. This is maintened for backwared compatibility.
This mode as been introduced to store data in a RDBMS
in order to share subscribers data with a HTTP interface
and also to be able to manage very large mailing lists
(tested with MySql, 200.000 subscribers in a single list).
We strongly recommend to use this value (and of course to
configure a RDBMS). This improve Sympa performence and solve
possible conflict with sympa and wwsympa.
Please refer to the
section Üsing Sympa with a RDBMS(5, page ).
(Default value: 3600)
Sympa caches users data extracted using the include parameter. The time to leave of these data in Sympa can be controled with this parameter. The default value is 3600.
This parameter will be interpreted only if user_data_source is set to include. All subscribers of list listname will become subscribers of the current list. You may include as many lists as needed using one include_list listname line for each included list. You can include any list whatever is its user_data_source definition. In particular, you can include lists which are also defined by inclusion of other lists. Be carefull not to include list A in list B and then list B in list A : this would start an infinite loop.
This parameter will be interpreted only if the user_data_source value is set to include, it is the begining of a paragraph which defines the SQL query parameters :
This is the DBD name (Oracle, mysql , Pg, Sybase ...). You must respect the case.
The Database Server Sympa will try to connect to.
The hostname of the database system.
The user id to connect to the database.
Example :
user_data_source include include_sql_query db_type oracle host sqlserv.admin.univ-x.fr user banalise passwd mysecret db_name scolarship sql_query SELECT DISTINCT email FROM student
This paragraph defines parameters for a LDAP query returning a list of subscribers. This paragraph is used only if user_data_source is set to include. This feature requires Net::LDAP (perlldap) Perl module.
Name of the LDAP directory host.
Port on which the Directory is accepting connections.
Username with read access on the LDAP directory.
Defines the naming space covered by the search (optional, depending on the LDAP server).
Defines the LDAP search filter (RFC 2254 compliant).
Example :
include_ldap_query host ldap.cru.fr suffix dc=cru, dc=fr filter (&(cn=aumont) (c=fr))
This parameter will be interpreted only if the user_data_source value is set to include, the file is interpreted as one email per line (line beginning with a "#" are ignored).
(Default value: open)
subscribe parameter is defined by scenario (see 6.4, page )
Subscribe parameter define the rules for subscribing to the list. Predefined scenari are :
subscribe open | owner | closed | auth |
Anyone can join the list with the SUBSCRIBE mail command. Optional notification of each succesful subscription to owners can be set for each list with:
subscribe open_notify.
Only the owner (see owner above) can subscribe or unsubscribe a user. The owner should send an ADD mail command to subscribe the user.
Any subscription is refused, except indirectly by the
owner using the ADD command (see 9.2,
page ). This parameter is forced to
closed value for lists defined using
user_data_sourceinclude.
Use of the SUBSCRIBE command requires prior authentication of the origin of the subscription request. Sympa sends a key to the requesting party, who should in return send Sympa a SUBSCRIBE command prefixed with auth key.
Note: The cookie parameter (see 8.4.9,
page ) allows allocation of a single
key.
When the optional notify parameter option is set, owners receive a notification of each subscription, unless their owner definition include the nomail option.
(Default value: open)
unsubscribe parameter is defined by scenario (see 6.4, page )
This parameter specifies the unsubscription method for the list. Use open_notify or auth_notify to allow owner notification of each unsubscribe command. Predefined scenari are :
unsubscribe open[_notify] | auth[_notify] owner closed
Anyone can unsubscribe from the list.
Use of the SIGNOFF command requires prior authentication of the sender. To perform this authentification, Sympa sends a key, indicating that the ``auth key'' parameter should be put in front of the command.
Note: it is advisable to enter the cookie parameter
(see 8.4.9, page ).
(Default value: owner)
add parameter is defined by scenario (see 6.4, page )
This parameter specifies who can perform ADD command Predefined scenari are :
Only owners can add subscribers to the list.
Use of the ADD command requires prior authentication of the owner. To perform this authentification, Sympa sends a key, indicating that the ``auth key'' parameter should be put in front of the command.
(Default value: owner)
del parameter is defined by scenario (see 6.4, page )
This parameter specifies who can perform DEL command Predefined scenari are :
Only owners can delete subscribers of the list.
Use of the DEL command requires prior authentication of the owner. To perform this authentification, Sympa sends a key, indicating that the ``auth key'' parameter should be put in front of the command.
(Default value: owner)
remind parameter is defined by scenario (see 6.4, page )
This parameter specifies who can perform remind command Predefined scenari are :
Only owners can perform remind for the list.
Use of the remind is a listmaster privilege.
(Default value: private)
send parameter is defined by scenario (see 6.4, page )
Predifined scenarii are :
public | private | privateoreditorkey | privateorpublickey | editor | editorkey | editorkeyonly
This parameter specifies who can send messages to the list ; it is performed by scenari :
Anyone can send a message to the list, including non-subscribers.
Anyone can send a message to the list, including non-subscribers; authentication is automatically requested by return mail.
Only subscribers or owners can send a message.
Only subscribers or owners can send a message; authentication is systematically requested by return mail.
Anyone can send a message to the list. Authentication is requested by return mail for non-subscribers.
Anyone can send a message to the list. Message for which the sender is not a subscriber are sent to the list editor to confirm or reject its distribution.
All messages are stored on the server awaiting approval for distribution. An enabling key is sent to the moderators wit a copy of the message. The message is distributed when the Sympa robot receives a DISTRIBUTE command with the sole key referring to the queued message.
The REJECT command delete the message from the moderation spool (see queuemod configuration variable).
This method is used for:
With this method, it is not possible for the moderator to change the message, which is always refused or distributed as a whole. This moderation feature is only available as of release 1.2.0 of Sympa.
In this configuration, Sympa distributes the messages for
which at least one of the SMTP fields From:,
X-Sender: contains
the address of one of the moderators, distributing these
in the list (see editor parameter for list
description file, 8.1.6, page ).
In the opposite case, it sends these list moderators a message entitled ``Article to moderate'' containing a copy of the article to be distributed. It is up to the moderator to send this copy of the message to be distributed back to the list, using the redirect, redistribute, forward or other functions from its MUA (moderation depends on processing of headers, managed by each MUA).
It should be noted that the security level of this method is associated to the enabling level of the message SMTP fields; it is therefore rather low.
This method mixes send editor and send editorkeyonly functionalities: If one of the SMTP fields From:, X-Sender: or Approved: contains the address of one of the moderators, the message is distributed without any control.
In the opposite case, it works in the same way as a moderated list with send editorkeyonly.
Available as of release 1.2.0 of Sympa.
(Default value: owner)
review parameter is defined by scenario (see 6.4, page )
This parameter specifies who can use the
REVIEW (see 9.1, page ),
administrative requests.
Predifined scenari are :
review public | private | owner |
REVIEW access is not protected and anyone, even non-subscribers, can use it.
The REVIEW command is only authorized for subscribers.
Only the list owner can use it.
(Default value: sender)
reply_to sender | list | email
This parameter indicates whether the Reply-To: field should point to the sender of the message (sender) or to the list itself (list) or to anyother e-mail. If Reply-To: SMTP header field is set in incoming message, Sympa will never modify it.
Note: it is unadvisable to change this field, especially to point to the list. Experience demonstrates that numerous users, thinking they are responding to the sender, send private messages to a list. This can lead to an embarrassing situation.
(Default value: max_size robot parameter)
Maximum size of a message in 8-bit bytes. Default value is set in /etc/sympa.conf file.
If this parameter is set for a list, all messages distributed in that list are anonymized. The SMTP From: fields are replace by anonymous_sender). value. Various other field are removed (Received:, Reply-To:, Sender: X-Sender:, Message-id:, Resent-From:
custom_header header-field: value
This parameter is optional. The header specified with this parameter will be placed in each of the message headers distributed in 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.
Example: custom_header X-url: http://www.cru.fr/listes/apropos/sedesabonner.faq.html.
This parameter is optional. This parameter specifies a string which is added to the subject of distributed messages (this is intented to help users who do not use automatic tools to sort incoming messages).
Example: custom_subject [sympa-users].
(Default value: mime)
footer_type (optional, default value is mime) mime | append
List owners may decide to add message header or footer to messages sent to the list. This parameter defines the way a footer/header is added to a message.
This is the default value. Sympa will add properly the footer/header as a new MIME part. If message if multipart/alternative, nothing is added (would require another level of MIME encapsulation).
In this configuration, sympa won't create new MIME parts but will try to append the header/footer to the body of the message. ~sympa/expl/mylist/message.footer.mime will be ignored. Header/footer may be appendeded to text/plain messages only.
Definition of digest mode. If this parameter is filled in, subscribers can select the receive option in multipart/digest MIME format. Messages are then grouped together and this compilation is sent to the subscribers in accordance with the rythm selected with this parameter.
Daylist designates a list of days in the week in number format (from 0 for Sunday to 6 for Saturday), separated by commas.
Example: digest 1,2,3,4,5 15:30
In this example, Sympa sends digests at 3:30 PM from Monday to Friday.
WARNING: if the sending time is too late, Sympa may not be able to process it. It is essential that Sympa scans the digest queue at least once between the time laid down for sending of the digest and 12:00 PM. Usually do not use digest time later than 11:00 PM.
default_user_options parameter starts a paragraph to define a default profile for the subscribers of the list.
Mail reception mode.
Visibility of the subscriber with the REVIEW command.
(Default value: cookie robot parameter)
cookie random-numbers-or-letters
This parameter is a secret item for generating authentication keys for administrative commands (ADD,
DELETE, etc.). This parameter should remain secret,
even for owners. The cookie is applied to all list owners, and is
only taken into account when the owner has the auth
parameter (owner parameter, see 8.1.5,
page ).
Example: cookie secret22
(Default value: default_list_priority robot parameter)
This is the priority Sympa will process messages for this list. This is applied while going through the spool.
0 is the highest priority. The following priorities can be used: 0...9 A...Z a...z. z is a special priority since messages will stay in spool forever (useful to hangup a list).
Available since release 2.3.1.
This paragraph defines bounce management parameters :
(Default value: bounce_warn_rate robot parameter)
Above this rate of bouncing addresses in a list, listowner receives a warning for each mail distributed in the list.
(Default value: bounce_halt_rate robot parameter)
NOT USED YET
If bounce rate reaches the halt_rate, messages for the list will be halted, ie they are kept for later moderation.Above this rate of bouncing addresses in a list, messages for the list aren't distributed.
If the config file contains a archive paragraph Sympa will manage an archive of this list
Example:
archive period week access private
If parameter archive is specified, archives are accessible to users through the GET command, and the index of the list archives is given by the INDEX command (last message of a list is availible using LAST command).
period day | week | month | quarter | year
This parameter specifies how archiving is organised: by day, by week, by month, by quarter or by year. Generation of automatic list archives requires creation of an archive directory in the root of the list (~sympa/expl/mylist/archives/) where these documents will be put.
access private | public | owner | closed |
This parameter specifies who is allowed to send GET, LAST or INDEX commands.
If the config file contains a web_archive paragraph Sympa will copy all messages ditributed in the list to the "queueoutgoing" spool. It is intented to be use with WWSympa html archive tools. This paragraph must contain at least the access parameter to control who can browse the web archive.
Example:
web_archive access private
Value for web_archive access parameter must be one of the following : access private | public | owner | closed | listmaster