Skip to Content.
Sympa Menu

Documentation for Sympa

NAME

sympa_config - Configuration files for Sympa mailing list manager

DESCRIPTION

There are three levels in Sympa’s main configuration: site global, mail domain and list.

sympa.conf: Configuration file for global settings

/etc/sympa/sympa.conf is main configuration file of Sympa. Several parameters defined in this file may be overridden by robot.conf configuration file for each virtual domain, or by config configuration file for each mailing list.

Format of sympa.conf and robot.conf is as following:

robot.conf: Optional configuration file for the mail domain

robot.conf is the optional configuration file for each mail domain.

Format of robot.conf is the same as sympa.conf above.

config: Configuration file for the mailing list

config is main configuration file of each mailing list.

Format of config is as following:

PARAMETERS

Below is entire list of configuration parameters.

Service description

domain

Primary mail domain name

Example:

domain mail.example.org

listmaster

Email addresses of listmasters

Email addresses of the listmasters (users authorized to perform global server commands). Some error reports may also be sent to these addresses. Listmasters can be defined for each virtual host, however, the default listmasters will have privileges to manage all virtual hosts.

Example:

listmaster your_email_address@domain.tld

supported_lang

Supported languages

All supported languages for the user interface. Languages proper locale information not installed are ignored.

title

Title of service

The name of your mailing list service. It will appear in the header of web interface and subjects of several service messages.

gecos

Display name of Sympa

This parameter is used for display name in the “From:” header field for the messages sent by Sympa itself.

legacy_character_support_feature

Support of legacy character set

If set to “on”, enables support of legacy character set according to charset.conf(5) configuration file.

In some language environments, legacy encoding (character set) can be preferred for e-mail messages: for example iso-2022-jp in Japanese language.

update_db_field_types

Update database structure

auto: Updates database table structures automatically.

However, since version 5.3b.5, Sympa will not shorten field size if it already have been longer than the size defined in database definition.

db_type

Type of the database

Possible types are “MySQL”, “PostgreSQL”, “Oracle” and “SQLite”.

db_name

Name of the database

With SQLite, this must be the full path to database file.

With Oracle Database, this must be SID, net service name or easy connection identifier (to use net service name, db_host should be set to “none” and HOST, PORT and SERVICE_NAME should be defined in tnsnames.ora file).

db_host

Hostname of the database server

With PostgreSQL, you can also use the path to Unix Socket Directory, e.g. “/var/run/postgresql” for connection with Unix domain socket.

Example:

db_host localhost

db_port

Port of the database server

db_user

User for the database connection

Example:

db_user sympa

db_passwd

Password for the database connection

What ever you use a password or not, you must protect the SQL server (is it not a public internet service ?)

Example:

db_passwd your_passwd

db_options

Database options

If these options are defined, they will be appended to data source name (DSN) fed to database driver. Check the related DBD documentation to learn about the available options.

Example:

db_options mysql_read_default_file=/home/joe/my.cnf;mysql_socket=tmp/mysql.sock-test

db_env

Environment variables setting for database

With Oracle Database, this is useful for defining ORACLE_HOME and NLS_LANG.

Example:

db_env NLS_LANG=American_America.AL32UTF8;ORACLE_HOME=/u01/app/oracle/product/11.2.0/server

db_timeout

Database processing timeout

Currently, this parameter may be used for SQLite only.

db_additional_subscriber_fields

Database private extension to subscriber table

Adds more fields to “subscriber_table” table. Sympa recognizes fields defined with this parameter. You will then be able to use them from within templates and scenarios:

* for scenarios: [subscriber->field]

* for templates: [% subscriber.field %]

These fields will also appear in the list members review page and will be editable by the list owner. This parameter is a comma-separated list.

You need to extend the database format with these fields

Example:

db_additional_subscriber_fields billing_delay,subscription_expiration

db_additional_user_fields

Database private extension to user table

Adds more fields to “user_table” table. Sympa recognizes fields defined with this parameter. You will then be able to use them from within templates: [% subscriber.field %]

This parameter is a comma-separated list.

You need to extend the database format with these fields

Example:

db_additional_user_fields age,address

System log

syslog

System log facility for Sympa

Do not forget to configure syslog server.

log_socket_type

Communication mode with syslog server

log_level

Log verbosity

Sets the verbosity of logs.

0: Only main operations are logged

3: Almost everything is logged.

Example:

log_level 2

Mail server

sendmail

Path to sendmail

Absolute path to sendmail command line utility (e.g.: a binary named “sendmail” is distributed with Postfix).

Sympa expects this binary to be sendmail compatible (exim, Postfix, qmail and so on provide it).

sendmail_args

Command line parameters passed to sendmail

Note that “-f”, “-N” and “-V” options and recipient addresses should not be included, because they will be included by Sympa.

sendmail_aliases

Path of the file that contains all list related aliases

It is recommended to create a specific alias file so that Sympa never overwrites the standard alias file, but only a dedicated file.

Set this parameter to “none” if you want to disable alias management in Sympa.

aliases_program

Program used to update alias database

This may be “makemap”, “newaliases”, “postalias”, “postmap” or full path to custom program.

aliases_wrapper

Whether to use the alias wrapper

If the program to update alias database does not require root privileges, set this parameter to “off” and remove the wrapper file sympa_newaliases-wrapper.

aliases_db_type

Type of alias database

“btree”, “dbm”, “hash” and so on. Available when aliases_program is “makemap”, “postalias” or “postmap”

alias_manager

Path to alias manager

The absolute path to the script that will add/remove mail aliases

Example:

alias_manager /usr/local/libexec/ldap_alias_manager.pl

List definition

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.

visibility

Visibility of the list

This parameter indicates whether the list should feature in the output generated in response to a LISTS command or should be shown in the list overview of the web-interface.

topics

Topics for the list

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.

lang

Language of the list

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

family_name

Family name

max_list_members

Maximum number of list members

limit for the number of subscribers. 0 means no limit.

priority

Priority

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. The z priority will freeze the message in the spool.

Receiving

sender_headers

Header field name(s) used to determine sender of the messages

“Return-Path” means envelope sender (a.k.a. “UNIX From”) which will be alternative to sender of messages without “From” field. “Resent-From” may also be inserted before “From”, because some mailers add it into redirected messages and keep original “From” field intact. In particular cases, “Return-Path” can not give right sender: Several mail gateway products rewrite envelope sender and add original one as non-standard field such as “X-Envelope-From”. If that is the case, you might want to insert it in place of “Return-Path”.

Example:

sender_headers Resent-From,From,Return-Path

misaddressed_commands

Reject misaddressed commands

When a mail command is sent to a list, by default Sympa rejects this message. This feature can be turned off by setting this parameter to “ignore”.

misaddressed_commands_regexp

Regular expression matching with misaddressed commands

Perl regular expression applied on messages subject and body to detect misaddressed commands.

sympa_priority

Priority for command messages

Priority applied to messages sent to Sympa command address.

request_priority

Priority for messages bound for list owners

Priority for processing of messages bound for “LIST-request” address, i.e. owners of the list

owner_priority

Priority for non-VERP bounces

Priority for processing of messages bound for “LIST-owner” address, i.e. non-delivery reports (bounces).

incoming_max_count

Max number of sympa_msg.pl workers

Max number of workers of sympa_msg.pl daemon processing incoming spool.

sleep

Interval between scanning incoming message spool

Must not be 0.

Sending/receiving setup

send

Who can send messages

This parameter specifies who can send messages to the list.

delivery_time

Delivery time (hh:mm)

If this parameter is present, non-digest messages will be delivered to subscribers at this time: When this time has been past, delivery is postponed to the same time in next day.

digest

(Paragraph) Digest frequency

Definition of digest mode. If this parameter is present, subscribers can select the option of receiving messages in multipart/digest MIME format, or as a plain text digest. Messages are then grouped together, and compiled messages are sent to subscribers according to the frequency selected with this parameter.

