1# -*- python -*-
2
3# Copyright (C) 1998-2018 by the Free Software Foundation, Inc.
4#
5# This program is free software; you can redistribute it and/or
6# modify it under the terms of the GNU General Public License
7# as published by the Free Software Foundation; either version 2
8# of the License, or (at your option) any later version.
9#
10# This program is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13# GNU General Public License for more details.
14#
15# You should have received a copy of the GNU General Public License
16# along with this program; if not, write to the Free Software
17# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
18# USA.
19
20"""Distributed default settings for significant Mailman config variables."""
21
22# NEVER make site configuration changes to this file.  ALWAYS make them in
23# mm_cfg.py instead, in the designated area.  See the comments in that file
24# for details.
25
26
27import os
28
29def seconds(s): return s
30def minutes(m): return m * 60
31def hours(h): return h * 60 * 60
32def days(d): return d * 60 * 60 * 24
33
34# Some convenient constants
35try:
36    True, False
37except NameError:
38    True = 1
39    False = 0
40
41Yes = yes = On = on = True
42No = no = Off = off = False
43
44
45
46#####
47# General system-wide defaults
48#####
49
50# Should image logos be used?  Set this to 0 to disable image logos from "our
51# sponsors" and just use textual links instead (this will also disable the
52# shortcut "favicon").  Otherwise, this should contain the URL base path to
53# the logo images (and must contain the trailing slash)..  If you want to
54# disable Mailman's logo footer altogther, hack
55# Mailman/htmlformat.py:MailmanLogo(), which also contains the hardcoded links
56# and image names.
57IMAGE_LOGOS = '/icons/'
58
59# The name of the Mailman favicon
60SHORTCUT_ICON = 'mm-icon.png'
61
62# Don't change MAILMAN_URL, unless you want to point it at one of the mirrors.
63MAILMAN_URL = 'http://www.gnu.org/software/mailman/index.html'
64#MAILMAN_URL = 'http://www.list.org/'
65#MAILMAN_URL = 'http://mailman.sf.net/'
66
67# Mailman needs to know about (at least) two fully-qualified domain names
68# (fqdn); 1) the hostname used in your urls, and 2) the hostname used in email
69# addresses for your domain.  For example, if people visit your Mailman system
70# with "http://www.dom.ain/mailman" then your url fqdn is "www.dom.ain", and
71# if people send mail to your system via "yourlist@dom.ain" then your email
72# fqdn is "dom.ain".  DEFAULT_URL_HOST controls the former, and
73# DEFAULT_EMAIL_HOST controls the latter.  Mailman also needs to know how to
74# map from one to the other (this is especially important if you're running
75# with virtual domains).  You use "add_virtualhost(urlfqdn, emailfqdn)" to add
76# new mappings.
77#
78# If you don't need to change DEFAULT_EMAIL_HOST and DEFAULT_URL_HOST in your
79# mm_cfg.py, then you're done; the default mapping is added automatically.  If
80# however you change either variable in your mm_cfg.py, then be sure to also
81# include the following:
82#
83#     add_virtualhost(DEFAULT_URL_HOST, DEFAULT_EMAIL_HOST)
84#
85# because otherwise the default mappings won't be correct.
86DEFAULT_EMAIL_HOST = '@MAILHOST@'
87DEFAULT_URL_HOST = '@URLHOST@'
88DEFAULT_URL_PATTERN = 'http://%s/mailman/'
89
90# DEFAULT_HOST_NAME has been replaced with DEFAULT_EMAIL_HOST, however some
91# sites may have the former in their mm_cfg.py files.  If so, we'll believe
92# that, otherwise we'll believe DEFAULT_EMAIL_HOST.  Same for DEFAULT_URL.
93DEFAULT_HOST_NAME = None
94DEFAULT_URL = None
95
96HOME_PAGE         = 'index.html'
97MAILMAN_SITE_LIST = 'mailman'
98
99# Normally when a site administrator authenticates to a web page with the site
100# password, they get a cookie which authorizes them as the list admin.  It
101# makes me nervous to hand out site auth cookies because if this cookie is
102# cracked or intercepted, the intruder will have access to every list on the
103# site.  OTOH, it's dang handy to not have to re-authenticate to every list on
104# the site.  Set this value to Yes to allow site admin cookies.
105ALLOW_SITE_ADMIN_COOKIES = No
106
107# If the following is set to a non-zero value, web authentication cookies will
108# expire that many seconds following their last use.
109AUTHENTICATION_COOKIE_LIFETIME = 0
110
111# Form lifetime is set against Cross Site Request Forgery.
112FORM_LIFETIME = hours(1)
113
114# If the following is set to a non-empty string, this string in combination
115# with the time, list name and the IP address of the requestor is used to
116# create a hidden hash as part of the subscribe form on the listinfo page.
117# This hash is checked upon form submission and the subscribe fails if it
118# doesn't match.  I.e. the form posted must be first retrieved from the
119# listinfo CGI by the same IP that posts it.  The subscribe also fails if
120# the time the form was retrieved is more than the above FORM_LIFETIME or less
121# than the below SUBSCRIBE_FORM_MIN_TIME before submission.
122# Important: If you have any static subscribe forms on your web site, setting
123# this option will break them.  With this option set, subscribe forms must be
124# dynamically generated to include the hidden data.  See the code block
125# beginning with "if mm_cfg.SUBSCRIBE_FORM_SECRET:" in Mailman/Cgi/listinfo.py
126# for the details of the hidden data.
127SUBSCRIBE_FORM_SECRET = None
128
129# If SUBSCRIBE_FORM_SECRET is not None, this is the minimum time the user must
130# take after retrieving the form before submitting it.  Set to 0 to skip this
131# test.
132SUBSCRIBE_FORM_MIN_TIME = seconds(5)
133
134# Use a custom question-answer CAPTCHA to protect against subscription spam.
135# Has no effect unless SUBSCRIBE_FORM_SECRET is set.
136# Should be set to a dict mapping language keys to a list of pairs
137# of questions and regexes for the answers, e.g.
138# CAPTCHAS = {
139#   'en': [
140#     ('What is two times six?', '(12|twelve)'),
141#     ('What is this mailing list software called?', '[Mm]ailman'),
142#   ],
143#   'de': [
144#     ('Was ist 3 mal 6?', '(18|achtzehn)'),
145#   ],
146# }
147# The regular expression must match the full string, i.e., it is implicitly
148# acting as if it had "^" in the beginning and "$" at the end.
149# An 'en' key must be present and is used as fall-back if there are no
150# questions for the currently set language.
151CAPTCHAS = None
152
153# Use Google reCAPTCHA to protect the subscription form from spam bots.  The
154# following must be set to a pair of keys issued by the reCAPTCHA service at
155# https://www.google.com/recaptcha/admin
156RECAPTCHA_SITE_KEY = None
157RECAPTCHA_SECRET_KEY = None
158
159# Installation wide ban list.  This is a list of email addresses and regexp
160# patterns (beginning with ^) which are not allowed to subscribe to any lists
161# in the installation.  This supplements the individual list's ban_list.
162# For example, to ban xxx@aol.com and any @gmail.com address beginning with
163# yyy, set
164# GLOBAL_BAN_LIST = ['xxx@aol\.com', '^yyy.*@gmail\.com$']
165GLOBAL_BAN_LIST = []
166
167# If the following is set to Yes, and a web subscribe comes from an IPv4
168# address and the IP is listed in Spamhaus SBL, CSS or XBL, the subscription
169# will be blocked.  It will work with IPv6 addresses if Python's py2-ipaddress
170# module is installed.  The module can be installed via pip if not included
171# in your Python.
172BLOCK_SPAMHAUS_LISTED_IP_SUBSCRIBE = No
173
174# If the following is set to Yes, and a subscriber uses a domain that is
175# listed in the Spamhaus DBL, the subscription will be blocked.
176BLOCK_SPAMHAUS_LISTED_DBL_SUBSCRIBE = No
177
178# Command that is used to convert text/html parts into plain text.  This
179# should output results to standard output.  %(filename)s will contain the
180# name of the temporary file that the program should operate on.
181HTML_TO_PLAIN_TEXT_COMMAND = '/usr/local/bin/lynx -dump %(filename)s'
182
183# A Python regular expression character class which defines the characters
184# allowed in list names.  Lists cannot be created with names containing any
185# character that doesn't match this class.  Do not include '/' in this list.
186ACCEPTABLE_LISTNAME_CHARACTERS = '[-+_.=a-z0-9]'
187
188# The number of characters in the longest listname in the installation.  The
189# fix for LP: #1780874 truncates list names in web URLs to this length to avoid
190# a content spoofing vulnerability.  If this is left at its default value of
191# 0, the length of the longest listname is calculated on every web access.
192# This can have performance implications in installations with a very large
193# number of lists.  To use this feature to avoid the calculation, set this to
194# a number equal to the length of the longest expected valid list name.
195MAX_LISTNAME_LENGTH = 0
196
197# Shall the user's real names be displayed along with their email addresses
198# in list rosters?  Defaults to No to preserve prior behavior.
199ROSTER_DISPLAY_REALNAME = No
200
201# Beginning in Mailman 2.1.21, localized help and some other output from
202# Mailman's bin/ commands is converted to the character set of the user's
203# workstation (LC_CTYPE) if different from the character set of the language.
204# This is not well tested over a wide range of locales, so if it causes
205# problems, it can be disabled by setting the following to Yes.
206DISABLE_COMMAND_LOCALE_CSET = No
207
208
209
210#####
211# Virtual domains
212#####
213
214# Set up your virtual host mappings here.  This is primarily used for the
215# thru-the-web list creation, so its effects are currently fairly limited.
216# Use add_virtualhost() call to add new mappings.  The keys are strings as
217# determined by Utils.get_domain(), the values are as appropriate for
218# DEFAULT_HOST_NAME.
219VIRTUAL_HOSTS = {}
220
221# When set to Yes, the listinfo and admin overviews of lists on the machine
222# will be confined to only those lists whose web_page_url configuration option
223# host is included within the URL by which the page is visited - only those
224# "on the virtual host".  When set to No, all advertised (i.e. public) lists
225# are included in the overview.
226VIRTUAL_HOST_OVERVIEW = On
227
228
229# Helper function; use this in your mm_cfg.py files.  If optional emailhost is
230# omitted it defaults to urlhost with the first name stripped off, e.g.
231#
232# add_virtualhost('www.dom.ain')
233# VIRTUAL_HOSTS['www.dom.ain']
234# ==> 'dom.ain'
235#
236def add_virtualhost(urlhost, emailhost=None):
237    DOT = '.'
238    if emailhost is None:
239        emailhost = DOT.join(urlhost.split(DOT)[1:])
240    VIRTUAL_HOSTS[urlhost.lower()] = emailhost.lower()
241
242# And set the default
243add_virtualhost(DEFAULT_URL_HOST, DEFAULT_EMAIL_HOST)
244
245# Note that you will want to run bin/fix_url.py to change the domain of an
246# existing list.  bin/fix_url.py must be run within the bin/withlist script,
247# like so: bin/withlist -l -r bin/fix_url.py <listname>
248
249
250
251#####
252# Spam avoidance defaults
253#####
254
255# This variable contains a list of 2-tuple of the format (header, regex) which
256# the Mailman/Handlers/SpamDetect.py module uses to match against the current
257# message.  If the regex matches the given header in the current message, then
258# it is flagged as spam.  header is case-insensitive and should not include
259# the trailing colon.  regex is always matched with re.IGNORECASE.
260#
261# Note that the more searching done, the slower the whole process gets.  Spam
262# detection is run against all messages coming to either the list, or the
263# -owners address, unless the message is explicitly approved.
264KNOWN_SPAMMERS = []
265
266# The header_filter_rules in Privacy options... -> Spam filters are matched as
267# normalized unicodes against normalized unicode headers.  This setting
268# determines the normalization form.  It is one of 'NFC', 'NFD', 'NFKC' or
269# 'NFKD'.  See
270# https://docs.python.org/2/library/unicodedata.html#unicodedata.normalize
271NORMALIZE_FORM = 'NFKC'
272
273
274
275#####
276# Web UI defaults
277#####
278
279# Almost all the colors used in Mailman's web interface are parameterized via
280# the following variables.  This lets you easily change the color schemes for
281# your preferences without having to do major surgery on the source code.
282# Note that in general, the template colors are not included here since it is
283# easy enough to override the default template colors via site-wide,
284# vdomain-wide, or list-wide specializations.
285
286WEB_BG_COLOR = 'white'                            # Page background
287WEB_HEADER_COLOR = '#99ccff'                      # Major section headers
288WEB_SUBHEADER_COLOR = '#fff0d0'                   # Minor section headers
289WEB_ADMINITEM_COLOR = '#dddddd'                   # Option field background
290WEB_ADMINPW_COLOR = '#99cccc'                     # Password box color
291WEB_ERROR_COLOR = 'red'                           # Error message foreground
292WEB_LINK_COLOR = ''                               # If true, forces LINK=
293WEB_ALINK_COLOR = ''                              # If true, forces ALINK=
294WEB_VLINK_COLOR = ''                              # If true, forces VLINK=
295WEB_HIGHLIGHT_COLOR = '#dddddd'                   # If true, alternating rows
296                                                  # in listinfo & admin display
297
298# If you wish to include extra elements in the <HEAD> section of Mailman's
299# web pages, e.g. style information or a link to a style sheet, you can set
300# the following.  For example, to include a css style sheet reference, you
301# can put in mm_cfg.py
302# WEB_HEAD_ADD = """<LINK REL=stylesheet
303#                TYPE="text/css"
304#                HREF="path or URL"
305#                >"""
306# You can specify anything that is allowed in the <HEAD> section.  The default
307# is to not add anything.  This only applies to internally generated pages.
308# For pages built from templates you can create custom templates containing
309# this information.
310WEB_HEAD_ADD = None
311
312# User entered data is escaped for redisplay in web responses to avoid Cross
313# Site Scripting (XSS) attacks. The normal escaping replaces the characters
314# <, >, & and " with the respective HTML entities &lt;, &gt;, &amp; and
315# &quot;.  There are apparently some older, broken browsers that misinterpret
316# certain non-ascii characters as <, > or ".  The following two settings
317# control whether additional characters are escaped, and what characters are
318# replaced with what.  Note that in character sets that represent some
319# characters as multi-byte sequences, enabling the escaping of additional
320# characters can replace part of a multi-byte sequence with an HTML entity,
321# thus breaking an otherwise harmless character.
322#
323# Enable the replacement of additional characters when escaping strings for
324# the web.
325BROKEN_BROWSER_WORKAROUND = No
326#
327# If the above setting is Yes, the following dictionary definition determines
328# what additional characters are replaced with what.
329BROKEN_BROWSER_REPLACEMENTS = {'\x8b': '&#8249;',  # single left angle quote
330                               '\x9b': '&#8250;',  # single right angle quote
331                               '\xbc': '&#188;',   # < plus high order bit
332                               '\xbe': '&#190;',   # > plus high order bit
333                               '\xa2': '&#162;',   # " plus high order bit
334                              }
335#
336# Shall the admindb held message summary display the grouping and sorting
337# option radio buttons?  Set this in mm_cfg.py to one of the following:
338# SSENDER -> Default to grouped and sorted by sender.
339# SSENDERTIME -> Default to grouped by sender and sorted by time.
340# STIME -> Default to ungrouped and sorted by time.
341DISPLAY_HELD_SUMMARY_SORT_BUTTONS = No
342#
343# Shall the default for the admin Mass Subscription function be Invite rather
344# than Subscribe?  Set to Yes in mm_cfg.py to make the default be Invite.
345DEFAULT_SUBSCRIBE_OR_INVITE = No
346
347
348
349#####
350# Archive defaults
351#####
352
353# The url template for the public archives.  This will be used in several
354# places, including the List-Archive: header, links to the archive on the
355# list's listinfo page, and on the list's admin page.
356#
357# This should be a string with "%(listname)s" somewhere in it.  Mailman will
358# interpolate the name of the list into this.  You can also include a
359# "%(hostname)s" in the string, into which Mailman will interpolate
360# the host name (usually DEFAULT_URL_HOST).
361PUBLIC_ARCHIVE_URL = 'http://%(hostname)s/pipermail/%(listname)s'
362
363# Are archives on or off by default?
364DEFAULT_ARCHIVE = On
365
366# Are archives public or private by default?
367# 0=public, 1=private
368DEFAULT_ARCHIVE_PRIVATE = 0
369
370# ARCHIVE_TO_MBOX
371#-1 - do not do any archiving
372# 0 - do not archive to mbox, use builtin mailman html archiving only
373# 1 - do not use builtin mailman html archiving, archive to mbox only
374# 2 - archive to both mbox and builtin mailman html archiving.
375#     See the settings below for PUBLIC_EXTERNAL_ARCHIVER and
376#     PRIVATE_EXTERNAL_ARCHIVER which can be used to replace mailman's
377#     builtin html archiving with an external archiver.  The flat mail
378#     mbox file can be useful for searching, and is another way to
379#     interface external archivers, etc.
380ARCHIVE_TO_MBOX = 2
381
382# 0 - yearly
383# 1 - monthly
384# 2 - quarterly
385# 3 - weekly
386# 4 - daily
387DEFAULT_ARCHIVE_VOLUME_FREQUENCY = 1
388DEFAULT_DIGEST_VOLUME_FREQUENCY = 1
389
390# These variables control the use of an external archiver.  Normally if
391# archiving is turned on (see ARCHIVE_TO_MBOX above and the list's archive*
392# attributes) the internal Pipermail archiver is used.  This is the default if
393# both of these variables are set to No.  When either is set, the value should
394# be a shell command string which will get passed to os.popen().  This string
395# can contain the following substitution strings:
396#
397#     %(listname)s -- gets the internal name of the list
398#     %(hostname)s -- gets the email hostname for the list
399#
400# being archived will be substituted for this.  Please note that os.popen() is
401# used.
402#
403# Note that if you set one of these variables, you should set both of them
404# (they can be the same string).  This will mean your external archiver will
405# be used regardless of whether public or private archives are selected.
406PUBLIC_EXTERNAL_ARCHIVER = No
407PRIVATE_EXTERNAL_ARCHIVER = No
408
409# A filter module that converts from multipart messages to "flat" messages
410# (i.e. containing a single payload).  This is required for Pipermail, and you
411# may want to set it to 0 for external archivers.  You can also replace it
412# with your own module as long as it contains a process() function that takes
413# a MailList object and a Message object.  It should raise
414# Errors.DiscardMessage if it wants to throw the message away.  Otherwise it
415# should modify the Message object as necessary.
416ARCHIVE_SCRUBBER = 'Mailman.Handlers.Scrubber'
417
418# Control parameter whether Mailman.Handlers.Scrubber should use message
419# attachment's filename as is indicated by the filename parameter or use
420# 'attachement-xxx' instead.  The default is set True because the applications
421# on PC and Mac begin to use longer non-ascii filenames.  Historically, it
422# was set False in 2.1.6 for backward compatiblity but it was reset to True
423# for safer operation in mailman-2.1.7.
424SCRUBBER_DONT_USE_ATTACHMENT_FILENAME = True
425
426# Use of attachment filename extension per se is may be dangerous because
427# virus fakes it. You can set this True if you filter the attachment by
428# filename extension
429SCRUBBER_USE_ATTACHMENT_FILENAME_EXTENSION = False
430
431# This variable defines what happens to text/html subparts.  They can be
432# stripped completely, escaped, or filtered through an external program.  The
433# legal values are:
434# 0 - Strip out text/html parts completely, leaving a notice of the removal in
435#     the message.  If the outer part is text/html, the entire message is
436#     discarded.
437# 1 - Remove any embedded text/html parts, leaving them as HTML-escaped
438#     attachments which can be separately viewed.  Outer text/html parts are
439#     simply HTML-escaped.
440# 2 - Leave it inline, but HTML-escape it
441# 3 - Remove text/html as attachments but don't HTML-escape them. Note: this
442#     is very dangerous because it essentially means anybody can send an HTML
443#     email to your site containing evil JavaScript or web bugs, or other
444#     nasty things, and folks viewing your archives will be susceptible.  You
445#     should only consider this option if you do heavy moderation of your list
446#     postings.
447#
448# Note: given the current archiving code, it is not possible to leave
449# text/html parts inline and un-escaped.  I wouldn't think it'd be a good idea
450# to do anyway.
451#
452# The value can also be a string, in which case it is the name of a command to
453# filter the HTML page through.  The resulting output is left in an attachment
454# or as the entirety of the message when the outer part is text/html.  The
455# format of the string must include a "%(filename)s" which will contain the
456# name of the temporary file that the program should operate on.  It should
457# write the processed message to stdout.  Set this to
458# HTML_TO_PLAIN_TEXT_COMMAND to specify an HTML to plain text conversion
459# program.
460ARCHIVE_HTML_SANITIZER = 1
461
462# Set this to Yes to enable gzipping of the downloadable archive .txt file.
463# Note that this is /extremely/ inefficient, so an alternative is to just
464# collect the messages in the associated .txt file and run a cron job every
465# night to generate the txt.gz file.  See cron/nightly_gzip for details.
466GZIP_ARCHIVE_TXT_FILES = No
467
468# This sets the default `clobber date' policy for the archiver.  When a
469# message is to be archived either by Pipermail or an external archiver,
470# Mailman can modify the Date: header to be the date the message was received
471# instead of the Date: in the original message.  This is useful if you
472# typically receive messages with outrageous dates.  Set this to 0 to retain
473# the date of the original message, or to 1 to always clobber the date.  Set
474# it to 2 to perform `smart overrides' on the date; when the date is outside
475# ARCHIVER_ALLOWABLE_SANE_DATE_SKEW (either too early or too late), then the
476# received date is substituted instead.
477ARCHIVER_CLOBBER_DATE_POLICY = 2
478ARCHIVER_ALLOWABLE_SANE_DATE_SKEW = days(15)
479
480# Pipermail archives contain the raw email addresses of the posting authors.
481# Some view this as a goldmine for spam harvesters.  Set this to Yes to
482# moderately obscure email addresses, but note that this breaks mailto: URLs
483# in the archives too.
484ARCHIVER_OBSCURES_EMAILADDRS = Yes
485
486# Pipermail assumes that message bodies contain US-ASCII text.
487# Change this option to define a different character set to be used as
488# the default character set for the archive.  The term "character set"
489# is used in MIME to refer to a method of converting a sequence of
490# octets into a sequence of characters.  If you change the default
491# charset, you might need to add it to VERBATIM_ENCODING below.
492DEFAULT_CHARSET = None
493
494# Most character set encodings require special HTML entity characters to be
495# quoted, otherwise they won't look right in the Pipermail archives.  However
496# some character sets must not quote these characters so that they can be
497# rendered properly in the browsers.  The primary issue is multi-byte
498# encodings where the octet 0x26 does not always represent the & character.
499# This variable contains a list of such characters sets which are not
500# HTML-quoted in the archives.
501VERBATIM_ENCODING = ['iso-2022-jp']
502
503# When the archive is public, should Mailman also make the raw Unix mbox file
504# publically available?
505PUBLIC_MBOX = No
506
507
508
509#####
510# Delivery defaults
511#####
512
513# Final delivery module for outgoing mail.  This handler is used for message
514# delivery to the list via the smtpd, and to an individual user.  This value
515# must be a string naming a module in the Mailman.Handlers package.
516#
517# WARNING: Sendmail has security holes and should be avoided.  In fact, you
518# must read the Mailman/Handlers/Sendmail.py file before it will work for
519# you.
520#
521#DELIVERY_MODULE = 'Sendmail'
522DELIVERY_MODULE = 'SMTPDirect'
523
524# Sometimes there are 'low level' smtplib failures that are difficult to
525# debug.  To enable very verbose debugging info from smtplib to Mailman's
526# error log, set the following to 1.  This will only work if
527# DELIVERY_MODULE = 'SMTPDirect' and Python is >= 2.4.
528SMTPLIB_DEBUG_LEVEL = 0
529
530# MTA should name a module in Mailman/MTA which provides the MTA specific
531# functionality for creating and removing lists.  Some MTAs like Exim can be
532# configured to automatically recognize new lists, in which case the MTA
533# variable should be set to None.  Use 'Manual' to print new aliases to
534# standard out (or send an email to the site list owner) for manual twiddling
535# of an /etc/aliases style file.  Use 'Postfix' if you are using the Postfix
536# MTA -- but then also see POSTFIX_STYLE_VIRTUAL_DOMAINS.
537MTA = 'Manual'
538
539# If you set MTA='Postfix', then you also want to set the following variable,
540# depending on whether you're using virtual domains in Postfix, and which
541# style of virtual domain you're using.  Set this to the empty list if you're
542# not using virtual domains in Postfix, or if you're using Sendmail-style
543# virtual domains (where all addresses are visible in all domains).  If you're
544# using Postfix-style virtual domains, where aliases should only show up in
545# the virtual domain, set this variable to the list of host_name values to
546# write separate virtual entries for.  I.e. if you run dom1.ain, dom2.ain, and
547# dom3.ain, but only dom2 and dom3 are virtual, set this variable to the list
548# ['dom2.ain', 'dom3.ain'].  Matches are done against the host_name attribute
549# of the mailing lists.  See the Postfix section of the installation manual
550# for details.
551POSTFIX_STYLE_VIRTUAL_DOMAINS = []
552
553# If you specify any virtual domains in the above list, Mailman will generate
554# a virtual-mailman file containing virtual mappings of the form
555#
556# listaddress@dom2.ain   listaddress
557# etc.
558#
559# to map the list addresses in those domains to local addresses. If you need
560# mappings that specify a domain on the right hand side such as
561#
562# listaddress@dom2.ain   listaddress@localhost
563# or
564# listaddress@dom2.ain   listaddress@other.local.domain
565#
566# specify the desired local domain in mm_cfg.py as for example
567#
568# VIRTUAL_MAILMAN_LOCAL_DOMAIN = 'localhost'
569# or
570# VIRTUAL_MAILMAN_LOCAL_DOMAIN = 'other.local.domain'
571#
572# Whatever string value you set will be literally appended with an '@' to the
573# listaddress local parts on the right hand side.
574VIRTUAL_MAILMAN_LOCAL_DOMAIN = None
575
576# These variables describe the program to use for regenerating the aliases.db
577# and virtual-mailman.db files, respectively, from the associated plain text
578# files.  The file being updated will be appended to this string (with a
579# separating space), so it must be appropriate for os.system().
580POSTFIX_ALIAS_CMD = '/usr/local/sbin/postalias'
581POSTFIX_MAP_CMD = '/usr/local/sbin/postmap'
582
583# Ceiling on the number of recipients that can be specified in a single SMTP
584# transaction.  Set to 0 to submit the entire recipient list in one
585# transaction.  Only used with the SMTPDirect DELIVERY_MODULE.
586SMTP_MAX_RCPTS = 500
587
588# Ceiling on the number of SMTP sessions to perform on a single socket
589# connection.  Some MTAs have limits.  Set this to 0 to do as many as we like
590# (i.e. your MTA has no limits).  Set this to some number great than 0 and
591# Mailman will close the SMTP connection and re-open it after this number of
592# consecutive sessions.
593SMTP_MAX_SESSIONS_PER_CONNECTION = 0
594
595# Maximum number of simultaneous subthreads that will be used for SMTP
596# delivery.  After the recipients list is chunked according to SMTP_MAX_RCPTS,
597# each chunk is handed off to the smptd by a separate such thread.  If your
598# Python interpreter was not built for threads, this feature is disabled.  You
599# can explicitly disable it in all cases by setting MAX_DELIVERY_THREADS to
600# 0.  This feature is only supported with the SMTPDirect DELIVERY_MODULE.
601#
602# NOTE: This is an experimental feature and limited testing shows that it may
603# in fact degrade performance, possibly due to Python's global interpreter
604# lock.  Use with caution.
605MAX_DELIVERY_THREADS = 0
606
607# SMTP host and port, when DELIVERY_MODULE is 'SMTPDirect'.  Make sure the
608# host exists and is resolvable (i.e., if it's the default of "localhost" be
609# sure there's a localhost entry in your /etc/hosts file!)
610SMTPHOST = 'localhost'
611SMTPPORT = 0                                      # default from smtplib
612
613# Command for direct command pipe delivery to sendmail compatible program,
614# when DELIVERY_MODULE is 'Sendmail'.
615SENDMAIL_CMD = '/usr/sbin/sendmail'
616
617# SMTP authentication for DELIVERY_MODULE = 'SMTPDirect'.  To enable SASL
618# authentication for SMTPDirect, set SMTP_AUTH = Yes and provide appropriate
619# settings for SMTP_USER and SMTP_PASSWD.
620SMTP_AUTH = No
621SMTP_USER = ''
622SMTP_PASSWD = ''
623
624# If using SASL authentication (SMTP_AUTH = Yes), set the following to Yes
625# to also use TLS. This has no effect if SMTP_AUTH = No.
626SMTP_USE_TLS = No
627
628# When using TLS the following should be set to the hostname that should be
629# used in order to identify Mailman to the SMTP server.  By default, it
630# uses DEFAULT_URL_HOST. Normally, you should not change this.
631SMTP_HELO_HOST = DEFAULT_URL_HOST
632
633# Set these variables if you need to authenticate to your NNTP server for
634# Usenet posting or reading.  If no authentication is necessary, specify None
635# for both variables.
636NNTP_USERNAME = None
637NNTP_PASSWORD = None
638
639# Set this if you have an NNTP server you prefer gatewayed lists to use.
640DEFAULT_NNTP_HOST = ''
641
642# These variables controls how headers must be cleansed in order to be
643# accepted by your NNTP server.  Some servers like INN reject messages
644# containing prohibited headers, or duplicate headers.  The NNTP server may
645# reject the message for other reasons, but there's little that can be
646# programmatically done about that.  See Mailman/Queue/NewsRunner.py
647#
648# First, these headers (case ignored) are removed from the original message.
649NNTP_REMOVE_HEADERS = ['nntp-posting-host', 'nntp-posting-date', 'x-trace',
650                       'x-complaints-to', 'xref', 'date-received', 'posted',
651                       'posting-version', 'relay-version', 'received']
652
653# Next, these headers are left alone, unless there are duplicates in the
654# original message.  Any second and subsequent headers are rewritten to the
655# second named header (case preserved).
656NNTP_REWRITE_DUPLICATE_HEADERS = [
657    ('to', 'X-Original-To'),
658    ('cc', 'X-Original-Cc'),
659    ('content-transfer-encoding', 'X-Original-Content-Transfer-Encoding'),
660    ('mime-version', 'X-MIME-Version'),
661    ]
662
663# Some list posts and mail to the -owner address may contain DomainKey or
664# DomainKeys Identified Mail (DKIM) signature headers <http://www.dkim.org/>.
665# Various list transformations to the message such as adding a list header or
666# footer or scrubbing attachments or even reply-to munging can break these
667# signatures.  It is generally felt that these signatures have value, even if
668# broken and even if the outgoing message is resigned.  However, some sites
669# may wish to remove these headers.  Possible values and meanings are:
670# No, 0, False -> do not remove headers.
671# Yes, 1, True -> remove headers only if we are munging the from header due
672#                 to from_is_list or dmarc_moderation_action.
673# 2 -> always remove headers.
674# 3 -> always remove, rename and preserve original DKIM headers.
675REMOVE_DKIM_HEADERS = No
676
677# If the following is set to a non-empty string, that string is the name of a
678# header that will be added to personalized and VERPed deliveries with value
679# equal to the base64 encoding of the recipient's email address.  This is
680# intended to enable identification of the recipient otherwise redacted from
681# "spam report" feedback loop messages.  For example, if
682# RCPT_BASE64_HEADER_NAME = 'X-Mailman-R-Data'
683# a header like
684# X-Mailman-R-Data: dXNlckBleGFtcGxlLmNvbQo=
685# will be added to messages sent to user@@example.com.
686RCPT_BASE64_HEADER_NAME = ''
687
688# All `normal' messages which are delivered to the entire list membership go
689# through this pipeline of handler modules.  Lists themselves can override the
690# global pipeline by defining a `pipeline' attribute.
691GLOBAL_PIPELINE = [
692    # These are the modules that do tasks common to all delivery paths.
693    'SpamDetect',
694    'Approve',
695    'Replybot',
696    'Moderate',
697    'Hold',
698    'MimeDel',
699    'Scrubber',
700    'Emergency',
701    'Tagger',
702    'CalcRecips',
703    'AvoidDuplicates',
704    'Cleanse',
705    'CleanseDKIM',
706    'CookHeaders',
707    # And now we send the message to the digest mbox file, and to the arch and
708    # news queues.  Runners will provide further processing of the message,
709    # specific to those delivery paths.
710    'ToDigest',
711    'ToArchive',
712    'ToUsenet',
713    # Now we'll do a few extra things specific to the member delivery
714    # (outgoing) path, finally leaving the message in the outgoing queue.
715    'AfterDelivery',
716    'Acknowledge',
717    'WrapMessage',
718    'ToOutgoing',
719    ]
720
721# This is the pipeline which messages sent to the -owner address go through
722OWNER_PIPELINE = [
723    'SpamDetect',
724    'Replybot',
725    'OwnerRecips',
726    'ToOutgoing',
727    ]
728
729
730# This defines syslog() format strings for the SMTPDirect delivery module (see
731# DELIVERY_MODULE above).  Valid %()s string substitutions include:
732#
733#     time -- the time in float seconds that it took to complete the smtp
734#     hand-off of the message from Mailman to your smtpd.
735#
736#     size -- the size of the entire message, in bytes
737#
738#     #recips -- the number of actual recipients for this message.
739#
740#     #refused -- the number of smtp refused recipients (use this only in
741#     SMTP_LOG_REFUSED).
742#
743#     listname -- the `internal' name of the mailing list for this posting
744#
745#     msg_<header> -- the value of the delivered message's given header.  If
746#     the message had no such header, then "n/a" will be used.  Note though
747#     that if the message had multiple such headers, then it is undefined
748#     which will be used.
749#
750#     allmsg_<header> - Same as msg_<header> above, but if there are multiple
751#     such headers in the message, they will all be printed, separated by
752#     comma-space.
753#
754#     sender -- the "sender" of the messages, which will be the From: or
755#     envelope-sender as determeined by the USE_ENVELOPE_SENDER variable
756#     below.
757#
758# The format of the entries is a 2-tuple with the first element naming the
759# file in logs/ to print the message to, and the second being a format string
760# appropriate for Python's %-style string interpolation.  The file name is
761# arbitrary; qfiles/<name> will be created automatically if it does not
762# exist.
763
764# The format of the message printed for every delivered message, regardless of
765# whether the delivery was successful or not.  Set to None to disable the
766# printing of this log message.
767SMTP_LOG_EVERY_MESSAGE = (
768    'smtp',
769    '%(msg_message-id)s smtp to %(listname)s for %(#recips)d recips, completed in %(time).3f seconds')
770
771# This will only be printed if there were no immediate smtp failures.
772# Mutually exclusive with SMTP_LOG_REFUSED.
773SMTP_LOG_SUCCESS = (
774    'post',
775    'post to %(listname)s from %(sender)s, size=%(size)d, message-id=%(msg_message-id)s, success')
776
777# This will only be printed if there were any addresses which encountered an
778# immediate smtp failure.  Mutually exclusive with SMTP_LOG_SUCCESS.
779SMTP_LOG_REFUSED = (
780    'post',
781    'post to %(listname)s from %(sender)s, size=%(size)d, message-id=%(msg_message-id)s, %(#refused)d failures')
782
783# This will be logged for each specific recipient failure.  Additional %()s
784# keys are:
785#
786#     recipient -- the failing recipient address
787#     failcode  -- the smtp failure code
788#     failmsg   -- the actual smtp message, if available
789SMTP_LOG_EACH_FAILURE = (
790    'smtp-failure',
791    'delivery to %(recipient)s failed with code %(failcode)d: %(failmsg)s')
792
793# These variables control the format and frequency of VERP-like delivery for
794# better bounce detection.  VERP is Variable Envelope Return Path, defined
795# here:
796#
797# http://cr.yp.to/proto/verp.txt
798#
799# This involves encoding the address of the recipient as we (Mailman) know it
800# into the envelope sender address (i.e. the SMTP `MAIL FROM:' address).
801# Thus, no matter what kind of forwarding the recipient has in place, should
802# it eventually bounce, we will receive an unambiguous notice of the bouncing
803# address.
804#
805# However, we're technically only "VERP-like" because we're doing the envelope
806# sender encoding in Mailman, not in the MTA.  We do require cooperation from
807# the MTA, so you must be sure your MTA can be configured for extended address
808# semantics.
809#
810# The first variable describes how to encode VERP envelopes.  It must contain
811# these three string interpolations:
812#
813# %(bounces)s -- the list-bounces mailbox will be set here
814# %(mailbox)s -- the recipient's mailbox will be set here
815# %(host)s    -- the recipient's host name will be set here
816#
817# This example uses the default below.
818#
819# FQDN list address is: mylist@dom.ain
820# Recipient is:         aperson@a.nother.dom
821#
822# The envelope sender will be mylist-bounces+aperson=a.nother.dom@dom.ain
823#
824# Note that your MTA /must/ be configured to deliver such an addressed message
825# to mylist-bounces!
826VERP_FORMAT = '%(bounces)s+%(mailbox)s=%(host)s'
827
828# The second describes a regular expression to unambiguously decode such an
829# address, which will be placed in the To: header of the bounce message by the
830# bouncing MTA.  Getting this right is critical -- and tricky.  Learn your
831# Python regular expressions.  It must define exactly three named groups,
832# bounces, mailbox and host, with the same definition as above.  It will be
833# compiled case-insensitively.
834VERP_REGEXP = r'^(?P<bounces>[^+]+?)\+(?P<mailbox>[^=]+)=(?P<host>[^@]+)@.*$'
835
836# VERP format and regexp for probe messages
837VERP_PROBE_FORMAT = '%(bounces)s+%(token)s'
838VERP_PROBE_REGEXP = r'^(?P<bounces>[^+]+?)\+(?P<token>[^@]+)@.*$'
839# Set this Yes to activate VERP probe for disabling by bounce
840VERP_PROBES = No
841
842# A perfect opportunity for doing VERP is the password reminders, which are
843# already addressed individually to each recipient.  Set this to Yes to enable
844# VERPs on all password reminders.  However, because password reminders are
845# sent from the site list and site list bounces aren't processed but are just
846# forwarded to the site list admins, this isn't too useful.  See comments at
847# lines 70-84 of Mailman/Queue/BounceRunner.py for why we don't process them.
848VERP_PASSWORD_REMINDERS = No
849
850# Another good opportunity is when regular delivery is personalized.  Here
851# again, we're already incurring the performance hit for addressing each
852# individual recipient.  Set this to Yes to enable VERPs on all personalized
853# regular deliveries (personalized digests aren't supported yet).
854VERP_PERSONALIZED_DELIVERIES = No
855
856# And finally, we can VERP normal, non-personalized deliveries.  However,
857# because it can be a significant performance hit, we allow you to decide how
858# often to VERP regular deliveries.  This is the interval, in number of
859# messages, to do a VERP recipient address.  The same variable controls both
860# regular and digest deliveries.  Set to 0 to disable occasional VERPs, set to
861# 1 to VERP every delivery, or to some number > 1 for only occasional VERPs.
862VERP_DELIVERY_INTERVAL = 0
863
864# For nicer confirmation emails, use a VERP-like format which encodes the
865# confirmation cookie in the reply address.  This lets us put a more user
866# friendly Subject: on the message, but requires cooperation from the MTA.
867# Format is like VERP_FORMAT above, but with the following substitutions:
868#
869# %(addr)s -- the list-confirm mailbox will be set here
870# %(cookie)s  -- the confirmation cookie will be set here
871VERP_CONFIRM_FORMAT = '%(addr)s+%(cookie)s'
872
873# This is analogous to VERP_REGEXP, but for splitting apart the
874# VERP_CONFIRM_FORMAT.  MUAs have been observed that mung
875# From: local_part@host
876# into
877# To: "local_part" <local_part@host>
878# or even
879# To: "local_part@host" <local_part@host>
880# and may even fold the header when replying, so we skip everything up to '<'
881# if any and include ($s) so dot will match the newline in a folded header.
882VERP_CONFIRM_REGEXP = r'(?s)^(.*<)?(?P<addr>.+)\+(?P<cookie>[0-9a-f]{40})@.*$'
883
884# Set this to Yes to enable VERP-like (more user friendly) confirmations
885VERP_CONFIRMATIONS = No
886
887# This is the maximum number of automatic responses sent to an address because
888# of -request messages or posting hold messages.  This limit prevents response
889# loops between Mailman and misconfigured remote email robots.  Mailman
890# already inhibits automatic replies to any message labeled with a header
891# "Precendence: bulk|list|junk".  This is a fallback safety valve so it should
892# be set fairly high.  Set to 0 for no limit (probably useful only for
893# debugging).
894MAX_AUTORESPONSES_PER_DAY = 10
895
896# This FreeBSD port of Mailman can utilize Postfix SMTP server's VERP ability.
897# You may set VERP_STYLE = 'Postfix' to enable it.
898VERP_STYLE = 'Manual'
899
900# When using Postfix style VERP you will need the following setting.
901POSTFIX_XVERP_OPTS = '+='
902
903
904#####
905# Backscatter mitigation
906#####
907
908# This controls whether a message to the -request address without any
909# commands or a message to -confirm whose To: address doesn't match
910# VERP_CONFIRM_REGEXP above is responded to or just logged.
911DISCARD_MESSAGE_WITH_NO_COMMAND = Yes
912
913# This controls how much of the original message is included in automatic
914# responses to email commands.  The values are:
915# 0 - Do not include any unprocessed or ignored commands.  Do not include
916#     the original message.
917# 1 - Do not include any unprocessed or ignored commands.  Include only the
918#     headers from the original message.
919# 2 - Include unprocessed and ignored commands.  Include the complete original
920#     message.
921#
922# In order to minimize the effect of backscatter due to spam sent to
923# administrative addresses, it is recommended to set this to 0, however the
924# default is 2 for backwards compatibility.
925RESPONSE_INCLUDE_LEVEL = 2
926
927# This sets the default for respond_to_post_requests for new lists.  It is
928# set to Yes for backwards compatibility, but it is recommended that serious
929# consideration be given to setting it to No.
930DEFAULT_RESPOND_TO_POST_REQUESTS = Yes
931
932
933
934#####
935# Qrunner defaults
936#####
937
938# Which queues should the qrunner master watchdog spawn?  This is a list of
939# 2-tuples containing the name of the qrunner class (which must live in a
940# module of the same name within the Mailman.Queue package), and the number of
941# parallel processes to fork for each qrunner.  If more than one process is
942# used, each will take an equal subdivision of the hash space.
943
944# BAW: Eventually we may support weighted hash spaces.
945# BAW: Although not enforced, the # of slices must be a power of 2
946
947QRUNNERS = [
948    ('ArchRunner',     1), # messages for the archiver
949    ('BounceRunner',   1), # for processing the qfile/bounces directory
950    ('CommandRunner',  1), # commands and bounces from the outside world
951    ('IncomingRunner', 1), # posts from the outside world
952    ('NewsRunner',     1), # outgoing messages to the nntpd
953    ('OutgoingRunner', 1), # outgoing messages to the smtpd
954    ('VirginRunner',   1), # internally crafted (virgin birth) messages
955    ('RetryRunner',    1), # retry temporarily failed deliveries
956    ]
957
958# Set this to Yes to use the `Maildir' delivery option.  If you change this
959# you will need to re-run bin/genaliases for MTAs that don't use list
960# auto-detection.
961#
962# WARNING: If you want to use Maildir delivery, you /must/ start Mailman's
963# qrunner as root, or you will get permission problems.
964#
965# NOTE: Maildir delivery is experimental for Mailman 2.1.
966USE_MAILDIR = No
967# NOTE: If you set USE_MAILDIR = Yes, add the following line to your mm_cfg.py
968# file (uncommented of course!)
969# QRUNNERS.append(('MaildirRunner', 1))
970
971# After processing every file in the qrunner's slice, how long should the
972# runner sleep for before checking the queue directory again for new files?
973# This can be a fraction of a second, or zero to check immediately
974# (essentially busy-loop as fast as possible).
975QRUNNER_SLEEP_TIME = seconds(1)
976
977# When a message that is unparsable (by the email package) is received, what
978# should we do with it?  The most common cause of unparsable messages is
979# broken MIME encapsulation, and the most common cause of that is viruses like
980# Nimda.  Set this variable to No to discard such messages, or to Yes to store
981# them in qfiles/bad subdirectory.
982QRUNNER_SAVE_BAD_MESSAGES = Yes
983
984# Depending on the above setting, the queue entries with messages which can't
985# be parsed may be saved in qfiles/bad.  Certain other exceptions which occur
986# during unpickling of a queue entry also cause the entry to be saved in
987# qfiles/bad.  Various exceptions which occur during message processing cause
988# the message to be shunted (saved in qfiles/shunt) where they can be
989# reprocessed with bin/unshunt after the underlying problem is fixed.  The
990# cull_bad_shunt cron job normally runs daily to remove and possibly archive
991# stale entries in qfiles/bad and qfiles/shunt.  The following settings
992# control this.
993
994# The length of time after which a qfiles/bad or qfiles/shunt file is
995# considered to be stale.  Set to zero to disable culling of qfiles/bad and
996# qfiles/shunt entries.
997BAD_SHUNT_STALE_AFTER = days(7)
998
999# The pathname of a directory (searchable and writable by the Mailman cron
1000# user) to which the culled qfiles/bad and qfiles/shunt entries will be
1001# moved.  Set to None to simply delete the culled entries.
1002BAD_SHUNT_ARCHIVE_DIRECTORY = None
1003
1004# This flag causes Mailman to fsync() its data files after writing and
1005# flushing its contents.  While this ensures the data is written to disk,
1006# avoiding data loss, it may be a performance killer.  Note that this flag
1007# affects both message pickles and MailList config.pck files.
1008SYNC_AFTER_WRITE = No
1009
1010# This is the name used for the mailmanctl master lock file. In a clustered
1011# load sharing environment with a shared 'locks' directory, it is desirable
1012# to have separate locks for each host mailmanctl. This can be used to enable
1013# that.
1014MASTER_LOCK_FILE = 'master-qrunner'
1015
1016
1017
1018#####
1019# General defaults
1020#####
1021
1022# The default language for this server.  Whenever we can't figure out the list
1023# context or user context, we'll fall back to using this language.  See
1024# LC_DESCRIPTIONS below for legal values.
1025DEFAULT_SERVER_LANGUAGE = 'en'
1026
1027# When allowing only members to post to a mailing list, how is the sender of
1028# the message determined?  If this variable is set to Yes, then first the
1029# message's envelope sender is used, with a fallback to the sender if there is
1030# no envelope sender.  Set this variable to No to always use the sender.
1031#
1032# The envelope sender is set by the SMTP delivery and is thus less easily
1033# spoofed than the sender, which is typically just taken from the From: header
1034# and thus easily spoofed by the end-user.  However, sometimes the envelope
1035# sender isn't set correctly and this will manifest itself by postings being
1036# held for approval even if they appear to come from a list member.  If you
1037# are having this problem, set this variable to No, but understand that some
1038# spoofed messages may get through.
1039USE_ENVELOPE_SENDER = No
1040
1041# Membership tests for posting purposes are usually performed by looking at a
1042# set of headers, passing the test if any of their values match a member of
1043# the list.  Headers are checked in the order given in this variable.  The
1044# value None means use the From_ (envelope sender) header.  Field names are
1045# case insensitive.
1046SENDER_HEADERS = ('from', None, 'reply-to', 'sender')
1047
1048# How many members to display at a time on the admin cgi to unsubscribe them
1049# or change their options?
1050DEFAULT_ADMIN_MEMBER_CHUNKSIZE = 30
1051
1052# how many bytes of a held message post should be displayed in the admindb web
1053# page?  Use a negative number to indicate the entire message, regardless of
1054# size (though this will slow down rendering those pages).
1055ADMINDB_PAGE_TEXT_LIMIT = 4096
1056
1057# Set this variable to Yes to allow list owners to delete their own mailing
1058# lists.  You may not want to give them this power, in which case, setting
1059# this variable to No instead requires list removal to be done by the site
1060# administrator, via the command line script bin/rmlist.
1061OWNERS_CAN_DELETE_THEIR_OWN_LISTS = No
1062
1063# Set this variable to Yes to allow list owners to set the "personalized"
1064# flags on their mailing lists.  Turning these on tells Mailman to send
1065# separate email messages to each user instead of batching them together for
1066# delivery to the MTA.  This gives each member a more personalized message,
1067# but can have a heavy impact on the performance of your system.
1068OWNERS_CAN_ENABLE_PERSONALIZATION = No
1069
1070# Set this variable to Yes to allow list owners to change a member's password
1071# from the member's options page.  Do not do this if list owners aren't all
1072# trustworthy as it allows a list owner to change a member's password and then
1073# log in as the member and make global changes.
1074OWNERS_CAN_CHANGE_MEMBER_PASSWORDS = No
1075
1076# Should held messages be saved on disk as Python pickles or as plain text?
1077# The former is more efficient since we don't need to go through the
1078# parse/generate roundtrip each time, but the latter might be preferred if you
1079# want to edit the held message on disk.
1080HOLD_MESSAGES_AS_PICKLES = Yes
1081
1082# This variable controls the order in which list-specific category options are
1083# presented in the admin cgi page.
1084ADMIN_CATEGORIES = [
1085    # First column
1086    'general', 'passwords', 'language', 'members', 'nondigest', 'digest',
1087    # Second column
1088    'privacy', 'bounce', 'archive', 'gateway', 'autoreply',
1089    'contentfilter', 'topics',
1090    ]
1091
1092# See "Bitfield for user options" below; make this a sum of those options, to
1093# make all new members of lists start with those options flagged.  We assume
1094# by default that people don't want to receive two copies of posts.  Note
1095# however that the member moderation flag's initial value is controlled by the
1096# list's config variable default_member_moderation.
1097DEFAULT_NEW_MEMBER_OPTIONS = 256
1098
1099# Specify the type of passwords to use, when Mailman generates the passwords
1100# itself, as would be the case for membership requests where the user did not
1101# fill in a password, or during list creation, when auto-generation of admin
1102# passwords was selected.
1103#
1104# Set this value to Yes for classic Mailman user-friendly(er) passwords.
1105# These generate semi-pronounceable passwords which are easier to remember.
1106# Set this value to No to use more cryptographically secure, but harder to
1107# remember, passwords -- if your operating system and Python version support
1108# the necessary feature (specifically that /dev/urandom be available).
1109USER_FRIENDLY_PASSWORDS = Yes
1110# This value specifies the default lengths of member and list admin passwords
1111MEMBER_PASSWORD_LENGTH = 8
1112ADMIN_PASSWORD_LENGTH = 10
1113
1114# The following headers are always removed from posts to anonymous lists as
1115# they can reveal the identity of the poster or at least the poster's domain.
1116#
1117# From:, Reply-To:, Sender:, Return-Path:, X-Originating-Email:, Received:,
1118# Message-ID: and X-Envelope-From:.
1119#
1120# In addition, Return-Receipt-To:, Disposition-Notification-To:,
1121# X-Confirm-Reading-To: and X-Pmrqc: headers are removed from all posts as
1122# they can be used to fish for list membership in addition to possibly
1123# revealing sender information.
1124#
1125# In addition to the above removals, all other headers except those matching
1126# regular expressions in the following setting are also removed. The default
1127# setting below keeps all non X- headers, those X- headers added by Mailman
1128# and any X-Spam- headers.
1129ANONYMOUS_LIST_KEEP_HEADERS = ['^(?!x-)', '^x-mailman-',
1130                               '^x-content-filtered-by:', '^x-topics:',
1131                               '^x-ack:', '^x-beenthere:',
1132                               '^x-list-administrivia:', '^x-spam-',
1133                              ]
1134#
1135# It is possible to mailbomb a third party by repeatrdly posting the subscribe
1136# form.  You can prevent this by setting the following to Yes which will refuse
1137# pending a subscription confirmation when one is already pending.  The down
1138# side to this is if a subscriber loses or doesn't receive the confirmation
1139# request email, she has to wait PENDING_REQUEST_LIFE (default 3 days) before
1140# she can request another.  This setting also applies to repeated unsubscribes.
1141REFUSE_SECOND_PENDING = No
1142# Mailbombing of a list member of a list with private rosters can occur with
1143# repeated subscribe attempts resulting in repeated user warnings.  Set the
1144# following to No to supress the user warnings.
1145WARN_MEMBER_OF_SUBSCRIBE = Yes
1146
1147
1148
1149#####
1150# List defaults.  NOTE: Changing these values does NOT change the
1151# configuration of an existing list.  It only defines the default for new
1152# lists you subsequently create.
1153#####
1154
1155# Should a list, by default be advertised?  What is the default maximum number
1156# of explicit recipients allowed?  What is the default maximum message size
1157# allowed?
1158DEFAULT_LIST_ADVERTISED = Yes
1159DEFAULT_MAX_NUM_RECIPIENTS = 10
1160DEFAULT_MAX_MESSAGE_SIZE = 40           # KB
1161
1162# These format strings will be expanded w.r.t. the dictionary for the
1163# mailing list instance.
1164DEFAULT_SUBJECT_PREFIX  = "[%(real_name)s] "
1165# DEFAULT_SUBJECT_PREFIX = "[%(real_name)s %%d]" # for numbering
1166DEFAULT_MSG_HEADER = ""
1167DEFAULT_MSG_FOOTER = """--
1168%(real_name)s mailing list
1169%(real_name)s@%(host_name)s
1170%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
1171"""
1172
1173# Where to put subject prefix for 'Re:' messages:
1174#
1175#     old style: Re: [prefix] test
1176#     new style: [prefix 123] Re: test ... (number is optional)
1177#
1178# Old style is default for backward compatibility.  New style is forced if a
1179# list owner set %d (numbering) in prefix.  If the site owner had applied new
1180# style patch (from SF patch area) before, he/she may want to set this No in
1181# mm_cfg.py.
1182OLD_STYLE_PREFIXING = Yes
1183
1184# Scrub regular delivery
1185DEFAULT_SCRUB_NONDIGEST = False
1186
1187# Mail command processor will ignore mail command lines after designated max.
1188DEFAULT_MAIL_COMMANDS_MAX_LINES = 25
1189
1190# Is the list owner notified of admin requests immediately by mail, as well as
1191# by daily pending-request reminder?
1192DEFAULT_ADMIN_IMMED_NOTIFY = Yes
1193
1194# Is the list owner notified of subscribes/unsubscribes?
1195DEFAULT_ADMIN_NOTIFY_MCHANGES = No
1196
1197# Discard held messages after this days
1198DEFAULT_MAX_DAYS_TO_HOLD = 0
1199
1200# Should list members, by default, have their posts be moderated?
1201DEFAULT_DEFAULT_MEMBER_MODERATION = No
1202
1203# Should non-member posts which are auto-discarded also be forwarded to the
1204# moderators?
1205DEFAULT_FORWARD_AUTO_DISCARDS = Yes
1206
1207# Shall dmarc_moderation_action be applied to messages From: domains with
1208# a DMARC policy of quarantine as well as reject?  This sets the default for
1209# the list setting that controls it.
1210DEFAULT_DMARC_QUARANTINE_MODERATION_ACTION = Yes
1211
1212# Default action for posts whose From: address domain has a DMARC policy of
1213# reject or quarantine.  See DEFAULT_FROM_IS_LIST below.  Whatever is set as
1214# the default here precludes the list owner from setting a lower value, however
1215# an existing list won't be changed until the first time "Submit Your Changes"
1216# is pressed on the list's Privacy options... -> Sender filters page.
1217# 0 = Accept
1218# 1 = Munge From
1219# 2 = Wrap Message
1220# 3 = Reject
1221# 4 = Discard
1222DEFAULT_DMARC_MODERATION_ACTION = 0
1223
1224# Domain owners can publish DMARC p=none policy in order to request that
1225# reports of DMARC failures be sent but special action not be taken on
1226# messages From: their domain that fail DMARC.  This can result in over
1227# estimation of the number of messages that would be quarantined or rejected
1228# with a stronger DMARC policy if such a policy would result in message
1229# modification because dmarc_moderation_action is 1 or 2.  Thus, there is
1230# a list setting to apply dmarc_moderaction_action of 1 or 2 to messages
1231# From: domains with DMARC p=none.  Setting this to Yes is only effective if
1232# dmarc_quarantine_moderaction_action is also Yes.  The following is the
1233# default for this setting for new lists.
1234DEFAULT_DMARC_NONE_MODERATION_ACTION = No
1235
1236# Default for text to be added to a separate text/plain part preceding the
1237# message/rfc822 part containing the original message when
1238# dmarc_moderation_action is Wrap Message.
1239DEFAULT_DMARC_WRAPPED_MESSAGE_TEXT = ''
1240
1241# Parameters for DMARC DNS lookups. If you are seeing 'DNSException:
1242# Unable to query DMARC policy ...' entries in your error log, you may need
1243# to adjust these.
1244# The time to wait for a response from a name server before timeout.
1245DMARC_RESOLVER_TIMEOUT = seconds(3)
1246# The total time to spend trying to get an answer to the question.
1247DMARC_RESOLVER_LIFETIME = seconds(5)
1248
1249# A URL from which to retrieve the data for the algorithm that computes
1250# Organizational Domains for DMARC policy lookup purposes.  This can be
1251# anything handled by the Python urllib2.urlopen function.  See
1252# https://publicsuffix.org/list/ for info.
1253DMARC_ORGANIZATIONAL_DOMAIN_DATA_URL = \
1254'https://publicsuffix.org/list/public_suffix_list.dat'
1255
1256# Should the list server auto-moderate members who post too frequently
1257# This is intended to stop people who join a list and then use a bot to
1258# send many spam messages in a short interval.  These are default settings
1259# for new lists.  See the web admin Privacy options -> Sender filters page
1260# and the Details for member_verbosity_threshold and member_verbosity_interval
1261# links for more information.
1262# DEFAULT_MEMBER_VERBOSITY_INTERVAL = number of seconds to track posts
1263# DEFAULT_MEMBER_VERBOSITY_THRESHOLD = number of allowed posts per interval
1264#                                     (0 to disable).
1265DEFAULT_MEMBER_VERBOSITY_INTERVAL = 300
1266DEFAULT_MEMBER_VERBOSITY_THRESHOLD = 0
1267
1268# This controls how often to clean old post time entries from the dictionary
1269# used to implement the member verbosity feature. This is a compromise between
1270# using resources for cleaning and allowing the dictionary to grow very large.
1271# The setting is the number of passes through the code before the dictionary
1272# is cleaned.
1273VERBOSE_CLEAN_LIMIT = 1000
1274
1275# What domains should be considered equivalent when testing list membership
1276# for posting/moderation.
1277# If two poster addresses with the same local part but
1278# different domains are to be considered equivalents for list
1279# membership tests, the domains are put in the list's equivalent_domains.
1280# This provides a default value for new lists.
1281# The format is one or more groups of equivalent domains.  Within a group,
1282# the domains are separated by commas and multiple groups are
1283# separated by semicolons. White space is ignored.
1284# For example:
1285#
1286#    'example.com,mail.example.com;mac.com,me.com,icloud.com'
1287#
1288# In this example, if user@example.com is a list member,
1289# a post from user@mail.example.com will be treated as if it is
1290# from user@example.com for list membership/moderation purposes,
1291# and likewise, if user@me.com is a list member, posts from
1292# user@mac.com or user@icloud.com will be treated as if from
1293# user@me.com.
1294DEFAULT_EQUIVALENT_DOMAINS = ''
1295
1296# What should happen to non-member posts which are do not match explicit
1297# non-member actions?
1298# 0 = Accept
1299# 1 = Hold
1300# 2 = Reject
1301# 3 = Discard
1302DEFAULT_GENERIC_NONMEMBER_ACTION = 1
1303
1304# Bounce if 'To:', 'Cc:', or 'Resent-To:' fields don't explicitly name list?
1305# This is an anti-spam measure
1306DEFAULT_REQUIRE_EXPLICIT_DESTINATION = Yes
1307
1308# Alternate names acceptable as explicit destinations for this list.
1309DEFAULT_ACCEPTABLE_ALIASES ="""
1310"""
1311# For mailing lists that have only other mailing lists for members:
1312DEFAULT_UMBRELLA_LIST = No
1313
1314# For umbrella lists, the suffix for the account part of address for
1315# administrative notices (subscription confirmations, password reminders):
1316DEFAULT_UMBRELLA_MEMBER_ADMIN_SUFFIX = "-owner"
1317
1318# Exclude/include (sibling) lists for non-digest delivery.
1319DEFAULT_REGULAR_EXCLUDE_LISTS = []
1320DEFAULT_REGULAR_INCLUDE_LISTS = []
1321DEFAULT_REGULAR_EXCLUDE_IGNORE = True
1322ALLOW_CROSS_DOMAIN_SIBLING = False
1323
1324# This variable controls whether monthly password reminders are sent.
1325DEFAULT_SEND_REMINDERS = Yes
1326
1327# Send welcome messages to new users?
1328DEFAULT_SEND_WELCOME_MSG = Yes
1329
1330# Send goodbye messages to unsubscribed members?
1331DEFAULT_SEND_GOODBYE_MSG = Yes
1332
1333# The following is a three way setting.  It sets the default for the list's
1334# from_is_list policy which is applied to all posts except those for which a
1335# dmarc_moderation_action other than accept applies.
1336# 0 -> Do not rewrite the From: or wrap the message.
1337# 1 -> Rewrite the From: header of posts replacing the posters address with
1338#      that of the list.  Also see REMOVE_DKIM_HEADERS above.
1339# 2 -> Do not modify the From: of the message, but wrap the message in an outer
1340#      message From the list address.
1341DEFAULT_FROM_IS_LIST = 0
1342
1343# Wipe sender information, and make it look like the list-admin
1344# address sends all messages
1345DEFAULT_ANONYMOUS_LIST = No
1346
1347# {header-name: regexp} spam filtering - we include some for example sake.
1348DEFAULT_BOUNCE_MATCHING_HEADERS = """
1349# Lines that *start* with a '#' are comments.
1350to: friend@public.com
1351message-id: relay.comanche.denmark.eu
1352from: list@listme.com
1353from: .*@uplinkpro.com
1354"""
1355
1356# Mailman can be configured to "munge" Reply-To: headers for any passing
1357# messages.  One the one hand, there are a lot of good reasons not to munge
1358# Reply-To: but on the other, people really seem to want this feature.  See
1359# the help for reply_goes_to_list in the web UI for links discussing the
1360# issue.
1361# 0 - Reply-To: not munged
1362# 1 - Reply-To: set back to the list
1363# 2 - Reply-To: set to an explicit value (reply_to_address)
1364DEFAULT_REPLY_GOES_TO_LIST = 0
1365
1366# Mailman can be configured to strip any existing Reply-To: header, or simply
1367# extend any existing Reply-To: with one based on the above setting.
1368DEFAULT_FIRST_STRIP_REPLY_TO = No
1369
1370# SUBSCRIBE POLICY
1371# 0 - open list (only when ALLOW_OPEN_SUBSCRIBE is set to 1) **
1372# 1 - confirmation required for subscribes
1373# 2 - admin approval required for subscribes
1374# 3 - both confirmation and admin approval required
1375#
1376# ** please do not choose option 0 if you are not allowing open
1377# subscribes (next variable)
1378DEFAULT_SUBSCRIBE_POLICY = 1
1379
1380# Does this site allow completely unchecked subscriptions?
1381ALLOW_OPEN_SUBSCRIBE = No
1382
1383# This is the default list of addresses and regular expressions (beginning
1384# with ^) that are exempt from approval if SUBSCRIBE_POLICY is 2 or 3.
1385DEFAULT_SUBSCRIBE_AUTO_APPROVAL = []
1386
1387# The default policy for unsubscriptions.  0 (unmoderated unsubscribes) is
1388# highly recommended!
1389# 0 - unmoderated unsubscribes
1390# 1 - unsubscribes require approval
1391DEFAULT_UNSUBSCRIBE_POLICY = 0
1392
1393# Private_roster == 0: anyone can see, 1: members only, 2: admin only.
1394DEFAULT_PRIVATE_ROSTER = 1
1395
1396# When exposing members, make them unrecognizable as email addrs, so
1397# web-spiders can't pick up addrs for spam purposes.
1398DEFAULT_OBSCURE_ADDRESSES = Yes
1399
1400# RFC 2369 defines List-* headers which are added to every message sent
1401# through to the mailing list membership.  These are a very useful aid to end
1402# users and should always be added.  However, not all MUAs are compliant and
1403# if a list's membership has many such users, they may clamor for these
1404# headers to be suppressed.  By setting this variable to Yes, list owners will
1405# be given the option to suppress these headers.  By setting it to No, list
1406# owners will not be given the option to suppress these headers (although some
1407# header suppression may still take place, i.e. for announce-only lists, or
1408# lists with no archives).
1409ALLOW_RFC2369_OVERRIDES = Yes
1410
1411# RFC 2822 suggests that not adding a Sender header when Mailman is the agent
1412# responsible for the actual transmission is a breach of the RFC.  However,
1413# some MUAs (notably Outlook) tend to display the Sender header instead of the
1414# From details, confusing users and actually losing the original sender when
1415# forwarding mail.  By setting this variable to Yes, list owners will be
1416# given the option to avoid setting this header.
1417ALLOW_SENDER_OVERRIDES = Yes
1418
1419# Defaults for content filtering on mailing lists.  DEFAULT_FILTER_CONTENT is
1420# a flag which if set to true, turns on content filtering.
1421DEFAULT_FILTER_CONTENT = No
1422
1423# DEFAULT_FILTER_MIME_TYPES is a list of MIME types to be removed.  This is a
1424# list of strings of the format "maintype/subtype" or simply "maintype".
1425# E.g. "text/html" strips all html attachments while "image" strips all image
1426# types regardless of subtype (jpeg, gif, etc.).
1427DEFAULT_FILTER_MIME_TYPES = []
1428
1429# DEFAULT_PASS_MIME_TYPES is a list of MIME types to be passed through.
1430# Format is the same as DEFAULT_FILTER_MIME_TYPES
1431DEFAULT_PASS_MIME_TYPES = ['multipart',
1432                           'message/rfc822',
1433                           'application/pgp-signature',
1434                           'text/plain',
1435                          ]
1436
1437# DEFAULT_FILTER_FILENAME_EXTENSIONS is a list of filename extensions to be
1438# removed. It is useful because many viruses fake their content-type as
1439# harmless ones while keep their extension as executable and expect to be
1440# executed when victims 'open' them.
1441DEFAULT_FILTER_FILENAME_EXTENSIONS = [
1442    'exe', 'bat', 'cmd', 'com', 'pif', 'scr', 'vbs', 'cpl'
1443    ]
1444
1445# DEFAULT_PASS_FILENAME_EXTENSIONS is a list of filename extensions to be
1446# passed through. Format is the same as DEFAULT_FILTER_FILENAME_EXTENSIONS.
1447DEFAULT_PASS_FILENAME_EXTENSIONS = []
1448
1449# Replace multipart/alternative with its first alternative.
1450DEFAULT_COLLAPSE_ALTERNATIVES = Yes
1451
1452# Whether text/html should be converted to text/plain after content filtering
1453# is performed.  Conversion is done according to HTML_TO_PLAIN_TEXT_COMMAND
1454DEFAULT_CONVERT_HTML_TO_PLAINTEXT = Yes
1455
1456# Default action to take on filtered messages.
1457# 0 = Discard, 1 = Reject, 2 = Forward, 3 = Preserve
1458DEFAULT_FILTER_ACTION = 0
1459
1460# Whether to allow list owners to preserve content filtered messages to a
1461# special queue on the disk.
1462OWNERS_CAN_PRESERVE_FILTERED_MESSAGES = Yes
1463
1464# Check for administrivia in messages sent to the main list?
1465DEFAULT_ADMINISTRIVIA = Yes
1466
1467# The process which avoids sending a list copy of a message to a member who
1468# is also directly addressed in To: or Cc: can drop the address from Cc: to
1469# avoid growing a long Cc: list in long threads.  This can be undesirable as
1470# it can break DKIM signatures and possibly cause confusion.  To avoid changes
1471# to Cc: headers, set the list's drop_cc to No.
1472DEFAULT_DROP_CC = Yes
1473
1474
1475
1476#####
1477# Digestification defaults.  Same caveat applies here as with list defaults.
1478#####
1479
1480# Will list be available in non-digested form?
1481DEFAULT_NONDIGESTABLE = Yes
1482
1483# Will list be available in digested form?
1484DEFAULT_DIGESTABLE = Yes
1485DEFAULT_DIGEST_HEADER = ""
1486DEFAULT_DIGEST_FOOTER = """%(real_name)s mailing list
1487%(real_name)s@%(host_name)s
1488%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
1489"""
1490
1491DEFAULT_DIGEST_IS_DEFAULT = No
1492DEFAULT_MIME_IS_DEFAULT_DIGEST = No
1493DEFAULT_DIGEST_SIZE_THRESHHOLD = 30     # KB
1494DEFAULT_DIGEST_SEND_PERIODIC = Yes
1495
1496# Headers which should be kept in both RFC 1153 (plain) and MIME digests.  RFC
1497# 1153 also specifies these headers in this exact order, so order matters.
1498MIME_DIGEST_KEEP_HEADERS = [
1499    'Date', 'From', 'To', 'Cc', 'Subject', 'Message-ID', 'Keywords',
1500    # I believe we should also keep these headers though.
1501    'In-Reply-To', 'References', 'Content-Type', 'MIME-Version',
1502    'Content-Transfer-Encoding', 'Precedence', 'Reply-To', 'List-Post',
1503    # Mailman 2.0 adds these headers
1504    'Message',
1505    ]
1506
1507# The order in this list controls the order of the RFC 1153 digest headers.
1508# Also, any headers in this list will be kept in the MIME digest even if they
1509# don't appear in the MIME list above.  Finally, headers appearing in both
1510# lists must be casewise the same or duplication can result in the digest.
1511PLAIN_DIGEST_KEEP_HEADERS = [
1512    'Message',
1513    # RFC 1153 headers in order
1514    'Date', 'From', 'To', 'Cc', 'Subject', 'Message-ID', 'Keywords',
1515    'Content-Type',
1516    ]
1517
1518
1519
1520#####
1521# Bounce processing defaults.  Same caveat applies here as with list defaults.
1522#####
1523
1524# Should we do any bounced mail response at all?
1525DEFAULT_BOUNCE_PROCESSING = Yes
1526
1527# How often should the bounce qrunner process queued detected bounces?
1528REGISTER_BOUNCES_EVERY = minutes(15)
1529
1530# Bounce processing works like this: when a bounce from a member is received,
1531# we look up the `bounce info' for this member. If there is no bounce info,
1532# this is the first bounce we've received from this member.  In that case, we
1533# record today's date, and initialize the bounce score (see below for initial
1534# value).
1535#
1536# If there is existing bounce info for this member, we look at the last bounce
1537# receive date.  If this date is farther away from today than the `bounce
1538# expiration interval', we throw away all the old data and initialize the
1539# bounce score as if this were the first bounce from the member.
1540#
1541# Otherwise, we increment the bounce score.  If we can determine whether the
1542# bounce was soft or hard (i.e. transient or fatal), then we use a score value
1543# of 0.5 for soft bounces and 1.0 for hard bounces.  Note that we only score
1544# one bounce per day.  If the bounce score is then greater than the `bounce
1545# threshold' we disable the member's address.
1546#
1547# After disabling the address, we can send warning messages to the member,
1548# providing a confirmation cookie/url for them to use to re-enable their
1549# delivery.  After a configurable period of time, we'll delete the address.
1550# When we delete the address due to bouncing, we'll send one last message to
1551# the member.
1552
1553# Bounce scores greater than this value get disabled.
1554DEFAULT_BOUNCE_SCORE_THRESHOLD = 5.0
1555
1556# Bounce information older than this interval is considered stale, and is
1557# discarded.
1558DEFAULT_BOUNCE_INFO_STALE_AFTER = days(7)
1559
1560# The number of notifications to send to the disabled/removed member before we
1561# remove them from the list.  A value of 0 means we remove the address
1562# immediately (with one last notification).  Note that the first one is sent
1563# upon change of status to disabled.
1564DEFAULT_BOUNCE_YOU_ARE_DISABLED_WARNINGS = 3
1565
1566# The interval of time between disabled warnings.
1567DEFAULT_BOUNCE_YOU_ARE_DISABLED_WARNINGS_INTERVAL = days(7)
1568
1569# Does the list owner get messages to the -bounces (and -admin) address that
1570# failed to match by the bounce detector?
1571DEFAULT_BOUNCE_UNRECOGNIZED_GOES_TO_LIST_OWNER = Yes
1572
1573# Does the list owner get a copy of every recognized bounce that increments
1574# the score for a list member but doesn't result in a disable or probe?
1575DEFAULT_BOUNCE_NOTIFY_OWNER_ON_BOUNCE_INCREMENT = No
1576
1577# Notifications on bounce actions.  The first specifies whether the list owner
1578# should get a notification when a member is disabled due to bouncing, while
1579# the second specifies whether the owner should get one when the member is
1580# removed due to bouncing.
1581DEFAULT_BOUNCE_NOTIFY_OWNER_ON_DISABLE = Yes
1582DEFAULT_BOUNCE_NOTIFY_OWNER_ON_REMOVAL = Yes
1583
1584
1585
1586#####
1587# General time limits
1588#####
1589
1590# Default length of time a pending request is live before it is evicted from
1591# the pending database.
1592PENDING_REQUEST_LIFE = days(3)
1593
1594# How long should messages which have delivery failures continue to be
1595# retried?  After this period of time, a message that has failed recipients
1596# will be dequeued and those recipients will never receive the message.
1597DELIVERY_RETRY_PERIOD = days(5)
1598
1599# How long should we wait before we retry a temporary delivery failure?
1600# Because RetryRunner sleeps for 15 minutes between processes of its queue,
1601# whatever is put here is effectively rounded up to the next integer multiple
1602# of 15 minutes.
1603DELIVERY_RETRY_WAIT = hours(1)
1604
1605
1606
1607#####
1608# Lock management defaults
1609#####
1610
1611# These variables control certain aspects of lock acquisition and retention.
1612# They should be tuned as appropriate for your environment.  All variables are
1613# specified in units of floating point seconds.  YOU MAY NEED TO TUNE THESE
1614# VARIABLES DEPENDING ON THE SIZE OF YOUR LISTS, THE PERFORMANCE OF YOUR
1615# HARDWARE, NETWORK AND GENERAL MAIL HANDLING CAPABILITIES, ETC.
1616
1617# Set this to On to turn on MailList object lock debugging messages, which
1618# will be written to logs/locks.  If you think you're having lock problems, or
1619# just want to tune the locks for your system, turn on lock debugging.
1620LIST_LOCK_DEBUGGING = Off
1621
1622# This variable specifies how long the lock will be retained for a specific
1623# operation on a mailing list.  Watch your logs/lock file and if you see a lot
1624# of lock breakages, you might need to bump this up.  However if you set this
1625# too high, a faulty script (or incorrect use of bin/withlist) can prevent the
1626# list from being used until the lifetime expires.  This is probably one of
1627# the most crucial tuning variables in the system.
1628LIST_LOCK_LIFETIME = hours(5)
1629
1630# This variable specifies how long an attempt will be made to acquire a list
1631# lock by the incoming qrunner process.  If the lock acquisition times out,
1632# the message will be re-queued for later delivery.
1633LIST_LOCK_TIMEOUT = seconds(10)
1634
1635# Set this to On to turn on lock debugging messages for the pending requests
1636# database, which will be written to logs/locks.  If you think you're having
1637# lock problems, or just want to tune the locks for your system, turn on lock
1638# debugging.
1639PENDINGDB_LOCK_DEBUGGING = Off
1640
1641
1642
1643#####
1644# Nothing below here is user configurable.  Most of these values are in this
1645# file for internal system convenience.  Don't change any of them or override
1646# any of them in your mm_cfg.py file!
1647#####
1648
1649# These directories are used to find various important files in the Mailman
1650# installation.  PREFIX and EXEC_PREFIX are set by configure and should point
1651# to the installation directory of the Mailman package.
1652PYTHON          = '@PYTHON@'
1653PREFIX          = '@prefix@'
1654EXEC_PREFIX     = '@exec_prefix@'
1655VAR_PREFIX      = '@VAR_PREFIX@'
1656
1657# Work around a bogus autoconf 2.12 bug
1658if EXEC_PREFIX == '${prefix}':
1659    EXEC_PREFIX = PREFIX
1660
1661# CGI extension, change using configure script
1662CGIEXT = '@CGIEXT@'
1663
1664# Group id that group-owns the Mailman installation
1665MAILMAN_USER = '@MAILMAN_USER@'
1666MAILMAN_GROUP = '@MAILMAN_GROUP@'
1667
1668# Enumeration for Mailman cgi widget types
1669Toggle      = 1
1670Radio       = 2
1671String      = 3
1672Text        = 4
1673Email       = 5
1674EmailList   = 6
1675Host        = 7
1676Number      = 8
1677FileUpload  = 9
1678Select      = 10
1679Topics      = 11
1680Checkbox    = 12
1681# An "extended email list".  Contents must be an email address or a ^-prefixed
1682# regular expression.  Used in the sender moderation text boxes.
1683EmailListEx = 13
1684# Extended spam filter widget
1685HeaderFilter  = 14
1686
1687# Actions
1688DEFER = 0
1689APPROVE = 1
1690REJECT = 2
1691DISCARD = 3
1692SUBSCRIBE = 4
1693UNSUBSCRIBE = 5
1694ACCEPT = 6
1695HOLD = 7
1696
1697# admindb summary sort button settings.  All must evaluate to True.
1698SSENDER = 1
1699SSENDERTIME = 2
1700STIME = 3
1701
1702# Standard text field width
1703TEXTFIELDWIDTH = 40
1704
1705# Bitfield for user options.  See DEFAULT_NEW_MEMBER_OPTIONS above to set
1706# defaults for all new lists.
1707Digests             = 0 # handled by other mechanism, doesn't need a flag.
1708DisableDelivery     = 1 # Obsolete; use set/getDeliveryStatus()
1709DontReceiveOwnPosts = 2 # Non-digesters only
1710AcknowledgePosts    = 4
1711DisableMime         = 8 # Digesters only
1712ConcealSubscription = 16
1713SuppressPasswordReminder = 32
1714ReceiveNonmatchingTopics = 64
1715Moderate = 128
1716DontReceiveDuplicates = 256
1717
1718# A mapping between short option tags and their flag
1719OPTINFO = {'hide'    : ConcealSubscription,
1720           'nomail'  : DisableDelivery,
1721           'ack'     : AcknowledgePosts,
1722           'notmetoo': DontReceiveOwnPosts,
1723           'digest'  : 0,
1724           'plain'   : DisableMime,
1725           'noremind': SuppressPasswordReminder,
1726           'nmtopics': ReceiveNonmatchingTopics,
1727           'mod'     : Moderate,
1728           'nodupes' : DontReceiveDuplicates
1729           }
1730
1731# Authentication contexts.
1732#
1733# Mailman defines the following roles:
1734
1735# - User, a normal user who has no permissions except to change their personal
1736#   option settings
1737# - List creator, someone who can create and delete lists, but cannot
1738#   (necessarily) configure the list.
1739# - List poster, someone who can pre-approve her/his own posts to the list by
1740#   including an Approved: or X-Approved: header or first body line pseudo-
1741#   header containing the poster password. The list admin and moderator
1742#   passwords can also be used for this purpose, but the poster password can
1743#   only be used for this and nothing else.
1744# - List moderator, someone who can tend to pending requests such as
1745#   subscription requests, or held messages
1746# - List administrator, someone who has total control over a list, can
1747#   configure it, modify user options for members of the list, subscribe and
1748#   unsubscribe members, etc.
1749# - Site administrator, someone who has total control over the entire site and
1750#   can do any of the tasks mentioned above.  This person usually also has
1751#   command line access.
1752
1753UnAuthorized = 0
1754AuthUser = 1          # Joe Shmoe User
1755AuthCreator = 2       # List Creator / Destroyer
1756AuthListAdmin = 3     # List Administrator (total control over list)
1757AuthListModerator = 4 # List Moderator (can only handle held requests)
1758AuthSiteAdmin = 5     # Site Administrator (total control over everything)
1759AuthListPoster = 6    # List poster (Approved: <pw> header in posts only)
1760
1761# Useful directories
1762LIST_DATA_DIR   = os.path.join(VAR_PREFIX, 'lists')
1763LOG_DIR         = os.path.join(VAR_PREFIX, 'logs')
1764LOCK_DIR        = os.path.join(VAR_PREFIX, 'locks')
1765DATA_DIR        = os.path.join(VAR_PREFIX, 'data')
1766SPAM_DIR        = os.path.join(VAR_PREFIX, 'spam')
1767WRAPPER_DIR     = os.path.join(EXEC_PREFIX, 'mail')
1768BIN_DIR         = os.path.join(PREFIX, 'bin')
1769SCRIPTS_DIR     = os.path.join(PREFIX, 'scripts')
1770TEMPLATE_DIR    = os.path.join(PREFIX, 'templates')
1771MESSAGES_DIR    = os.path.join(PREFIX, 'messages')
1772PUBLIC_ARCHIVE_FILE_DIR  = os.path.join(VAR_PREFIX, 'archives', 'public')
1773PRIVATE_ARCHIVE_FILE_DIR = os.path.join(VAR_PREFIX, 'archives', 'private')
1774
1775# Directories used by the qrunner subsystem
1776QUEUE_DIR       = os.path.join(VAR_PREFIX, 'qfiles')
1777INQUEUE_DIR     = os.path.join(QUEUE_DIR, 'in')
1778OUTQUEUE_DIR    = os.path.join(QUEUE_DIR, 'out')
1779CMDQUEUE_DIR    = os.path.join(QUEUE_DIR, 'commands')
1780BOUNCEQUEUE_DIR = os.path.join(QUEUE_DIR, 'bounces')
1781NEWSQUEUE_DIR   = os.path.join(QUEUE_DIR, 'news')
1782ARCHQUEUE_DIR   = os.path.join(QUEUE_DIR, 'archive')
1783SHUNTQUEUE_DIR  = os.path.join(QUEUE_DIR, 'shunt')
1784VIRGINQUEUE_DIR = os.path.join(QUEUE_DIR, 'virgin')
1785BADQUEUE_DIR    = os.path.join(QUEUE_DIR, 'bad')
1786RETRYQUEUE_DIR  = os.path.join(QUEUE_DIR, 'retry')
1787MAILDIR_DIR     = os.path.join(QUEUE_DIR, 'maildir')
1788
1789# Other useful files
1790PIDFILE = os.path.join(DATA_DIR, 'master-qrunner.pid')
1791SITE_PW_FILE = os.path.join(DATA_DIR, 'adm.pw')
1792LISTCREATOR_PW_FILE = os.path.join(DATA_DIR, 'creator.pw')
1793
1794# Import a bunch of version numbers
1795from Version import *
1796
1797# Vgg: Language descriptions and charsets dictionary, any new supported
1798# language must have a corresponding entry here. Key is the name of the
1799# directories that hold the localized texts. Data are tuples with first
1800# element being the description, as described in the catalogs, and second
1801# element is the language charset.  I have chosen code from /usr/share/locale
1802# in my GNU/Linux. :-)
1803def _(s):
1804    return s
1805
1806LC_DESCRIPTIONS = {}
1807
1808def add_language(code, description, charset, direction='ltr'):
1809    LC_DESCRIPTIONS[code] = (description, charset, direction)
1810
1811add_language('ar',    _('Arabic'),              'utf-8',       'rtl')
1812add_language('ast',   _('Asturian'),            'iso-8859-1',  'ltr')
1813add_language('ca',    _('Catalan'),             'utf-8',       'ltr')
1814add_language('cs',    _('Czech'),               'iso-8859-2',  'ltr')
1815add_language('da',    _('Danish'),              'iso-8859-1',  'ltr')
1816add_language('de',    _('German'),              'iso-8859-1',  'ltr')
1817add_language('en',    _('English (USA)'),       'us-ascii',    'ltr')
1818add_language('eo',    _('Esperanto'),           'utf-8',       'ltr')
1819add_language('es',    _('Spanish (Spain)'),     'iso-8859-1',  'ltr')
1820add_language('et',    _('Estonian'),            'iso-8859-15', 'ltr')
1821add_language('eu',    _('Euskara'),             'iso-8859-15', 'ltr') # Basque
1822add_language('fa',    _('Persian'),             'utf-8',       'rtl')
1823add_language('fi',    _('Finnish'),             'iso-8859-1',  'ltr')
1824add_language('fr',    _('French'),              'iso-8859-1',  'ltr')
1825add_language('gl',    _('Galician'),            'utf-8',       'ltr')
1826add_language('el',    _('Greek'),               'iso-8859-7',  'ltr')
1827add_language('he',    _('Hebrew'),              'utf-8',       'rtl')
1828add_language('hr',    _('Croatian'),            'iso-8859-2',  'ltr')
1829add_language('hu',    _('Hungarian'),           'iso-8859-2',  'ltr')
1830add_language('ia',    _('Interlingua'),         'iso-8859-15', 'ltr')
1831add_language('it',    _('Italian'),             'iso-8859-1',  'ltr')
1832add_language('ja',    _('Japanese'),            'euc-jp',      'ltr')
1833add_language('ko',    _('Korean'),              'euc-kr',      'ltr')
1834add_language('lt',    _('Lithuanian'),          'iso-8859-13', 'ltr')
1835add_language('nl',    _('Dutch'),               'iso-8859-1',  'ltr')
1836add_language('no',    _('Norwegian'),           'iso-8859-1',  'ltr')
1837add_language('pl',    _('Polish'),              'iso-8859-2',  'ltr')
1838add_language('pt',    _('Portuguese'),          'iso-8859-1',  'ltr')
1839add_language('pt_BR', _('Portuguese (Brazil)'), 'iso-8859-1',  'ltr')
1840add_language('ro',    _('Romanian'),            'utf-8',       'ltr')
1841add_language('ru',    _('Russian'),             'utf-8',       'ltr')
1842add_language('sk',    _('Slovak'),              'utf-8',       'ltr')
1843add_language('sl',    _('Slovenian'),           'iso-8859-2',  'ltr')
1844add_language('sr',    _('Serbian'),             'utf-8',       'ltr')
1845add_language('sv',    _('Swedish'),             'iso-8859-1',  'ltr')
1846add_language('tr',    _('Turkish'),             'iso-8859-9',  'ltr')
1847add_language('uk',    _('Ukrainian'),           'utf-8',       'ltr')
1848add_language('vi',    _('Vietnamese'),          'utf-8',       'ltr')
1849add_language('zh_CN', _('Chinese (China)'),     'utf-8',       'ltr')
1850add_language('zh_TW', _('Chinese (Taiwan)'),    'utf-8',       'ltr')
1851
1852del _
1853