sympa-community.github.io

Incubating the new Sympa documentation site

NAME

list_config - Configuration file for mailing list

DESCRIPTION

config is main configuration file of the mailing list.

Format of config is as following:

PARAMETERS

Below is entire list of configuration parameters. “Default” is built-in default value if any.

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.

host

Deprecated.

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.

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

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

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

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

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

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.

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. Headers/footers may be appended to text/plain messages only.

max_size

Maximum message size

Maximum size of a message in 8-bit bytes.

merge_feature

Allow message personalization

message_hook

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

remove_headers

Incoming SMTP header fields to be removed

remove_outgoing_headers

Outgoing SMTP header fields to be removed

rfc2369_header_fields

RFC 2369 Header fields

forced_reply_to

Deprecated.

reply_to

Deprecated.

Privileges

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.

owner_domain_min

Minimum owners in required domains

Require list ownership by a minimum number of addresses in the specified domains.

shared_doc

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

Archives

process_archive

Store distributed messages into archive

archive

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

email address protection method

Idem spam_protection is provided but it can be used only for web archives. Access requires a cookie, and users must submit a small form in order to receive a cookie before browsing the archives. This blocks all robot, even google and co.

web_archive

Deprecated.

Bounces

bounce

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

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

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

tracking

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

welcome_return_path

Welcome return-path

If set to unique, the welcome message is sent using a unique return path in order to remove the subscriber immediately in the case of a bounce.

remind_return_path

Return-path of the REMIND command

Same as welcome_return_path, but applied to remind messages.

Data sources setup

inclusion_notification_feature

Notify subscribers when they are included from a data source?

member_include

Subscribers defined in an external data source

member_include.source

the data source

member_include.source_parameters

data source parameters

owner_include

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

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

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_sympa_list

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_remote_sympa_list

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

remote host

include_remote_sympa_list.port

remote port

include_remote_sympa_list.path

remote path of sympa list dump

include_remote_sympa_list.cert

certificate for authentication by remote Sympa

include_ldap_query

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

Deprecated.

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

remote user

include_ldap_query.passwd

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

Time ranges when inclusion is not allowed

include_ldap_query.use_ssl

Obsoleted. Use use_tls.

include_ldap_2level_query

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

Deprecated.

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

remote user

include_ldap_2level_query.passwd

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

Obsoleted. Use use_tls.

include_sql_query

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

remote host

include_sql_query.db_port

database port

include_sql_query.connect_options

connection options

include_sql_query.db_name

database name

include_sql_query.db_env

environment variables for database connection

include_sql_query.user

remote user

include_sql_query.passwd

remote password

include_sql_query.sql_query

SQL query

include_sql_query.f_dir

Directory where the database is stored (used for DBD::CSV only)

include_sql_query.nosync_time_ranges

Time ranges when inclusion is not allowed

include_voot_group

VOOT group inclusion

include_voot_group.name

short name for this source

include_voot_group.user

user

include_voot_group.provider

provider

include_voot_group.group

group

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

LDAP query custom attribute

include_ldap_ca.name

short name for this source

include_ldap_ca.host

remote host

include_ldap_ca.port

Deprecated.

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

remote user

include_ldap_ca.passwd

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

Time ranges when inclusion is not allowed

include_ldap_ca.use_ssl

Obsoleted. Use use_tls.

include_ldap_2level_ca

LDAP 2-level query custom attribute

include_ldap_2level_ca.host

remote host

include_ldap_2level_ca.name

short name for this source

include_ldap_2level_ca.port

Deprecated.

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

remote user

include_ldap_2level_ca.passwd

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

Obsoleted. Use use_tls.

include_sql_ca

SQL query custom attribute

include_sql_ca.name

short name for this source

include_sql_ca.db_type

database type

include_sql_ca.host

remote host

include_sql_ca.db_port

database port

include_sql_ca.db_name

database name

include_sql_ca.connect_options

connection options

include_sql_ca.db_env

environment variables for database connection

include_sql_ca.user

remote user

include_sql_ca.passwd

remote password

include_sql_ca.sql_query

SQL query

include_sql_ca.f_dir

Directory where the database is stored (used for DBD::CSV only)

include_sql_ca.email_entry

Name of email entry

include_sql_ca.nosync_time_ranges

Time ranges when inclusion is not allowed

include_list

Deprecated.

user_data_source

Deprecated.

DKIM

dkim_feature

Insert DKIM signature to messages sent to the list

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

dkim_parameters

DKIM configuration

A set of parameters in order to define outgoing DKIM signature

dkim_parameters.private_key_path

File path for list DKIM private key

The file must contain a RSA 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 brodcasted 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_parameters

ARC configuration

A set of parameters in order to define outgoing ARC seal

arc_parameters.arc_private_key_path

File path for list ARC private key

The file must contain a RSA pem encoded private key. Default is DKIM private key.

arc_parameters.arc_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 selector for DKIM signature

arc_parameters.arc_signer_domain

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

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

dmarc_protection

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.

dmarc_protection.domain_regex

Match domain regular expression

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.

Miscellaneous

clean_delay_queuemod

Expiration of unmoderated messages

Secret string for generating unique keys

This parameter is a confidential item for generating authentication keys for administrative commands (ADD, DELETE, etc.). This parameter should remain concealed, even for owners. The cookie is applied to all list owners, and is only taken into account when the owner has the auth parameter.

custom_attribute

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

custom parameters

custom_vars.name

var name

custom_vars.value

var value

expire_task

Periodical subscription expiration task

This parameter states which model is used to create an expire task. An expire task regularly checks the subscription or resubscription date of subscribers and asks them to renew their subscription. If they don’t they are deleted.

loop_prevention_regex

Regular expression applied to prevent loops with robots

pictures_feature

Allow picture display? (must be enabled for the current robot)

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.

spam_protection

email address protection method

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.

latest_instantiation

Latest family instantiation

latest_instantiation.email

who ran the instantiation

latest_instantiation.date_epoch

date

latest_instantiation.date

Deprecated.

creation

Creation of the list

creation.email

who created the list

creation.date_epoch

date

creation.date

Deprecated.

update

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

account

Deprecated.

FILES

SEE ALSO

sympa.conf(5).

Sympa Administration Manual. https://sympa-community.github.io/manual/.


The content of this page is automatically generated from the source distribution of Sympa. For details about this document see original source file.

Theme originally designed by orderedlist