digest.days

days

digest.hour

hour

digest.minute

minute

digest_max_size

Digest maximum number of messages

available_user_options

(Paragraph) Available subscription options

available_user_options.reception

reception mode

Only these modes will be allowed for the subscribers of this list. If a subscriber has a reception mode not in the list, Sympa uses the mode specified in the default_user_options paragraph.

default_user_options

(Paragraph) Subscription profile

Default profile for the subscribers of the list.

default_user_options.reception

reception mode

Mail reception mode.

default_user_options.visibility

visibility

Visibility of the subscriber.

msg_topic

(Paragraph) Topics for message categorization

This paragraph defines a topic used to tag a message of a list, named by msg_topic.name (“other” is a reserved word), its title is msg_topic.title. The msg_topic.keywords entry is optional and allows automatic tagging. This should be a list of keywords, separated by ‘,’.

msg_topic.name

Message topic name

msg_topic.keywords

Message topic keywords

msg_topic.title

Message topic title

msg_topic_keywords_apply_on

Defines to which part of messages topic keywords are applied

This parameter indicates which part of the message is used to perform automatic tagging.

msg_topic_tagging

Message tagging

This parameter indicates if the tagging is optional or required for a list.

reply_to_header

(Paragraph) Reply address

This defines what Sympa will place in the Reply-To: SMTP header field of the messages it distributes.

reply_to_header.value

value

This parameter indicates whether the Reply-To: field should indicate the sender of the message (sender), the list itself (list), both list and sender (all) or an arbitrary e-mail address (defined by the other_email parameter).

Note: it is inadvisable to change this parameter, and particularly inadvisable to set it to list. Experience has shown it to be almost inevitable that users, mistakenly believing that they are replying only to the sender, will send private messages to a list. This can lead, at the very least, to embarrassment, and sometimes to more serious consequences.

reply_to_header.other_email

other email address

If value was set to other_email, this parameter defines the e-mail address used.

reply_to_header.apply

respect of existing header field

The default is to respect (preserve) the existing Reply-To: SMTP header field in incoming messages. If set to forced, Reply-To: SMTP header field will be overwritten.

anonymous_sender

Anonymous sender

To hide the sender’s email address before distributing the message. It is replaced by the provided email address.

anonymous_header_fields

Header fields removed when a mailing list is setup in anonymous mode

custom_header

Custom header field

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.

custom_subject

Subject tagging

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). This string will be surrounded by [] characters.

Attachment type

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.

mime:

The default value. Sympa will add the footer/header as a new MIME part.

append:

Sympa will not create new MIME parts, but will try to append the header/footer to the body of the message. Predefined message-footers will be ignored.

max_size

Maximum message size

Maximum size of a message in 8-bit bytes.

Example:

max_size 2097152

personalization_feature

Allow message personalization

personalization

(Paragraph) Message personalization

personalization.web_apply_on

Scope for messages from the web interface

personalization.mail_apply_on

Scope for messages from incoming email

message_hook

(Paragraph) Hook modules for message processing

message_hook.pre_distribute

A hook on the messages before distribution

message_hook.post_archive

A hook on the messages just after archiving

reject_mail_from_automates_feature

Reject mail from automatic processes (crontab, etc)?

Rejects messages that seem to be from automated services, based on a few header fields (“Content-Identifier:”, “Auto-Submitted:”).

Sympa also can be configured to reject messages based on the “From:” header field value (see “loop_prevention_regex”).

remove_headers

Header fields to be removed from incoming messages

Use it, for example, to ensure some privacy for your users in case that “anonymous_sender” mode is inappropriate.

The removal of these header fields is applied before Sympa adds its own header fields (“rfc2369_header_fields” and “custom_header”).

Example:

remove_headers Resent-Date,Resent-From,Resent-To,Resent-Message-Id,Sender,Delivered-To

remove_outgoing_headers

Header fields to be removed before message distribution

The removal happens after Sympa’s own header fields are added; therefore, it is a convenient way to remove Sympa’s own header fields (like “X-Loop:” or “X-no-archive:”) if you wish.

Example:

remove_outgoing_headers X-no-archive

rfc2369_header_fields

RFC 2369 header fields

Specify which RFC 2369 mailing list header fields to be added.

“List-Id:” header field defined in RFC 2919 is always added. Sympa also adds “Archived-At:” header field defined in RFC 5064.

Distribution

urlize_min_size

Minimum size to be urlized

When a subscriber chose “urlize” reception mode, attachments not smaller than this size will be urlized.

allowed_external_origin

Allowed external links in sanitized HTML

When the HTML content of a message must be sanitized, links (“href” or “src” attributes) with the hosts listed in this parameter will not be scrubbed. If “*” character is included, it matches any subdomains. Single “*” allows any hosts.

Example:

allowed_external_origin *.example.org,www.example.com

sympa_packet_priority

Default priority for a packet

The default priority set to a packet to be sent by the bulk.

bulk_fork_threshold

Fork threshold of bulk daemon

The minimum number of packets before bulk daemon forks a new worker to increase sending rate.

bulk_max_count

Maximum number of bulk workers

bulk_lazytime

Idle timeout of bulk workers

The number of seconds a bulk worker will remain running without processing a message before it spontaneously exits.

bulk_sleep

Sleep time of bulk workers

The number of seconds a bulk worker sleeps between starting a new loop if it didn’t find a message to send.

Keep it small if you want your server to be reactive.

bulk_wait_to_fork

Interval between checks of packet numbers

Number of seconds a master bulk daemon waits between two packets number checks.

Keep it small if you expect brutal increases in the message sending load.

log_smtp

Log invocation of sendmail

This can be overwritten by “-m” option for sympa.pl.

maxsmtp

Maximum number of sendmail processes

Maximum number of simultaneous child processes spawned by Sympa. This is the main load control parameter.

Proposed value is quite low, but you can rise it up to 100, 200 or even 300 with powerful systems.

Example:

maxsmtp 500

nrcpt

Maximum number of recipients per call to sendmail

This grouping factor makes it possible for the sendmail processes to optimize the number of SMTP sessions for message distribution. If needed, you can limit the number of recipients for a particular domain. Check the “nrcpt_by_domain.conf” configuration file.

avg

Maximum number of different mail domains per call to sendmail

Privileges

create_list

Who is able to create lists

Defines who can create lists (or request list creation) by creating new lists or by renaming or copying existing lists.

Example:

create_list listmaster

allow_subscribe_if_pending

Allow adding subscribers to a list not open

If set to “off”, adding subscribers to, or removing subscribers from a list with status other than “open” is forbidden.

global_remind

Who is able to send remind messages over all lists

move_user

Who is able to change user’s email

use_blocklist

Use blocklist

List of operations separated by comma for which blocklist filter is applied. Setting this parameter to “none” will hide the blocklist feature.

info

Who can view list information

subscribe

Who can subscribe to the list

The subscribe parameter defines the rules for subscribing to the list.

add

Who can add subscribers

Privilege for adding (ADD command) a subscriber to the list

unsubscribe

Who can unsubscribe

This parameter specifies the unsubscription method for the list. Use open_notify or auth_notify to allow owner notification of each unsubscribe command.

del

Who can delete subscribers

invite

Who can invite people

remind

Who can start a remind process

This parameter specifies who is authorized to use the remind command.

review

Who can review subscribers

This parameter specifies who can access the list of members. Since subscriber addresses can be abused by spammers, it is strongly recommended that you only authorize owners or subscribers to access the subscriber list.

owner_domain

Required domains for list owners

Restrict list ownership to addresses in the specified domains. This can be used to reserve list ownership to a group of trusted users from a set of domains associated with an organization, while allowing moderators and subscribers from the Internet at large.

owner_domain_min

Minimum owners in required domains

