1 # Copyright (C) 2008-2009 by the Free Software Foundation, Inc.
3 # This file is part of GNU Mailman.
5 # GNU Mailman is free software: you can redistribute it and/or modify it under
6 # the terms of the GNU General Public License as published by the Free
7 # Software Foundation, either version 3 of the License, or (at your option)
10 # GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 # You should have received a copy of the GNU General Public License along with
16 # GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
18 # This is the GNU Mailman configuration schema. It defines the default
19 # configuration options for the core system and plugins. It uses ini-style
20 # formats under the lazr.config regime to define all system configuration
21 # options. See <https://launchpad.net/lazr.config> for details.
24 # This address is the "site owner" address. Certain messages which must be
25 # delivered to a human, but which can't be delivered to a list owner (e.g. a
26 # bounce from a list owner), will be sent to this address. It should point to
28 site_owner: changeme@example.com
30 # This address is used as the from address whenever a message comes from some
31 # entity to which there is no natural reply recipient. Set this to a real
32 # human or to /dev/null. It will be appended with the host name of the list
33 # involved. This address must not bounce and it must not point to a Mailman
35 noreply_address: noreply
37 # Where all the runtime data will be kept. This directory must exist.
40 # The default language for this server.
43 # Membership tests for posting purposes are usually performed by looking at a
44 # set of headers, passing the test if any of their values match a member of
45 # the list. Headers are checked in the order given in this variable. The
46 # value From_ means to use the envelope sender. Field names are case
47 # insensitive. This is a space separate list of headers.
48 sender_headers: from from_ reply-to sender
50 # Mail command processor will ignore mail command lines after designated max.
51 email_commands_max_lines: 10
53 # Default length of time a pending request is live before it is evicted from
54 # the pending database.
55 pending_request_life: 3d
57 # A callable to run with no arguments early in the initialization process.
58 # This runs before database initialization.
61 # A callable to run with no arguments late in the initialization process.
62 # This runs after adapters are initialized.
67 # When Mailman generates them, this is the default length of member passwords.
68 member_password_length: 8
70 # Specify the type of passwords to use, when Mailman generates the passwords
71 # itself, as would be the case for membership requests where the user did not
72 # fill in a password, or during list creation, when auto-generation of admin
73 # passwords was selected.
75 # Set this value to 'yes' for classic Mailman user-friendly(er) passwords.
76 # These generate semi-pronounceable passwords which are easier to remember.
77 # Set this value to 'no' to use more cryptographically secure, but harder to
78 # remember, passwords -- if your operating system and Python version support
79 # the necessary feature (specifically that /dev/urandom be available).
80 user_friendly_passwords: yes
84 # Define which process queue runners, and how many of them, to start.
86 # The full import path to the class for this queue runner.
87 class: mailman.queue.runner.Runner
89 # The directory path that this queue runner scans.
90 path: $VAR_DIR/qfiles/$name
92 # The number of parallel queue runners. This must be a power of 2.
95 # Whether to start this queue runner or not.
98 # The maximum number of restarts for this queue runner. When the runner exits
99 # because of an error or other unexpected problem, it is automatically
100 # restarted, until the maximum number of restarts has been reached.
103 # The sleep interval for the queue runner. It wakes up once every interval to
104 # process the files in its slice of the queue directory.
108 # The class implementing the IDatabase interface.
109 class: mailman.database.StockDatabase
111 # Use this to set the Storm database engine URL. You generally have one
112 # primary database connection for all of Mailman. List data and most rosters
113 # will store their data in this database, although external rosters may access
114 # other databases in their own way. This string supports standard
115 # 'configuration' substitutions.
116 url: sqlite:///$DATA_DIR/mailman.db
120 # This defines various log settings. The options available are:
122 # - level -- Overrides the default level; this may be any of the
123 # standard Python logging levels, case insensitive.
124 # - format -- Overrides the default format string
125 # - datefmt -- Overrides the default date format string
126 # - path -- Overrides the default logger path. This may be a relative
127 # path name, in which case it is relative to Mailman's LOG_DIR,
128 # or it may be an absolute path name. You cannot change the
129 # handler class that will be used.
130 # - propagate -- Boolean specifying whether to propagate log message from this
131 # logger to the root "mailman" logger. You cannot override
132 # settings for the root logger.
134 # In this section, you can define defaults for all loggers, which will be
135 # prefixed by 'mailman.'. Use subsections to override settings for specific
136 # loggers. The names of the available loggers are:
138 # - archiver -- All archiver output
139 # - bounce -- All bounce processing logs go here
140 # - config -- Configuration issues
141 # - debug -- Only used for development
142 # - error -- All exceptions go to this log
143 # - fromusenet -- Information related to the Usenet to Mailman gateway
144 # - http -- Internal wsgi-based web interface
145 # - locks -- Lock state changes
146 # - mischief -- Various types of hostile activity
147 # - post -- Information about messages posted to mailing lists
148 # - qrunner -- qrunner start/stops
149 # - smtp -- Successful SMTP activity
150 # - smtp-failure -- Unsuccessful SMTP activity
151 # - subscribe -- Information about leaves/joins
152 # - vette -- Information related to admindb activity
153 format: %(asctime)s (%(process)d) %(message)s
154 datefmt: %b %d %H:%M:%S %Y
187 # The smtp logger defines additional options for handling the logging of each
188 # attempted delivery. These format strings specify what information is logged
189 # for every message, every successful delivery, every refused delivery and
190 # every recipient failure. To disable a status message, set the value to 'no'
191 # (without the quotes).
193 # These template strings accept the following set of substitution
194 # placeholders, if available.
196 # msgid -- the Message-ID of the message in question
197 # listname -- the fully-qualified list name
198 # sender -- the sender if available
199 # recip -- the recipient address if available, or the number of
200 # recipients being delivered to
201 # size -- the approximate size of the message in bytes
202 # seconds -- the number of seconds the operation took
203 # refused -- the number of refused recipients
204 # smtpcode -- the SMTP success or failure code
205 # smtpmsg -- the SMTP success or failure message
207 every: $msgid smtp to $listname for $recip recips, completed in $time seconds
208 success: $msgid post to $listname from $sender, $size bytes
209 refused: $msgid post to $listname from $sender, $size bytes, $refused failures
210 failure: $msgid delivery to $recip failed with code $smtpcode, $smtpmsg
219 # The hostname at which admin web service resources are exposed.
222 # The port at which the admin web service resources are exposed.
225 # Whether or not requests to the web service are secured through SSL.
228 # Default view permission for the admin web service.
229 view_permission: None
231 # Whether or not to show tracebacks in an HTTP response for a request that
232 # raised an exception.
237 # Template for language definitions. The section name must be [language.xx]
238 # where xx is the 2-character ISO code for the language.
240 # The English name for the language.
241 description: English (USA)
242 # And the default character set for the language.
244 # Whether the language is enabled or not.
248 [spam.headers.template]
249 # This section defines basic header matching actions. Each spam.header
250 # section names a header to match (case-insensitively), a pattern to match
251 # against the header's value, and the chain to jump to when the match
254 # The header value should not include the trailing colon.
256 # The pattern is always matched with re.IGNORECASE.
258 # The chain to jump to if the pattern matches. Maybe be any existing chain
259 # such as 'discard', 'reject', 'hold', or 'accept'.
264 # The class defining the interface to the incoming mail transport agent.
265 incoming: mailman.mta.postfix.LMTP
267 # The class defining the interface to the outgoing mail transport agent.
268 outgoing: mailman.mta.smtp_direct.process
270 # How to connect to the outgoing MTA.
274 # Where the LMTP server listens for connections.
278 # Ceiling on the number of recipients that can be specified in a single SMTP
279 # transaction. Set to 0 to submit the entire recipient list in one
283 # Ceiling on the number of SMTP sessions to perform on a single socket
284 # connection. Some MTAs have limits. Set this to 0 to do as many as we like
285 # (i.e. your MTA has no limits). Set this to some number great than 0 and
286 # Mailman will close the SMTP connection and re-open it after this number of
287 # consecutive sessions.
288 max_sessions_per_connection: 0
290 # Maximum number of simultaneous subthreads that will be used for SMTP
291 # delivery. After the recipients list is chunked according to max_recipients,
292 # each chunk is handed off to the SMTP server by a separate such thread. If
293 # your Python interpreter was not built for threads, this feature is disabled.
294 # You can explicitly disable it in all cases by setting max_delivery_threads
296 max_delivery_threads: 0
298 # How long should messages which have delivery failures continue to be
299 # retried? After this period of time, a message that has failed recipients
300 # will be dequeued and those recipients will never receive the message.
301 delivery_retry_period: 5d
303 # These variables control the format and frequency of VERP-like delivery for
304 # better bounce detection. VERP is Variable Envelope Return Path, defined
307 # http://cr.yp.to/proto/verp.txt
309 # This involves encoding the address of the recipient as we (Mailman) know it
310 # into the envelope sender address (i.e. the SMTP `MAIL FROM:' address).
311 # Thus, no matter what kind of forwarding the recipient has in place, should
312 # it eventually bounce, we will receive an unambiguous notice of the bouncing
315 # However, we're technically only "VERP-like" because we're doing the envelope
316 # sender encoding in Mailman, not in the MTA. We do require cooperation from
317 # the MTA, so you must be sure your MTA can be configured for extended address
320 # The first variable describes how to encode VERP envelopes. It must contain
321 # these three string interpolations:
323 # $bounces -- the list-bounces mailbox will be set here
324 # $mailbox -- the recipient's mailbox will be set here
325 # $host -- the recipient's host name will be set here
327 # This example uses the default below.
329 # FQDN list address is: mylist@dom.ain
330 # Recipient is: aperson@a.nother.dom
332 # The envelope sender will be mylist-bounces+aperson=a.nother.dom@dom.ain
334 # Note that your MTA /must/ be configured to deliver such an addressed message
337 verp_format: ${bounces}+${mailbox}=${host}
339 # For nicer confirmation emails, use a VERP-like format which encodes the
340 # confirmation cookie in the reply address. This lets us put a more user
341 # friendly Subject: on the message, but requires cooperation from the MTA.
342 # Format is like verp_format, but with the following substitutions:
344 # $address -- the list-confirm address
345 # $cookie -- the confirmation cookie
346 verp_confirm_format: $address+$cookie
348 # This is analogous to verp_regexp, but for splitting apart the
349 # verp_confirm_format. MUAs have been observed that mung
351 # From: local_part@host
355 # To: "local_part" <local_part@host>
357 # when replying, so we skip everything up to '<' if any.
358 verp_confirm_regexp: ^(.*<)?(?P<addr>[^+]+?)\+(?P<cookie>[^@]+)@.*$
360 # Set this to 'yes' to enable VERP-like (more user friendly) confirmations.
361 verp_confirmations: no
363 # Another good opportunity is when regular delivery is personalized. Here
364 # again, we're already incurring the performance hit for addressing each
365 # individual recipient. Set this to 'yes' to enable VERPs on all personalized
366 # regular deliveries (personalized digests aren't supported yet).
367 verp_personalized_deliveries: no
369 # And finally, we can VERP normal, non-personalized deliveries. However,
370 # because it can be a significant performance hit, we allow you to decide how
371 # often to VERP regular deliveries. This is the interval, in number of
372 # messages, to do a VERP recipient address. The same variable controls both
373 # regular and digest deliveries. Set to 0 to disable occasional VERPs, set to
374 # 1 to VERP every delivery, or to some number > 1 for only occasional VERPs.
375 verp_delivery_interval: 0
377 # VERP format and regexp for probe messages.
378 verp_probe_format: %(bounces)s+%(token)s
379 verp_probe_regexp: ^(?P<bounces>[^+]+?)\+(?P<token>[^@]+)@.*$
380 # Set this 'yes' to activate VERP probe for disabling by bounce.
383 # This is the maximum number of automatic responses sent to an address because
384 # of -request messages or posting hold messages. This limit prevents response
385 # loops between Mailman and misconfigured remote email robots. Mailman
386 # already inhibits automatic replies to any message labeled with a header
387 # "Precendence: bulk|list|junk". This is a fallback safety valve so it should
388 # be set fairly high. Set to 0 for no limit (probably useful only for
390 max_autoresponses_per_day: 10
392 # Some list posts and mail to the -owner address may contain DomainKey or
393 # DomainKeys Identified Mail (DKIM) signature headers <http://www.dkim.org/>.
394 # Various list transformations to the message such as adding a list header or
395 # footer or scrubbing attachments or even reply-to munging can break these
396 # signatures. It is generally felt that these signatures have value, even if
397 # broken and even if the outgoing message is resigned. However, some sites
398 # may wish to remove these headers by setting this to 'yes'.
399 remove_dkim_headers: no
401 # This variable describe the program to use for regenerating the transport map
402 # db file, from the associated plain text files. The file being updated will
403 # be appended to this string (with a separating space), so it must be
404 # appropriate for os.system().
405 postfix_map_cmd: /usr/sbin/postmap
409 # How often should the bounce qrunner process queued detected bounces?
410 register_bounces_every: 15m
414 # To add new archivers, define a new section based on this one, overriding the
417 # The class implementing the IArchiver interface.
418 class: mailman.archiving.prototype.Prototype
420 # Set this to 'yes' to enable the archiver.
423 # The base url for the archiver. This is used to to calculate links to
424 # individual messages in the archive.
425 base_url: http://archive.example.com/
427 # If the archiver works by getting a copy of the message, this is the address
428 # to send the copy to.
429 recipient: archive@archive.example.com
431 # If the archiver works by calling a command on the local machine, this is the
437 # This is the stock MHonArc archiver.
438 class: mailman.archiving.mhonarc.MHonArc
440 base_url: http://$hostname/archives/$fqdn_listname
443 [archiver.mail_archive]
444 # This is the stock mail-archive.com archiver.
445 class: mailman.archiving.mailarchive.MailArchive
448 # This is the stock Pipermail archiver.
449 class: mailman.archiving.pipermail.Pipermail
451 # This sets the default `clobber date' policy for the archiver. When a
452 # message is to be archived either by Pipermail or an external archiver,
453 # Mailman can modify the Date: header to be the date the message was received
454 # instead of the Date: in the original message. This is useful if you
455 # typically receive messages with outrageous dates. Set this to 0 to retain
456 # the date of the original message, or to 1 to always clobber the date. Set
457 # it to 2 to perform `smart overrides' on the date; when the date is outside
458 # allowable_sane_date_skew (either too early or too late), then the received
459 # date is substituted instead.
460 clobber_date_policy: 2
461 allowable_sane_date_skew: 15d
463 # Pipermail archives contain the raw email addresses of the posting authors.
464 # Some view this as a goldmine for spam harvesters. Set this to 'yes' to
465 # moderately obscure email addresses, but note that this breaks mailto: URLs
466 # in the archives too.
467 obscure_email_addresses: yes
469 # When the archive is public, should Pipermail also make the raw Unix mbox
470 # file publically available?
475 # This is a prototypical sample archiver.
476 class: mailman.archiving.prototype.Prototype
480 # The style's priority, with 0 being the lowest priority.
483 # The class implementing the IStyle interface, which applies the style.
484 class: mailman.styles.default.DefaultStyle
488 # A filter that converts from multipart messages to "flat" messages
489 # (i.e. containing a single payload). This is required for Pipermail, and you
490 # may want to set it to 0 for external archivers. You can also replace it
491 # with your own module as long as it contains a process() function that takes
492 # a MailList object and a Message object. It should raise
493 # Errors.DiscardMessage if it wants to throw the message away. Otherwise it
494 # should modify the Message object as necessary.
495 archive_scrubber: mailman.archiving.pipermail.Pipermail
497 # This variable defines what happens to text/html subparts. They can be
498 # stripped completely, escaped, or filtered through an external program. The
500 # 0 - Strip out text/html parts completely, leaving a notice of the removal in
501 # the message. If the outer part is text/html, the entire message is
503 # 1 - Remove any embedded text/html parts, leaving them as HTML-escaped
504 # attachments which can be separately viewed. Outer text/html parts are
505 # simply HTML-escaped.
506 # 2 - Leave it inline, but HTML-escape it
507 # 3 - Remove text/html as attachments but don't HTML-escape them. Note: this
508 # is very dangerous because it essentially means anybody can send an HTML
509 # email to your site containing evil JavaScript or web bugs, or other
510 # nasty things, and folks viewing your archives will be susceptible. You
511 # should only consider this option if you do heavy moderation of your list
514 # Note: given the current archiving code, it is not possible to leave
515 # text/html parts inline and un-escaped. I wouldn't think it'd be a good idea
518 # The value can also be a string, in which case it is the name of a command to
519 # filter the HTML page through. The resulting output is left in an attachment
520 # or as the entirety of the message when the outer part is text/html. The
521 # format of the string must include a $filename substitution variable which
522 # will contain the name of the temporary file that the program should operate
523 # on. It should write the processed message to stdout. Set this to
524 # HTML_TO_PLAIN_TEXT_COMMAND to specify an HTML to plain text conversion
526 archive_html_sanitizer: 1
528 # Control parameter whether the scrubber should use the message attachment's
529 # filename as is indicated by the filename parameter or use 'attachement-xxx'
530 # instead. The default is set 'no' because the applications on PC and Mac
531 # begin to use longer non-ascii filenames.
532 use_attachment_filename: no
534 # Use of attachment filename extension per se is may be dangerous because
535 # viruses fakes it. You can set this 'yes' if you filter the attachment by
536 # filename extension.
537 use_attachment_filename_extension: no
541 # Headers which should be kept in both RFC 1153 (plain) and MIME digests. RFC
542 # 1153 also specifies these headers in this exact order, so order matters.
543 # These are space separated and case insensitive.
544 mime_digest_keep_headers:
545 Date From To Cc Subject Message-ID Keywords
546 In-Reply-To References Content-Type MIME-Version
547 Content-Transfer-Encoding Precedence Reply-To
550 plain_digest_keep_headers:
558 # Set these variables if you need to authenticate to your NNTP server for
559 # Usenet posting or reading. If no authentication is necessary, specify None
560 # for both variables.
564 # Set this if you have an NNTP server you prefer gatewayed lists to use.
567 # This controls how headers must be cleansed in order to be accepted by your
568 # NNTP server. Some servers like INN reject messages containing prohibited
569 # headers, or duplicate headers. The NNTP server may reject the message for
570 # other reasons, but there's little that can be programmatically done about
573 # These headers (case ignored) are removed from the original message. This is
574 # a whitespace separate list of headers.
576 nntp-posting-host nntp-posting-date x-trace
577 x-complaints-to xref date-received posted
578 posting-version relay-version received
580 # These headers are left alone, unless there are duplicates in the original
581 # message. Any second and subsequent headers are rewritten to the second
582 # named header (case preserved). This is a list of header pairs, one pair per
584 rewrite_duplicate_headers:
587 Content-Transfer-Encoding X-Original-Content-Transfer-Encoding
588 MIME-Version X-MIME-Version