Next: 14. Shared documents Up: Sympa Mailing Lists Management Software version Previous: 12. Creating and editing mailing using Contents Index

Subsections

13. 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 !

13.1 List description

13.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 13.3.8, 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 13.1.4, page ), even when several moderators are defined.

13.1.2 host

(Default value: host robot parameter)

host fully-qualified-domain-name

Domain name of the list, mainly used on the web interface. The default value is set in the /etc/sympa.conf file.

13.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 10.6, page for available languages.

13.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 17.2, page ) and DELETE (see 17.2, page ) commands on behalf of other users.

When the subscribe parameter (see 13.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:

email address
Owner's e-mail address
reception nomail
Optional attribute for an owner who does not wish to receive mails. Useful to define an owner with multiple e-mail addresses: they are all recognized when Sympa receives mail, but thanks to reception nomail, not all of these addresses need receive administrative mail from Sympa.
gecos data
Public information on the owner
info data
Available since release 2.3
Private information on the owner
profile privileged $\vert$ normal
Available since release 2.3.5
Profile of the owner. This is currently used to restrict access to some features of WWSympa, such as adding new owners to a list.

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

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

13.1.7 visibility

(Default value: conceal)

visibility parameter is defined by scenario (see 10.8, page )

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.

visibility conceal (view)
conceal unless for subscribers
visibility intranet (view)
intranet access
visibility noconceal (view)
no conceal
visibility private (view)
subscribers
visibility secret (view)
conceal even for subscribers

13.2 Data source related

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

user_data_source file
When this value is used, subscriber data are stored in a file whose name is defined by N"> 13. List configuration parameters
Next: 14. Shared documents Up: Sympa Mailing Lists Management Software version Previous: 12. Creating and editing mailing using Contents Index

Subsections
13. 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 !

13.1 List description

13.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 13.3.8, 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 13.1.4, page ), even when several moderators are defined.

13.1.2 host

(Default value: host robot parameter)
host fully-qualified-domain-name
Domain name of the list, mainly used on the web interface. The default value is set in the /etc/sympa.conf file.

13.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 10.6, page for available languages.

13.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 17.2, page ) and DELETE (see 17.2, page ) commands on behalf of other users.
When the subscribe parameter (see 13.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:
- email address
  Owner's e-mail address
- reception nomail
  Optional attribute for an owner who does not wish to receive mails. Useful to define an owner with multiple e-mail addresses: they are all recognized when Sympa receives mail, but thanks to reception nomail, not all of these addresses need receive administrative mail from Sympa.
- gecos data
  Public information on the owner
- info data
  Available since release 2.3
  Private information on the owner
- profile privileged $\vert$ normal
  Available since release 2.3.5
  Profile of the owner. This is currently used to restrict access to some features of WWSympa, such as adding new owners to a list.
13.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.

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

13.1.7 visibility

(Default value: conceal)
visibility parameter is defined by scenario (see 10.8, page )
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.
- visibility conceal (view)
  conceal unless for subscribers
- visibility intranet (view)
  intranet access
- visibility noconceal (view)
  no conceal
- visibility private (view)
  subscribers
- visibility secret (view)
  conceal even for subscribers
13.2 Data source related

13.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).
- user_data_source file
  When this value is used, subscriber data are stored in a file whose name is defined by N"> 13. List configuration parameters
  Next: 14. Shared documents Up: Sympa Mailing Lists Management Software version Previous: 12. Creating and editing mailing using Contents Index
  
  Subsections
  13. 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 !
  
  13.1 List description
  
  13.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 13.3.8, 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 13.1.4, page ), even when several moderators are defined.
  
  13.1.2 host
  
  (Default value: host robot parameter)
  host fully-qualified-domain-name
  Domain name of the list, mainly used on the web interface. The default value is set in the /etc/sympa.conf file.
  
  13.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 10.6, page for available languages.
  
  13.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 17.2, page ) and DELETE (see 17.2, page ) commands on behalf of other users.
  When the subscribe parameter (see 13.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:
  - email address
    Owner's e-mail address
  - reception nomail
    Optional attribute for an owner who does not wish to receive mails. Useful to define an owner with multiple e-mail addresses: they are all recognized when Sympa receives mail, but thanks to reception nomail, not all of these addresses need receive administrative mail from Sympa.
  - gecos data
    Public information on the owner
  - info data
    Available since release 2.3
    Private information on the owner
  - profile privileged $\vert$ normal
    Available since release 2.3.5
    Profile of the owner. This is currently used to restrict access to some features of WWSympa, such as adding new owners to a list.
  13.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.
  
  13.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.
  
  13.1.7 visibility
  
  (Default value: conceal)
  visibility parameter is defined by scenario (see 10.8, page )
  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.
  - visibility conceal (view)
    conceal unless for subscribers
  - visibility intranet (view)
    intranet access
  - visibility noconceal (view)
    no conceal
  - visibility private (view)
    subscribers
  - visibility secret (view)
    conceal even for subscribers
  13.2 Data source related
  
  13.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).
  - user_data_source file
    When this value is used, subscriber data are stored in a file whose name is defined by N"> 13. List configuration parameters
    Next: 14. Shared documents Up: Sympa Mailing Lists Management Software version Previous: 12. Creating and editing mailing using Contents Index
    
    Subsections
    13. 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 !
    
    13.1 List description
    
    13.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 13.3.8, 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 13.1.4, page ), even when several moderators are defined.
    
    13.1.2 host
    
    (Default value: host robot parameter)
    host fully-qualified-domain-name
    Domain name of the list, mainly used on the web interface. The default value is set in the /etc/sympa.conf file.
    
    13.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 10.6, page for available languages.
    
    13.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 17.2, page ) and DELETE (see 17.2, page ) commands on behalf of other users.
    When the subscribe parameter (see 13.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:
    - email address
      Owner's e-mail address
    - reception nomail
      Optional attribute for an owner who does not wish to receive mails. Useful to define an owner with multiple e-mail addresses: they are all recognized when Sympa receives mail, but thanks to reception nomail, not all of these addresses need receive administrative mail from Sympa.
    - gecos data
      Public information on the owner
    - info data
      Available since release 2.3
      Private information on the owner
    - profile privileged $\vert$ normal
      Available since release 2.3.5
      Profile of the owner. This is currently used to restrict access to some features of WWSympa, such as adding new owners to a list.
    13.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.
    
    13.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.
    
    13.1.7 visibility
    
    (Default value: conceal)
    visibility parameter is defined by scenario (see 10.8, page )
    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.
    - visibility conceal (view)
      conceal unless for subscribers
    - visibility intranet (view)
      intranet access
    - visibility noconceal (view)
      no conceal
    - visibility private (view)
      subscribers
    - visibility secret (view)
      conceal even for subscribers
    13.2 Data source related
    
    13.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).
    - user_data_source file
      When this value is used, subscriber data are stored in a file whose name is defined by N"> 13. List configuration parameters
      Next: 14. Shared documents Up: Sympa Mailing Lists Management Software version Previous: 12. Creating and editing mailing using Contents Index
      
      Subsections
      - 13.1 List description
        
        13.1.1 editor
        13.1.2 host
        13.1.3 lang
        13.1.4 owner
        13.1.5 subject
        13.1.6 topics
        13.1.7 visibility
      - 13.2 Data source related
        
        13.2.1 user_data_source