Minimum number of owners for each list must satisfy the owner_domain restriction. The default of zero (0) means *all* list owners must match. Setting to 1 requires only one list owner to match owner_domain; all other owners can be from any domain. This setting can be used to ensure that there is always at least one known contact point for any mailing list.

default_owner_options

(Paragraph) Owner profile

Default profile for the owners of the list.

default_owner_options.profile

profile

default_owner_options.reception

reception mode

Mail reception mode.

default_owner_options.visibility

visibility

Visibility of the owner.

default_editor_options

(Paragraph) Moderator profile

Default profile for the moderators of the list.

default_editor_options.reception

reception mode

Mail reception mode.

default_editor_options.visibility

visibility

Visibility of the moderator.

Archives

ignore_x_no_archive_header_feature

Ignore “X-no-archive:” header field

Sympa’s default behavior is to skip archiving of incoming messages that have an “X-no-archive:” header field set. This parameter allows one to change this behavior.

Example:

ignore_x_no_archive_header_feature on

custom_archiver

Custom archiver

Activates a custom archiver to use instead of MHonArc. The value of this parameter is the absolute path to the executable file.

Sympa invokes this file with these two arguments:

--list

The address of the list including domain part.

--file

Absolute path to the message to be archived.

process_archive

Store distributed messages into archive

If enabled, distributed messages via lists will be archived. Otherwise archiving is disabled.

Note that even if setting this parameter disabled, past archives will not be removed and will be accessible according to access settings by each list.

archive

(Paragraph) Archives

Privilege for reading mail archives and frequency of archiving.

Defines who can access the list’s web archive.

archive.period

Deprecated.

archive.access

Deprecated.

archive.web_access

access right

archive.mail_access

access right by mail commands

archive.quota

quota

archive.max_month

Maximum number of month archived

archive_crypted_msg

Archive encrypted mails as cleartext

web_archive_spam_protection

Protect web archive against spam harvesters

The same as “spam_protection”, but restricted to the web archive.

In addition to it:

cookie: users must submit a small form in order to receive a cookie before browsing the web archive.

concealed: e-mail addresses will never be displayed.

Bounces

bounce

(Paragraph) Bounces management

bounce.warn_rate

warn rate

The list owner receives a warning whenever a message is distributed and the number (percentage) of bounces exceeds this value.

bounce.halt_rate

Deprecated.

bouncers_level1

(Paragraph) Management of bouncers, 1st level

Level 1 is the lower level of bouncing users

bouncers_level1.rate

threshold

Each bouncing user have a score (from 0 to 100).

This parameter defines a lower limit for each category of bouncing users.For example, level 1 begins from 45 to level_2_treshold.

bouncers_level1.action

action for this population

This parameter defines which task is automatically applied on level 1 bouncers.

bouncers_level1.notification

notification

When automatic task is executed on level 1 bouncers, a notification email can be send to listowner or listmaster.

bouncers_level2

(Paragraph) Management of bouncers, 2nd level

Level 2 is the highest level of bouncing users

bouncers_level2.rate

threshold

Each bouncing user have a score (from 0 to 100).

This parameter defines the score range defining each category of bouncing users.For example, level 2 is for users with a score between 80 and 100.

bouncers_level2.action

action for this population

This parameter defines which task is automatically applied on level 2 bouncers.

bouncers_level2.notification

notification

When automatic task is executed on level 2 bouncers, a notification email can be send to listowner or listmaster.

verp_rate

percentage of list members in VERP mode

Uses variable envelope return path (VERP) to detect bouncing subscriber addresses.

0%: VERP is never used.

100%: VERP is always in use.

VERP requires address with extension to be supported by MTA. If tracking is enabled for a list or a message, VERP is applied for 100% of subscribers.

tracking

(Paragraph) Message tracking feature

tracking.delivery_status_notification

tracking message by delivery status notification

tracking.message_disposition_notification

tracking message by message disposition notification

tracking.tracking

who can view message tracking

tracking.retention_period

Tracking datas are removed after this number of days

tracking.message_delivery_notification

See tracking.message_disposition_notification.

verp_welcome

Remove bouncing new subscribers

If enabled, the welcome message is sent using VERP in order to remove the subscriber immediately in the case of a bounce.

verp_remind

Remove subscribers bouncing remind message

If enabled, the remind message is sent using VERP in order to remove the subscriber immediately in the case of a bounce.

expire_bounce_task

Task for expiration of old bounces

This task resets bouncing information for addresses not bouncing in the last 10 days after the latest message distribution.

purge_orphan_bounces_task

Task for cleaning invalidated bounces

This task deletes bounce information for unsubscribed users.

eval_bouncers_task

Task for updating bounce scores

This task scans all bouncing users for all lists, and updates “bounce_score_subscriber” field in “subscriber_table” table. The scores may be used for management of bouncers.

process_bouncers_task

Task for management of bouncers

This task executes actions on bouncing users configured by each list, according to their scores.

purge_tables_task

Task for cleaning tables

This task cleans old tracking information from “notification_table” table.

minimum_bouncing_count

Minimum number of bounces

The minimum number of bounces received to update bounce score of a user.

minimum_bouncing_period

Minimum bouncing period

The minimum period for which bouncing lasted to update bounce score of a user.

bounce_delay

Delay of bounces

Average time for a bounce sent back to mailing list server after a post was sent to a list. Usually bounces are sent back on the same day as the original message.

bounce_email_prefix

Prefix of VERP return address

The prefix to consist the return-path of probe messages used for bounce management, when variable envelope return path (VERP) is enabled. VERP requires address with extension to be supported by MTA.

If you change the default value, you must modify the mail aliases too.

return_path_suffix

Suffix of list return address

The suffix appended to the list name to form the return-path of messages distributed through the list. This address will receive all non-delivery reports (also called bounces).

Loop prevention

loop_command_max

Maximum number of responses to command message

The maximum number of command reports sent to an email address. Messages are stored in “bad” subdirectory of incoming message spool, and reports are not longer sent.

loop_command_sampling_delay

Delay before counting responses to command message

This parameter defines the delay in seconds before decrementing the counter of reports sent to an email address.

loop_command_decrease_factor

Decrementing factor of responses to command message

The decrementation factor (from 0 to 1), used to determine the new report counter after expiration of the delay.

msgid_table_cleanup_ttl

Expiration period of message ID table

Expiration period of entries in the table maintained by sympa_msg.pl daemon to prevent delivery of duplicate messages caused by loop.

msgid_table_cleanup_frequency

Cleanup interval of message ID table

Interval between cleanups of the table maintained by sympa_msg.pl daemon to prevent delivery of duplicate messages caused by loop.

Automatic lists

automatic_list_feature

Automatic list

automatic_list_removal

Remove empty automatic list

If set to “if_empty”, then Sympa will remove automatically created mailing lists just after their creation, if they contain no list member.

Example:

automatic_list_removal if_empty

automatic_list_creation

Who is able to create automatic list

automatic_list_families

Definition of automatic list families

Defines the families the automatic lists are based on. It is a character string structured as follows:

* each family is separated from the other by a semicolon (;)

* inside a family definition, each field is separated from the other by a colon (:)

* each field has the structure: “<field name>=<field value>”

Basically, each time Sympa uses the automatic lists families, the values defined in this parameter will be available in the family object.

* for scenarios: [family->name]

* for templates: [% family.name %]

Example:

automatic_list_families name=family_one:prefix=f1:display=My automatic lists:prefix_separator=+:classes separator=-:family_owners_list=alist@domain.tld;name=family_two:prefix=f2:display=My other automatic lists:prefix_separator=+:classes separator=-:family_owners_list=anotherlist@domain.tld;

parsed_family_files

Parsed files for families

comma-separated list of files that will be parsed by Sympa when instantiating a family (no space allowed in file names)

family_signoff

Global unsubscription

Tag based spam filtering

spam_status

Type of spam filter

