next up previous contents index
Next: 12. Shared documents Up: Sympa Mailing Lists Management Software Previous: 10. Creating and editing mailing using   Contents   Index

Subsections


11. List configuration parameters

The configuration file is composed of paragraphs separated by blank lines and introduced by a keyword.

Even though there are a very large number of possible parameters, the minimal list definition is very short. The only required parameters are owner and subject. All other parameters have a default value.

keyword value

WARNING: configuration parameters must be separated by blank lines and BLANK LINES ONLY !

11.1 List description


11.1.1 editor

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)

Only the editor of a list is authorized to send messages to the list when the send parameter (see 11.3.6, page [*]) is set to either editor, editorkey, or editorkeyonly. The editor parameter is also consulted in certain other cases ( privateoreditorkey ).

The syntax of this directive is the same as that of the owner parameter (see 11.1.4, page [*]), even when several moderators are defined.


11.1.2 host

(Default value: host robot parameter)

host fully-qualified-domain-name

Domain name of the server hosting the list (used for From: , for example). The default value is set in the /etc/sympa.conf file.


11.1.3 lang

(Default value: lang robot parameter)

Example:

lang cn-big5

This parameter defines the language used for the list. It is used to initialize a user's lang preference ; Sympa command reports are extracted from the associated message catalog.

See 8.4, page [*] for available languages.


11.1.4 owner

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 15.2, page [*]) and DELETE (see 15.2, page [*]) commands on behalf of other users.

When the subscribe parameter (see 11.3.1, page [*]) specifies a restricted list, it is the owner who has the exclusive right to subscribe users, and it is therefore to the owner that SUBSCRIBE requests will be forwarded.

There may be several owners of a single list; in this case, each owner is declared in a paragraph starting with the owner keyword.

The owner directive is followed by one or several lines giving details regarding the owner's characteristics:


11.1.5 subject

subject subject-of-the-list

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 the ~sympa/expl/lists file (a static list of lists) exists.


11.1.6 topics

topics computing/internet,education/university

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.


11.1.7 visibility

(Default value: conceal)

visibility parameter is defined by scenario (see 8.6, page [*])

visibility conceal $\vert$ noconceal

This parameter indicates whether the list should feature in the output generated in response to a LISTS command. This parameter is not used by Sympa if the ~sympa/expl/lists file (a static list of lists) exists.

11.2 Data source related

11.2.1 user_data_source

(Default value: file|database, if using an RDBMS)

user_data_source file $\vert$ database $\vert$ include

Sympa allows the mailing list manager to choose how Sympa loads subscriber data. Subscriber information can be stored in a text file or relational database, or included from various external sources (list, flat file, result of LDAP or SQL query).

11.2.2 ttl

(Default value: 3600)

ttl delay_in_seconds

Sympa caches user data extracted using the include parameter. Their TTL (time-to-live) within Sympa can be controlled using this parameter. The default value is 3600.

11.2.3 include_list

include_list listname

This parameter will be interpreted only if user_data_source is set to include. All subscribers of list listname become subscribers of the current list. You may include as many lists as required, using one include_list listname line for each included list. Any list at all may be included ; the user_data_source definition of the included list is irrelevant, and 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 an infinite loop.


11.2.4 include_sql_query

include_sql_query

This parameter will be interpreted only if the user_data_source value is set to include, and is used to begin a paragraph defining the SQL query parameters :

Example :

user_data_source include

include_sql_query
      db_type oracle
      host sqlserv.admin.univ-x.fr
      user stduser
      passwd mysecret
      db_name studentbody
      sql_query SELECT DISTINCT email FROM student


11.2.5 include_ldap_query

include_ldap_query

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 the Net::LDAP (perlldap) PERL module.

Example :

    include_ldap_query
    host ldap.cru.fr
    suffix dc=cru, dc=fr
    filter (&(cn=aumont) (c=fr))
    attrs mail
    select first


11.2.6 include_file

include_file path to file

This parameter will be interpreted only if the user_data_source value is set to include. The file should contain one e-mail address per line (lines beginning with a "#" are ignored).

11.3 Command related


11.3.1 subscribe

(Default value: open)

subscribe parameter is defined by scenario (see 8.6, page [*])

The subscribe parameter defines the rules for subscribing to the list. Predefined scenarii are :

subscribe open $\vert$ owner $\vert$ closed $\vert$ auth $\vert$

When the optional notify parameter option is set, owners receive a notification of each subscription, unless their owner definition includes the nomail option.


11.3.2 unsubscribe

(Default value: open)

