| blob | 2cc72862b16774da17d63c75c2ebd6e84286955b |
1 ===============================================
2 Mailman - The GNU Mailing List Management System
3 ================================================
5 Copyright (C) 1998-2015 by the Free Software Foundation, Inc.
6 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
8 Here is a history of user visible changes to Mailman.
11 3.1.0 -- "Between The Wheels"
12 =============================
13 (2015-XX-XX)
15 Bugs
16 ----
17 * When the mailing list's `admin_notify_mchanges` is True, the list owners
18 now get the subscription notification. (Closes: #1)
19 * Fix the traceback that occurred when trying to convert a `text/html`
20 subpart to plaintext via the `mimedel` handler. Now, a configuration
21 variable `[mailman]html_to_plain_text_command` in the `mailman.cfg` file
22 defines the command to use. It defaults to `lynx`. (Closes: #109)
23 * Confirmation messages should not be `Precedence: bulk`. (Closes #75)
24 * Fix constraint violations on mailing list deletes affecting PostgreSQL.
25 Given by Abhilash Raj. (Closes #115)
26 * `mailman` command with no subcommand now prints the help text. Given by
27 Abhilash Raj. (Closes #137)
28 * The MHonArc archiver must set stdin=PIPE when calling the subprocess.
29 Given by Walter Doekes.
30 * For now, treat `DeliveryMode.summary_digests` the same as `.mime_digests`.
31 (Closes #141). Also, don't enqueue a particular digest if there are no
32 recipients for that digest.
33 * For Python versions earlier than 3.5, use a compatibility layer for a
34 backported smtpd module which can accept non-UTF-8 data. (Closes #140)
35 * Bulk emails are now decorated with headers and footers. Given by Aurélien
36 Bompard. (Closes #145)
37 * Core no longer depends on the standalone `mock` module. (Closes: #146)
38 * The logging of moderation reasons has been fixed. Given by Aurélien
39 Bompard.
40 * Collapse multiple ``Re:`` in Subject headers. Given by Mark Sapiro.
41 (Closes: #147)
42 * Added Trove classifiers to setup.py. (Closes: #152)
43 * Fix the processing of subscription confirmation messages when the mailing
44 list is set to confirm-then-moderate. (Closes #114)
45 * Fix ``UnicodeEncodeError`` in the hold chain when sending the authorization
46 email to the mailing list moderators. (Closes: #144)
47 * Fix traceback in approved handler when the moderator password is None.
48 Given by Aurélien Bompard.
49 * Fix IntegrityErrors raised under PostreSQL when deleting users and
50 addresses. Given by Aurélien Bompard.
51 * Allow mailing lists to have localhost names with a suffix matching the
52 subcommand extensions. Given by Aurélien Bompard. (Closes: #168)
53 * Don't traceback if a nonexistent message-id is deleted from the message
54 store. Given by Aurélien Bompard, tweaked by Barry Warsaw. (Closes: #167)
55 * Fix a bug in ``SubscriptionService.find_members()`` when searching for a
56 subscribed address that is not linked to a user. Given by Aurélien Bompard.
58 Configuration
59 -------------
60 * Mailing lists can now have their own header matching rules, although
61 site-defined rules still take precedence. Importing a Mailman 2.1 list
62 with header matching rules defined will create them in Mailman 3, albeit
63 with a few unsupported corner cases. Definition of new header matching
64 rules is not yet exposed through the REST API. Given by Aurélien Bompard.
65 * The default languages from Mailman 2.1 have been ported over. Given by
66 Aurélien Bompard.
68 Interfaces
69 ----------
70 * Implement reasons for why a message is being held for moderator approval.
71 Given by Aurélien Bompard, tweaked by Barry Warsaw.
72 * The default `postauth.txt` and `postheld.txt` templates now no longer
73 include the inaccurate admindb and confirmation urls.
74 * Messages now include a `Message-ID-Hash` as the replacement for
75 `X-Message-ID-Hash` although the latter is still included for backward
76 compatibility. Also be sure that all places which add the header use the
77 same algorithm. (Closes #118)
78 * ``IMessageStore.delete_message()`` no longer raises a ``LookupError`` when
79 you attempt to delete a nonexistent message from the message store.
81 Internal API
82 ------------
83 * A handful of unused legacy exceptions have been removed. The redundant
84 `MailmanException` has been removed; use `MailmanError` everywhere.
86 Message handling
87 ----------------
88 * New placeholders have been added for message headers and footers. You can
89 use a placeholder of the format `$<archiver-name>_url` to insert the
90 permalink to the message in the named archiver, for any archiver enabled
91 for the mailing list. Given by Abhilash Raj.
92 * The default posting chain has been modified so that the header-match chain
93 and nonmember-moderation rule are processed before "hold" rules are
94 processed. This allows for better anti-spam defenses and rejecting
95 non-member posts instead of always holding them for moderator review.
96 Given by Aurélien Bompard. (Closes #163)
97 * Bounces can now contain rejection messages. Given by Aurélien Bompard.
99 REST
100 ----
101 * REST API version 3.1 introduced. Mostly backward compatible with version
102 3.0 except that UUIDs are represented as hex strings instead of 128-bit
103 integers, since the latter are not compatible with all versions of
104 JavaScript.
105 * When creating a user via REST using an address that already exists, but
106 isn't linked, the address is linked to the new user. Given by Aurélien
107 Bompard.
108 * The REST API incorrectly parsed `is_server_owner` values when given
109 explicitly in the POST that creates a user. (Closes #136)
110 * A new top-level resource `<api>/owners` can be used to get the list of
111 server owners as `IUser`s. (Closes #135)
112 * By POSTing to a user resource with an existing unlinked address, you can
113 link the address to the user. Given by Abhilash Raj.
114 * Fix pagination values `start` and `total_size` in the REST API. Given by
115 Aurélien Bompard. (Closes: #154)
116 * JSON representations for held message now include a ``self_link``.
117 * When ``[devmode]enabled`` is set, the JSON output is sorted. Given by
118 Aurélien Bompard.
119 * A member's moderation action can be changed via the REST API. Given by
120 Aurélien Bompard.
121 * Fixed a number of corner cases for the return codes when PUTing or PATCHing
122 list configuration variables. (Closes: #182)
123 * Expose ``digest_send_periodic``, ``digest_volume_frequency``, and
124 ``digests_enabled`` (renamed from ``digestable``) to the REST API.
125 (Closes: #159)
127 Other
128 -----
129 * The test suite is now Python 3.5 compatible.
130 * Improvements in importing Mailman 2.1 lists, given by Aurélien Bompard.
131 * The ``prototype`` archiver is not web accessible so it does not have a
132 ``list_url`` or permalink. Given by Aurélien Bompard.
133 * Large performance improvement in ``SubscriptionService.find_members()``.
134 Given by Aurélien Bompard.
137 3.0.0 -- "Show Don't Tell"
138 ==========================
139 (2015-04-28)
141 Architecture
142 ------------
143 * Domains now have a list of owners, which are ``IUser`` objects, instead of
144 the single ``contact_address`` they used to have. ``IUser`` objects now
145 also have a ``is_server_owner`` flag (defaulting to False) to indicate
146 whether they have superuser privileges. Give by Abhliash Raj, with fixes
147 and refinements by Barry Warsaw. (LP: #1423756)
148 * Mailing list subscription policy work flow has been completely rewritten.
149 It now properly supports email verification and subscription confirmation
150 by the user, and approval by the moderator using unique tokens.
151 ``IMailingList`` objects now have a ``subscription_policy`` attribute.
152 (LP: #1095552)
153 * Port the REST machinery to Falcon 0.3. (LP: #1446881)
155 Bugs
156 ----
157 * Fix calculation of default configuration file to use when the ``$var_dir``
158 is created by ``mailman start``. (LP: #1411435)
159 * When creating a user with an email address, do not create the user record
160 if the email address already exists. Given by Andrew Stuart.
161 (LP: #1418280)
162 * When deleting a user via REST, make sure all linked addresses are deleted.
163 Found by Andrew Stuart. (LP: #1419519)
164 * When trying to subscribe an address to a mailing list through the REST API
165 where a case-differing version of the address is already subscribed, return
166 a 409 error instead of a 500 error. Found by Ankush Sharma. (LP: #1425359)
167 * ``mailman lists --domain`` was not properly handling its arguments. Given
168 by Manish Gill. (LP: #1166911)
169 * When deleting a user object, make sure their preferences are also deleted.
170 Given by Abhishek. (LP: #1418276)
171 * Be sure a mailing list's acceptable aliases are deleted when the mailing
172 list itself is deleted. (LP: #1432239)
173 * The built-in example ``IArchiver`` implementations now explicitly return
174 None. (LP: #1203359)
175 * The test suite now runs successfully again with PostgreSQL. Given by
176 Aurélien Bompard. (LP: #1435941)
178 Configuration
179 -------------
180 * When specifying a file system path in the [paths.*] section, $cfg_file can
181 be used to expand into the path of the ``-C`` option if given. In the
182 default ``[paths.dev]`` section, ``$var_dir`` is now specified relative to
183 ``$cfg_file`` so that it won't accidentally be relative to the current
184 working directory, if ``-C`` is given.
185 * ``$cwd`` is now an additional substitution variable for the ``mailman.cfg``
186 file's ``[paths.*]`` sections. A new ``[paths.here]`` section is added,
187 which puts the ``var_dir`` in ``$cwd``. It is made the default layout.
189 Documentation
190 -------------
191 * Improve the documentation describing how to run Alembic to add new schema
192 migrations. Given by Abhilash Raj.
194 REST
195 ----
196 * **Backward incompatible change**: The JSON representation for pending
197 mailing list subscription hold now no longer includes the ``password``
198 key. Also, the ``address`` key has been renamed ``email`` for consistent
199 terminology and other usage.
200 * You can now view the contents of, inject messages into, and delete messages
201 from the various queue directories via the ``<api>/queues`` resource.
202 * You can now DELETE an address. If the address is linked to a user, the
203 user is not delete, it is just unlinked.
204 * A new API is provided to support non-production testing infrastructures,
205 allowing a client to cull all orphaned UIDs via ``DELETE`` on
206 ``<api>/reserved/uids/orphans``. Note that *no guarantees* of API
207 stability will ever be made for resources under ``reserved``.
208 (LP: #1420083)
209 * Domains can now optionally be created with owners; domain owners can be
210 added after the fact; domain owners can be deleted. Also, users now have
211 an ``is_server_owner`` flag as part of their representation, which defaults
212 to False, and can be PUT and PATCH'd. Given by Abhilash Raj, with fixes
213 and refinements by Barry Warsaw. (LP: #1423756)
216 3.0 beta 5 -- "Carve Away The Stone"
217 ====================================
218 (2014-12-29)
220 Bugs
221 ----
222 * Fixed Unicode errors in the digest runner and when sending messages to the
223 site owner as a fallback. Given by Aurélien Bompard. (LP: #1130957).
224 * Fixed Unicode errors when a message being added to the digest has non-ascii
225 characters in its payload, but no Content-Type header defining a charset.
226 Given by Aurélien Bompard. (LP: #1170347)
227 * Fixed messages without a `text/plain` part crashing the `Approved` rule.
228 Given by Aurélien Bompard. (LP: #1158721)
229 * Fixed getting non-ASCII filenames from RFC 2231 i18n'd messages. Given by
230 Aurélien Bompard. (LP: #1060951)
231 * Fixed `AttributeError` on MIME digest messages. Given by Aurélien Bompard.
232 (LP: #1130696)
234 Commands
235 --------
236 * The `mailman conf` command no longer takes the `-t/--sort` option; the
237 output is always sorted.
239 Configuration
240 -------------
241 * The ``[database]migrations_path`` setting is removed.
243 Database
244 --------
245 * The ORM layer, previously implemented with Storm, has been replaced by
246 SQLAlchemy, thanks to the fantastic work by Abhilash Raj and Aurélien
247 Bompard. Alembic is now used for all database schema migrations.
248 * The new logger `mailman.database` logs any errors at the database layer.
250 Development
251 -----------
252 * Python 3.4 is now the minimum requirement.
253 * You no longer have to create a virtual environment separately when running
254 the test suite. Just use `tox`.
255 * You no longer have to edit `src/mailman/testing/testing.cfg` to run the
256 test suite against PostgreSQL. See `src/mailman/docs/START.rst` for
257 details.
259 Interfaces
260 ----------
261 * The RFC 2369 headers added to outgoing messages are now added in sorted
262 order.
263 * Several changes to the internal API:
265 - `IListManager.mailing_lists` is guaranteed to be sorted in List-ID order.
266 - `IDomains.mailing_lists` is guaranteed to be sorted in List-ID order.
267 - Iteration over domains via the `IDomainManager` is guaranteed to be sorted
268 by `IDomain.mail_host` order.
269 - `ITemporaryDatabase` interface and all implementations are removed.
271 REST
272 ----
273 * The Falcon Framework has replaced restish as the REST layer. This is an
274 internal change only.
275 * The JSON representation `http_etag` key uses an algorithm that is
276 insensitive to Python's dictionary sort order.
277 * The address resource now has an additional '/user' sub-resource which can
278 be used to GET the address's linked user if there is one. This
279 sub-resource also supports POST to link an unlinked address (with an
280 optional 'auto_create' flag), and PUT to link the address to a different
281 user. It also supports DELETE to unlink the address. (LP: #1312884)
282 Given by Aurélien Bompard based on work by Nicolas Karageuzian.
283 * The ``/3.0/system`` path is deprecated; use ``/3.0/system/versions`` to get
284 the system version information.
285 * You can access the system configuration via the resource path
286 ``/3.0/system/configuration/<section>``. This returns a dictionary with
287 the keys being the section's variables and the values being their value
288 from ``mailman.cfg`` as verbatim strings. You can get a list of all
289 section names via ``/3.0/system/configuration`` which returns a dictionary
290 containing the ``http_etag`` and the section names as a sorted list under
291 the ``sections`` key. The system configuration resource is read-only.
292 * Member resource JSON now include the ``member_id`` as a separate key.
295 3.0 beta 4 -- "Time and Motion"
296 ===============================
297 (2014-04-22)
299 Development
300 -----------
301 * Mailman 3 no longer uses ``zc.buildout`` and tests are now run by the
302 ``nose2`` test runner. See ``src/mailman/docs/START.rst`` for details on
303 how to build Mailman and run the test suite. Also, use ``-P`` to select a
304 test pattern and ``-E`` to enable stderr debugging in runners.
305 * Use the ``enum34`` package instead of ``flufl.enum``.
306 * Use ``setuptools`` instead of ``distribute``, since the latter is defunct.
308 REST
309 ----
310 * Add ``reply_to_address`` and ``first_strip_reply_to`` as writable
311 attributes of a mailing list's configuration. (LP: #1157881)
312 * Support pagination of some large collections (lists, users, members).
313 [Florian Fuchs] (LP: #1156529)
314 * Expose ``hide_address`` to the ``.../preferences`` REST API.
315 [Sneha Priscilla.] (LP: #1203519)
316 * Mailing lists can now individually enable or disable any archiver available
317 site-wide. [Joanna Skrzeszewska] (LP: #1158040)
318 * Addresses can be added to existing users, including display names, via the
319 REST API. [Florian Fuchs]
320 * Fixed a crash in the REST server when searching for nonmembers via
321 ``/find`` which we've never seen before, because those members only have an
322 address record, not a user record. This requires a small change in the API
323 where the JSON response's ``address`` key now contains the URL to the
324 address resource, the new ``email`` key contains the email address as a
325 string, and the ``user`` key is optional.
327 Commands
328 --------
329 * `mailman conf` now has a `-t/--sort` flag which sorts the output by section
330 and then key. [Karl-Aksel Puulmann and David Soto] (LP: 1162492)
331 * Greatly improve the fidelity of the Mailman 2.1 list importer functionality
332 (i.e. ``mailman import21``). [Aurélien Bompard].
334 Configuration
335 -------------
336 * Add support for the Exim 4 MTA. [Stephen Turnbull]
337 * When creating the initial file system layout in ``var``, e.g. via
338 ``bin/mailman info``, add an ``var/etc/mailman.cfg`` file if one does not
339 already exist. Also, when initializing the system, look for that file as
340 the configuration file, just after ``./mailman.cfg`` and before
341 ``~/.mailman.cfg``. (LP: #1157861)
343 Database
344 --------
345 * The `bounceevent` table now uses list-ids to cross-reference the mailing
346 list, to match other tables. Similarly for the `IBounceEvent` interface.
347 * Added a `listarchiver` table to support list-specific archivers.
349 Bugs
350 ----
351 * Non-queue runners should not create ``var/queue`` subdirectories.
352 [Sandesh Kumar Agrawal] (LP: #1095422)
353 * Creation of lists with upper case names should be coerced to lower case.
354 (LP: #1117176)
355 * Fix REST server crash on `mailman reopen` due to no interception of
356 signals. (LP: #1184376)
357 * Add `subject_prefix` to the `IMailingList` interface, and clarify the
358 docstring for `display_name`. (LP: #1181498)
359 * Fix importation from MM2.1 to MM3 of the archive policy.
360 [Aurélien Bompard] (LP: #1227658)
361 * Fix non-member moderation rule to prefer a member sender if both members
362 and non-members are in the message's sender list. [Aurélien Bompard]
363 (LP: #1291452)
364 * Fix IntegrityError (against PostgreSQL) when deleting a list with content
365 filters. [Aurélien Bompard] (LP: #1117174)
366 * Fix test isolation bug in ``languages.rst``.
367 [Piotr Kasprzyk] (LP: #1308769)
370 3.0 beta 3 -- "Here Again"
371 ==========================
372 (2012-12-31)
374 Compatibility
375 -------------
376 * Python 2.7 is now required. Python 2.6 is no longer officially supported.
377 The code base is now also `python2.7 -3` clean, although there are still
378 some warnings in 3rd party dependencies. (LP: #1073506)
380 REST
381 ----
382 * **API change**: The JSON representation for held messages no longer
383 includes the `data` key. The values in this dictionary are flatted into
384 the top-level JSON representation. The `key` key is remove since it's
385 redundant. Use `message_id` for held messages, and `address` for held
386 subscriptions/unsubscriptions. The following `_mod_*` keys are inserted
387 without the `_mod_` prefix:
389 - `_mod_subject` -> `subject`
390 - `_mod_hold_date` -> `hold_date`
391 - `_mod_reason` -> `reason`
392 - `_mod_sender` -> `sender`
393 - `_mod_message_id` -> `message_id`
395 * List styles are supported through the REST API. Get the list of available
396 styles (by name) via `.../lists/styles`. Create a list in a specific style
397 by using POST data `style_name=<style>`. (LP: #975692)
398 * Allow the getting/setting of IMailingList.subject_prefix via the REST API
399 (given by Terri Oda). (LP: #1062893)
400 * Expose a REST API for membership change (subscriptions and unsubscriptions)
401 moderation. (LP: #1090753)
402 * Add list_id to JSON representation for a mailing list (given by Jimmy
403 Bergman).
404 * The canonical resource for a mailing list (and thus its self_link) is now
405 the URL with the list-id. To reference a mailing list, the list-id url is
406 preferred, but for backward compatibility, the posting address is still
407 accepted.
408 * You can now PUT and PATCH on user resources to change the user's display
409 name or password. For passwords, you pass in the clear text password and
410 Mailman will hash it before storing.
411 * You can now verify and unverify an email address through the REST API.
412 POST to .../addresses/<email>/verify and .../addresses/<email>/unverify
413 respectively. The POST data is ignored. It is not an error to verify or
414 unverify an address more than once, but verifying an already verified
415 address does not change its `.verified_on` date. (LP: #1054730)
416 * Deleting a user through the REST API also deletes all the user's linked
417 addresses and memberships. (LP: #1074374)
418 * A user's password can be verified by POSTing to .../user/<id>/login. The
419 data must contain a single parameter `cleartext_password` and if this
420 matches, a 204 (No Content) will be returned, otherwise a 403 (Forbidden)
421 is returned. (LP: #1065447)
423 Configuration
424 -------------
425 * `[passlib]path` configuration variable renamed to `[passlib]configuration`.
426 * Postfix-specific configurations in the `[mta]` section are moved to a
427 separate file, named by the `[mta]configuration` variable.
428 * In the new `postfix.cfg` file, `postfix_map_cmd` is renamed to
429 `postmap_command`.
430 * The default list style is renamed to `legacy-default` and a new
431 `legacy-announce` style is added. This is similar to the `legacy-default`
432 except set up for announce-only lists.
434 Database
435 --------
436 * The `ban` table now uses list-ids to cross-reference the mailing list,
437 since these cannot change even if the mailing list is moved or renamed.
438 * The following columns were unused and have been removed:
440 - `mailinglist.new_member_options`
441 - `mailinglist.send_reminders`
442 - `mailinglist.subscribe_policy`
443 - `mailinglist.unsubscribe_policy`
444 - `mailinglist.subscribe_auto_approval`
445 - `mailinglist.private_roster`
446 - `mailinglist.admin_member_chunksize`
448 Interfaces
449 ----------
450 * The `IBanManager` is no longer a global utility. Instead, you adapt an
451 `IMailingList` to an `IBanManager` to manage the bans for a specific
452 mailing list. To manage the global bans, adapt ``None``.
454 Commands
455 --------
456 * `bin/mailman aliases` loses the `--output`, `--format`, and `--simple`
457 arguments, and adds a `--directory` argument. This is necessary to support
458 the Postfix `relay_domains` support.
459 * `bin/mailman start` was passing the wrong relative path to its runner
460 subprocesses when -C was given. (LP: #982551)
461 * `bin/runner` command has been simplified and its command line options
462 reduced. Now, only one `-r/--runner` option may be provided and the
463 round-robin feature has been removed.
465 Other
466 -----
467 * Added support for Postfix `relay_domains` setting for better virtual domain
468 support. [Jimmy Bergman].
469 * Two new events are triggered on membership changes: `SubscriptionEvent`
470 when a new member joins a mailing list, and an `UnsubscriptionEvent` when a
471 member leaves a mailing list. (LP: #1047286)
472 * Improve the --help text for the `start`, `stop`, `restart`, and `reopen`
473 subcommands. (LP: #1035033)
475 Bugs
476 ----
477 * Fixed `send_goodbye_message()`. (LP: #1091321)
478 * Fixed REST server crash on `reopen` command. Identification and test
479 provided by Aurélien Bompard. (LP: #1184376)
482 3.0 beta 2 -- "Freeze"
483 ======================
484 (2012-09-05)
486 Architecture
487 ------------
488 * The link between members and the mailing lists they are subscribed to, is
489 now via the RFC 2369 `list_id` instead of the fqdn listname (i.e. posting
490 address). This is because while the posting address can change if the
491 mailing list is moved to a new server, the list id is fixed.
492 (LP: #1024509)
494 - IListManager.get_by_list_id() added.
495 - IListManager.list_ids added.
496 - IMailingList.list_id added.
497 - Several internal APIs that accepted fqdn list names now require list ids,
498 e.g. ISubscriptionService.join() and .find_members().
499 - IMember.list_id attribute added; .mailing_list is now an alias that
500 retrieves and returns the IMailingList.
502 * `passlib`_ is now used for all password hashing instead of flufl.password.
503 The default hash is `sha512_crypt`. (LP: #1015758)
504 * Internally, all datetimes are kept in the UTC timezone, however because of
505 LP: #280708, they are stored in the database in naive format.
506 * `received_time` is now added to the message metadata by the LMTP runner
507 instead of by `Switchboard.enqueue()`. This latter no longer depends on
508 `received_time` in the metadata.
509 * The `ArchiveRunner` no longer acquires a lock before it calls the
510 individual archiver implementations, since not all of them need a lock. If
511 they do, the implementations must acquire said lock themselves.
512 * The `news` runner and queue has been renamed to the more accurate `nntp`.
513 The runner has also been ported to Mailman 3 (LP: #967409). Beta testers
514 can safely remove `$var_dir/queue/news`.
515 * A mailing list's *moderator password* is no longer stored in the clear; it
516 is hashed with the currently selected scheme.
517 * An `AddressVerificationEvent` is triggered when an `IAddress` is verified
518 or unverified. (LP: #975698)
519 * A `PasswordChangeEvent` is triggered when an `IUser`'s password changes.
520 (LP: #975700)
521 * When a queue runner gets an exception in its _dispose() method, a
522 `RunnerCrashEvent` is triggered, which contains references to the queue
523 runner, mailing list, message, metadata, and exception. Interested parties
524 can subscribe to that `zope.event` for notification.
525 * Events renamed and moved:
526 * `mailman.chains.accept.AcceptNotification`
527 * `mailman.chains.base.ChainNotification`
528 * `mailman.chains.discard.DiscardNotification`
529 * `mailman.chains.hold.HoldNotification`
530 * `mailman.chains.owner.OwnerNotification`
531 * `mailman.chains.reject.RejectNotification`
532 changed to (respectively):
533 * `mailman.interfaces.chains.AcceptEvent`
534 * `mailman.interfaces.chains.ChainEvent`
535 * `mailman.interfaces.chains.DiscardEvent`
536 * `mailman.interfaces.chains.HoldEvent`
537 * `mailman.interfaces.chains.AcceptOwnerEvent`
538 * `mailman.interfaces.chains.RejectEvent`
539 * A `ConfigurationUpdatedEvent` is triggered when the system-wide global
540 configuration stack is pushed or popped.
541 * The policy for archiving has now been collapsed into a single enum, called
542 ArchivePolicy. This describes the three states of never archive, archive
543 privately, and archive_publicly. (LP: #967238)
545 Database
546 --------
547 * Schema migrations (LP: #971013)
549 - mailinglist.include_list_post_header -> allow_list_posts
550 - mailinglist.news_prefix_subject_too -> nntp_prefix_subject_too
551 - mailinglist.news_moderation -> newsgroup_moderation
552 - mailinglist.archive and mailinglist.archive_private have been collapsed
553 into archive_policy.
554 - mailinglist.nntp_host has been removed.
555 - mailinglist.generic_nonmember_action has been removed (LP: #975696)
557 * Schema migrations (LP: #1024509)
558 - member.mailing_list -> list_id
559 * The PostgreSQL port of the schema accidentally added a moderation_callback
560 column to the mailinglist table. Since this is unused in Mailman, it was
561 simply commented out of the base schema for PostgreSQL.
563 REST
564 ----
565 * Expose `archive_policy` in the REST API. Contributed by Alexander
566 Sulfrian. (LP: #1039129)
568 Configuration
569 -------------
570 * New configuration variables `clobber_date` and `clobber_skew` supported in
571 every `[archiver.<name>]` section. These are used to determine under what
572 circumstances a message destined for a specific archiver should have its
573 `Date:` header clobbered. (LP: #963612)
574 * With the switch to `passlib`_, `[passwords]password_scheme` has been
575 removed. Instead use `[passwords]path` to specify where to find the
576 `passlib.cfg` file. See the comments in `schema.cfg` for details.
577 * Configuration schema variable changes:
578 * [nntp]username -> [nntp]user
579 * [nntp]port (added)
580 * Header check specifications in the `mailman.cfg` file have changed quite
581 bit. The previous `[spam.header.foo]` sections have been removed.
582 Instead, there's a new `[antispam]` section that contains a `header_checks`
583 variable. This variable takes multiple lines of `Header: regexp` values,
584 one per line. There is also a new `jump_chain` variable which names the
585 chain to jump to should any of the header checks (including the
586 list-specific, and programmatically added ones) match.
588 Documentation
589 -------------
590 * Some additional documentation on related components such as Postorius and
591 hyperkitty have been added, given by Stephen J Turnbull.
593 Bug fixes
594 ---------
595 * Fixed the RFC 1153 digest footer to be compliant. (LP: #887610)
596 * Fixed a UnicodeError with non-ascii message bodies in the `approved` rule,
597 given by Mark Sapiro. (LP: #949924)
598 * Fixed a typo when returning the configuration file's header match checks.
599 (LP: #953497)
600 * List-Post should be NO when posting is not allowed. (LP: #987563)
601 * Non-unicode values in msgdata broke pending requests. (LP: #1031391)
602 * Show devmode in `bin/mailman info` output. (LP: #1035028)
603 * Fix residual references to the old `IMailingList` archive variables.
604 (LP: #1031393)
606 .. _`passlib`: http://packages.python.org/passlib/index.html
609 3.0 beta 1 -- "The Twilight Zone"
610 =================================
611 (2012-03-23)
613 Architecture
614 ------------
615 * Schema migrations have been implemented.
616 * Implement the style manager as a utility instead of an attribute hanging
617 off the `mailman.config.config` object.
618 * PostgreSQL support contributed by Stephen A. Goss. (LP: #860159)
619 * Separate out the RFC 2369 header adding handler.
620 * Dynamically calculate the `List-Id` header instead of storing it in the
621 database. This means it cannot be changed.
622 * Major redesign of the template search system, fixing LP: #788309. $var_dir
623 is now used when search for all template overrides, site, domain, or
624 mailing list. The in-tree English templates are used only as a last
625 fallback.
626 * Support downloading templates by URI, including mailman:// URIs. This is
627 used in welcome and goodbye messages, as well as regular and digest headers
628 and footers, and supports both language and mailing list specifications.
629 E.g. mailman:///test@example.com/it/welcome.txt
630 * $user_password is no longer supported as a placeholder in headers and
631 footers.
632 * Mailing lists get multiple chains and pipelines. For example, normal
633 postings go through the `posting_chain` while messages to owners to through
634 `owners_chain`. The default `built-in` chain is renamed to
635 `default-posting-chain` while the `built-in` pipeline is renamed
636 `default-posting-pipeline`.
637 * The experimental `maildir` runner is removed. Use LMTP.
638 * The LMTP server now requires that the incoming message have a `Message-ID`,
639 otherwise it rejects the message with a 550 error. Also, the LMTP server
640 adds the `X-Message-ID-Hash` header automatically. The `inject` cli
641 command will also add the `X-Message-ID-Hash` header, but it will craft a
642 `Message-ID` header first if one is missing from the injected text. Also,
643 `inject` will always set the correct value for the `original_size`
644 attribute on the message object, instead of trusting a possibly incorrect
645 value if it's already set. The individual `IArchiver` implementations no
646 longer set the `X-Message-ID-Hash` header.
647 * The Prototype archiver now stores its files in maildir format inside of
648 `$var_dir/archives/prototype`, given by Toshio Kuratomi.
649 * Improved "8 mile high" document distilled by Stephen J Turnbull from the
650 Pycon 2012 Mailman 3 sprint. Also improvements to the Sphinx build given
651 by Andrea Crotti (LP: #954718).
652 * Pipermail has been eradicated.
653 * Configuration variable `[mailman]filtered_messages_are_preservable`
654 controls whether messages which have their top-level `Content-Type`
655 filtered out can be preserved in the `bad` queue by list owners.
656 * Configuration section `[scrubber]` removed, as is the scrubber handler.
657 This handler was essentially incompatible with Mailman 3 since it required
658 coordination with Pipermail to store attachments on disk.
660 Database
661 --------
662 * Schema changes:
663 - welcome_msg -> welcome_message_uri
664 - goodbye_msg -> goodbye_message_uri
665 - send_welcome_msg -> send_welcome_message
666 - send_goodbye_msg -> send_goodbye_message
667 - msg_header -> header_uri
668 - msg_footer -> footer_uri
669 - digest_header -> digest_header_uri
670 - digest_footer -> digest_footer_uri
671 - start_chain -> posting_chain
672 - pipeline -> posting_pipeline
673 - real_name -> display_name (mailinglist, user, address)
674 * Schema additions:
675 - mailinglist.filter_action
676 - mailinglist.owner_chain
677 - mailinglist.owner_pipeline
679 REST
680 ----
681 * Held messages can now be moderated through the REST API. Mailing list
682 resources now accept a `held` path component. GETing this returns all held
683 messages for the mailing list. POSTing to a specific request id under this
684 url can dispose of the message using `Action` enums.
685 * Mailing list resources now have a `member_count` attribute which gives the
686 number of subscribed members. Given by Toshio Kuratomi.
688 Interfaces
689 ----------
690 * Add property `IUserManager.members` to return all `IMembers` in the system.
691 * Add property `IListmanager.name_components` which returns 2-tuples for
692 every mailing list as (list_name, mail_host).
693 * Remove previously deprecated `IListManager.get_mailing_lists()`.
694 * `IMailTransportAgentAliases` now explicitly accepts duck-typed arguments.
695 * `IRequests` interface is removed. Now just use adaptation from
696 `IListRequests` directly (which takes an `IMailingList` object).
697 * `handle_message()` now allows for `Action.hold` which is synonymous with
698 `Action.defer` (since the message is already being held).
699 * `IListRequests.get_request()` now takes an optional `request_type`
700 argument to narrow the search for the given request.
701 * New `ITemplateLoader` utility.
702 * `ILanguageManager.add()` returns the `ILanguage` object just created.
703 * `IMailinglist.decorators` removed; it was unused
704 * `IMailingList.real_name` -> `IMailingList.display_name`
705 * `IUser.real_name` -> `IUser.display_name`
706 * `IAddress.real_name` -> `IAddress.display_name`
707 * Add property `IRoster.member_count`.
709 Commands
710 --------
711 * IPython support in `bin/mailman shell` contributed by Andrea Crotti.
712 (LP: #949926).
713 * The `mailman.cfg` configuration file will now automatically be detected if
714 it exists in an `etc` directory which is a sibling of argv0.
715 * `bin/mailman shell` is an alias for `withlist`.
716 * The `confirm` email command now properly handles `Re:`-like prefixes, even
717 if they contain non-ASCII characters. (LP: #685261)
718 * The `join` email command no longer accepts an `address=` argument. Its
719 `digest=` argument now accepts the following values: `no` (for regular
720 delivery), `mime`, or `plain`.
721 * Added a `help` email command.
722 * A welcome message is sent when the user confirms their subscription via
723 email.
724 * Global ``-C`` option now accepts an absolute path to the configuration
725 file. Given by Andrea Crotti. (LP: #953707)
727 Bug fixes
728 ---------
729 * Subscription disabled probe warning notification messages are now sent
730 without a `Precedence:` header. Given by Mark Sapiro. (LP: #808821)
731 * Fixed KeyError in retry runner, contributed by Stephen A. Goss.
732 (LP: #872391)
733 * Fixed bogus use of `bounce_processing` attribute (should have been
734 `process_bounces`, with thanks to Vincent Fretin. (LP: #876774)
735 * Fix `test_moderation` for timezones east of UTC+0000, given by blacktav.
736 (LP: #890675)
739 3.0 alpha 8 -- "Where's My Thing?"
740 ==================================
741 (2011-09-23)
743 Architecture
744 ------------
745 * Factor out bounce detection to `flufl.bounce`.
746 * Unrecognized bounces can now also be forwarded to the site owner.
747 * mailman.qrunner log is renamed to mailman.runner
748 * master-qrunner.lck -> master.lck
749 * master-qrunner.pid -> master.pid
750 * Four new events are created, and notifications are sent during mailing list
751 lifecycle changes:
752 - ListCreatingEvent - sent before the mailing list is created
753 - ListCreatedEvent - sent after the mailing list is created
754 - ListDeletingEvent - sent before the mailing list is deleted
755 - ListDeletedEvent - sent after the mailing list is deleted
756 * Four new events are created, and notifications are sent during domain
757 lifecycle changes:
758 - DomainCreatingEvent - sent before the domain is created
759 - DomainCreatedEvent - sent after the domain is created
760 - DomainDeletingEvent - sent before the domain is deleted
761 - DomainDeletedEvent - sent after the domain is deleted
762 * Using the above events, when a domain is deleted, associated mailing lists
763 are deleted. (LP: #837526)
764 * IDomain.email_host -> .mail_host (LP: #831660)
765 * User and Member ids are now proper UUIDs.
766 * Improved the way enums are stored in the database, so that they are more
767 explicitly expressed in the code, and more database efficient.
769 REST
770 ----
771 * Preferences for addresses, users, and members can be accessed, changed, and
772 deleted through the REST interface. Hierarchical, combined preferences for
773 members, and system preferences can be read through the REST interface.
774 (LP: #821438)
775 * The IMailingList attribute ``host_name`` has been renamed to ``mail_host``
776 for consistency. This changes the REST API for mailing list
777 resources. (LP: #787599)
778 * New REST resource http://.../members/find can be POSTed to in order to find
779 member records. Optional arguments are `subscriber` (email address to
780 search for), `fqdn_listname`, and `role` (i.e. MemberRole). (LP: #799612)
781 * You can now query or change a member's `delivery_mode` attribute through
782 the REST API (LP: #833132). Given by Stephen A. Goss.
783 * New REST resource http://.../<domain>/lists can be GETed in order to find
784 all the mailing lists in a specific domain (LP: #829765). Given by
785 Stephen A. Goss.
786 * Fixed /lists/<fqdn_listname>/<role>/<email> (LP: #825570)
787 * Remove role plurals from /lists/<fqdn_listname/rosters/<role>
788 * Fixed incorrect error code for /members/<bogus> (LP: #821020). Given by
789 Stephen A. Goss.
790 * DELETE users via the REST API. (LP: #820660)
791 * Moderators and owners can be added via REST (LP: #834130). Given by
792 Stephen A. Goss.
793 * Getting the roster or configuration of a nonexistent list did not give a
794 404 error (LP: #837676). Given by Stephen A. Goss.
795 * PATCHing an invalid attribute on a member did not give a 400 error
796 (LP: #833376). Given by Stephen A. Goss.
797 * Getting the memberships for a non-existent address did not give a 404 error
798 (LP: #848103). Given by Stephen A. Goss.
800 Commands
801 --------
802 * `bin/qrunner` is renamed to `bin/runner`.
803 * `bin/mailman aliases` gains `-f` and `-s` options.
804 * `bin/mailman create` no longer allows a list to be created with bogus owner
805 addresses. (LP: #778687)
806 * `bin/mailman start --force` option is fixed. (LP: #869317)
808 Documentation
809 -------------
810 * Update the COPYING file to contain the GPLv3. (LP: #790994)
811 * Major terminology change: ban the terms "queue runners" and "qrunners" since
812 not all runners manage queue directories. Just call them "runners". Also,
813 the master is now just called "the master runner".
815 Testing
816 -------
817 * New configuration variable in [devmode] section, called `wait` which sets
818 the timeout value used in the test suite for starting up subprocesses.
819 * Handle SIGTERM in the REST server so that the test suite always shuts down
820 correctly. (LP: #770328)
822 Other bugs and changes
823 ----------------------
824 * Moderating a message with Action.accept now sends the message. (LP: #827697)
825 * Fix AttributeError triggered by i18n call in autorespond_to_sender()
826 (LP: #827060)
827 * Local timezone in X-Mailman-Approved-At caused test failure. (LP: #832404)
828 * InvalidEmailAddressError no longer repr()'s its value.
829 * Rewrote a test for compatibility between Python 2.6 and 2.7. (LP: #833208)
830 * Fixed Postfix alias file generation when more than one mailing list
831 exists. (LP: #874929). Given by Vincent Fretin.
834 3.0 alpha 7 -- "Mission"
835 ========================
836 (2011-04-29)
838 Architecture
839 ------------
840 * Significant updates to the subscription model. Members can now subscribe
841 with a preferred address, and changes to that will be immediately reflected
842 in mailing list subscriptions. Users who subscribe with an explicit
843 address can easily change to a different address, as long as that address
844 is verified. (LP: #643949)
845 * IUsers and IMembers are now assigned a unique, random, immutable id.
846 * IUsers now have created_on and .preferred_address properties.
847 * IMembers now have a .user attribute for easy access to the subscribed user.
848 * When created with add_member(), passwords are always stored encrypted.
849 * In all interfaces, "email" refers to the textual email address while
850 "address" refers to the `IAddress` object.
851 * mailman.chains.base.Chain no longer self registers.
852 * New member and nonmember moderation rules and chains. This effectively
853 ports moderation rules from Mailman 2 and replaces attributes such as
854 member_moderation_action, default_member_moderation, and
855 generic_nonmember_action. Now, nonmembers exist as subscriptions on a
856 mailing list and members have a moderation_action attribute which describes
857 the disposition for postings from that address.
858 * Member.is_moderated was removed because of the above change.
859 * default_member_action and default_nonmember_action were added to mailing
860 lists.
861 * All sender addresses are registered (unverified) with the user manager by
862 the incoming queue runner. This way, nonmember moderation rules will
863 always have an IAddress that they can subscribe to the list (as
864 MemberRole.nonmember).
865 * Support for SMTP AUTH added via smtp_user and smtp_pass configuration
866 variables in the [mta] section. (LP: #490044)
867 * IEmailValidator interface for pluggable validation of email addresses.
868 * .subscribe() is moved from the IAddress to the IMailingList
869 * IAddresses get their registered_on attribute set when the object is created.
871 Configuration
872 -------------
873 * [devmode] section gets a new 'testing' variable.
874 * Added password_scheme and password_length settings for defining the
875 default password encryption scheme.
876 * creator_pw_file and site_pw_file are removed.
878 Commands
879 --------
880 * 'bin/mailman start' does a better job of producing an error when Mailman is
881 already running.
882 * 'bin/mailman status' added for providing command line status on the master
883 queue runner watcher process.
884 * 'bin/mailman info' now prints the REST root url and credentials.
885 * mmsitepass removed; there is no more site password.
887 REST
888 ----
889 * Add Basic Auth support for REST API security. (Jimmy Bergman)
890 * Include the fqdn_listname and email address in the member JSON
891 representation.
892 * Added reply_goes_to_list, send_welcome_msg, welcome_msg,
893 default_member_moderation to the mailing list's writable attributes in the
894 REST service. (Jimmy Bergman)
895 * Expose the new membership model to the REST API. Canonical member resource
896 URLs are now much shorter and live in their own top-level namespace instead
897 of within the mailing list's namespace.
898 * /addresses/<email>/memberships gets all the memberships for a given email
899 address.
900 * /users is a new top-level URL under which user information can be
901 accessed. Posting to this creates new users.
902 * Users can subscribe to mailing lists through the REST API.
903 * Domains can be deleted via the REST API.
904 * PUT and PATCH to a list configuration now returns a 204 (No Content).
906 Build
907 -----
908 * Support Python 2.7. (LP: #667472)
909 * Disable site-packages in buildout.cfg because of LP: #659231.
910 * Don't include eggs/ or parts/ in the source tarball. (LP: #656946)
911 * flufl.lock is now required instead of locknix.
913 Bugs fixed
914 ----------
915 * Typo in scan_message(). (LP: #645897)
916 * Typo in add_member(). (LP: #710182) (Florian Fuchs)
917 * Re-enable bounce detectors. (LP: #756943)
918 * Clean up many pyflakes problems; ditching pylint.
921 3.0 alpha 6 -- "Cut to the Chase"
922 =================================
923 (2010-09-20)
925 Commands
926 --------
927 * The functionality of 'bin/list_members' has been moved to
928 'bin/mailman members'.
929 * 'bin/mailman info' -v/--verbose output displays the file system
930 layout paths Mailman is currently configured to use.
932 Configuration
933 -------------
934 * You can now configure the paths Mailman uses for queue files, lock files,
935 data files, etc. via the configuration file. Define a file system 'layout'
936 and then select that layout in the [mailman] section. Default layouts
937 include 'local' for putting everything in /var/tmp/mailman, 'dev' for local
938 development, and 'fhs' for Filesystem Hierarchy Standard 2.3 (LP #490144).
939 * Queue file directories now live in $var_dir/queues.
941 REST
942 ----
943 * lazr.restful has been replaced by restish as the REST publishing technology
944 used by Mailman.
945 * New REST API for getting all the members of a roster for a specific mailing
946 list.
947 * New REST API for getting and setting a mailing list's configuration. GET
948 and PUT are supported to retrieve the current configuration, and set all
949 the list's writable attributes in one request. PATCH is supported to
950 partially update a mailing list's configuration. Individual options can be
951 set and retrieved by using subpaths.
952 * Subscribing an already subscribed member via REST now returns a 409 HTTP
953 error. LP: #552917
954 * Fixed a bug when deleting a list via the REST API. LP: #601899
956 Architecture
957 ------------
958 * X-BeenThere header is removed.
959 * Mailman no longer touches the Sender or Errors-To headers.
960 * Chain actions can now fire Zope events in their _process()
961 implementations.
962 * Environment variable $MAILMAN_VAR_DIR can be used to control the var/
963 directory for Mailman's runtime files. New environment variable
964 $MAILMAN_UNDER_MASTER_CONTROL is used instead of the qrunner's --subproc/-s
965 option.
967 Miscellaneous
968 -------------
969 * Allow X-Approved and X-Approve headers, equivalent to Approved and
970 Approve. LP: #557750
971 * Various test failure fixes. LP: #543618, LP: #544477
972 * List-Post header is retained in MIME digest messages. LP: #526143
973 * Importing from a Mailman 2.1.x list is partially supported.
976 3.0 alpha 5 -- "Distant Early Warning"
977 ======================================
978 (2010-01-18)
980 REST
981 ----
982 * Add REST API for subscription services. You can now:
984 - list all members in all mailing lists
985 - subscribe (and possibly register) an address to a mailing list
986 - unsubscribe an address from mailing list
988 Commands
989 --------
990 * 'bin/dumpdb' is now 'bin/mailman qfile'
991 * 'bin/unshunt' is now 'bin/mailman unshunt'
992 * Mailman now properly handles the '-join', '-leave', and '-confirm' email
993 commands and sub-addresses. '-subscribe' and '-unsubscribe' are aliases
994 for '-join' and '-leave' respectively.
996 Configuration
997 -------------
998 * devmode settings now live in their own [devmode] section.
999 * Mailman now searches for a configuration file using this search order. The
1000 first file that exists is used.
1002 - -C config command line argument
1003 - $MAILMAN_CONFIG_FILE environment variable
1004 - ./mailman.cfg
1005 - ~/.mailman.cfg
1006 - /etc/mailman.cfg
1009 3.0 alpha 4 -- "Vital Signs"
1010 ============================
1011 (2009-11-28)
1013 Commands
1014 --------
1015 * 'bin/inject' is now 'bin/mailman inject', with some changes
1016 * 'bin/mailmanctl' is now 'bin/mailman start|stop|reopen|restart'
1017 * 'bin/mailman version' is added (output same as 'bin/mailman --version')
1018 * 'bin/mailman members' command line arguments have changed. It also
1019 now ignores blank lines and lines that start with #. It also no longer
1020 quits when it sees an address that's already subscribed.
1021 * 'bin/withlist' is now 'bin/mailman withlist', and its command line
1022 arguments have changed.
1023 * 'bin/mailman lists' command line arguments have changed.
1024 * 'bin/genaliases' is now 'bin/mailman aliases'
1026 Architecture
1027 ------------
1028 * A near complete rewrite of the low-level SMTP delivery machinery. This
1029 greatly improves readability, testability, reuse and extensibility. Almost
1030 all the old functionality has been retained. The smtp_direct.py handler is
1031 gone.
1032 * Refactor model objects into the mailman.model subpackage.
1033 * Refactor most of the i18n infrastructure into a separate flufl.i18n package.
1034 * Switch from setuptools to distribute.
1035 * Remove the dependency on setuptools_bzr
1036 * Do not create the .mo files during setup.
1038 Configuration
1039 -------------
1040 * All log files now have a '.log' suffix by default.
1041 * The substitution placeholders in the verp_format configuration variable
1042 have been renamed.
1043 * Add a devmode configuration variable that changes some basic behavior.
1044 Most importantly, it allows you to set a low-level SMTP recipient for all
1045 mail for testing purposes. See also devmode_recipient.
1048 3.0 alpha 3 -- "Working Man"
1049 ============================
1050 (2009-08-21)
1052 Configuration
1053 -------------
1054 * Configuration is now done through lazr.config. Defaults.py is
1055 dead. lazr.config files are essentially hierarchical ini files.
1056 * Domains are now stored in the database instead of in the configuration file.
1057 * pre- and post- initialization hooks are now available to plugins. Specify
1058 additional hooks to run in the configuration file.
1059 * Add the environment variable $MAILMAN_CONFIG_FILE which overrides the -C
1060 command line option.
1061 * Make LMTP more compliant with Postfix docs (Patrick Koetter)
1062 * Added a NullMTA for mail servers like Exim which just work automatically.
1064 Architecture
1065 ------------
1066 * 'bin/mailman' is a new super-command for managing Mailman from the command
1067 line. Some older bin scripts have been converted, with more to come.
1068 * Mailman now has an administrative REST interface which can be used to get
1069 information from and manage Mailman remotely.
1070 * Back port of Mailman 2.1's limit on .bak file restoration. After 3
1071 restores, the file is moved to the bad queue, with a .psv extension. (Mark
1072 Sapiro)
1073 * Digest creation is moved into a new queue runner so it doesn't block main
1074 message processing.
1076 Other changes
1077 -------------
1078 * bin/make_instance is no longer necessary, and removed
1079 * The debug log is turned up to info by default to reduce log file spam.
1081 Building and installation
1082 -------------------------
1083 * All doc tests can now be turned into documentation, via Sphinx. Just run
1084 bin/docs after bin/buildout.
1087 3.0 alpha 2 -- "Grand Designs"
1088 ==============================
1089 (03-Jan-2009)
1091 Licensing
1092 ---------
1094 * Mailman 3 is now licensed under the GPLv3.
1096 Bug fixes
1097 ---------
1099 * Changed bin/arch to attempt to open the mbox before wiping the old
1100 archive. Launchpad bug #280418.
1102 * Added digest.mbox and pending.pck to the 'list' files checked by
1103 check_perms. Launchpad bug #284802.
1105 Architecture
1106 ------------
1108 * Converted to using zope.testing as the test infrastructure. Use bin/test
1109 now to run the full test suite.
1110 <http://pypi.python.org/pypi/zope.testing/3.7.1>
1111 * Partially converted to using lazr.config as the new configuration
1112 regime. Not everything has been converted yet, so some manual editing
1113 of mailman/Defaults.py is required. This will be rectified in future
1114 versions. <http://launchpad.net/lazr.config>
1115 * All web-related stuff is moved to its own directory, effectively moving
1116 it out of the way for now.
1117 * The email command infrastructure has been reworked to play more nicely
1118 with the plug-in architecture. Not all commands have yet been
1119 converted.
1121 Other changes
1122 -------------
1124 * The LMTP server now properly calculates the message's original size.
1125 * For command line scripts, -C names the configuration file to use. For
1126 convenient testing, if -C is not given, then the environment variable
1127 MAILMAN_CONFIG_FILE is consulted.
1128 * Support added for a local MHonArc archiver, as well as archiving
1129 automatically in the remote Mail-Archive.com service.
1130 * The permalink proposal for supporting RFC 5064 has been adopted.
1131 * Mailing lists no longer have a .web_page_url attribute; this is taken from
1132 the mailing list's domain's base_url attribute.
1133 * Incoming MTA selection is now taken from the config file instead of
1134 plugins. An MTA for Postfix+LMTP is added. bin/genaliases works again.
1135 * If a message has no Message-ID, the stock archivers will return None for
1136 the permalink now instead of raising an assertion.
1137 * IArchiver no longer has an is_enabled property; this is taken from the
1138 configuration file now.
1140 Installation
1141 ------------
1143 * Python 2.6 is the minimal requirement.
1144 * Converted to using zc.buildout as the build infrastructure. See
1145 docs/ALPHA.txt for details.
1146 <http://pypi.python.org/pypi/zc.buildout/1.1.1>
1149 3.0 alpha 1 -- "Leave That Thing Alone"
1150 =======================================
1151 (08-Apr-2008)
1153 User visible changes
1154 --------------------
1156 * So called 'new style' subject prefixing is the default now, and the only
1157 option. When a list's subject prefix is added, it's always done so before
1158 any Re: tag, not after. E.g. '[My List] Re: The subject'.
1159 * RFC 2369 headers List-Subscribe and List-Unsubscribe now use the preferred
1160 -join and -leave addresses instead of the -request address with a subject
1161 value.
1163 Configuration
1164 -------------
1166 * There is no more separate configure; make; make install step. Mailman 3.0
1167 is a setuptools package.
1168 * Mailman can now be configured via a 'mailman.cfg' file which lives in
1169 $VAR_PREFIX/etc. This is used to separate the configuration from the
1170 source directory. Alternative configuration files can be specified via
1171 -C/--config for most command line scripts. mailman.cfg contains Python
1172 code. mm_cfg.py is no more. You do not need to import Defaults.py in
1173 etc/mailman.cfg. You should still consult Defaults.py for the list of site
1174 configuration variables available to you.
1176 See the etc/mailman.cfg.sample file.
1177 * PUBLIC_ARCHIVE_URL and DEFAULT_SUBJECT_PREFIX now takes $-string
1178 substitutions instead of %-string substitutions. See documentation in
1179 Defaults.py.in for details.
1180 * Message headers and footers now only accept $-string substitutions;
1181 %-strings are no longer supported. The substitution variable
1182 '_internal_name' has been removed; use $list_name or $real_name
1183 instead. The substitution variable $fqdn_listname has been added.
1184 DEFAULT_MSG_FOOTER in Defaults.py.in has been updated accordingly.
1185 * The KNOWN_SPAMMERS global variable is replaced with HEADER_MATCHES. The
1186 mailing list's header_filter_rules variable is replaced with header_matches
1187 which has the same semantics as HEADER_MATCHES, but is list-specific.
1188 * DEFAULT_MAIL_COMMANDS_MAX_LINES -> EMAIL_COMMANDS_MAX_LINES
1189 * All SMTP_LOG_* templates use $-strings and all consistently write the
1190 Message-ID as the first item in the log entry.
1191 * DELIVERY_MODULE now names a handler, not a module (yes, this is a
1192 misnomer, but it will likely change again before the final release).
1194 Architecture
1195 ------------
1197 * Internally, all strings are Unicodes.
1198 * Implementation of a chain-of-rules based approach for deciding whether a
1199 message should initially be accepted, held for approval, rejected/bounced,
1200 or discarded. This replaces most of the disposition handlers in the
1201 pipeline. The IncomingRunner now only processes message through the rule
1202 chains, and once accepted, places the message in a new queue processed by
1203 the PipelineRunner.
1204 * Substantially reworked the entire queue runner process management,
1205 including mailmanctl, a new master script, and the qrunners. This should
1206 be much more robust and reliable now.
1207 * The Storm ORM is used for data storage, with the SQLite backend as the
1208 default relational database.
1209 * Zope interfaces are used to describe the major components.
1210 * Users are now stored in a unified database, and shared across all mailing
1211 lists.
1212 * Mailman's web interface is now WSGI compliant. WSGI is a Python standard
1213 (PEP 333) allowing web applications to be (more) easily integrated with any
1214 number of existing Python web application frameworks. For more information
1215 see:
1217 http://www.wsgi.org/wsgi
1218 http://www.python.org/dev/peps/pep-0333/
1220 Mailman can still be run as a traditional CGI program of course.
1221 * Mailman now provides an LMTP server for more efficient integration with
1222 supporting mail servers (e.g. Postfix, Sendmail). The Local Mail Transport
1223 Protocol is defined in RFC 2033:
1225 http://www.faqs.org/rfcs/rfc2033.html
1226 * Virtual domains are now fully supported in that mailing lists of the same
1227 name can exist in more than one domain. This is accomplished by renaming
1228 the lists/ and archives/ subdirectories after the list's posting address.
1229 For example, data for list foo in example.com and list foo in example.org
1230 will be stored in lists/foo@example.com and lists/foo@example.org.
1232 For Postfix or manual MTA users, you will need to regenerate your mail
1233 aliases. Use bin/genaliases.
1235 VIRTUAL_HOST_OVERVIEW has been removed, effectively Mailman now operates
1236 as if it were always enabled. If your site has more than one domain,
1237 you must configure all domains by using add_domain() in your
1238 etc/mailman.cfg flie (see below -- add_virtual() has been removed).
1239 * If you had customizations based on Site.py, you will need to re-implement
1240 them. Site.py has been removed.
1241 * The site list is no more. You can remove your 'mailman' site list unless
1242 you want to retain it for other purposes, but it is no longer used (or
1243 required) by Mailman. You should set NO_REPLY_ADDRESS to an address that
1244 throws away replies, and you should set SITE_OWNER_ADDRESS to an email
1245 address that reaches the person ultimately responsible for the Mailman
1246 installation. The MAILMAN_SITE_LIST variable has been removed.
1247 * qrunners no longer restart on SIGINT; SIGUSR1 is used for that now.
1249 Internationalization Big Changes
1250 --------------------------------
1252 * Translators should work only on messages/<lang>/LC_MESSAGES/mailman.po.
1253 Templates files are generated from mailman.po during the build process.
1255 New Features
1256 ------------
1258 * Confirmed member change of address is logged in the 'subscribe' log, and if
1259 admin_notify_mchanges is true, a notice is sent to the list owner using a
1260 new adminaddrchgack.txt template.
1261 * There is a new list attribute 'subscribe_auto_approval' which is a list of
1262 email addresses and regular expressions matching email addresses whose
1263 subscriptions are exempt from admin approval. RFE 403066.
1265 Command line scripts
1266 --------------------
1268 * Most scripts have grown a -C/--config flag to allow you to specify a
1269 different configuration file. Without this, the default etc/mailman.cfg
1270 file will be used.
1271 * the -V/--virtual-host-overview switch in list_lists has been removed, while
1272 -d/--domain and -f/--full have been added.
1273 * bin/newlist is renamed bin/create_list and bin/rmlist is renamed
1274 bin/remove_list. Both take fully-qualified list names now (i.e. the list's
1275 posting address), but also accept short names, in which case the default
1276 domain is used. newlist's -u/--urlhost and -e/--emailhost switches have
1277 been removed. The domain that the list is being added to must already
1278 exist.
1279 * Backport the ability to specify additional footer interpolation variables
1280 by the message metadata 'decoration-data' key.
1282 Bug fixes and other patches
1283 ---------------------------
1285 * Removal of DomainKey/DKIM signatures is now controlled by Defaults.py
1286 mm_cfg.py variable REMOVE_DKIM_HEADERS (default = No).
1287 * Queue runner processing is improved to log and preserve for analysis in the
1288 shunt queue certain bad queue entries that were previously logged but lost.
1289 Also, entries are preserved when an attempt to shunt throws an exception
1290 (1656289).
1291 * The processing of Topics regular expressions has changed. Previously the
1292 Topics regexp was compiled in verbose mode but not documented as such which
1293 caused some confusion. Also, the documentation indicated that topic
1294 keywords could be entered one per line, but these entries were not handled
1295 properly. Topics regexps are now compiled in non-verbose mode and multi-
1296 line entries are 'ored'. Existing Topics regexps will be converted when
1297 the list is updated so they will continue to work.
1298 * The List-Help, List-Subscribe, and List-Unsubscribe headers were
1299 incorrectly suppressed in messages that Mailman sends directly to users.
1300 * The 'adminapproved' metadata key is renamed 'moderator_approved'.