next up previous contents index
Next: 9. Creating and editing mailing using Up: Sympa Automatic Multi-posting System Previous: 7. Customizing Sympa/WWSympa   Contents   Index

Subsections


8. Creation of mailing lists

The mailling list creation tool is Sympa's web interface. However this web feature is available only from 2.7 release. Previous version users have to create new lists with there favorit text file editor.

This chapter describe how to create mailing list without using web tools. See 9, page [*] to do it using WWSympa, you will do it in a easier way.

To create a mailing list, only system mail aliases modification requires system privileges. Other tasks will be carried out under sympa UID in order to guarantee that the files created have the right permissions.


8.1 Mail aliases

For each new list, it is necessary to create three mail aliases (the location of the sendmail alias file varies from one system to another).

For example, to create the mylist list, the following aliases must be added:

mylist: "|/home/sympa/bin/queue mylist"
mylist-request: "|/home/sympa/bin/queue mylist-request"
mylist-editor: "|/home/sympa/bin/queue mylist-editor"
mylist-owner: "|/home/sympa/bin/bouncequeue mylist
mylist-subscribe: "|/home/sympa/bin/queue mylist-subscribe"
mylist-unsubscribe: "|/home/sympa/bin/queue mylist-unsubscribe"

The address mylist-request should be the address of the person in charge of mylist list management (the list owner). Sympa will forward messages for mylist-request to the owner of list mylist defined in ~sympa/expl/mylist/config file. This feature avoids later changes to this alias when updating owner's addresses.

The address mylist-editor can be used as mylist-request to contact the list editors if defined in ~sympa/expl/mylist/config. This address definition is not mandatory.

The address mylist-owner is the address receiving non-delivery reports. bouncequeue program stores these messages in queuebounce directory. WWSympa ((see 1.2, page [*]) may then analyze them and provide a web access to them.

The address mylist-subscribe is for a fast and easy to explain subscription. Be carefull: subscription is so easy that spammer may subscribe by accident.

The address mylist-unsubscribe is for simple unsubscription. By the way, everything that simplifies unsubscription simplifies list administration.

8.2 List directory

Each list has its own directory which name defines the list name. We recommend to create it with the same name as the alias. This directory is located in the ~sympa/expl according bye defined in /etc/sympa.conf file.


8.3 List configuration file

The configuration file for the mylist list is named ~sympa/expl/mylist/config. Sympa reads it into memory the first time the list is referred to. This file is not rewritten by Sympa; as a result, it is possible to put comment lines in it. It is possible to change this file when the program is running. Changes are then taken into account the next time the list is accessed. Be careful to provide read access for Sympa on this file !

You will find a few configuration files in sample directory. Copy one of them to ~sympa/expl/mylist/config and customize it.

List configuration parameters are reviewed in list creation section, 10, page [*].

8.4 Examples of configuration files

This first example is for a list open to everyone:

subject First example (an open list)

visibility noconceal

owner
email Pierre.David@prism.uvsq.fr

send public

review public

The second example is for a moderated list with authentified subscription:

subject Second example (a moderated list)

visibility noconceal

owner
email moi@ici.fr

editor
email big.prof@ailleurs.edu

send editor

subscribe auth

review owner

reply_to list

cookie 142cleliste

The third example is for a moderated list, with subscription controlled by the owner, and running in digest mode. Subscribers who are in digest mode receive the mail on Monday and Thursday.

owner
email moi@ici.fr

editor
email prof@ailleurs.edu

send editor

subscribe owner

review owner

reply\_to list

digest 1,4 12:00


8.5 Subscribers file

WARNING: Sympa will not use this file if the list is configured in include or database user_data_source.

The ~sympa/expl/mylist/subscribers file is created and is automatically filled in. It contains information about list subscribers. It is not advisable to edit this file. Main parameters are:

8.6 Info file

~sympa/expl/mylist/info should contain a detailed text description of the list. If is used by INFO command. It can also be referenced from template files for service messages.

8.7 Homepage file

~sympa/expl/mylist/homepage is the HTML text on the WWSympa info page for the list.


8.8 List template files

These files are used by Sympa as service messages for commands such as SUB, ADD, SIG, DEL, REJECT. These files are interpreted (parsed) by Sympa and respect the template format ; every file has the .tpl extension. See 7.1, page [*].

Sympa looks for these files in the following order :

1.
~sympa/expl/mylist/<file>.tpl
2.
~sympa/etc/templates/<file>.tpl.
3.
~sympa/bin/etc/templates/<file>.tpl.

If the file starts with a From: line it is considered as a full message and will be sent (after parsing) without adding SMTP headers. Else file is taken as a text/plain message body.

The following variables may be used in list template files :

-
[conf->email] : sympa email address local part

-
[conf->host] : sympa host name

-
[conf->sympa] : sympa's complete email address

-
[conf->wwsympa_url] : WWSympa root URL

-
[conf->listmaster] : listmaster email addresses

-
[list->name] : list name

-
[list->host] : list hostname

-
[list->lang] : list language

-
[list->subject] : list subject

-
[list->owner] : list owners table hash

-
[user->email] : user email address

-
[user->gecos] : user gecos field (usually his/her name)

-
[user->password] : user password

-
[user->lang] : user language

You may also dynamically include a file from a template using the [INCLUDE] directive.

Example:

Dear [user->email],

Welcome to list [list->name.@[list->host].

Presentation of the list :
[INCLUDE 'info']

Owners of liste [list->name] are :
[FOREACH ow IN list->owner]
   [ow->gecos] <[ow->email]>
[END]

8.8.1 welcome.tpl

Sympa will send a welcome message for each subscription. The welcome message can be customized for each list.

8.8.2 bye.tpl

Sympa will send an unsubscription message for each received SIGNOFF mail command.

8.8.3 removed.tpl

This message is sent to users that have been deleted (using DELETE command) from the list by the list owner.

8.8.4 reject.tpl

Sympa will send a reject message to the sender of a message that is rejected par the list editor. If the editor prefixe the REJECT with the keyword QUIET, the reject message is not sent.

8.8.5 invite.tpl

This message is sent to users that have been invited (using INVITE command) to subscribe to a list.

You may use additional variables

-
[requested_by] : email of the person who sent the INVITE command

-
[url] : the mailto: URL to subscribe to the list

8.8.6 remind.tpl

This file contains a message which is sent to each subscriber when one of the list owners sends the command REMIND (see 11.2, page [*]).


8.9 Stats file

~sympa/expl/mylist/stats is a text file containing statistics about the list. These informations are numerics separated by white spaces within a single line :


8.10 Message header and footer

You may create ~sympa/expl/mylist/message.header and ~sympa/expl/mylist/message.footer files. Their content is added, either at the beginning or at the end of each message before the distribution process.

footer_type list parameter defines whether to attach the header/footer content as a MIME part (except for multipart/alternative messages) or to append them to the message body (if a text/plain message).

8.10.1 Archives directory

~sympa/expl/mylist/archives/ directory contains the archived messages if the list is archived, see 10.6.1, page [*]. The files are named in accordance with the frequency of archiving defined with the archive parameter.


next up previous contents index
Next: 9. Creating and editing mailing using Up: Sympa Automatic Multi-posting System Previous: 7. Customizing Sympa/WWSympa   Contents   Index
root
2000-06-27