unsubscribe parameter is defined by scenario (see 8.6, 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 scenarii are :

unsubscribe open[_notify] $\vert$ auth[_notify] owner closed


11.3.3 add

(Default value: owner)

add parameter is defined by scenario (see 8.6, page [*])

This parameter specifies who is authorized to use the ADD command. Predefined scenarii are :

add auth $\vert$ owner $\vert$ closed


11.3.4 del

(Default value: owner)

del parameter is defined by scenario (see 8.6, page [*])

This parameter specifies who is authorized to use the DEL command. Predefined scenarii are :

del auth $\vert$ owner $\vert$ closed


11.3.5 remind

(Default value: owner)

remind parameter is defined by scenario (see 8.6, page [*])

This parameter specifies who is authorized to use the remind command. Predefined scenarii are :

remind owner $\vert$ listmaster


11.3.6 send

(Default value: private)

send parameter is defined by scenario (see 8.6, page [*])

Predefined scenarii are :

public $\vert$ private $\vert$ privateoreditorkey $\vert$ privateorpublickey $\vert$ editor $\vert$ editorkey $\vert$ editorkeyonly

This parameter specifies who can send messages to the list. Valid values for this parameter are pointers to scenarii.


11.3.7 review

(Default value: owner)

review parameter is defined by scenario (see 8.6, page [*])

This parameter specifies who can use REVIEW (see 15.1, page [*]), administrative requests. Predefined scenarii are :

review public $\vert$ private $\vert$ owner $\vert$


11.3.8 shared_doc

This paragraph defines read and edit access to the shared document repository.

11.3.8.1 Read access

(Default value: private)

This parameter specifies who can read shared documents (access the contents of a list's shared directory).

Predefined scenarii are :

d_read public $\vert$ private $\vert$ owner $\vert$

11.3.8.2 Edit access

(Default value: owner)

This parameter specifies who can perform changes within a list's shared directory (i.e. upload files and create subdirectories).

Predefined scenarii are :

d_edit public $\vert$ private $\vert$ owner $\vert$

Example:

shared_doc
d_read		public
d_edit		private

11.4 List tuning


11.4.1 reply_to_header

The reply_to parameter starts a paragraph defining what Sympa will place in the Reply-To: SMTP header field of the messages it distributes.


11.4.2 max_size

(Default value: max_size robot parameter)

max_size number-of-bytes

Maximum size of a message in 8-bit bytes. The default value is set in the /etc/sympa.conf file.


11.4.3 anonymous_sender

anonymous_sender value

If this parameter is set for a list, all messages distributed via the list are rendered anonymous. SMTP From: headers in distributed messages are altered to contain the value of the anonymous_sender parameter. Various other fields are removed (Received:, Reply-To:, Sender:, X-Sender:, Message-id:, Resent-From:


11.4.4 custom_header

custom_header header-field: value

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.

Example: custom_header X-url: http://www.cru.fr/listes/apropos/sedesabonner.faq.html.

11.4.5 custom_subject

custom_subject value

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).

Example: custom_subject [sympa-users].


11.4.6 footer_type

(Default value: mime)

footer_type (optional, default value is mime) mime $\vert$ append

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.

11.4.7 digest

digest daylist hour:minutes

Definition of digest mode. If this parameter is present, subscribers can select the option of receiving messages in multipart/digest MIME format. Messages are then grouped together, and compilations of messages are sent to subscribers in accordance with the rhythm 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 should scan the digest queue at least once between the time laid down for sending the digest and 12:00 AM (midnight). As a rule of thumb, do not use a digest time later than 11:00 PM.

11.4.8 available_user_options

The available_user_options parameter starts a paragraph to define available options for the subscribers of the list.

Example :

## Nomail reception mode is not available
available_user_options
reception  	digest,mail

11.4.9 default_user_options

The default_user_options parameter starts a paragraph to define a default profile for the subscribers of the list.

Example :

default_user_options
reception  	digest
visibility	noconceal

11.4.10 cookie

(Default value: cookie robot parameter)

cookie random-numbers-or-letters

This parameter is a confidential item for generating authentication keys for administrative commands (ADD, DELETE, 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 (owner parameter, see 11.1.4, page [*]).

Example: cookie secret22


11.4.11 priority

(Default value: default_list_priority robot parameter)

priority 0-9

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.

0 is the highest priority. The following priorities can be used: 0...9 z. z is a special priority causing messages to remain spooled indefinitely (useful to hang up a list).

Available since release 2.3.1.

11.5 Bounce related


11.5.1 bounce

This paragraph defines bounce management parameters :

Example:

## Owners are warned with 10% bouncing addresses
## message distribution is halted with 20% bouncing rate
bounce
warn_rate	10
halt_rate	20


11.5.2 welcome_return_path

(Default value: welcome_return_path robot parameter)

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.


11.5.3 remind_return_path

(Default value: remind_return_path robot parameter)

Same as welcome_return_path, but applied to remind messages.

11.6 Archive related


11.6.1 archive

If the config file contains an archive paragraph Sympa will manage an archive for this list.

Example:

archive
period week
access private

If the archive parameter is specified, archives are accessible to users through the GET command, and the index of the list archives is provided in reply to the INDEX command (the last message of a list can be consulted using the LAST command).

period day $\vert$ week $\vert$ month $\vert$ quarter $\vert$ year

This parameter specifies how archiving is organized: by day, week, month, quarter, or year. Generation of automatic list archives requires the creation of an archive directory at the root of the list directory (~sympa/expl/mylist/archives/), used to store these documents.

access private $\vert$ public $\vert$ owner $\vert$ closed $\vert$

This parameter specifies who is authorized to use the GET, LAST and INDEX commands.


11.6.2 web_archive

If the config file contains a web_archive paragraph Sympa will copy all messages distributed via the list to the "queueoutgoing" spool. It is intended to be used 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

The value of the web_archive access parameter must be one of the following : access private $\vert$ public $\vert$ owner $\vert$ closed $\vert$ listmaster


next up previous contents index
Next: 12. Shared documents Up: Sympa Mailing Lists Management Software Previous: 10. Creating and editing mailing using   Contents   Index
root 2001-06-05