Messages are supposed to be filtered by an spam filter that adds them one or more headers. This parameter is used to select a special scenario in order to decide the message’s spam status: ham, spam or unsure.

Directories

home

List home

Base directory of list configurations.

etc

Directory for configuration files

Base directory of global configuration (except “sympa.conf”).

spool

Base directory of spools

Base directory of all spools which are created at runtime. This directory must be writable by Sympa user.

queue

Directory for message incoming spool

This spool is used both by “queue” program and “sympa_msg.pl” daemon.

queuemod

Directory for moderation spool

queuedigest

Directory for digest spool

queueauth

Directory for held message spool

This parameter is named such by historical reason.

queueoutgoing

Directory for archive spool

This parameter is named such by historical reason.

queuesubscribe

Directory for held request spool

This parameter is named such by historical reason.

queuetopic

Directory for topic spool

queuebounce

Directory for bounce incoming spool

This spool is used both by “bouncequeue” program and “bounced.pl” daemon.

queuetask

Directory for task spool

queueautomatic

Directory for automatic list creation spool

This spool is used both by “familyqueue” program and “sympa_automatic.pl” daemon.

queuebulk

Directory for message outgoing spool

This parameter is named such by historical reason.

tmpdir

Temporary directory used by external programs such as virus scanner. Also, outputs to daemons’ standard error are redirected to the files under this directory.

viewmail_dir

Directory to cache formatted messages

Base directory path of directories where HTML view of messages are cached.

bounce_path

Directory for storing bounces

The directory where bounced.pl daemon will store the last bouncing message for each user. A message is stored in the file: <bounce_path>/<list name>@<mail domain name>/<email address>, or, if tracking is enabled: <bounce_path>/<list name>@<mail domain name>/<email address>_<envelope ID>.

Users can access to these messages using web interface in the bounce management page.

Don’t confuse with “queuebounce” parameter which defines the spool where incoming error reports are stored and picked by bounced.pl daemon.

arc_path

Directory for storing archives

Where to store HTML archives. This parameter is used by the “archived.pl” daemon. It is a good idea to install the archive outside the web document hierarchy to prevent overcoming of WWSympa’s access control.

purge_spools_task

Task for cleaning spools

This task cleans old content in spools.

clean_delay_queue

Max age of incoming bad messages

Number of days “bad” messages are kept in message incoming spool (as specified by “queue” parameter). Sympa keeps messages rejected for various reasons (badly formatted, looping etc.).

clean_delay_queueoutgoing

Max age of bad messages for archives

Number of days “bad” messages are kept in message archive spool (as specified by “queueoutgoing” parameter). Sympa keeps messages rejected for various reasons (unable to create archive directory, to copy file etc.).

clean_delay_queuebounce

Max age of bad bounce messages

Number of days “bad” messages are kept in bounce spool (as specified by “queuebounce” parameter). Sympa keeps messages rejected for various reasons (unknown original sender, unknown report type).

clean_delay_queueauth

Max age of held messages

Number of days messages are kept in held message spool (as specified by “queueauth” parameter). Beyond this deadline, messages that have not been confirmed are deleted.

clean_delay_queuesubscribe

Max age of held requests

Number of days requests are kept in held request spool (as specified by “queuesubscribe” parameter). Beyond this deadline, requests that have not been validated nor declined are deleted.

clean_delay_queuetopic

Max age of tagged topics

Number of days (automatically or manually) tagged topics are kept in topic spool (as specified by “queuetopic” parameter). Beyond this deadline, tagging is forgotten.

clean_delay_queueautomatic

Max age of incoming bad messages in automatic list creation spool

Number of days “bad” messages are kept in automatic list creation spool (as specified by “queueautomatic” parameter). Sympa keeps messages rejected for various reasons (badly formatted, looping etc.).

clean_delay_queuebulk

Max age of outgoing bad messages

Number of days “bad” messages are kept in message outgoing spool (as specified by “queuebulk” parameter). Sympa keeps messages rejected for various reasons (failed personalization, bad configuration on MTA etc.).

clean_delay_queuedigest

Max age of bad messages in digest spool

Number of days “bad” messages are kept in digest spool (as specified by “queuedigest” parameter). Sympa keeps messages rejected for various reasons (syntax errors in “digest.tt2” template etc.).

clean_delay_tmpdir

Max age of temporary files

Number of days files in temporary directory (as specified by “tmpdir” parameter), including standard error logs, are kept.

S/MIME and TLS

S/MIME authentication, decryption and re-encryption. It requires these external modules: Crypt-OpenSSL-X509 and Crypt-SMIME.

TLS client authentication. It requires an external module: IO-Socket-SSL.

cafile

File containing trusted CA certificates

This can be used alternatively and/or additionally to “capath”.

capath

Directory containing trusted CA certificates

CA certificates in this directory are used for client authentication.

The certificates need to have names including hash of subject, or symbolic links to them with such names. The links may be created by using “c_rehash” script bundled in OpenSSL.

key_passwd

Password used to crypt lists private keys

If not defined, Sympa assumes that list private keys are not encrypted.

Example:

key_passwd your_password

ssl_cert_dir

Directory containing user certificates

Data sources setup

Including subscribers, owners and moderators from data sources. Appropriate database driver (DBD) modules are required: DBD-CSV, DBD-mysql, DBD-ODBC, DBD-Oracle, DBD-Pg, DBD-SQLite and/or Net-LDAP. And also, if secure connection (LDAPS) to LDAP server is required: IO-Socket-SSL.

inclusion_notification_feature

Notify subscribers when they are included from a data source?

member_include

(Paragraph) Subscribers defined in an external data source

member_include.source

the data source

member_include.source_parameters

data source parameters

member_include.reception

reception mode

Mail reception mode.

member_include.visibility

visibility

Visibility of the subscriber.

owner_include

(Paragraph) Owners defined in an external data source

owner_include.source

the data source

owner_include.source_parameters

data source parameters

owner_include.profile

profile

owner_include.reception

reception mode

owner_include.visibility

visibility

editor_include

(Paragraph) Moderators defined in an external data source

editor_include.source

the data source

editor_include.source_parameters

data source parameters

editor_include.reception

reception mode

editor_include.visibility

visibility

sql_fetch_timeout

Timeout for fetch of include_sql_query

include_file

File inclusion

