Template files within Sympa used to be in a proprietary format that has been replaced with the TT2 template format.
You will find detailed documentation about the TT2 syntax on the web site : http://www.tt2.org
Here are some aspects regarding templates that are specific to Sympa:
These files are used by Sympa as service messages for the HELP,
LISTS and REMIND * commands. These files are interpreted
(parsed) by Sympa and respect the TT2 template format ; every file has a .tt2 extension.
See 16.1,
page .
Sympa looks for these files in the following order (where <list> is the listname if defined, <action> is the name of the command, and <lang> is the preferred language of the user) :
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. Otherwise the file is treated as a text/plain message body.
The following variables may be used in these template files :
This file is sent in response to a HELP command. You may use additional variables
File returned by LISTS command. An additional variable is available :
Example:
These are the public lists for [conf->email]@[conf->domain] [% FOREACH l = lists %] [% l.key %]@[% l.value.host %] : [% l.value.subject %] [% END %]
This file is sent in response to a REMIND * command.
(see 27.2, page )
You may use additional variables
Example:
This is a subscription reminder. You are subscribed to the following lists : [% FOREACH l = lists %] [% l %] : [% conf.wwsympa\_url \%]/info/[% l %] [% END %] Your subscriber e-mail : [% user.email %] Your password : [% user.password %]
This message is sent to warn the sender of a virus infected mail,
indicating the name of the virus found
(see , page
).
You may define your own web template files, different from the standard ones. WWSympa first looks for list specific web templates, then for site web templates, before falling back on its defaults.
Your list web template files should be placed in the /home/sympa/expl/mylist/web_tt2 directory ; your site web templates in ~/home/sympa/etc/web_tt2 directory.
Note that web colors are defined in Sympa's main Makefile (see 3.3,
page ).
Sympa was originally designed as a multilingual Mailing List Manager. Even in its earliest versions, Sympa separated messages from the code itself, messages being stored in NLS catalogues (according to the XPG4 standard). Later a lang list parameter was introduced. Nowadays Sympa is able to keep track of individual users' language preferences.
If you are willing to provide Sympa into your native language, please check the translation howto (http://www.sympa.org/howtotranslate.html);
Every message sent by Sympa to users, owners and editors is outside the code, in a message catalog. These catalogs are located in the /home/sympa/locale directory.
To tell Sympa to use a particular message catalog, you can should set the lang parameter in sympa.conf.
The lang list parameter defines the language for a list. It is currently used by WWSympa and to initialize users' language preferences at subscription time.
In future versions, all messages returned by Sympa concerning a list should be in the list's language.
The user language preference is currently used by WWSympa only. There is no e-mail-based command for a user to set his/her language. The language preference is initialized when the user subscribes to his/her first list. WWSympa allows the user to change it.
WWSympa's homepage shows a list of topics for classifying mailing lists. This is dynamically generated using the different lists' topics configuration parameters. A list may appear in multiple categories (This parameter is different from msg_topic used to tag list messages)
The list of topics is defined in the topics.conf configuration file, located in the /home/sympa/etc directory. The format of this file is as follows :
<topic1_name> title <topic1 title> title.fr <topic french title> visibility <topic1 visibility> .... <topicn_name/subtopic_name> title <topicn title> title.de <topicn german title>
You will notice that subtopics can be used, the separator being /. The topic name is composed of alphanumerics (0-1a-zA-Z) or underscores (_). The order in which the topics are listed is respected in WWSympa's homepage. The visibility line defines who can view the topic (now available for subtopics). It refers to the associated topics_visibility authorization scenario. You will find a sample topics.conf in the sample directory ; NONE is installed as the default.
A default topic is hard-coded in Sympa: default. This default topic contains all lists for which a topic has not been specified.
See 13, page .
Sympa uses multiple heuristics to avoid loops in Mailing lists
First, it rejects messages coming from a robot (as indicated by the From: and other header fields), and messages containing commands.
Secondly, every message sent by Sympa includes an X-Loop header field set to the listname. If the message comes back, Sympa will detect that it has already been sent (unless X-Loop header fields have been erased).
Thirdly, Sympa keeps track of Message IDs and will refuse to send multiple messages with the same message ID to the same mailing list.
Finally, Sympa detect loops arising from command reports (i.e. sympa-generated replies to commands). This sort of loop might occur as follows:
1 - X sends a command to Sympa 2 - Sympa sends a command report to X 3 - X has installed a home-made vacation program replying to programs 4 - Sympa processes the reply and sends a report 5 - Looping to step 3
Sympa keeps track (via an internal counter) of reports sent to any particular address. The loop detection algorithm is :
A task is a sequence of simple actions which realize a complex routine. It is executed in background by the task manager daemon and allow the list master to automate the processing of recurrent tasks. For example a task sends every year the subscribers of a list a message to remind their subscription.
A task is created with a task model. It is a text file which describes a sequence of simple actions. It may have different versions (for instance reminding subscribers every year or semester). A task model file name has the following format : <model name>.<model version>.task. For instance remind.annual.task or remind.semestrial.task.
Sympa provides several task models stored in /home/sympa/bin/etc/global_task_models and /home/sympa/bin/etc/list_task_models directories. Others can be designed by the listmaster.
A task is global or related to a list.
You define in the list config file the model and the version you want to use (see
20.3.5, page ). Then the task manager daemon will automatically
create the task by looking for the appropriate model file in different directories in the
following order :
See also 17.10, page , to know more about standard list models provided with Sympa.
The task manager daemon checks if a version of a global task model is specified in sympa.conf and then creates a task as soon as it finds the model file by looking in different directories in the following order :
Model files are composed of comments, labels, references, variables, date values and commands. All those syntactical elements are composed of alphanumerics (0-9a-zA-Z) and underscores (_).
Here is the list of current avalable commands :
Stops the execution of the task and delete the task file
Stop the execution. The task will go on at the date value and begin at the label line.
Delete @user_selection email list and stores user emails successfully deleted in @deleted_users.
Send the template message to emails stored in @user_selection.
Store emails which match the condition in @user_selection. See 8.6 Authorization Scenarios section to know how to write conditions. Only available for list models.
Create a task for object with model file ~model type.model.task.
Send the template message to emails whose certificate has expired or will expire before the date value.
Update certificate revocation lists (CRL) which are expired or will expire before the date value. The file stores the CRL's URLs.
Clean bounces by removing unsubscribed-users archives.
Evaluate all bouncing users of all list and give them a score from 0 to 100. (0 = no bounces for this user, 100 is for users who should be removed).
Execute actions defined in list configuration on each bouncing users, according to their score.
Model files may have a scenario-like title line at the beginning.
When you change a configuration file by hand, and a task parameter is created or modified, it is up to you to remove existing task files in the task/ spool if needed. Task file names have the following format :
<date>.<label>.<model name>.<list name | global> where :
title.gettext daily update of the certificate revocation list /ACTION update_crl (CA_list, [execution_date]+1d) next ([execution_date] + 1d, ACTION)