Include subscribers from this file. The file should contain one e-mail address per line (lines beginning with a “#” are ignored).

include_remote_file

(Paragraph) Remote file inclusion

include_remote_file.name

short name for this source

include_remote_file.url

data location URL

include_remote_file.user

remote user

include_remote_file.passwd

remote password

include_remote_file.timeout

idle timeout

include_remote_file.ssl_version

SSL version

include_remote_file.ssl_ciphers

SSL ciphers used

include_remote_file.ca_verify

Certificate verification

include_remote_file.nosync_time_ranges

Time ranges when inclusion is not allowed

include_sympa_list

(Paragraph) List inclusion

Include subscribers from other list. All subscribers of list listname become subscribers of the current list. You may include as many lists as required, using one include_sympa_list paragraph for each included list. Any list at all may be included; 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 to an infinite loop.

include_sympa_list.name

short name for this source

include_sympa_list.listname

list name to include

include_sympa_list.filter

filter definition

include_sympa_list.nosync_time_ranges

Time ranges when inclusion is not allowed

include_remote_sympa_list

(Paragraph) remote list inclusion

Sympa can contact another Sympa service using HTTPS to fetch a remote list in order to include each member of a remote list as subscriber. You may include as many lists as required, using one include_remote_sympa_list paragraph for each included list. Be careful, however, not to give rise to an infinite loop resulting from cross includes.

For this operation, one Sympa site acts as a server while the other one acs as client. On the server side, the only setting needed is to give permission to the remote Sympa to review the list. This is controlled by the review scenario.

include_remote_sympa_list.name

short name for this source

include_remote_sympa_list.url

data location URL

include_remote_sympa_list.user

remote user

include_remote_sympa_list.passwd

remote password

include_remote_sympa_list.host

remote host

obsoleted. Use “data location URL”.

include_remote_sympa_list.port

remote port

obsoleted. Use “data location URL”.

include_remote_sympa_list.path

remote path of sympa list dump

obsoleted. Use “data location URL”.

include_remote_sympa_list.cert

Deprecated.

include_remote_sympa_list.timeout

idle timeout

include_remote_sympa_list.ssl_version

SSL version

include_remote_sympa_list.ssl_ciphers

SSL ciphers used

include_remote_sympa_list.ca_verify

Certificate verification

include_remote_sympa_list.nosync_time_ranges

Time ranges when inclusion is not allowed

include_ldap_query

(Paragraph) LDAP query inclusion

This paragraph defines parameters for a query returning a list of subscribers. This feature requires the Net::LDAP (perlldap) PERL module.

include_ldap_query.name

short name for this source

include_ldap_query.host

remote host

include_ldap_query.use_tls

use TLS (formerly SSL)

include_ldap_query.ssl_version

SSL version

include_ldap_query.ssl_ciphers

SSL ciphers used

include_ldap_query.ca_verify

Certificate verification

include_ldap_query.bind_dn

remote user

include_ldap_query.bind_password

remote password

include_ldap_query.suffix

suffix

include_ldap_query.scope

search scope

include_ldap_query.timeout

connection timeout

include_ldap_query.filter

filter

include_ldap_query.attrs

extracted attribute

include_ldap_query.select

selection (if multiple)

include_ldap_query.regex

regular expression

include_ldap_query.nosync_time_ranges

Time ranges when inclusion is not allowed

include_ldap_query.passwd

See include_ldap_query.bind_password.

include_ldap_query.port

Deprecated.

include_ldap_query.use_ssl

See include_ldap_query.use_tls.

include_ldap_query.user

See include_ldap_query.bind_dn.

include_ldap_2level_query

(Paragraph) LDAP 2-level query inclusion

This paragraph defines parameters for a two-level query returning a list of subscribers. Usually the first-level query returns a list of DNs and the second-level queries convert the DNs into e-mail addresses. This feature requires the Net::LDAP (perlldap) PERL module.

include_ldap_2level_query.name

short name for this source

include_ldap_2level_query.host

remote host

include_ldap_2level_query.use_tls

use TLS (formerly SSL)

include_ldap_2level_query.ssl_version

SSL version

include_ldap_2level_query.ssl_ciphers

SSL ciphers used

include_ldap_2level_query.ca_verify

Certificate verification

include_ldap_2level_query.bind_dn

remote user

include_ldap_2level_query.bind_password

remote password

include_ldap_2level_query.suffix1

first-level suffix

include_ldap_2level_query.scope1

first-level search scope

include_ldap_2level_query.timeout1

first-level connection timeout

include_ldap_2level_query.filter1

first-level filter

include_ldap_2level_query.attrs1

first-level extracted attribute

include_ldap_2level_query.select1

first-level selection

include_ldap_2level_query.regex1

first-level regular expression

include_ldap_2level_query.suffix2

second-level suffix template

include_ldap_2level_query.scope2

second-level search scope

include_ldap_2level_query.timeout2

second-level connection timeout

include_ldap_2level_query.filter2

second-level filter template

include_ldap_2level_query.attrs2

second-level extracted attribute

include_ldap_2level_query.select2

second-level selection

include_ldap_2level_query.regex2

second-level regular expression

include_ldap_2level_query.nosync_time_ranges

Time ranges when inclusion is not allowed

include_ldap_2level_query.passwd

See include_ldap_2level_query.bind_password.

include_ldap_2level_query.port

Deprecated.

include_ldap_2level_query.use_ssl

See include_ldap_2level_query.use_tls.

include_ldap_2level_query.user

See include_ldap_2level_query.bind_dn.

include_sql_query

(Paragraph) SQL query inclusion

This parameter is used to define the SQL query parameters.

include_sql_query.name

short name for this source

include_sql_query.db_type

database type

include_sql_query.db_name

database name

include_sql_query.db_host

remote host

include_sql_query.db_port

database port

include_sql_query.db_options

connection options

include_sql_query.db_env

environment variables for database connection

include_sql_query.db_user

remote user

include_sql_query.db_passwd

remote password

include_sql_query.sql_query

SQL query

include_sql_query.f_dir

See include_sql_query.db_name.

include_sql_query.nosync_time_ranges

Time ranges when inclusion is not allowed

include_sql_query.connect_options

See include_sql_query.db_options.

include_sql_query.host

See include_sql_query.db_host.

include_sql_query.passwd

See include_sql_query.db_passwd.

include_sql_query.user

See include_sql_query.db_user.

ttl

Inclusions timeout

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

distribution_ttl

Inclusions timeout for message distribution

This parameter defines the delay since the last synchronization after which the user’s list will be updated before performing either of following actions:

* Reviewing list members

* Message distribution

include_ldap_ca

(Paragraph) LDAP query custom attribute

include_ldap_ca.name

short name for this source

include_ldap_ca.host

remote host

include_ldap_ca.use_tls

use TLS (formerly SSL)

include_ldap_ca.ssl_version

SSL version

include_ldap_ca.ssl_ciphers

SSL ciphers used

include_ldap_ca.ca_verify

Certificate verification

include_ldap_ca.bind_dn

remote user

include_ldap_ca.bind_password

remote password

include_ldap_ca.suffix

suffix

include_ldap_ca.scope

search scope

include_ldap_ca.timeout

connection timeout

include_ldap_ca.filter

filter

include_ldap_ca.attrs

extracted attribute

include_ldap_ca.email_entry

Name of email entry

include_ldap_ca.select

selection (if multiple)

include_ldap_ca.regex

regular expression

include_ldap_ca.nosync_time_ranges

Time ranges when inclusion is not allowed

include_ldap_ca.passwd

See include_ldap_ca.bind_password.

include_ldap_ca.port

Deprecated.

include_ldap_ca.use_ssl

See include_ldap_ca.use_tls.

include_ldap_ca.user

See include_ldap_ca.bind_dn.

include_ldap_2level_ca

(Paragraph) LDAP 2-level query custom attribute

include_ldap_2level_ca.name

short name for this source

include_ldap_2level_ca.host

remote host

include_ldap_2level_ca.use_tls

use TLS (formerly SSL)

include_ldap_2level_ca.ssl_version

SSL version

include_ldap_2level_ca.ssl_ciphers

SSL ciphers used

include_ldap_2level_ca.ca_verify

Certificate verification

include_ldap_2level_ca.bind_dn

remote user

include_ldap_2level_ca.bind_password

remote password

include_ldap_2level_ca.suffix1

first-level suffix

include_ldap_2level_ca.scope1

first-level search scope

include_ldap_2level_ca.timeout1

first-level connection timeout

include_ldap_2level_ca.filter1

first-level filter

include_ldap_2level_ca.attrs1

first-level extracted attribute

include_ldap_2level_ca.select1

first-level selection

include_ldap_2level_ca.regex1

first-level regular expression

include_ldap_2level_ca.suffix2

second-level suffix template

include_ldap_2level_ca.scope2

second-level search scope

include_ldap_2level_ca.timeout2

second-level connection timeout

include_ldap_2level_ca.filter2

second-level filter template

include_ldap_2level_ca.attrs2

second-level extracted attribute

include_ldap_2level_ca.select2

second-level selection

include_ldap_2level_ca.regex2

second-level regular expression

include_ldap_2level_ca.email_entry

Name of email entry

include_ldap_2level_ca.nosync_time_ranges

Time ranges when inclusion is not allowed

include_ldap_2level_ca.passwd

See include_ldap_2level_ca.bind_password.

include_ldap_2level_ca.port

Deprecated.

include_ldap_2level_ca.use_ssl

See include_ldap_2level_ca.use_tls.

include_ldap_2level_ca.user

See include_ldap_2level_ca.bind_dn.

include_sql_ca

(Paragraph) SQL query custom attribute

include_sql_ca.name

short name for this source

include_sql_ca.db_type

database type

include_sql_ca.db_name

database name

include_sql_ca.db_host

remote host

include_sql_ca.db_port

database port

include_sql_ca.db_options

connection options

include_sql_ca.db_env

environment variables for database connection

include_sql_ca.db_user

remote user

include_sql_ca.db_passwd

remote password

include_sql_ca.sql_query

SQL query

include_sql_ca.f_dir

See include_sql_ca.db_name.

include_sql_ca.email_entry

Name of email entry

include_sql_ca.nosync_time_ranges

Time ranges when inclusion is not allowed

include_sql_ca.connect_options

See include_sql_ca.db_options.

include_sql_ca.host

See include_sql_ca.db_host.

include_sql_ca.passwd

See include_sql_ca.db_passwd.

include_sql_ca.user

See include_sql_ca.db_user.

DKIM/DMARC/ARC

DKIM signature verification and re-signing. It requires an external module: Mail-DKIM.

ARC seals on forwarded messages. It requires an external module: Mail-DKIM.

dkim_add_signature_to

Which service messages to be signed

Inserts a DKIM signature to service messages in context of robot, list or both

dkim_signer_identity

The “i=” tag as defined in rfc 4871

Default is null.

dkim_feature

Insert DKIM signature to messages sent to the list

If set to “on”, Sympa may verify DKIM signatures of incoming messages and/or insert DKIM signature to outgoing messages.

dkim_parameters

(Paragraph) DKIM configuration

A set of parameters in order to define outgoing DKIM signature

dkim_parameters.private_key_path

File path for DKIM private key

The file must contain a PEM encoded private key

dkim_parameters.selector

Selector for DNS lookup of DKIM public key

The selector is used in order to build the DNS query for public key. It is up to you to choose the value you want but verify that you can query the public DKIM key for “<selector>._domainkey.your_domain”

dkim_parameters.header_list

Deprecated.

dkim_parameters.signer_domain

DKIM “d=” tag, you should probably use the default value

The DKIM “d=” tag, is the domain of the signing entity. The list domain MUST be included in the “d=” domain

dkim_parameters.signer_identity

DKIM “i=” tag, you should probably leave this parameter empty

DKIM “i=” tag, you should probably not use this parameter, as recommended by RFC 4871, default for list broadcasted messages is i=<listname>-request@<domain>

dkim_signature_apply_on

The categories of messages sent to the list that will be signed using DKIM.

This parameter controls in which case messages must be signed using DKIM, you may sign every message choosing ‘any’ or a subset. The parameter value is a comma separated list of keywords

arc_feature

Add ARC seals to messages sent to the list

Enable/Disable ARC. This feature requires Mail::DKIM::ARC to be installed, and maybe some custom scenario to be updated

arc_srvid

SRV ID for Authentication-Results used in ARC seal

Typically the domain of the mail server

arc_parameters

(Paragraph) ARC configuration

A set of parameters in order to define outgoing ARC seal

arc_parameters.private_key_path

File path for ARC private key

The file must contain a PEM encoded private key. Defaults to same file as DKIM private key

arc_parameters.selector

Selector for DNS lookup of ARC public key

The selector is used in order to build the DNS query for public key. It is up to you to choose the value you want but verify that you can query the public DKIM key for “<selector>._domainkey.your_domain”. Default is the same selector as for DKIM signatures

arc_parameters.signer_domain

ARC “d=” tag, you should probably use the default value

The ARC “d=” tag is the domain of the signing entity. The DKIM d= domain name is used as its default value

arc_parameters.arc_private_key_path

See arc_parameters.private_key_path.

arc_parameters.arc_selector

See arc_parameters.selector.

arc_parameters.arc_signer_domain

See arc_parameters.signer_domain.

dmarc_protection

(Paragraph) DMARC Protection

Parameters to define how to manage From address processing to avoid some domains’ excessive DMARC protection

dmarc_protection.mode

Protection modes

Select one or more operation modes. “Domain matching regular expression” (domain_regex) matches the specified Domain regular expression; “DKIM signature exists” (dkim_signature) matches any message with a DKIM signature header; “DMARC policy …” (dmarc_*) matches messages from sender domains with a DMARC policy as given; “all” (all) matches all messages.

Example:

dmarc_protection.mode dmarc_reject,dkim_signature

dmarc_protection.domain_regex

Regular expression for domain name match

Regular expression match pattern for From domain

dmarc_protection.other_email

New From address

This is the email address to use when modifying the From header. It defaults to the list address. This is similar to Anonymisation but preserves the original sender details in the From address phrase.

dmarc_protection.phrase

New From name format

This is the format to be used for the sender name part of the new From header field.

List address verification

Checks if an alias with the same name as the list to be created already exists on the SMTP server. This feature requires an external module: Net-SMTP.

list_check_helo

SMTP HELO (EHLO) parameter used for address verification

Default value is the host part of “list_check_smtp” parameter.

list_check_smtp

SMTP server to verify existence of the same addresses as the list to be created

This is needed if you are running Sympa on a host but you handle all your mail on a separate mail relay.

Default value is real FQDN of the host. Port number may be specified as “mail.example.org:25” or “203.0.113.1:25”. If port is not specified, standard port (25) will be used.

list_check_suffixes

Address suffixes to verify

List of suffixes you are using for list addresses, i.e. “mylist-request”, “mylist-owner” and so on.

This parameter is used with the “list_check_smtp” parameter. It is also used to check list names at list creation time.

Antivirus plug-in

antivirus_path

Path to the antivirus scanner engine

Supported antivirus: Clam AntiVirus/clamscan & clamdscan, McAfee/uvscan, Fsecure/fsav, Sophos, AVP and Trend Micro/VirusWall

Example:

antivirus_path /usr/local/bin/clamscan

antivirus_args

Antivirus plugin command line arguments

Example:

antivirus_args --no-summary --database /usr/local/share/clamav

antivirus_notify

Notify sender if virus checker detects malicious content

“sender” to notify originator of the message, “delivery_status” to send delivery status, or “none”

Miscellaneous

email

Local part of Sympa email address

Local part (the part preceding the “@” sign) of the address by which mail interface of Sympa accepts mail commands.

If you change the default value, you must modify the mail aliases too.

listmaster_email

Local part of listmaster email address

Local part (the part preceding the “@” sign) of the address by which listmasters receive messages.

If you change the default value, you must modify the mail aliases too.

custom_robot_parameter

Custom robot parameter

Used to define a custom parameter for your server. Do not forget the semicolon between the parameter name and the parameter value.

You will be able to access the custom parameter value in web templates by variable “conf.custom_robot_parameter.<param_name>”

Example:

custom_robot_parameter param_name ; param_value

prohibited_listnames

Prevent people to use some names for their lists names

This parameter is a comma-separated list of names. You can use * as a wildcard character. To use a regex for this, please use prohibited_listnames_regex setting.

Example:

prohibited_listnames www,root,*master

prohibited_listnames_regex

Prevent people to use some names for their lists names, based on a regex

This parameter is a regex. Please note that prohibited_listnames and prohibited_listnames_regex will both be applied if set, they are not exclusive.

Example:

prohibited_listnames_regex www|root|.*master

cache_list_config

Use of binary cache of list configuration

binary_file: Sympa processes will maintain a binary version of the list configuration, “config.bin” file on local disk. If you manage a big amount of lists (1000+), it should make the web interface startup faster.

You can recreate cache by running “sympa.pl –reload_list_config”.

db_list_cache

Use database cache to search lists

Note that “list_table” database table should be filled at the first time by running:

# sympa.pl --sync_list_db

purge_user_table_task

Task for expiring inactive users

This task removes rows in the “user_table” table which have not corresponding entries in the “subscriber_table” table.

purge_logs_table_task

Task for cleaning tables

This task cleans old logs from “logs_table” table.

logs_expiration_period

Max age of logs in database

Number of months that elapse before a log is expired

stats_expiration_period

Max age of statistics information in database

Number of months that elapse before statistics information are expired

umask

Umask

Default mask for file creation (see umask(2)). Note that it will be interpreted as an octal value.

clean_delay_queuemod

Max age of moderated messages

Number of days messages are kept in moderation spool (as specified by “queuemod” parameter). Beyond this deadline, messages that have not been processed are deleted.

custom_attribute

(Paragraph) Custom user attributes

custom_attribute.id

internal identifier

custom_attribute.name

label

custom_attribute.comment

additional comment

custom_attribute.type

type

custom_attribute.enum_values

possible attribute values (if enum is used)

custom_attribute.optional

is the attribute optional?

custom_vars

(Paragraph) custom parameters

custom_vars.name

var name

custom_vars.value

var value

loop_prevention_regex

Regular expression applied to prevent loops with robots

If the sender address matches the regular expression, then the message is rejected.

pictures_feature

Pictures

Enables or disables the pictures feature by default. If enabled, subscribers can upload their picture (from the “Subscriber option” page) to use as an avatar.

Pictures are stored in a directory specified by the “static_content_path” parameter.

remind_task

Periodical subscription reminder task

This parameter states which model is used to create a remind task. A remind task regularly sends subscribers a message which reminds them of their list subscriptions.

latest_instantiation

(Paragraph) Latest family instantiation

latest_instantiation.email

who ran the instantiation

latest_instantiation.date_epoch

date

latest_instantiation.date

Deprecated.

creation

(Paragraph) Creation of the list

creation.email

who created the list

creation.date_epoch

date

creation.date

Deprecated.

update

(Paragraph) Last update of config

update.email

who updated the config

update.date_epoch

date

update.date

Deprecated.

status

Status of the list

serial

Serial number of the config

Web interface parameters

wwsympa_url

URL prefix of web interface

This is used to construct URLs of web interface. The protocol (either https:// or http://) is required.

Example:

wwsympa_url https://web.example.org/sympa

wwsympa_url_local

URL prefix of WWSympa behind proxy

static_content_url

URL for static contents

HTTP server have to map it with “static_content_path” directory.

static_content_path

Directory for static contents

css_path

Directory for static style sheets (CSS)

After an upgrade, static CSS files are upgraded with the newly installed “css.tt2” template. Therefore, this is not a good place to store customized CSS files.

css_url

URL for style sheets (CSS)

To use auto-generated static CSS, HTTP server have to map it with “css_path”.

pictures_path

Directory for subscribers pictures

pictures_url

URL for subscribers pictures

HTTP server have to map it with “pictures_path” directory.

mhonarc

Path to MHonArc mail-to-HTML converter

This is required for HTML mail archiving.

log_facility

System log facility for web interface

System log facility for WWSympa, archived.pl and bounced.pl. Default is to use value of “syslog” parameter.

Web interface parameters: Appearances

logo_html_definition

Custom logo

HTML fragment to insert a logo in the page of web interface.

Example:

logo_html_definition <a href="http://www.example.com"><img style="float: left; margin-top: 7px; margin-left: 37px;" src="http://www.example.com/logos/mylogo.jpg" alt="My Company" /></a>

favicon_url

Custom favicon

URL of favicon image

default_home

Type of main web page

“lists” for the page of list of lists. “home” for home page.

archive_default_index

Default index organization of web archive

thrd: Threaded index.

mail: Chronological index.

review_page_size

Size of review page

Default number of lines of the array displaying users in the review page

viewlogs_page_size

Size of viewlogs page

Default number of lines of the array displaying the log entries in the logs page.

main_menu_custom_button_1_title, … main_menu_custom_button_3_title, main_menu_custom_button_1_url, … main_menu_custom_button_3_url, main_menu_custom_button_1_target, … main_menu_custom_button_3_target

Custom menus

You may modify the main menu content by editing the menu.tt2 file, but you can also edit these parameters in order to add up to 3 buttons. Each button is defined by a title (the text in the button), an URL and, optionally, a target.

Example:

main_menu_custom_button_1_title FAQ
main_menu_custom_button_1_url http://www.renater.fr/faq/universalistes/index
main_menu_custom_button_1_target Help

Password validation

Checks if the password the user submitted has sufficient strength. This feature requires an external module: Data-Password.

password_validation

Password validation

The password validation techniques to be used against user passwords that are added to mailing lists. Options come from Data::Password https://metacpan.org/pod/Data::Password#VARIABLES

Example:

password_validation MINLEN=8,GROUPS=3,DICTIONARY=4,DICTIONARIES=/pentest/dictionaries

Authentication with LDAP

Authenticates users based on the directory on LDAP server. This feature requires an external module: Net-LDAP. And also, if secure connection (LDAPS) is required: IO-Socket-SSL.

ldap_force_canonical_email

Use canonical email address for LDAP authentication

When using LDAP authentication, if the identifier provided by the user was a valid email, if this parameter is set to false, then the provided email will be used to authenticate the user. Otherwise, use of the first email returned by the LDAP server will be used.

SOAP HTTP interface

Provides some functions of Sympa through the SOAP HTTP interface. This feature requires an external module: SOAP-Lite.

soap_url

URL of SympaSOAP

WSDL document of SympaSOAP refers to this URL in its service section.

Example:

soap_url http://web.example.org/sympasoap

soap_url_local

URL of SympaSOAP behind proxy

Web interface parameters: Miscellaneous

HTTP cookies validity domain

If beginning with a dot (“.”), the cookie is available within the specified Internet domain. Otherwise, for the specified host. The only reason for replacing the default value would be where WWSympa’s authentication process is shared with an application running on another host.

Example:

cookie_domain .renater.fr

HTTP cookies lifetime

This is the default value when not set explicitly by users. “0” means the cookie may be retained during browser sessions.

Average interval to refresh HTTP session ID.

purge_session_table_task

Task for cleaning old sessions

This task removes old entries in the “session_table” table.

session_table_ttl

Max age of sessions

Session duration is controlled by “sympa_session” cookie validity attribute. However, by security reason, this delay also need to be controlled by server side. This task removes old entries in the “session_table” table.

Format of values is a string without spaces including “y” for years, “m” for months, “d” for days, “h” for hours, “min” for minutes and “sec” for seconds.

anonymous_session_table_ttl

Max age of sessions for anonymous users

shared_feature

Enable shared repository

If set to “on”, list owners can open shared repository.

shared_doc

(Paragraph) Shared documents

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

shared_doc.d_read

Who can view

shared_doc.d_edit

Who can edit

shared_doc.quota

quota

use_html_editor

Use HTML editor

If set to “on”, users will be able to post messages in HTML using a javascript WYSIWYG editor.

Example:

use_html_editor on

html_editor_url

URL of HTML editor

URL path to the javascript file making the WYSIWYG HTML editor available. Relative path under <static_content_url> or absolute path.

Example is for TinyMCE 4 installed under <static_content_path>/js/tinymce/.

Example:

html_editor_url js/tinymce/tinymce.min.js

html_editor_init

HTML editor initialization

Javascript excerpt that enables and configures the WYSIWYG HTML editor.

Example:

html_editor_init tinymce.init({selector:"#body",language:lang.split(/[^a-zA-Z]+/).join("_")});

max_wrong_password

Count limit of wrong password submission

If this limit is reached, the account is locked until the user renews their password. The default value is chosen in order to block bots trying to log in using brute force strategy. This value should never be reached by real users that will probably uses the renew password service before they performs so many tries.

password_case

Password case

“insensitive” or “sensitive”.

If set to “insensitive”, WWSympa’s password check will be insensitive. This only concerns passwords stored in the Sympa database, not the ones in LDAP.

Should not be changed! May invalid all user password.

password_hash

Password hashing algorithm

“md5” or “bcrypt”.

If set to “md5”, Sympa will use MD5 password hashes. If set to “bcrypt”, bcrypt hashes will be used instead. This only concerns passwords stored in the Sympa database, not the ones in LDAP.

password_hash_update

Update password hashing algorithm when users log in

On successful login, update the encrypted user password to use the algorithm specified by “password_hash”. This allows for a graceful transition to a new password hash algorithm. A value of 0 disables updating of existing password hashes. New and reset passwords will use the “password_hash” setting in all cases.

bcrypt_cost

Bcrypt hash cost

When “password_hash” is set to “bcrypt”, this sets the “cost” parameter of the bcrypt hash function. The default of 12 is expected to require approximately 250ms to calculate the password hash on a 3.2GHz CPU. This only concerns passwords stored in the Sympa database, not the ones in LDAP.

Can be changed but any new cost setting will only apply to new passwords.

one_time_ticket_lifetime

Age of one time ticket

Duration before the one time tickets are expired

one_time_ticket_lockout

Restrict access to one time ticket

Is access to the one time ticket restricted, if any users previously accessed? (one_time | remote_addr | open)

purge_one_time_ticket_table_task

Task for expiring old one time tickets

one_time_ticket_table_ttl

Expiration period of one time ticket

pictures_max_size

The maximum size of uploaded picture

spam_protection

Protect web interface against spam harvesters

There is a need to protect Sympa web sites against spambots which collect email addresses from public web sites. Various methods are available in Sympa and you can choose to use them with the spam_protection and web_archive_spam_protection parameters. Possible value are:

javascript:

the address is hidden using a javascript. A user who enables javascript can see a nice mailto address where others have nothing.

at:

the @ char is replaced by the string “ AT “.

none:

no protection against spammer.

reporting_spam_script_path

Script to report spam

If set, when a list moderator report undetected spams for list moderation, this external script is invoked and the message is injected into standard input of the script.

domains_blocklist

Prevent people to subscribe to a list with addresses using these domains

This parameter is a comma-separated list.

Example:

domains_blocklist example.org,spammer.com

quiet_subscription

Quiet subscriptions policy

Global policy for quiet subscriptions: “on” means that subscriptions will never send a notice to the subscriber, “off” will enforce a notice sending, and “optional” (default) allows the use of the list policy.

show_report_abuse

Add a “Report abuse” link in the side menu of the lists

The link is a mailto link, you can change that by overriding web_tt2/report_abuse.tt2

allow_account_deletion

EXPERIMENTAL! Allow users to delete their account. If enabled, shows a “delete my account” form in user’s preferences page.

Account deletion unsubscribes the users from his/her lists and removes him/her from lists ownership. It is only available to users using internal authentication (i.e. no LDAP, no SSO…). See https://github.com/sympa-community/sympa/issues/300 for details

Renamed parameters

These parameters were renamed. Though older names are still available, their use is no longer recommended.

arc_parameters.arc_private_key_path

See arc_parameters.private_key_path.

arc_parameters.arc_selector

See arc_parameters.selector.

arc_parameters.arc_signer_domain

See arc_parameters.signer_domain.

arc_private_key_path

See arc_parameters.private_key_path.

arc_selector

See arc_parameters.selector.

arc_signer_domain

See arc_parameters.signer_domain.

archive_mail_access

See archive.mail_access.

archive_web_access

See archive.web_access.

bounce_halt_rate

See bounce.halt_rate.

bounce_warn_rate

See bounce.warn_rate.

custom-header

See custom_header.

custom-subject

See custom_subject.

d_edit

See shared_doc.d_edit.

d_read

See shared_doc.d_read.

default_archive_quota

See archive.quota.

default_bounce_level1_rate

See bouncers_level1.rate.

default_bounce_level2_rate

See bouncers_level2.rate.

default_list_priority

See priority.

default_max_list_members

See max_list_members.

default_remind_task

See remind_task.

default_shared_quota

See shared_doc.quota.

default_sql_fetch_timeout

See sql_fetch_timeout.

default_ttl

See ttl.

dkim_private_key_path

See dkim_parameters.private_key_path.

dkim_selector

See dkim_parameters.selector.

dkim_signer_domain

See dkim_parameters.signer_domain.

dmarc_protection_domain_regex

See dmarc_protection.domain_regex.

dmarc_protection_mode

See dmarc_protection.mode.

dmarc_protection_other_email

See dmarc_protection.other_email.

dmarc_protection_phrase

See dmarc_protection.phrase.

domains_blacklist

See domains_blocklist.

email_gecos

See gecos.

forced_reply-to

See forced_reply_to.

forced_replyto

See forced_reply_to.

key_password

See key_passwd.

max-size

See max_size.

merge_feature

See personalization_feature.

remind_return_path

See verp_remind.

reply-to

See reply_to.

replyto

See reply_to.

subscription

See subscribe.

tracking_default_retention_period

See tracking.retention_period.

tracking_delivery_status_notification

See tracking.delivery_status_notification.

tracking_message_delivery_notification

See tracking_message_disposition_notification.

tracking_message_disposition_notification

See tracking.message_disposition_notification.

unsubscription

See unsubscribe.

use_blacklist

See use_blocklist.

welcome_return_path

See verp_welcome.

Deprecated parameters

These parameters were deprecated. They may not be used anymore.

account

Deprecated.

antispam_feature

Deprecated.

antispam_tag_header_ham_regexp

Deprecated.

antispam_tag_header_name

Deprecated.

antispam_tag_header_spam_regexp

Deprecated.

archived_pidfile

Deprecated.

automatic_list_prefix

Deprecated.

bounced_pidfile

Deprecated.

clean_delay_queueother

Deprecated.

color_0, …, color_15

See description on web interface. Deprecated.

Deprecated.

dark_color, light_color,

text_color, bg_color, error_color, selected_color, shaded_color

See description on web interface. Deprecated.

default_distribution_ttl

Deprecated.

distribution_mode

Deprecated.

edit_list

Deprecated.

editor

Deprecated.

expire_task

Deprecated.

filesystem_encoding

Deprecated.

forced_reply_to

Deprecated.

host

Deprecated.

html_editor_file

Deprecated.

htmlarea_url

Deprecated.

http_host

Deprecated.

include_list

Deprecated.

ldap_export_connection_timeout

Deprecated.

ldap_export_dnmanager

Deprecated.

ldap_export_host

Deprecated.

ldap_export_name

Deprecated.

ldap_export_password

Deprecated.

ldap_export_suffix

Deprecated.

localedir

Deprecated.

lock_method

Deprecated.

log_condition

Deprecated.

log_module

Deprecated.

msgcat

Deprecated.

openssl

Deprecated.

owner

Deprecated.

pidfile

Deprecated.

pidfile_bulk

Deprecated.

pidfile_creation

Deprecated.

pidfile_distribute

Deprecated.

queuedistribute

Deprecated.

queueexpire

Deprecated.

reply_to

Deprecated.

sort

Deprecated.

task_manager_pidfile

Deprecated.

tracking (domain and site)

See tracking.tracking.

tri

Deprecated.

trusted_ca_options

Deprecated.

use_fast_cgi

Deprecated.

user_data_source

Deprecated.

web_archive

Deprecated.

web_recode_to

Deprecated.

FILES

SEE ALSO

Sympa Administration Manual. https://www.sympa.community/manual/.

auth.conf(5), charset.conf(5), crawlers_detection.conf(5), edit_list.conf(5), ldap_alias_manager.conf(5), nrcpt_by_domain.conf(5), sympa_scenario(5), topics.conf(5).

Top of Page