1 =======================
3 =======================
5 Copyright (C) 1998-2018 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.
20 * Bounce runner now properly commits database transactions. (Closes #850)
21 * Pending subscriptions now have a lifetime equal to the configured
22 ``pending_request_life`` rather than 3650 days. (Closes #729)
23 * Held messages which are handled are now removed from the message store and
24 the pending db. (Closes #257)
25 * Admin notices sent when a list member's delivery is disabled by bounce or
26 when a member's bounce score is incremented, now contain a copy of the
27 triggering DSN. (Closes #737)
28 * Handling a held message now also removes the poster's pending
29 ``held message`` from the pending db. (Closes #257)
30 * Deleting a pending request now also deletes any associated workflow.
32 * A new runner which is not a queue runner and which doesn't override its
33 ``run`` or ``_one_itiration`` methods can now be implemented. (Closes #866)
34 * The ``FileNotFound`` exception thrown in CacheManager on attempt to delete
35 an entry for a missing file is now caught. (Closes #867)
36 * Pending probe bounce tokens now have a lifetime of 10 days. (Closes #869)
37 * Improve the performance of ``/users`` API when paginating by doing the
38 pagination in database layer. (Closes #876)
39 * Attempts to get a message from the message store with a missing file are
40 now handled. (Closes #877)
41 * The task runner no longer prematurely deletes saved DSNs. (Closes #878)
42 * Bounce probe messages now contain the DSN as advertised. (Closes #880)
43 * The avoid_duplicates handler properly handles headers that are returned as
44 email.header.Header instances rather than strings. (Closeds #881)
45 * The mta.deliver module properly handles headers that are returned as
46 email.header.Header instances rather than strings. (Closeds #882)
47 * Places where ``to_list`` in the message metadata were increctly referenced
48 as ``tolist`` have been corrected. (Closes #883)
49 * It is now possible to confirm held messages by email as the admin notice
51 * Some exceptions in ARC signing of some posts from HyperKitty and some from
52 prod.outlook.com are now handled without shunting the message. (Closes #885)
53 * Command runner now will decode the message body before processing it.
55 * The ``mailinglist`` table ``info`` column is changed to Text. (Closes #840
57 * The mailing list administrators roster ``get_member()`` method now returns
58 the owner if the target is both an owner and moderator. (Closes #888)
59 * Command runner now handles RFC 2047 encoded command with non-ascii prefix.
61 * Improve performance of the bounce runner by decreasing the number of
62 database queries executed.
63 * The master watcher will now restart a process that exits. (See #887)
64 * When using MySQL, most database columns that expect user input will now
65 accept emojis and other 4-byte unicode characters by using the utf8mb4
66 character set instead of 3-byte. (Closes #891)
67 * LMTP runner now sets unixfrom in incoming messages. (Closes #904)
68 * The ``Message`` ``senders()`` method now RFC2047-decodes and unfolds headers.
70 * The ``Message`` ``senders()`` method now gets all the addresses from the
71 configured headers. (Closes #905)
72 * Require flufl.bounce >=3.0.2, which improves parsing of bounce messages.
74 * DMARC policy discovery ignores domains with multiple DMARC records per
75 RFC 7849. (Closes #907)
76 * Held messages missing from the message store can now be accepted and/or
77 forwarded. (closes #914)
78 * Dispose SQLAlchemy connections after a new worker process is forked. (Closes
80 * Exceptions in bounce processing member removal don't roll back successful
81 removals. (Closes #909)
82 * Only remove or send warnings to list members when processing bounces.
84 * Replacements are now expanded in the ``list:user:notice:goodbye`` template.
86 * The nntp runner no longer folds long headers in newsgroup posts. (Closes
88 * RFC 2047 encoded subject headers will now be recoded in the character set of
89 the list's preferred_language during subject prefixing if possible. (Closes
94 * The ``notify`` subcommand is now more tolerant of certain database anomalies.
96 * The ``notify`` subcommand now handles unicode errors in decoding RFC 2047
97 encoded subject headers. (Closes #915)
101 * Fixed an exception on retreiving held messages if the held request exists,
102 but the message is missing. (Closes #856)
103 * Add a new ``/users/find`` endpoint to allow searching for users by matching
104 display_name and user's email address. (Closes #874)
108 * There is a new ``bounce_notify_admin_on_bounce_increment`` list setting and
109 a corresponding ``list:admin:notice:increment`` template for the notice.
110 This setting, if True, will cause a notice to be sent to the list admins
111 when a member's bounce score is incremented, but doesn't disable delivery.
112 * There is a new ``moderator_request_life`` setting in the ``[mailman]``
113 section of mailman.cfg that controls the lifetime of pending moderator
114 requests as opposed to pending user confirmations. Default is 180 days.
115 * There is a new ``task`` runner to do periodic tasks. The current
116 implementation evicts expired pendings and cache entries and removes
117 orphaned workflows and orphaned message store messages. It does these tasks
118 at intervals defined by the new ``run_tasks_every`` setting in the
119 ``[mailman]`` section of mailman.cfg. Default is 1 hour. (Closes #467 and
121 * There is a new ``list:admin:notice:pending`` template for the notice from
122 the ``mailman notify`` command. (Closes #890)
126 * Check the REST API password in a way that is resistant to timing attacks.
127 (CVE-2021-34337, Closes #911)
138 * Require aiosmtpd >= 1.4.1 to allow address local parts longer than 64 bytes
139 in the lmtp runner. (Closes #836)
140 * The email join command now honors the digest=<no|mime|plain> option.
142 * Folded ``Message-ID`` headers no longer cause folded smtp.log messages.
144 * Removal of headers from posts to anonymous lists that can reveal the poster
145 or the poster's domain has been improved. (Closes #848)
149 * The ``notify`` subcommand will now decode an RFC 2047 encoded Subject: for
150 the report of held messages. (Closes #831)
151 * The deprecated options ``--add``, ``--del`` and ``--sync`` are now disabled
152 on the ``mailman members`` command.
156 * Improve the speed of Members lookup via REST API. (Related to #700)
157 * Allow specifying ``delivery_mode`` and ``delivery_status`` when creating a
158 new Member. (Closes #828)
159 * Allow filtering members in ``/members/find`` API using ``delivery_status``,
160 ``delivery_mode`` and ``moderation_action``. (See #827)
164 * There is a new setting ``filter_report`` in the ``[mailman]`` section of
165 mailman.cfg. If this is set to ``yes``, a report of changes by content
166 filtering will be added to the outgoing message. (Closes #833)
167 * There is a new setting ``check_max_size_on_filtered_message`` in the
168 ``[mailman]`` section of mailman.cfg. If this is set to ``yes`` and the
169 list does content filtering, the ``max_message_size`` hold will be based
170 on the size of the content filtered message. (Closes #377)
171 * There is a new setting ``anonymous_list_keep_headers`` in the ``[mailman]``
172 section of mailman.cfg. This is part of improved removal of headers from
173 posts to anonymous lists. This setting is a space separated list of regexp
174 patterns. After anonomyzing removes the headers which are known to reveal
175 the poster or poster's domain, it then removes all headers whose names do
176 not match (case-insensitively) one of these patterns. The default setting
177 keeps non X- headers, those X- headers added by Mailman and any X-Spam-
182 * Add better error message for preferred email edit when not verified. (Closes #706)
183 * Reduce the number of database calls in UserManager. (Closes #700)
194 * Handle some UnicodeEncodeErrors in creating digests. (Closes #560)
195 * Increased the size of the data column in the workflowstate table.
197 * Implemented a ``scrubber`` for plain text digests. (Closes #473)
198 * The ``mailman gatenews`` command now adds ``original_size`` as a message
199 attribute. (Extends fix for #762)
200 * Handle FileNotFoundError when creating digest.mmdf file without a
201 parent directory present. (Closes #699)
202 * Fixed an issue where content filtering can throw UnicodeEncodeError when
203 converting HTML to plain text. (Closes #798)
204 * A bounce for a non-existent list is now handled. (Closes #799)
205 * RFC 2047 From: headers in emailed ``join`` commands are now decoded.
207 * The ``mailman addmembers`` command now catches and reports a
208 ``SubscriptionPendingError``. (Closes #805)
209 * RFC 2369 ``List-Owner`` header is now added when these headers are included.
211 * Header filters will now properly match RFC 2047 encoded headers.
213 * Mailman's ``vette`` log discard messages now include the reasons.
215 * Increase the default REST API (gunicorn) timeout to 360 seconds from 30 as
216 several API endpoinds can be very slow. (Closes #770)
217 * Header filter rules are now properly processed after deletions and/or
218 reordering. (Closes #818)
219 * Folded ``To: list-confirm+token@...`` headers are now parsed correctly.
224 * A new ``findmember`` ``mailman`` subcommand has been added to find to which
225 lists and with which roles an address matching a given pattern belongs.
226 * A new ``changeaddress`` ``mailman`` subcommand has been added to enable site
227 admins to change a user's address.
231 * There is a new setting ``hold_digest`` in the ``[mailman]`` section of
232 mailman.cfg. If this is set to ``yes``, posts with a digest like Subject:
233 header or which quote the digest masthead will be held for moderation.
237 * List configuration option ``send_goodbye_message`` is now exposed through
238 the REST API. (See !737)
239 * Allow updating an Addresses' display_name attribute. (Closes #786)
240 * Allow specifying a reason when rejecting a subscription request. (Closes
242 * REST API now exposes unsubscription requests that can be handled by
243 Moderator. (Closes #768)
252 * When importing 2.1 lists, ignore CR characters added by browsers in headers
253 and footers. (Closes #701)
254 * RFC 2369 headers are now added to notification messages. (Closes #710)
255 * Bounce probes are now encoded in the correct charset. (Closes #712)
256 * We now unfold address containing headers before parsing in avoid_duplicates.
258 * The ``dmarc`` rule no longer misses if DNS returns a name containing upper
260 * Fixed ``mailman.email.message.Message.as_string`` to not return unicode
261 surrogates. (Closes #732)
262 * Bounce probes can now be sent to a member subscribed as a User.
264 * A member subscribed as a User can now be unsubscribed. (Closes #734)
265 * When a handler rejects or discards a message, it won't be delivered or
266 archived anyway. (Closes #752)
267 * Messages forwarded when content filtering removes the entire message and
268 ``filter_action`` is forward now go to owners as well as moderators.
270 * Handle TOCTOU conditions when there are two simultaneous subscription
271 requests for the same email address. (Closes #748)
272 * Removed unnecessary call to ``Lock().disown()`` from ``bin/master.py``.
274 * Fixed an invalid logging call in bin/master.py. (Closes #756)
275 * VERPed list welcome messages now have a correct envelope sender.
277 * Messages in digests now contain a ``Message: N`` header. (Closes #764)
278 * The LMTP runner will now add a ``Message-ID:`` header if missing.
279 (Closes #448 and #490)
280 * The ``mailman gatenews`` command now adds ``original_size`` to the msgdata.
285 * New ``addmembers``, ``delmembers`` and ``syncmembers`` ``mailman``
286 subcommands have been added. These provide more options and controls than
287 the corresponding ``mailman members`` modes which are now deprecated.
289 * The ``mailman conf`` command without a ``-s/--section`` argument will now
290 show sections defined only in mailman.cfg in addition to those from
291 schema.cfg. (Closes #736)
292 * Added a ``charset`` option to the ``import21`` subcommand. (Closes #769)
293 * The ``import21`` subcommand will now truncate long SAUnicode values if the
294 database is MySQL. (Closes #772)
295 * The ``import21`` subcommand no longer adds the entire legacy
296 ``*_these_nonmembers`` list and then removes the non-regexps. It now just
297 adds the regexps. (Closes #773)
301 * Add a new endpoint ``/lists/<listid>/requests/count`` which returns total
302 number of pending requests. (Closes #713)
303 * Subscription requests API now allows filtering requests with ``token_owner``
304 parameter. (Closes #714)
305 * Add ``subscription_mode`` to ``Member`` resource so API clients can
306 differentiate between subscription via address and via primary address of an
308 * Add ``/list/<listid>/held/count`` to get a count of total held
309 messages. (Closes #713)
310 * Add ``fields`` as an optional parameter in all the Member's APIs to customize
311 which fields are included in the resource. (Closes #716)
312 * Expose ``emergency`` field of MailingList via REST API. (Closes #719)
316 * Italian translations of the templates have been added.
317 * The default charset for many languages is changed to utf-8. (Closes #747)
321 * Add a new ``archive_rendering_mode`` attribute to ``MailingList`` to
322 configure what kind of rendering should Archivers use to render
323 Emails. (Closes #720)
324 * An ``address=`` option has been added to the email ``join`` command to allow
325 requesting subscription of other than the sender of the email. (Closes #721)
326 * Added the ability to invite members to a list. (Closes #510 and #730)
327 * Made (un)subscription confirmation email subjects user friendly and
328 translatable. (Closes #541)
329 * Implemented a new email ``who`` command to obtain list membership.
330 * Add support for dnspython>=2.0. (Closes #743)
331 * Added information about ``pass_types``, ``filter_extensions`` and
332 ``pass_extensions`` to the content filtering doc. (Closes #775)
341 * Allow ``action`` for header matches to be None in REST interface. (Closes #671)
342 * It is now possible to add the list posting address with nonmember role, e.g.
343 to give it a moderaction of discard. (Closes #633)
344 * The issue of posting a message without a To: header to a fully personalized
345 list throwing a KeyError has been fixed. (Closes #639)
346 * Confirmation or moderator approval of a subscription from an address banned
347 subsequent to subscribing will no longer succeed. (Closes #642)
348 * Fixed an issue caused by the fix for #642 where email confirmation of a
349 banned subscription address would cause a shunted message. (Closes #643)
350 * Fixed a bug where the ``postfix_vmap`` file would merge two columns for long
351 domain names. (Closes #651)
352 * Fix failing test cases due to changed API in a new version of dkimpy. (Closes
354 * Mailman now auto-geneartes alias maps when it starts for the first
356 * Sending a bounce probe now resets ``bounce_score``. (Closes #660)
357 * Bounce probes which bounce are now properly recognized. (Closes #661)
358 * Residual bounces are logged but are not processed further. (Closes #662)
359 * Disabling delivery by bounce properly initializes some bounce info so
360 warnings can be sent and the member eventually removed. (Closes #663)
361 * Bouncing member is not removed until
362 ``bounce_you_are_disabled_warnings_interval`` after the last warning was
364 * Fixed recipient address in delivery disabled by bounce notice to the user.
366 * Residial bounces are now marked as processed. (Closes #669)
367 * Find members API now searches for the Member's display name too. (Closes #667)
368 * Content filtering ``convert_html_to_plaintext`` no longer creates messages
369 that can't be flattened as_bytes. (Closes #677)
370 * Removed an incorrect failing assertion when confirming a confirm_then_moderate
371 unsubscription. (Closes #553)
372 * Fix a bug due to incompatible API of a new version of ``importlib_resources``
373 library which causes Templates loading to fail. (Closes #691)
374 * Fix a bug due to incompatible API of a new version of ``zope.intefaces``.
376 * Import21 no longer tries to import banned addresses. (Closes #688)
380 * A new ``mailman members --sync`` command has been added to help you
381 synchronize subscribed mailing list members against a text list of
382 subscription addresses. (see !545)
386 * Expose ``max_days_to_hold``, ``accept_these_nonmembers``,
387 ``reject_these_nonmembers``, ``discard_these_nonmembers``,
388 ``hold_these_nonmembers``, ``personalize``, and ``unsubscription_policy``
389 attributes of a MailingList through API. (See !570)
390 * Add a new ``send_welcome_message`` flag when subscribing users to override
391 MailingList's default setting. (Closes #362)
392 * Expose content filtering settings for MailingList. (Closes #694)
393 * Add ``advertised`` attribute to ``MailingList`` object so Postorius doesn't
394 have to make multiple calls for Index Page. (See !608)
395 * Expose ``filter_action`` attribute of MailingList through API. (See !609)
396 * Unsubscribing a user by calling ``DELETE`` on a Member resources now honors
397 Lists's ``unsubscription_policy`` and also sends out notifications to user
398 and admins if list is configured to do so. (Closes #759)
402 * Add support for processing of email bounce events. Thanks to Aaryan Bhagat for
403 working on this as a part of his GSoC project and Thanks to Google for
404 sponsoring the project as a part of GSoC.(See !584)
407 3.3.0 -- "Tom Sawyer"
408 =====================
413 * A list member with ``receive_list_copy`` set to ``False`` who is addressed in
414 ``CC`` will now be removed from ``CC`` even if this results in no ``CC``.
416 * ``X-Mailman-Approved-At`` header now has correct timezone. (Closes #584)
417 * A spurious ``invalid FilterAction: discard. Treating as discard`` log
418 message is eliminated. (Closes #592)
419 * A post from a nonmember matching the legacy ``accept_these_nonmembers`` is
420 now subject to subsequent rules rather than accepted immediately.
422 * Email attempts to subscribe a user who is banned or has a subscription
423 already pending are now handled properly. (Closes #577 and #583)
424 * It is no longer possible to add the list's posting address with any role to
425 a list. (Closes #599)
426 * Fixed the nntp runner which was calling the ``nntplib.NNTP.post()`` method
427 with a string object instead of bytes. (Closes #613)
428 * A post with a Reply-To: the list address will no longer be shunted.
430 * Encoded (base64 or quoted-printable) HTML message bodies are now decoded for
431 ``html_to_plaintext``. (Closes #616)
432 * Non-VERPed temporary failure DSNs are no longer reported as unrecognized
433 bounces. (Closes #622)
434 * Fix ``mailman import21`` command to work in Python 3.7.4 and Python 3.8b4
439 * The ``mailman import21`` command now leaves only regexps in the legacy
440 ``*_these_nonmembers`` list attributes. (Closes #588)
441 * The ``mailman import21`` command now imports nonmember accept actions as
442 ``Action.defer`` rather than ``Action.accept``. (Closes #579)
443 * The ``mailman import21`` command now correctly imports ``*_these_nonmembers``
444 actions for nonmembers following a member in the list. (Closes #580)
445 * The progress meter while ``mailman import21`` is importing rosters has been
446 shortened so it no longer wraps and scrolls. (Closes #589)
447 * The ``mailman import21`` command no longer sends an email to existing owners
448 for each imported member. (Closes #605)
449 * A ``mailman notify`` command has been implemented to be run by cron to send
450 periodic notices of held requests to list owners and moderators.
452 * The ``mailman import21`` command now imports ``private_roster``.
454 * A ``mailman gatenews`` command has been implemented to be run by cron to gate
455 messages from usenet to those lists which have the gateway configured.
456 * The ``mailman members --add`` command no longer prints a stack trace if an
457 invalid email address is given. (See !544)
458 * A new ``mailman members --remove`` command has been added to help you
459 mass-unsubscribe subscribers from a mailing list.
463 * Expose a user's preferred address using REST API. (Closes #240)
464 * Expose `header_matches/find` API to find a list of ``HeaderMatches`` belonging
465 to a MailingList. (See !497)
466 * Allow adding a comment when rejecting held messages. (Closes #594)
467 * Fix a 500 error when creating a user with invalid email address. (Closes #263)
471 * Add French translations for mail templates. (See !522)
475 * Add a new attribute ``tag`` to ``HeaderMatch`` to find and manage a set of
477 * Expired cached entries will be deleted efficiently. (Closes #462)
478 * REST Runner now uses Gunicorn to run WSGI server instead of the standard
479 library wsgiref for better performance.
480 * Add support for SMPTS/STARTTLS for connections to MTA. (See !508)
481 * The last remnants of the mailing list attribute ``nntp_host`` have been
482 removed. (Closes #611)
483 * Email confirmation requests now include an ``Auto-Submitted`` header to
484 prevent robotic replies per ``RFC 3834``. (Closes #23)
485 * The mail->news gateway no longer munges Message-ID headers unless the
486 original Message-ID is rejected by the ``nntp_host``. (Closes #24)
494 * Failed validation to new Mailing List creation and Domain creation no longer
496 * Expose ``preferred_language`` for MailingList through REST API.
497 * Self-link of banned emails will be url-encoded when the email is actually
498 a regex, mainly to prevent misplaced `?` in the link.
499 * REST API now accepts inputs in JSON format. (See !451)
500 * REST API errors are now always formatted as JSON. (See !451)
501 * Failed request validations now return more verbose errors, like ``Enum`` types
502 return all acceptable values. (See !451)
503 * REST API accepts request with content type None (See !479)
508 * The ``mailman import21`` command now displays import progress. (Closes #561)
509 * An issue with ``mailman subcommand --help`` hanging has been worked around.
519 * The ``mailman import21`` command properly converts all acceptable_aliases
520 to regexps. (Closes #496)
521 * The ``mailman import21`` command correctly converts autorespond_* settings.
523 * The various ``mailman`` commands now issue a help hint in case of error.
524 Tests have been updated to recognize this. (Closes #519)
528 * Open non-regular log files (e.g. fifos) in write mode instead of append mode.
530 * Autoresponses to posts and -owner and -request messages now work.
532 * Message parts are now properly decoded when trying to remove an Approved:
533 header. (Closes #518)
534 * Outgoing SMTP connections are now closed following message delivery
535 regardless of the max_sessions_per_connection setting. (Closes #529)
536 * Messages with Subject: Re: only are now processed correctly. (Closes #545)
540 * Added German translations for mail templates. Thanks to the "Institut für
541 Gebrauchsgrafik" for providing them. (Closes #534)
545 * Allow setting ``max_num_recipients`` for a mailing list. (Closes #508)
546 * Add a per-list visibility option for Members. (Closes #108)
550 * Email commands are now case insensitive. (Closes #353)
551 * Implicit commands sent to -join, -leave and -confirm addresses no longer
552 generate a Results email. (Closes #516)
553 * An ``explicit_header_only`` option has been added to Reply-To: munging to
554 avoid putting the list address in Cc:. (Closes #531)
555 * The default list welcome message has been cleaned up a bit. (Closes #530)
556 * A substitution variable ``user_name_or_email`` has been added to
557 ``list:member:regular:header`` and ``list:member:regular:footer`` templates
558 when personalized deliveries are enabled. (Closes #533)
559 * The template search algorithm was fixed to look for in-tree templates for
560 each language in the search list. (Closes #535)
561 * Set default subscription policy to "confirm then moderate" for private
562 mailing list style. (Closes #536)
565 3.2.0 -- "La Villa Strangiato"
566 ==============================
571 * A missing html_to_plain_text_command is now properly detected and logged.
573 * Syntactically invalid sender addresses are now ignored. (Closes #229)
574 * An AttributeError: 'str' object has no attribute 'decode' exception in
575 subject prefixing is fixed. (Closes #359)
576 * Messages with no syntactically valid senders are now automatically
577 discarded. (Closes #369)
578 * Various message holds and rejects that gave 'N/A' as a reason now give an
579 appropriate reason. (Closes #368)
580 * Bounce messages are now composed for proper translations.
581 * Messages with badly encoded ``Subject`` headers no longer crash the message
582 moderation REST API. (Closes #383)
583 * Generated ``regexp`` tables for Postfix now account for possible ``+extra``
584 additions to the ``-bounces`` and ``-confirm`` addresses. (Closes #401)
585 * Address confirmation notices are now properly encoded in the character set
586 of the list's preferred_language. (Closes #395 and #413)
587 * Thanks to Jim Popovitch, certain failures in DNS lookups of DMARC policy
588 will now result in mitigations being applied. (Closes #415)
589 * Messages without a sender can no longer bypass the ``nonmember-moderation``
591 * Invalid regexps in header_matches rules are properly logged and can't be set
592 via REST. (Closes #418)
593 * A list whose name is one of the ``admin``, ``bounces``, ``confirm``, etc.
594 subaddresses can now be posted to. (Closes #433)
595 * The ``admin`` subaddress, a synonym for ``bounces`` and deprecated since
596 Mailman 2.1, has been removed. (Closes #435)
597 * Better support for changing the ``list_name`` property. (Closes #428)
598 * Raw Message text is now coerced to pure ascii before sending, and
599 https://bugs.python.org/issue27321 is now defended against by overriding
600 Message.as_string() to cover more cases than before. (Closes #406)
601 * The override of Message.as_string() has been extended to catch another
602 observed exception. (Closes #441)
603 * The email.message.UserNotification() constructor will now not fail if given
604 a ``text`` argument containing a character not in the charset of the
605 ``lang`` argument. (Closes #437)
606 * A new SQLAlchemy column type ``SAUnicodeXL`` has been implemented to support
607 large columns in MySQL and is used for the ``value`` column of the
608 ``pendedkeyvalue`` table. (Closes #385)
609 * Messages with ``Subject`` headers encoded in an unknown character set no
610 longer throw ``LookupError`` in subject prefixing. (Closes #445)
611 * A list's ``last_post_at`` is now properly updated. (Closes #453)
612 * Fixed an AttributeError in mailman/handlers/decorate.py when
613 member.subscriber is an ``IUser`` instance rather than an ``IAddress``
614 instance. (Closes #449)
615 * Message decoration has been removed from the posting pipeline and added to
616 bulk delivery to avoid duplicate decoration of personalized and VERPed
617 messages. (Closes #450)
618 * The ``mailman inject`` command now reads standard input as documented if
619 there is no ``-f`` or ``--filename`` option. (Closes #459)
620 * Mailman doesn't chmod existing configuration directories on startup (Closes
622 * Calling ``set`` on a template evicts the local cache if the template was
623 cached before. (Closes #463)
624 * The override of Message.as_string() has been extended to catch yet another
625 observed exception. (Closes #470)
626 * Fixed a typo in the help for ``mailman digests --periodic``. (Closes #472)
627 * Character encoding errors in adding headers and footers to multipart messages
628 are detected and ``replaced``. (Closes #409)
629 * The help for ``mailman qfile`` has been fixed to reference ``mailman qfile``
630 rather than the non-existent ``bin/dumpdb``. (Closes #475)
631 * The dmarc rule has been fixed to not throw a TypeError when msg.get('from')
632 returns a header instance. (Closes #477)
633 * ``mailman`` command without any sub-command now invokes ``mailman help`` by
634 default. (Closes #479)
635 * The ``alias_domain`` attribute can become a null string. ``mta/postfix.py``
636 has been fixed to generate proper mappings in this case. (Closes #485)
637 * Fix a bug where duplicate address records can be created when a user adds an
638 existing address with a different case. (Closes #476)
639 * Several additional templates can now be set in the ``var/templates``
640 hierarchy. (Closes #486)
644 * Adopt the ``click`` package for command line parsing. This makes the
645 command line more consistent and pluggable. Also, many CLIs that accepted a
646 "fqdn list name" (i.e. the posting address of a mailing list), now also
647 accept a ``List-ID``. Every attempt has been made to keep the CLI backward
648 compatible, but there may be subtle differences. (Closes #346)
649 * If no listname is given, running ``mailman withlist -r`` must name a
650 function taking no arguments. This can be used to introspect Mailman
651 outside of the context of a mailing list.
652 * Fix ``mailman withlist`` command parsing. (Closes #319)
653 * Add a new option ``--periodic`` to ``mailman digests`` command. It sends out
654 digests for only those Mailing Lists that have ``digest_send_periodic`` option
655 set to ``True``. (Closes #384)
656 * The ``mailman import21`` command now imports DMARC mitigations.
657 * The ``mailman import21`` command no longer creates templates with
658 non-standard names, (Closes #482)
662 * The ``[mailman]pre_hook`` and ``[mailman]post_hook`` variables are
663 deprecated. They can still be specified but they will not be run.
664 * The ``[paths.*]ext_dir`` variable has been removed.
665 * A new logger has been added called ``logging.plugins``.
666 * The ``[styles]paths`` variable has been removed; you can now specify
667 additional styles using the new plugin architecture.
668 * Mailman now also searches at ``/etc/mailman3/mailman.cfg`` for the
673 * The fix for #313 which ported an upstream SQLAlchemy fix to Mailman
674 has been refactored now that SQLAlchemy 1.2 has been released.
678 * Broaden the semantics for ``IListManager.get()``. This API now accepts
679 both ``List-ID``s and fully qualified list names, since that's the most
680 common use case. There's now a separate ``.get_by_fqdn()`` which only
681 accepts the latter and mirrors the already existing ``.get_by_list_id()``.
682 * A new template ``list:user:notice:rejected`` has been added for customizing
683 the bounce message rejection notice.
684 * The ``acceptable_alias`` and ``require_explicit_destination`` attributes
685 have been added to the ``IMailingList`` definition. (Closes #483)
689 * Add a new plugin architecture, which allows third parties to add
690 initialization hooks, REST endpoints, and additional components. Given by
692 * Drop support for Python 3.4. (Closes #373)
693 * Bump minimum requirements for aiosmtpd (>= 1.1) and flufl.lock (>= 3.1).
694 * Add '.pc' (patch directory) to list of ignored patterns when building the
695 documentation with Sphinx.
696 * Domain objects now have an ``alias_domain`` attribute which is normally
697 ``None``, but which can be set to an alternate domain. This will enable
698 the Postfix MTA to generate ``virtual_alias_maps`` which will map list
699 addresses in the domain to addresses in the alternate domain, and will
700 modify the other generated mappings to use the ``alias_domain``. The
701 ``lmtp`` runner will also accept the alias_domain as an alias for the
703 * ``ICacheManager`` now allows evicting a single file from cache.
707 * Allow a mailing list's acceptable aliases to be cleared by calling
708 ``DELETE`` on the list's ``config/acceptable_aliases`` resource.
710 * Allow setting ``max_message_size`` for a mailing list. (Closes #417)
711 * Added new attribute in ``lists/styles`` resource ``styles`` that contains the
712 list of all the styles in Core along with their description. ``style_names``
713 attribute is now deprecated and will be removed in future versions.
714 * Add ``display_name`` for ``member`` in order to expose ``member.display_name``.
716 * Expose ``MailingList.respond_to_post_request`` through REST API. (Closes #420)
717 * Add a new API ``lists/find`` which returns all the lists related to a
718 subscriber. It optionally allows filtering based on a role. (See !388)
719 * ``IAcceptableAliasSet`` resource now interprets an empty string ('') as an
720 empty list ([]). This can be used to clear the list of acceptable aliases of a
721 MailingList in a PATCH or PUT request, without having to use a DELETE request.
722 * Expose ``MailingList.require_explicit_destination`` through REST API.
726 3.1.0 -- "Between The Wheels"
727 =============================
732 * When the mailing list's ``admin_notify_mchanges`` is True, the list owners
733 now get the subscription notification. (Closes: #1)
734 * Fix the traceback that occurred when trying to convert a ``text/html``
735 subpart to plaintext via the ``mimedel`` handler. Now, a configuration
736 variable ``[mailman]html_to_plain_text_command`` in the ``mailman.cfg`` file
737 defines the command to use. It defaults to ``lynx``. (Closes: #109)
738 * Confirmation messages should not be ``Precedence: bulk``. (Closes #75)
739 * Fix constraint violations on mailing list deletes affecting PostgreSQL.
740 Given by Abhilash Raj. (Closes #115)
741 * ``mailman`` command with no subcommand now prints the help text. Given by
742 Abhilash Raj. (Closes #137)
743 * The MHonArc archiver must set stdin=PIPE when calling the subprocess.
744 Given by Walter Doekes.
745 * For now, treat ``DeliveryMode.summary_digests`` the same as
747 (Closes #141). Also, don't enqueue a particular digest if there are no
748 recipients for that digest.
749 * For Python versions earlier than 3.5, use a compatibility layer for a
750 backported smtpd module which can accept non-UTF-8 data. (Closes #140)
751 * Bulk emails are now decorated with headers and footers. Given by Aurélien
752 Bompard. (Closes #145)
753 * Core no longer depends on the standalone ``mock`` module. (Closes: #146)
754 * The logging of moderation reasons has been fixed. Given by Aurélien
756 * Collapse multiple ``Re:`` in Subject headers. Given by Mark Sapiro.
758 * Added Trove classifiers to setup.py. (Closes: #152)
759 * Fix the processing of subscription confirmation messages when the mailing
760 list is set to confirm-then-moderate. (Closes #114)
761 * Fix ``UnicodeEncodeError`` in the hold chain when sending the authorization
762 email to the mailing list moderators. (Closes: #144)
763 * Fix traceback in approved handler when the moderator password is None.
764 Given by Aurélien Bompard.
765 * Fix IntegrityErrors raised under PostreSQL when deleting users and
766 addresses. Given by Aurélien Bompard.
767 * Allow mailing lists to have localhost names with a suffix matching the
768 subcommand extensions. Given by Aurélien Bompard. (Closes: #168)
769 * Don't traceback if a nonexistent message-id is deleted from the message
770 store. Given by Aurélien Bompard, tweaked by Barry Warsaw. (Closes: #167)
771 * Fix a bug in ``SubscriptionService.find_members()`` when searching for a
772 subscribed address that is not linked to a user. Given by Aurélien Bompard.
773 * Fix a REST server crash when trying to subscribe a user without a preferred
774 address. (Closes #185)
775 * Fix membership query when multiple users are subscribed to a mailing list.
776 Reported by Darrell Kresge. (Closes: #190)
777 * Prevent moderation of messages held for a different list. (Closes: #161)
778 * When approving a subscription request via the REST API, for a user who is
779 already a member, return an HTTP 409 Conflict code instead of the previous
780 server traceback (and resulting HTTP 500 code). (Closes: #193)
781 * In decoration URIs (e.g. ``IMailingList.header_uri`` and ``.footer_uri``)
782 you should now use the mailing list's List-ID instead of the
783 fqdn-listname. The latter is deprecated. (Closes #196)
784 * Trying to subscribe an address as a list owner (or moderator or nonmember)
785 which is already subscribed with that role produces a server error.
786 Originally given by Anirudh Dahiya. (Closes #198)
787 * Cross-posting messages held on both lists no longer fails. (Closes #176)
788 * Don't let unknown charsets crash the "approved" rule. Given by Aurélien
789 Bompard. (Closes #203)
790 * Don't let crashes in IArchiver plugins break handlers or runners.
792 * Fix "None" as display name in welcome message. Given by Aditya Divekar.
794 * Fix ``mailman shell`` processing of ``$PYTHONSTARTUP``. (Closes #224)
795 * Fix query bug for ``SubscriptionService.find_members()`` leading to the
796 incorrect number of members being returned. Given by Aurélien Bompard.
798 * Fix header match rule suffix inflation. Given by Aurélien Bompard.
800 * MIME digests now put the individual message/rfc822 messages inside a
801 multipart/digest subpart. (Closes #234)
802 * Nonmember subscriptions are removed when one of the addresses controlled by
803 a user is subscribed as a member. Given by Aditya Divekar. (Closes #237)
804 * Email address validation is now more compliant with RFC 5321. (Closes #266)
805 * A mailing list's ``description`` must not contain newlines. Given by
806 Aurélien Bompard. (Closes: #273)
807 * Allow MailingList.info to be set using the REST API. Given by Aurélien
809 * Extend header filters to also check sub-part headers. (Closes #280)
810 * Allow REST API to PUT and PATCH domain attributes. Allows Postorius domain
811 edit to work. (Closes: #290)
812 * Prevent posting from banned addresses. Given by Aurélien Bompard.
814 * Remove the digest mbox files after the digests are sent. Given by Aurélien
815 Bompard. (Closes: #259)
816 * Transmit the moderation reason and expose it in the REST API as the
817 ``reason`` attribute. Given by Aurélien Bompard.
818 * Don't return a 500 error from the REST API when trying to handle a held
819 message with defective content. Given by Abhilash Raj. (Closes: #256)
820 * Delete subscription requests when a mailing list is deleted. Given by
821 Abhilash Raj. (Closes: #214)
822 * Messages were shunted when non-ASCII characters appeared in a mailing
823 list's description. Given by Mark Sapiro. (Closes: #215)
824 * Fix confirmation of unsubscription requests. (Closes: #294)
825 * Fix ``mailman stop`` not stopping some runners due to PEP 475 interaction.
827 * Update documentation links for ``config.cfg`` settings. (Closes: #306)
828 * Disallow problematic characters in listnames. (Closes: #311)
829 * Forward port several content filtering fixes from the 2.1 branch.
830 (Closes: #330, #331, #332 and #334)
834 * Mailing lists can now have their own header matching rules, although
835 site-defined rules still take precedence. Importing a Mailman 2.1 list
836 with header matching rules defined will create them in Mailman 3, albeit
837 with a few unsupported corner cases. Definition of new header matching
838 rules is not yet exposed through the REST API. Given by Aurélien Bompard.
839 * The default languages from Mailman 2.1 have been ported over. Given by
841 * There is now a configuration setting to limit the characters that can be
846 * ``mailman create <listname@dom.ain>`` will now create missing domains
847 by default. The ``-d``/``--domain`` option is kept for backward
848 compatibility, but now there is a ``-D``/``--no-domain`` option to prevent
849 missing domains from being create, forcing an error in those cases.
850 Given by Gurkirpal Singh. (Closes #39)
851 * ``mailman`` subcommands now properly commit any outstanding transactions.
853 * ``mailman digests`` has grown ``--verbose`` and ``-dry-run`` options.
854 * ``mailman shell`` now supports readline history if you set the
855 ``[shell]history_file`` variable in mailman.cfg. Also, many useful names
856 are pre-populated in the namespace of the shell. (Closes: #228)
860 * MySQL is now an officially supported database. Given by Abhilash Raj.
861 * Fix a problem with tracebacks when a PostgreSQL database is power cycled
862 while Mailman is still running. This ports an upstream SQLAlchemy fix to
863 Mailman in lieu of a future SQLAlchemy 1.2 release. (Closes: #313)
867 * Implement reasons for why a message is being held for moderator approval.
868 Given by Aurélien Bompard, tweaked by Barry Warsaw.
869 * The default ``postauth.txt`` and ``postheld.txt`` templates now no longer
870 include the inaccurate admindb and confirmation urls.
871 * Messages now include a ``Message-ID-Hash`` as the replacement for
872 ``X-Message-ID-Hash`` although the latter is still included for backward
873 compatibility. Also be sure that all places which add the header use the
874 same algorithm. (Closes #118)
875 * ``IMessageStore.delete_message()`` no longer raises a ``LookupError`` when
876 you attempt to delete a nonexistent message from the message store.
877 * ``ISubscriptionService.find_members()`` accepts asterisks as wildcards in
878 the ``subscriber`` argument string. Given by Aurélien Bompard.
879 * ``ISubscriptionService`` now supports mass unsubscribes. Given by Harshit
884 * New DMARC mitigations have been added. Given by Mark Sapiro. (Closes #247)
885 * New placeholders have been added for message headers and footers. You can
886 use a placeholder of the format ``$<archiver-name>_url`` to insert the
887 permalink to the message in the named archiver, for any archiver enabled
888 for the mailing list. Given by Abhilash Raj.
889 * The default posting chain has been modified so that the header-match chain
890 and nonmember-moderation rule are processed before "hold" rules are
891 processed. This allows for better anti-spam defenses and rejecting
892 non-member posts instead of always holding them for moderator review.
893 Given by Aurélien Bompard. (Closes #163)
894 * Bounces can now contain rejection messages. Given by Aurélien Bompard.
895 * The ``moderation_action`` for members and nonmember can now be ``None``
896 which signals falling back to the appropriate list default action,
897 e.g. ``default_member_action`` and ``default_nonmember_action``. Given by
898 Aurélien Bompard. (Closes #189)
899 * Ensure that postings from alternative emails aren't held for moderator
900 approval. For example, if a user is subscribed with one email but posts
901 with a second email that they control, the message should be processed as
902 a posting from a member. Given by Aditya Divekar. (Closes #222)
903 * The default message footer has been improved to include a way to
904 unsubscribe via the ``-leave`` address. Given by Francesco Ariis.
908 * REST API version 3.1 introduced. Mostly backward compatible with version
909 3.0 except that UUIDs are represented as hex strings instead of 128-bit
910 integers, since the latter are not compatible with all versions of
911 JavaScript. (Closes #121)
912 * REST clients must minimally support HTTP/1.1. (Closes #288)
913 * Experimental Gunicorn support. See ``contrib/gunicorn.py`` docstring for
914 details. With assistance from Eric Searcy. (Closes #287)
915 * The new template system is introduced for API 3.1. See
916 ``src/mailman/rest/docs/templates.rst`` for details. (Closes #249)
917 * When creating a user via REST using an address that already exists, but
918 isn't linked, the address is linked to the new user. Given by Aurélien
920 * The REST API incorrectly parsed ``is_server_owner`` values when given
921 explicitly in the POST that creates a user. (Closes #136)
922 * A new top-level resource ``<api>/owners`` can be used to get the list of
923 server owners as ``IUser`` s. (Closes #135)
924 * By POSTing to a user resource with an existing unlinked address, you can
925 link the address to the user. Given by Abhilash Raj.
926 * Fix pagination values ``start`` and ``total_size`` in the REST API. Given
927 by Aurélien Bompard. (Closes: #154)
928 * JSON representations for held message now include a ``self_link``.
929 * When ``[devmode]enabled`` is set, the JSON output is sorted. Given by
931 * A member's moderation action can be changed via the REST API. Given by
933 * Fixed a number of corner cases for the return codes when PUTing or PATCHing
934 list configuration variables. (Closes: #182)
935 * Expose ``digest_send_periodic``, ``digest_volume_frequency``, and
936 ``digests_enabled`` (renamed from ``digestable``) to the REST API.
938 * Expose the "bump digest" and "send digest" functionality though the REST
939 API via the ``<api>/lists/<list-id>/digest`` end-point. GETting this
940 resource returns the ``next_digest_number`` and ``volume`` as the same
941 values accessible through the list's configuraiton resource. POSTing to
942 the resource with either ``send=True``, ``bump=True``, or both invokes the
944 * Global and list-centric bans can now be managed through the REST API.
945 Given by Aurélien Bompard.
946 * ``<api>/members/find`` accepts GET query parameters in addition to POST
947 arguments. Given by Aurélien Bompard.
948 * Header match rules for individual mailing lists are now exposed in the REST
949 API. Given by Aurélien Bompard. (Closes: #192)
950 * Expose ``goodbye_message_uri`` in the REST API. Given by Harshit Bansal.
951 * New subscription requests are rejected if there is already one pending.
952 With thanks to Anirudh Dahiya. (Closes #199)
953 * Expose the system pipelines and chains via ``<api>/system/pipelines`` and
954 ``<api>/system/chains`` respectively. Given by Simon Hanna. (Closes #66)
955 * Support mass unsubscription of members via ``DELETE`` on the
956 ``<api>/lists/<list-id>/roster/member`` resource. Given by Harshit
957 Bansal. (Closes #171)
958 * It is now possible to merge users when creating them via REST. When you
959 POST to ``<api>/users/<address>/addresses`` and the address given in the
960 ``email`` parameter already exists, instead of getting a 400 error, if you
961 set ``absorb_existing=True`` in the POST data, the existing user will be
962 merged into the newly created on. Given by Aurélien Bompard.
963 * Port to Falcon 1.0 (Closes #20)
964 * A member's ``moderation_action`` can be reset, allowing fallback to the
965 list's ``default_member_action`` by setting the attribute to the empty
966 string in the REST API. Given by Aurélien Bompard.
967 * A list's ``moderator_password`` can be set via the REST API. Given by
968 Andrew Breksa. (Closes #207)
969 * The ban manager now returns a pageable, sorted sequence. Given by Amit and
970 Aurélien Bompard. (Closes #284)
971 * Query parameters now allow you to filter mailing lists by the
972 ``advertised`` boolean parameter. Given by Aurélien Bompard.
973 * Only the system-enabled archivers are returned in the REST API. Given by
975 * **Backward incompatibility: mild** Held message resources now have an
976 ``original_subject`` key which is the raw value of the ``Subject:`` header
977 (i.e. without any RFC 2047 decoding). The ``subject`` key is RFC 2047
978 decoded. Given by Simon Hanna. (Closes #219)
982 * Add official support for Python 3.5 and 3.6. (Closes #295)
983 * A handful of unused legacy exceptions have been removed. The redundant
984 ``MailmanException`` has been removed; use ``MailmanError`` everywhere.
985 * Drop the use of the ``lazr.smtptest`` library, which is based on the
986 asynchat/asyncore-based smtpd.py stdlib module. Instead, use the
987 asyncio-based `aiosmtpd <https://aiosmtpd.readthedocs.io/>`_ package.
988 * Improvements in importing Mailman 2.1 lists, given by Aurélien Bompard.
989 * The ``prototype`` archiver is not web accessible so it does not have a
990 ``list_url`` or permalink. Given by Aurélien Bompard.
991 * Large performance improvement in ``SubscriptionService.find_members()``.
992 Given by Aurélien Bompard.
993 * Rework the digest machinery, and add a new ``digests`` subcommand, which
994 can be used from the command line or cron to immediately send out any
995 partially collected digests, or bump the digest and volume numbers.
996 * The mailing list "data directory" has been renamed. Instead of using the
997 fqdn listname, the subdirectory inside ``[paths]list_data_dir`` now uses
999 * The ``mailman members`` command can now be used to display members based on
1000 subscription roles. Also, the positional "list" argument can now accept
1001 list names or list-ids.
1002 * Unsubscriptions can now be confirmed and/or moderated. (Closes #213)
1005 3.0.0 -- "Show Don't Tell"
1006 ==========================
1011 * Domains now have a list of owners, which are ``IUser`` objects, instead of
1012 the single ``contact_address`` they used to have. ``IUser`` objects now
1013 also have a ``is_server_owner`` flag (defaulting to False) to indicate
1014 whether they have superuser privileges. Give by Abhliash Raj, with fixes
1015 and refinements by Barry Warsaw. (LP: #1423756)
1016 * Mailing list subscription policy work flow has been completely rewritten.
1017 It now properly supports email verification and subscription confirmation
1018 by the user, and approval by the moderator using unique tokens.
1019 ``IMailingList`` objects now have a ``subscription_policy`` attribute.
1021 * Port the REST machinery to Falcon 0.3. (LP: #1446881)
1025 * Fix calculation of default configuration file to use when the ``$var_dir``
1026 is created by ``mailman start``. (LP: #1411435)
1027 * When creating a user with an email address, do not create the user record
1028 if the email address already exists. Given by Andrew Stuart.
1030 * When deleting a user via REST, make sure all linked addresses are deleted.
1031 Found by Andrew Stuart. (LP: #1419519)
1032 * When trying to subscribe an address to a mailing list through the REST API
1033 where a case-differing version of the address is already subscribed, return
1034 a 409 error instead of a 500 error. Found by Ankush Sharma. (LP: #1425359)
1035 * ``mailman lists --domain`` was not properly handling its arguments. Given
1036 by Manish Gill. (LP: #1166911)
1037 * When deleting a user object, make sure their preferences are also deleted.
1038 Given by Abhishek. (LP: #1418276)
1039 * Be sure a mailing list's acceptable aliases are deleted when the mailing
1040 list itself is deleted. (LP: #1432239)
1041 * The built-in example ``IArchiver`` implementations now explicitly return
1042 None. (LP: #1203359)
1043 * The test suite now runs successfully again with PostgreSQL. Given by
1044 Aurélien Bompard. (LP: #1435941)
1048 * When specifying a file system path in the [paths.*] section, $cfg_file can
1049 be used to expand into the path of the ``-C`` option if given. In the
1050 default ``[paths.dev]`` section, ``$var_dir`` is now specified relative to
1051 ``$cfg_file`` so that it won't accidentally be relative to the current
1052 working directory, if ``-C`` is given.
1053 * ``$cwd`` is now an additional substitution variable for the ``mailman.cfg``
1054 file's ``[paths.*]`` sections. A new ``[paths.here]`` section is added,
1055 which puts the ``var_dir`` in ``$cwd``. It is made the default layout.
1059 * Improve the documentation describing how to run Alembic to add new schema
1060 migrations. Given by Abhilash Raj.
1064 * **Backward incompatible change**: The JSON representation for pending
1065 mailing list subscription hold now no longer includes the ``password``
1066 key. Also, the ``address`` key has been renamed ``email`` for consistent
1067 terminology and other usage.
1068 * You can now view the contents of, inject messages into, and delete messages
1069 from the various queue directories via the ``<api>/queues`` resource.
1070 * You can now DELETE an address. If the address is linked to a user, the
1071 user is not delete, it is just unlinked.
1072 * A new API is provided to support non-production testing infrastructures,
1073 allowing a client to cull all orphaned UIDs via ``DELETE`` on
1074 ``<api>/reserved/uids/orphans``. Note that *no guarantees* of API
1075 stability will ever be made for resources under ``reserved``.
1077 * Domains can now optionally be created with owners; domain owners can be
1078 added after the fact; domain owners can be deleted. Also, users now have
1079 an ``is_server_owner`` flag as part of their representation, which defaults
1080 to False, and can be PUT and PATCH'd. Given by Abhilash Raj, with fixes
1081 and refinements by Barry Warsaw. (LP: #1423756)
1084 3.0 beta 5 -- "Carve Away The Stone"
1085 ====================================
1090 * Fixed Unicode errors in the digest runner and when sending messages to the
1091 site owner as a fallback. Given by Aurélien Bompard. (LP: #1130957).
1092 * Fixed Unicode errors when a message being added to the digest has non-ascii
1093 characters in its payload, but no Content-Type header defining a charset.
1094 Given by Aurélien Bompard. (LP: #1170347)
1095 * Fixed messages without a `text/plain` part crashing the `Approved` rule.
1096 Given by Aurélien Bompard. (LP: #1158721)
1097 * Fixed getting non-ASCII filenames from RFC 2231 i18n'd messages. Given by
1098 Aurélien Bompard. (LP: #1060951)
1099 * Fixed `AttributeError` on MIME digest messages. Given by Aurélien Bompard.
1104 * The `mailman conf` command no longer takes the `-t/--sort` option; the
1105 output is always sorted.
1109 * The ``[database]migrations_path`` setting is removed.
1113 * The ORM layer, previously implemented with Storm, has been replaced by
1114 SQLAlchemy, thanks to the fantastic work by Abhilash Raj and Aurélien
1115 Bompard. Alembic is now used for all database schema migrations.
1116 * The new logger `mailman.database` logs any errors at the database layer.
1120 * Python 3.4 is now the minimum requirement.
1121 * You no longer have to create a virtual environment separately when running
1122 the test suite. Just use `tox`.
1123 * You no longer have to edit `src/mailman/testing/testing.cfg` to run the
1124 test suite against PostgreSQL. See `src/mailman/docs/START.rst` for
1129 * The RFC 2369 headers added to outgoing messages are now added in sorted
1131 * Several changes to the internal API:
1133 - `IListManager.mailing_lists` is guaranteed to be sorted in List-ID order.
1134 - `IDomains.mailing_lists` is guaranteed to be sorted in List-ID order.
1135 - Iteration over domains via the `IDomainManager` is guaranteed to be sorted
1136 by `IDomain.mail_host` order.
1137 - `ITemporaryDatabase` interface and all implementations are removed.
1141 * The Falcon Framework has replaced restish as the REST layer. This is an
1142 internal change only.
1143 * The JSON representation `http_etag` key uses an algorithm that is
1144 insensitive to Python's dictionary sort order.
1145 * The address resource now has an additional '/user' sub-resource which can
1146 be used to GET the address's linked user if there is one. This
1147 sub-resource also supports POST to link an unlinked address (with an
1148 optional 'auto_create' flag), and PUT to link the address to a different
1149 user. It also supports DELETE to unlink the address. (LP: #1312884)
1150 Given by Aurélien Bompard based on work by Nicolas Karageuzian.
1151 * The ``/3.0/system`` path is deprecated; use ``/3.0/system/versions`` to get
1152 the system version information.
1153 * You can access the system configuration via the resource path
1154 ``/3.0/system/configuration/<section>``. This returns a dictionary with
1155 the keys being the section's variables and the values being their value
1156 from ``mailman.cfg`` as verbatim strings. You can get a list of all
1157 section names via ``/3.0/system/configuration`` which returns a dictionary
1158 containing the ``http_etag`` and the section names as a sorted list under
1159 the ``sections`` key. The system configuration resource is read-only.
1160 * Member resource JSON now include the ``member_id`` as a separate key.
1163 3.0 beta 4 -- "Time and Motion"
1164 ===============================
1169 * Mailman 3 no longer uses ``zc.buildout`` and tests are now run by the
1170 ``nose2`` test runner. See ``src/mailman/docs/START.rst`` for details on
1171 how to build Mailman and run the test suite. Also, use ``-P`` to select a
1172 test pattern and ``-E`` to enable stderr debugging in runners.
1173 * Use the ``enum34`` package instead of ``flufl.enum``.
1174 * Use ``setuptools`` instead of ``distribute``, since the latter is defunct.
1178 * Add ``reply_to_address`` and ``first_strip_reply_to`` as writable
1179 attributes of a mailing list's configuration. (LP: #1157881)
1180 * Support pagination of some large collections (lists, users, members).
1181 [Florian Fuchs] (LP: #1156529)
1182 * Expose ``hide_address`` to the ``.../preferences`` REST API.
1183 [Sneha Priscilla.] (LP: #1203519)
1184 * Mailing lists can now individually enable or disable any archiver available
1185 site-wide. [Joanna Skrzeszewska] (LP: #1158040)
1186 * Addresses can be added to existing users, including display names, via the
1187 REST API. [Florian Fuchs]
1188 * Fixed a crash in the REST server when searching for nonmembers via
1189 ``/find`` which we've never seen before, because those members only have an
1190 address record, not a user record. This requires a small change in the API
1191 where the JSON response's ``address`` key now contains the URL to the
1192 address resource, the new ``email`` key contains the email address as a
1193 string, and the ``user`` key is optional.
1197 * `mailman conf` now has a `-t/--sort` flag which sorts the output by section
1198 and then key. [Karl-Aksel Puulmann and David Soto] (LP: 1162492)
1199 * Greatly improve the fidelity of the Mailman 2.1 list importer functionality
1200 (i.e. ``mailman import21``). [Aurélien Bompard].
1204 * Add support for the Exim 4 MTA. [Stephen Turnbull]
1205 * When creating the initial file system layout in ``var``, e.g. via
1206 ``bin/mailman info``, add an ``var/etc/mailman.cfg`` file if one does not
1207 already exist. Also, when initializing the system, look for that file as
1208 the configuration file, just after ``./mailman.cfg`` and before
1209 ``~/.mailman.cfg``. (LP: #1157861)
1213 * The `bounceevent` table now uses list-ids to cross-reference the mailing
1214 list, to match other tables. Similarly for the `IBounceEvent` interface.
1215 * Added a `listarchiver` table to support list-specific archivers.
1219 * Non-queue runners should not create ``var/queue`` subdirectories.
1220 [Sandesh Kumar Agrawal] (LP: #1095422)
1221 * Creation of lists with upper case names should be coerced to lower case.
1223 * Fix REST server crash on `mailman reopen` due to no interception of
1224 signals. (LP: #1184376)
1225 * Add `subject_prefix` to the `IMailingList` interface, and clarify the
1226 docstring for `display_name`. (LP: #1181498)
1227 * Fix importation from MM2.1 to MM3 of the archive policy.
1228 [Aurélien Bompard] (LP: #1227658)
1229 * Fix non-member moderation rule to prefer a member sender if both members
1230 and non-members are in the message's sender list. [Aurélien Bompard]
1232 * Fix IntegrityError (against PostgreSQL) when deleting a list with content
1233 filters. [Aurélien Bompard] (LP: #1117174)
1234 * Fix test isolation bug in ``languages.rst``.
1235 [Piotr Kasprzyk] (LP: #1308769)
1238 3.0 beta 3 -- "Here Again"
1239 ==========================
1244 * Python 2.7 is now required. Python 2.6 is no longer officially supported.
1245 The code base is now also `python2.7 -3` clean, although there are still
1246 some warnings in 3rd party dependencies. (LP: #1073506)
1250 * **API change**: The JSON representation for held messages no longer
1251 includes the `data` key. The values in this dictionary are flatted into
1252 the top-level JSON representation. The `key` key is remove since it's
1253 redundant. Use `message_id` for held messages, and `address` for held
1254 subscriptions/unsubscriptions. The following `_mod_*` keys are inserted
1255 without the `_mod_` prefix:
1257 - `_mod_subject` -> `subject`
1258 - `_mod_hold_date` -> `hold_date`
1259 - `_mod_reason` -> `reason`
1260 - `_mod_sender` -> `sender`
1261 - `_mod_message_id` -> `message_id`
1263 * List styles are supported through the REST API. Get the list of available
1264 styles (by name) via `.../lists/styles`. Create a list in a specific style
1265 by using POST data `style_name=<style>`. (LP: #975692)
1266 * Allow the getting/setting of IMailingList.subject_prefix via the REST API
1267 (given by Terri Oda). (LP: #1062893)
1268 * Expose a REST API for membership change (subscriptions and unsubscriptions)
1269 moderation. (LP: #1090753)
1270 * Add list_id to JSON representation for a mailing list (given by Jimmy
1272 * The canonical resource for a mailing list (and thus its self_link) is now
1273 the URL with the list-id. To reference a mailing list, the list-id url is
1274 preferred, but for backward compatibility, the posting address is still
1276 * You can now PUT and PATCH on user resources to change the user's display
1277 name or password. For passwords, you pass in the clear text password and
1278 Mailman will hash it before storing.
1279 * You can now verify and unverify an email address through the REST API.
1280 POST to .../addresses/<email>/verify and .../addresses/<email>/unverify
1281 respectively. The POST data is ignored. It is not an error to verify or
1282 unverify an address more than once, but verifying an already verified
1283 address does not change its `.verified_on` date. (LP: #1054730)
1284 * Deleting a user through the REST API also deletes all the user's linked
1285 addresses and memberships. (LP: #1074374)
1286 * A user's password can be verified by POSTing to .../user/<id>/login. The
1287 data must contain a single parameter `cleartext_password` and if this
1288 matches, a 204 (No Content) will be returned, otherwise a 403 (Forbidden)
1289 is returned. (LP: #1065447)
1293 * `[passlib]path` configuration variable renamed to `[passlib]configuration`.
1294 * Postfix-specific configurations in the `[mta]` section are moved to a
1295 separate file, named by the `[mta]configuration` variable.
1296 * In the new `postfix.cfg` file, `postfix_map_cmd` is renamed to
1298 * The default list style is renamed to `legacy-default` and a new
1299 `legacy-announce` style is added. This is similar to the `legacy-default`
1300 except set up for announce-only lists.
1304 * The `ban` table now uses list-ids to cross-reference the mailing list,
1305 since these cannot change even if the mailing list is moved or renamed.
1306 * The following columns were unused and have been removed:
1308 - `mailinglist.new_member_options`
1309 - `mailinglist.send_reminders`
1310 - `mailinglist.subscribe_policy`
1311 - `mailinglist.unsubscribe_policy`
1312 - `mailinglist.subscribe_auto_approval`
1313 - `mailinglist.private_roster`
1314 - `mailinglist.admin_member_chunksize`
1318 * The `IBanManager` is no longer a global utility. Instead, you adapt an
1319 `IMailingList` to an `IBanManager` to manage the bans for a specific
1320 mailing list. To manage the global bans, adapt ``None``.
1324 * `bin/mailman aliases` loses the `--output`, `--format`, and `--simple`
1325 arguments, and adds a `--directory` argument. This is necessary to support
1326 the Postfix `relay_domains` support.
1327 * `bin/mailman start` was passing the wrong relative path to its runner
1328 subprocesses when -C was given. (LP: #982551)
1329 * `bin/runner` command has been simplified and its command line options
1330 reduced. Now, only one `-r/--runner` option may be provided and the
1331 round-robin feature has been removed.
1335 * Added support for Postfix `relay_domains` setting for better virtual domain
1336 support. [Jimmy Bergman].
1337 * Two new events are triggered on membership changes: `SubscriptionEvent`
1338 when a new member joins a mailing list, and an `UnsubscriptionEvent` when a
1339 member leaves a mailing list. (LP: #1047286)
1340 * Improve the --help text for the `start`, `stop`, `restart`, and `reopen`
1341 subcommands. (LP: #1035033)
1345 * Fixed `send_goodbye_message()`. (LP: #1091321)
1346 * Fixed REST server crash on `reopen` command. Identification and test
1347 provided by Aurélien Bompard. (LP: #1184376)
1350 3.0 beta 2 -- "Freeze"
1351 ======================
1356 * The link between members and the mailing lists they are subscribed to, is
1357 now via the RFC 2369 `list_id` instead of the fqdn listname (i.e. posting
1358 address). This is because while the posting address can change if the
1359 mailing list is moved to a new server, the list id is fixed.
1362 - IListManager.get_by_list_id() added.
1363 - IListManager.list_ids added.
1364 - IMailingList.list_id added.
1365 - Several internal APIs that accepted fqdn list names now require list ids,
1366 e.g. ISubscriptionService.join() and .find_members().
1367 - IMember.list_id attribute added; .mailing_list is now an alias that
1368 retrieves and returns the IMailingList.
1370 * `passlib`_ is now used for all password hashing instead of flufl.password.
1371 The default hash is `sha512_crypt`. (LP: #1015758)
1372 * Internally, all datetimes are kept in the UTC timezone, however because of
1373 LP: #280708, they are stored in the database in naive format.
1374 * `received_time` is now added to the message metadata by the LMTP runner
1375 instead of by `Switchboard.enqueue()`. This latter no longer depends on
1376 `received_time` in the metadata.
1377 * The `ArchiveRunner` no longer acquires a lock before it calls the
1378 individual archiver implementations, since not all of them need a lock. If
1379 they do, the implementations must acquire said lock themselves.
1380 * The `news` runner and queue has been renamed to the more accurate `nntp`.
1381 The runner has also been ported to Mailman 3 (LP: #967409). Beta testers
1382 can safely remove `$var_dir/queue/news`.
1383 * A mailing list's *moderator password* is no longer stored in the clear; it
1384 is hashed with the currently selected scheme.
1385 * An `AddressVerificationEvent` is triggered when an `IAddress` is verified
1386 or unverified. (LP: #975698)
1387 * A `PasswordChangeEvent` is triggered when an `IUser`'s password changes.
1389 * When a queue runner gets an exception in its _dispose() method, a
1390 `RunnerCrashEvent` is triggered, which contains references to the queue
1391 runner, mailing list, message, metadata, and exception. Interested parties
1392 can subscribe to that `zope.event` for notification.
1393 * Events renamed and moved:
1394 * `mailman.chains.accept.AcceptNotification`
1395 * `mailman.chains.base.ChainNotification`
1396 * `mailman.chains.discard.DiscardNotification`
1397 * `mailman.chains.hold.HoldNotification`
1398 * `mailman.chains.owner.OwnerNotification`
1399 * `mailman.chains.reject.RejectNotification`
1400 changed to (respectively):
1401 * `mailman.interfaces.chains.AcceptEvent`
1402 * `mailman.interfaces.chains.ChainEvent`
1403 * `mailman.interfaces.chains.DiscardEvent`
1404 * `mailman.interfaces.chains.HoldEvent`
1405 * `mailman.interfaces.chains.AcceptOwnerEvent`
1406 * `mailman.interfaces.chains.RejectEvent`
1407 * A `ConfigurationUpdatedEvent` is triggered when the system-wide global
1408 configuration stack is pushed or popped.
1409 * The policy for archiving has now been collapsed into a single enum, called
1410 ArchivePolicy. This describes the three states of never archive, archive
1411 privately, and archive_publicly. (LP: #967238)
1415 * Schema migrations (LP: #971013)
1417 - mailinglist.include_list_post_header -> allow_list_posts
1418 - mailinglist.news_prefix_subject_too -> nntp_prefix_subject_too
1419 - mailinglist.news_moderation -> newsgroup_moderation
1420 - mailinglist.archive and mailinglist.archive_private have been collapsed
1421 into archive_policy.
1422 - mailinglist.nntp_host has been removed.
1423 - mailinglist.generic_nonmember_action has been removed (LP: #975696)
1425 * Schema migrations (LP: #1024509)
1426 - member.mailing_list -> list_id
1427 * The PostgreSQL port of the schema accidentally added a moderation_callback
1428 column to the mailinglist table. Since this is unused in Mailman, it was
1429 simply commented out of the base schema for PostgreSQL.
1433 * Expose `archive_policy` in the REST API. Contributed by Alexander
1434 Sulfrian. (LP: #1039129)
1438 * New configuration variables `clobber_date` and `clobber_skew` supported in
1439 every `[archiver.<name>]` section. These are used to determine under what
1440 circumstances a message destined for a specific archiver should have its
1441 `Date:` header clobbered. (LP: #963612)
1442 * With the switch to `passlib`_, `[passwords]password_scheme` has been
1443 removed. Instead use `[passwords]path` to specify where to find the
1444 `passlib.cfg` file. See the comments in `schema.cfg` for details.
1445 * Configuration schema variable changes:
1446 * [nntp]username -> [nntp]user
1447 * [nntp]port (added)
1448 * Header check specifications in the `mailman.cfg` file have changed quite
1449 bit. The previous `[spam.header.foo]` sections have been removed.
1450 Instead, there's a new `[antispam]` section that contains a `header_checks`
1451 variable. This variable takes multiple lines of `Header: regexp` values,
1452 one per line. There is also a new `jump_chain` variable which names the
1453 chain to jump to should any of the header checks (including the
1454 list-specific, and programmatically added ones) match.
1458 * Some additional documentation on related components such as Postorius and
1459 hyperkitty have been added, given by Stephen J Turnbull.
1463 * Fixed the RFC 1153 digest footer to be compliant. (LP: #887610)
1464 * Fixed a UnicodeError with non-ascii message bodies in the `approved` rule,
1465 given by Mark Sapiro. (LP: #949924)
1466 * Fixed a typo when returning the configuration file's header match checks.
1468 * List-Post should be NO when posting is not allowed. (LP: #987563)
1469 * Non-unicode values in msgdata broke pending requests. (LP: #1031391)
1470 * Show devmode in `bin/mailman info` output. (LP: #1035028)
1471 * Fix residual references to the old `IMailingList` archive variables.
1474 .. _`passlib`: https://passlib.readthedocs.io/en/stable/index.html
1477 3.0 beta 1 -- "The Twilight Zone"
1478 =================================
1483 * Schema migrations have been implemented.
1484 * Implement the style manager as a utility instead of an attribute hanging
1485 off the `mailman.config.config` object.
1486 * PostgreSQL support contributed by Stephen A. Goss. (LP: #860159)
1487 * Separate out the RFC 2369 header adding handler.
1488 * Dynamically calculate the `List-Id` header instead of storing it in the
1489 database. This means it cannot be changed.
1490 * Major redesign of the template search system, fixing LP: #788309. $var_dir
1491 is now used when search for all template overrides, site, domain, or
1492 mailing list. The in-tree English templates are used only as a last
1494 * Support downloading templates by URI, including mailman:// URIs. This is
1495 used in welcome and goodbye messages, as well as regular and digest headers
1496 and footers, and supports both language and mailing list specifications.
1497 E.g. mailman:///test@example.com/it/welcome.txt
1498 * $user_password is no longer supported as a placeholder in headers and
1500 * Mailing lists get multiple chains and pipelines. For example, normal
1501 postings go through the `posting_chain` while messages to owners to through
1502 `owners_chain`. The default `built-in` chain is renamed to
1503 `default-posting-chain` while the `built-in` pipeline is renamed
1504 `default-posting-pipeline`.
1505 * The experimental `maildir` runner is removed. Use LMTP.
1506 * The LMTP server now requires that the incoming message have a `Message-ID`,
1507 otherwise it rejects the message with a 550 error. Also, the LMTP server
1508 adds the `X-Message-ID-Hash` header automatically. The `inject` cli
1509 command will also add the `X-Message-ID-Hash` header, but it will craft a
1510 `Message-ID` header first if one is missing from the injected text. Also,
1511 `inject` will always set the correct value for the `original_size`
1512 attribute on the message object, instead of trusting a possibly incorrect
1513 value if it's already set. The individual `IArchiver` implementations no
1514 longer set the `X-Message-ID-Hash` header.
1515 * The Prototype archiver now stores its files in maildir format inside of
1516 `$var_dir/archives/prototype`, given by Toshio Kuratomi.
1517 * Improved "8 mile high" document distilled by Stephen J Turnbull from the
1518 Pycon 2012 Mailman 3 sprint. Also improvements to the Sphinx build given
1519 by Andrea Crotti (LP: #954718).
1520 * Pipermail has been eradicated.
1521 * Configuration variable `[mailman]filtered_messages_are_preservable`
1522 controls whether messages which have their top-level `Content-Type`
1523 filtered out can be preserved in the `bad` queue by list owners.
1524 * Configuration section `[scrubber]` removed, as is the scrubber handler.
1525 This handler was essentially incompatible with Mailman 3 since it required
1526 coordination with Pipermail to store attachments on disk.
1531 - welcome_msg -> welcome_message_uri
1532 - goodbye_msg -> goodbye_message_uri
1533 - send_welcome_msg -> send_welcome_message
1534 - send_goodbye_msg -> send_goodbye_message
1535 - msg_header -> header_uri
1536 - msg_footer -> footer_uri
1537 - digest_header -> digest_header_uri
1538 - digest_footer -> digest_footer_uri
1539 - start_chain -> posting_chain
1540 - pipeline -> posting_pipeline
1541 - real_name -> display_name (mailinglist, user, address)
1543 - mailinglist.filter_action
1544 - mailinglist.owner_chain
1545 - mailinglist.owner_pipeline
1549 * Held messages can now be moderated through the REST API. Mailing list
1550 resources now accept a `held` path component. GETing this returns all held
1551 messages for the mailing list. POSTing to a specific request id under this
1552 url can dispose of the message using `Action` enums.
1553 * Mailing list resources now have a `member_count` attribute which gives the
1554 number of subscribed members. Given by Toshio Kuratomi.
1558 * Add property `IUserManager.members` to return all `IMembers` in the system.
1559 * Add property `IListmanager.name_components` which returns 2-tuples for
1560 every mailing list as (list_name, mail_host).
1561 * Remove previously deprecated `IListManager.get_mailing_lists()`.
1562 * `IMailTransportAgentAliases` now explicitly accepts duck-typed arguments.
1563 * `IRequests` interface is removed. Now just use adaptation from
1564 `IListRequests` directly (which takes an `IMailingList` object).
1565 * `handle_message()` now allows for `Action.hold` which is synonymous with
1566 `Action.defer` (since the message is already being held).
1567 * `IListRequests.get_request()` now takes an optional `request_type`
1568 argument to narrow the search for the given request.
1569 * New `ITemplateLoader` utility.
1570 * `ILanguageManager.add()` returns the `ILanguage` object just created.
1571 * `IMailinglist.decorators` removed; it was unused
1572 * `IMailingList.real_name` -> `IMailingList.display_name`
1573 * `IUser.real_name` -> `IUser.display_name`
1574 * `IAddress.real_name` -> `IAddress.display_name`
1575 * Add property `IRoster.member_count`.
1579 * IPython support in `bin/mailman shell` contributed by Andrea Crotti.
1581 * The `mailman.cfg` configuration file will now automatically be detected if
1582 it exists in an `etc` directory which is a sibling of argv0.
1583 * `bin/mailman shell` is an alias for `withlist`.
1584 * The `confirm` email command now properly handles `Re:`-like prefixes, even
1585 if they contain non-ASCII characters. (LP: #685261)
1586 * The `join` email command no longer accepts an `address=` argument. Its
1587 `digest=` argument now accepts the following values: `no` (for regular
1588 delivery), `mime`, or `plain`.
1589 * Added a `help` email command.
1590 * A welcome message is sent when the user confirms their subscription via
1592 * Global ``-C`` option now accepts an absolute path to the configuration
1593 file. Given by Andrea Crotti. (LP: #953707)
1597 * Subscription disabled probe warning notification messages are now sent
1598 without a `Precedence:` header. Given by Mark Sapiro. (LP: #808821)
1599 * Fixed KeyError in retry runner, contributed by Stephen A. Goss.
1601 * Fixed bogus use of `bounce_processing` attribute (should have been
1602 `process_bounces`, with thanks to Vincent Fretin. (LP: #876774)
1603 * Fix `test_moderation` for timezones east of UTC+0000, given by blacktav.
1607 3.0 alpha 8 -- "Where's My Thing?"
1608 ==================================
1613 * Factor out bounce detection to `flufl.bounce`.
1614 * Unrecognized bounces can now also be forwarded to the site owner.
1615 * mailman.qrunner log is renamed to mailman.runner
1616 * master-qrunner.lck -> master.lck
1617 * master-qrunner.pid -> master.pid
1618 * Four new events are created, and notifications are sent during mailing list
1620 - ListCreatingEvent - sent before the mailing list is created
1621 - ListCreatedEvent - sent after the mailing list is created
1622 - ListDeletingEvent - sent before the mailing list is deleted
1623 - ListDeletedEvent - sent after the mailing list is deleted
1624 * Four new events are created, and notifications are sent during domain
1626 - DomainCreatingEvent - sent before the domain is created
1627 - DomainCreatedEvent - sent after the domain is created
1628 - DomainDeletingEvent - sent before the domain is deleted
1629 - DomainDeletedEvent - sent after the domain is deleted
1630 * Using the above events, when a domain is deleted, associated mailing lists
1631 are deleted. (LP: #837526)
1632 * IDomain.email_host -> .mail_host (LP: #831660)
1633 * User and Member ids are now proper UUIDs.
1634 * Improved the way enums are stored in the database, so that they are more
1635 explicitly expressed in the code, and more database efficient.
1639 * Preferences for addresses, users, and members can be accessed, changed, and
1640 deleted through the REST interface. Hierarchical, combined preferences for
1641 members, and system preferences can be read through the REST interface.
1643 * The IMailingList attribute ``host_name`` has been renamed to ``mail_host``
1644 for consistency. This changes the REST API for mailing list
1645 resources. (LP: #787599)
1646 * New REST resource http://.../members/find can be POSTed to in order to find
1647 member records. Optional arguments are `subscriber` (email address to
1648 search for), `fqdn_listname`, and `role` (i.e. MemberRole). (LP: #799612)
1649 * You can now query or change a member's `delivery_mode` attribute through
1650 the REST API (LP: #833132). Given by Stephen A. Goss.
1651 * New REST resource http://.../<domain>/lists can be GETed in order to find
1652 all the mailing lists in a specific domain (LP: #829765). Given by
1654 * Fixed /lists/<fqdn_listname>/<role>/<email> (LP: #825570)
1655 * Remove role plurals from /lists/<fqdn_listname/rosters/<role>
1656 * Fixed incorrect error code for /members/<bogus> (LP: #821020). Given by
1658 * DELETE users via the REST API. (LP: #820660)
1659 * Moderators and owners can be added via REST (LP: #834130). Given by
1661 * Getting the roster or configuration of a nonexistent list did not give a
1662 404 error (LP: #837676). Given by Stephen A. Goss.
1663 * PATCHing an invalid attribute on a member did not give a 400 error
1664 (LP: #833376). Given by Stephen A. Goss.
1665 * Getting the memberships for a non-existent address did not give a 404 error
1666 (LP: #848103). Given by Stephen A. Goss.
1670 * `bin/qrunner` is renamed to `bin/runner`.
1671 * `bin/mailman aliases` gains `-f` and `-s` options.
1672 * `bin/mailman create` no longer allows a list to be created with bogus owner
1673 addresses. (LP: #778687)
1674 * `bin/mailman start --force` option is fixed. (LP: #869317)
1678 * Update the COPYING file to contain the GPLv3. (LP: #790994)
1679 * Major terminology change: ban the terms "queue runners" and "qrunners" since
1680 not all runners manage queue directories. Just call them "runners". Also,
1681 the master is now just called "the master runner".
1685 * New configuration variable in [devmode] section, called `wait` which sets
1686 the timeout value used in the test suite for starting up subprocesses.
1687 * Handle SIGTERM in the REST server so that the test suite always shuts down
1688 correctly. (LP: #770328)
1690 Other bugs and changes
1691 ----------------------
1692 * Moderating a message with Action.accept now sends the message. (LP: #827697)
1693 * Fix AttributeError triggered by i18n call in autorespond_to_sender()
1695 * Local timezone in X-Mailman-Approved-At caused test failure. (LP: #832404)
1696 * InvalidEmailAddressError no longer repr()'s its value.
1697 * Rewrote a test for compatibility between Python 2.6 and 2.7. (LP: #833208)
1698 * Fixed Postfix alias file generation when more than one mailing list
1699 exists. (LP: #874929). Given by Vincent Fretin.
1702 3.0 alpha 7 -- "Mission"
1703 ========================
1708 * Significant updates to the subscription model. Members can now subscribe
1709 with a preferred address, and changes to that will be immediately reflected
1710 in mailing list subscriptions. Users who subscribe with an explicit
1711 address can easily change to a different address, as long as that address
1712 is verified. (LP: #643949)
1713 * IUsers and IMembers are now assigned a unique, random, immutable id.
1714 * IUsers now have created_on and .preferred_address properties.
1715 * IMembers now have a .user attribute for easy access to the subscribed user.
1716 * When created with add_member(), passwords are always stored encrypted.
1717 * In all interfaces, "email" refers to the textual email address while
1718 "address" refers to the `IAddress` object.
1719 * mailman.chains.base.Chain no longer self registers.
1720 * New member and nonmember moderation rules and chains. This effectively
1721 ports moderation rules from Mailman 2 and replaces attributes such as
1722 member_moderation_action, default_member_moderation, and
1723 generic_nonmember_action. Now, nonmembers exist as subscriptions on a
1724 mailing list and members have a moderation_action attribute which describes
1725 the disposition for postings from that address.
1726 * Member.is_moderated was removed because of the above change.
1727 * default_member_action and default_nonmember_action were added to mailing
1729 * All sender addresses are registered (unverified) with the user manager by
1730 the incoming queue runner. This way, nonmember moderation rules will
1731 always have an IAddress that they can subscribe to the list (as
1732 MemberRole.nonmember).
1733 * Support for SMTP AUTH added via smtp_user and smtp_pass configuration
1734 variables in the [mta] section. (LP: #490044)
1735 * IEmailValidator interface for pluggable validation of email addresses.
1736 * .subscribe() is moved from the IAddress to the IMailingList
1737 * IAddresses get their registered_on attribute set when the object is created.
1741 * [devmode] section gets a new 'testing' variable.
1742 * Added password_scheme and password_length settings for defining the
1743 default password encryption scheme.
1744 * creator_pw_file and site_pw_file are removed.
1748 * 'bin/mailman start' does a better job of producing an error when Mailman is
1750 * 'bin/mailman status' added for providing command line status on the master
1751 queue runner watcher process.
1752 * 'bin/mailman info' now prints the REST root url and credentials.
1753 * mmsitepass removed; there is no more site password.
1757 * Add Basic Auth support for REST API security. (Jimmy Bergman)
1758 * Include the fqdn_listname and email address in the member JSON
1760 * Added reply_goes_to_list, send_welcome_msg, welcome_msg,
1761 default_member_moderation to the mailing list's writable attributes in the
1762 REST service. (Jimmy Bergman)
1763 * Expose the new membership model to the REST API. Canonical member resource
1764 URLs are now much shorter and live in their own top-level namespace instead
1765 of within the mailing list's namespace.
1766 * /addresses/<email>/memberships gets all the memberships for a given email
1768 * /users is a new top-level URL under which user information can be
1769 accessed. Posting to this creates new users.
1770 * Users can subscribe to mailing lists through the REST API.
1771 * Domains can be deleted via the REST API.
1772 * PUT and PATCH to a list configuration now returns a 204 (No Content).
1776 * Support Python 2.7. (LP: #667472)
1777 * Disable site-packages in buildout.cfg because of LP: #659231.
1778 * Don't include eggs/ or parts/ in the source tarball. (LP: #656946)
1779 * flufl.lock is now required instead of locknix.
1783 * Typo in scan_message(). (LP: #645897)
1784 * Typo in add_member(). (LP: #710182) (Florian Fuchs)
1785 * Re-enable bounce detectors. (LP: #756943)
1786 * Clean up many pyflakes problems; ditching pylint.
1789 3.0 alpha 6 -- "Cut to the Chase"
1790 =================================
1795 * The functionality of 'bin/list_members' has been moved to
1796 'bin/mailman members'.
1797 * 'bin/mailman info' -v/--verbose output displays the file system
1798 layout paths Mailman is currently configured to use.
1802 * You can now configure the paths Mailman uses for queue files, lock files,
1803 data files, etc. via the configuration file. Define a file system 'layout'
1804 and then select that layout in the [mailman] section. Default layouts
1805 include 'local' for putting everything in /var/tmp/mailman, 'dev' for local
1806 development, and 'fhs' for Filesystem Hierarchy Standard 2.3 (LP #490144).
1807 * Queue file directories now live in $var_dir/queues.
1811 * lazr.restful has been replaced by restish as the REST publishing technology
1813 * New REST API for getting all the members of a roster for a specific mailing
1815 * New REST API for getting and setting a mailing list's configuration. GET
1816 and PUT are supported to retrieve the current configuration, and set all
1817 the list's writable attributes in one request. PATCH is supported to
1818 partially update a mailing list's configuration. Individual options can be
1819 set and retrieved by using subpaths.
1820 * Subscribing an already subscribed member via REST now returns a 409 HTTP
1822 * Fixed a bug when deleting a list via the REST API. LP: #601899
1826 * X-BeenThere header is removed.
1827 * Mailman no longer touches the Sender or Errors-To headers.
1828 * Chain actions can now fire Zope events in their _process()
1830 * Environment variable $MAILMAN_VAR_DIR can be used to control the var/
1831 directory for Mailman's runtime files. New environment variable
1832 $MAILMAN_UNDER_MASTER_CONTROL is used instead of the qrunner's --subproc/-s
1837 * Allow X-Approved and X-Approve headers, equivalent to Approved and
1838 Approve. LP: #557750
1839 * Various test failure fixes. LP: #543618, LP: #544477
1840 * List-Post header is retained in MIME digest messages. LP: #526143
1841 * Importing from a Mailman 2.1.x list is partially supported.
1844 3.0 alpha 5 -- "Distant Early Warning"
1845 ======================================
1850 * Add REST API for subscription services. You can now:
1852 - list all members in all mailing lists
1853 - subscribe (and possibly register) an address to a mailing list
1854 - unsubscribe an address from mailing list
1858 * 'bin/dumpdb' is now 'bin/mailman qfile'
1859 * 'bin/unshunt' is now 'bin/mailman unshunt'
1860 * Mailman now properly handles the '-join', '-leave', and '-confirm' email
1861 commands and sub-addresses. '-subscribe' and '-unsubscribe' are aliases
1862 for '-join' and '-leave' respectively.
1866 * devmode settings now live in their own [devmode] section.
1867 * Mailman now searches for a configuration file using this search order. The
1868 first file that exists is used.
1870 - -C config command line argument
1871 - $MAILMAN_CONFIG_FILE environment variable
1877 3.0 alpha 4 -- "Vital Signs"
1878 ============================
1883 * 'bin/inject' is now 'bin/mailman inject', with some changes
1884 * 'bin/mailmanctl' is now 'bin/mailman start|stop|reopen|restart'
1885 * 'bin/mailman version' is added (output same as 'bin/mailman --version')
1886 * 'bin/mailman members' command line arguments have changed. It also
1887 now ignores blank lines and lines that start with #. It also no longer
1888 quits when it sees an address that's already subscribed.
1889 * 'bin/withlist' is now 'bin/mailman withlist', and its command line
1890 arguments have changed.
1891 * 'bin/mailman lists' command line arguments have changed.
1892 * 'bin/genaliases' is now 'bin/mailman aliases'
1896 * A near complete rewrite of the low-level SMTP delivery machinery. This
1897 greatly improves readability, testability, reuse and extensibility. Almost
1898 all the old functionality has been retained. The smtp_direct.py handler is
1900 * Refactor model objects into the mailman.model subpackage.
1901 * Refactor most of the i18n infrastructure into a separate flufl.i18n package.
1902 * Switch from setuptools to distribute.
1903 * Remove the dependency on setuptools_bzr
1904 * Do not create the .mo files during setup.
1908 * All log files now have a '.log' suffix by default.
1909 * The substitution placeholders in the verp_format configuration variable
1911 * Add a devmode configuration variable that changes some basic behavior.
1912 Most importantly, it allows you to set a low-level SMTP recipient for all
1913 mail for testing purposes. See also devmode_recipient.
1916 3.0 alpha 3 -- "Working Man"
1917 ============================
1922 * Configuration is now done through lazr.config. Defaults.py is
1923 dead. lazr.config files are essentially hierarchical ini files.
1924 * Domains are now stored in the database instead of in the configuration file.
1925 * pre- and post- initialization hooks are now available to plugins. Specify
1926 additional hooks to run in the configuration file.
1927 * Add the environment variable $MAILMAN_CONFIG_FILE which overrides the -C
1928 command line option.
1929 * Make LMTP more compliant with Postfix docs (Patrick Koetter)
1930 * Added a NullMTA for mail servers like Exim which just work automatically.
1934 * 'bin/mailman' is a new super-command for managing Mailman from the command
1935 line. Some older bin scripts have been converted, with more to come.
1936 * Mailman now has an administrative REST interface which can be used to get
1937 information from and manage Mailman remotely.
1938 * Back port of Mailman 2.1's limit on .bak file restoration. After 3
1939 restores, the file is moved to the bad queue, with a .psv extension. (Mark
1941 * Digest creation is moved into a new queue runner so it doesn't block main
1946 * bin/make_instance is no longer necessary, and removed
1947 * The debug log is turned up to info by default to reduce log file spam.
1949 Building and installation
1950 -------------------------
1951 * All doc tests can now be turned into documentation, via Sphinx. Just run
1952 bin/docs after bin/buildout.
1955 3.0 alpha 2 -- "Grand Designs"
1956 ==============================
1962 * Mailman 3 is now licensed under the GPLv3.
1967 * Changed bin/arch to attempt to open the mbox before wiping the old
1968 archive. Launchpad bug #280418.
1970 * Added digest.mbox and pending.pck to the 'list' files checked by
1971 check_perms. Launchpad bug #284802.
1976 * Converted to using zope.testing as the test infrastructure. Use bin/test
1977 now to run the full test suite.
1978 <https://pypi.org/project/zope.testing/3.7.1/>
1979 * Partially converted to using lazr.config as the new configuration
1980 regime. Not everything has been converted yet, so some manual editing
1981 of mailman/Defaults.py is required. This will be rectified in future
1982 versions. <https://launchpad.net/lazr.config>
1983 * All web-related stuff is moved to its own directory, effectively moving
1984 it out of the way for now.
1985 * The email command infrastructure has been reworked to play more nicely
1986 with the plug-in architecture. Not all commands have yet been
1992 * The LMTP server now properly calculates the message's original size.
1993 * For command line scripts, -C names the configuration file to use. For
1994 convenient testing, if -C is not given, then the environment variable
1995 MAILMAN_CONFIG_FILE is consulted.
1996 * Support added for a local MHonArc archiver, as well as archiving
1997 automatically in the remote Mail-Archive.com service.
1998 * The permalink proposal for supporting RFC 5064 has been adopted.
1999 * Mailing lists no longer have a .web_page_url attribute; this is taken from
2000 the mailing list's domain's base_url attribute.
2001 * Incoming MTA selection is now taken from the config file instead of
2002 plugins. An MTA for Postfix+LMTP is added. bin/genaliases works again.
2003 * If a message has no Message-ID, the stock archivers will return None for
2004 the permalink now instead of raising an assertion.
2005 * IArchiver no longer has an is_enabled property; this is taken from the
2006 configuration file now.
2011 * Python 2.6 is the minimal requirement.
2012 * Converted to using zc.buildout as the build infrastructure. See
2013 docs/ALPHA.txt for details.
2014 <https://pypi.org/project/zc.buildout/1.1.1/>
2017 3.0 alpha 1 -- "Leave That Thing Alone"
2018 =======================================
2021 User visible changes
2022 --------------------
2024 * So called 'new style' subject prefixing is the default now, and the only
2025 option. When a list's subject prefix is added, it's always done so before
2026 any Re: tag, not after. E.g. '[My List] Re: The subject'.
2027 * RFC 2369 headers List-Subscribe and List-Unsubscribe now use the preferred
2028 -join and -leave addresses instead of the -request address with a subject
2034 * There is no more separate configure; make; make install step. Mailman 3.0
2035 is a setuptools package.
2036 * Mailman can now be configured via a 'mailman.cfg' file which lives in
2037 $VAR_PREFIX/etc. This is used to separate the configuration from the
2038 source directory. Alternative configuration files can be specified via
2039 -C/--config for most command line scripts. mailman.cfg contains Python
2040 code. mm_cfg.py is no more. You do not need to import Defaults.py in
2041 etc/mailman.cfg. You should still consult Defaults.py for the list of site
2042 configuration variables available to you.
2044 See the etc/mailman.cfg.sample file.
2045 * PUBLIC_ARCHIVE_URL and DEFAULT_SUBJECT_PREFIX now takes $-string
2046 substitutions instead of %-string substitutions. See documentation in
2047 Defaults.py.in for details.
2048 * Message headers and footers now only accept $-string substitutions;
2049 %-strings are no longer supported. The substitution variable
2050 '_internal_name' has been removed; use $list_name or $real_name
2051 instead. The substitution variable $fqdn_listname has been added.
2052 DEFAULT_MSG_FOOTER in Defaults.py.in has been updated accordingly.
2053 * The KNOWN_SPAMMERS global variable is replaced with HEADER_MATCHES. The
2054 mailing list's header_filter_rules variable is replaced with header_matches
2055 which has the same semantics as HEADER_MATCHES, but is list-specific.
2056 * DEFAULT_MAIL_COMMANDS_MAX_LINES -> EMAIL_COMMANDS_MAX_LINES
2057 * All SMTP_LOG_* templates use $-strings and all consistently write the
2058 Message-ID as the first item in the log entry.
2059 * DELIVERY_MODULE now names a handler, not a module (yes, this is a
2060 misnomer, but it will likely change again before the final release).
2065 * Internally, all strings are Unicodes.
2066 * Implementation of a chain-of-rules based approach for deciding whether a
2067 message should initially be accepted, held for approval, rejected/bounced,
2068 or discarded. This replaces most of the disposition handlers in the
2069 pipeline. The IncomingRunner now only processes message through the rule
2070 chains, and once accepted, places the message in a new queue processed by
2072 * Substantially reworked the entire queue runner process management,
2073 including mailmanctl, a new master script, and the qrunners. This should
2074 be much more robust and reliable now.
2075 * The Storm ORM is used for data storage, with the SQLite backend as the
2076 default relational database.
2077 * Zope interfaces are used to describe the major components.
2078 * Users are now stored in a unified database, and shared across all mailing
2080 * Mailman's web interface is now WSGI compliant. WSGI is a Python standard
2081 (PEP 333) allowing web applications to be (more) easily integrated with any
2082 number of existing Python web application frameworks. For more information
2085 https://wsgi.readthedocs.io/en/latest/
2086 https://www.python.org/dev/peps/pep-0333/
2088 Mailman can still be run as a traditional CGI program of course.
2089 * Mailman now provides an LMTP server for more efficient integration with
2090 supporting mail servers (e.g. Postfix, Sendmail). The Local Mail Transport
2091 Protocol is defined in RFC 2033:
2093 http://www.faqs.org/rfcs/rfc2033.html
2094 * Virtual domains are now fully supported in that mailing lists of the same
2095 name can exist in more than one domain. This is accomplished by renaming
2096 the lists/ and archives/ subdirectories after the list's posting address.
2097 For example, data for list foo in example.com and list foo in example.org
2098 will be stored in lists/foo@example.com and lists/foo@example.org.
2100 For Postfix or manual MTA users, you will need to regenerate your mail
2101 aliases. Use bin/genaliases.
2103 VIRTUAL_HOST_OVERVIEW has been removed, effectively Mailman now operates
2104 as if it were always enabled. If your site has more than one domain,
2105 you must configure all domains by using add_domain() in your
2106 etc/mailman.cfg flie (see below -- add_virtual() has been removed).
2107 * If you had customizations based on Site.py, you will need to re-implement
2108 them. Site.py has been removed.
2109 * The site list is no more. You can remove your 'mailman' site list unless
2110 you want to retain it for other purposes, but it is no longer used (or
2111 required) by Mailman. You should set NO_REPLY_ADDRESS to an address that
2112 throws away replies, and you should set SITE_OWNER_ADDRESS to an email
2113 address that reaches the person ultimately responsible for the Mailman
2114 installation. The MAILMAN_SITE_LIST variable has been removed.
2115 * qrunners no longer restart on SIGINT; SIGUSR1 is used for that now.
2117 Internationalization Big Changes
2118 --------------------------------
2120 * Translators should work only on messages/<lang>/LC_MESSAGES/mailman.po.
2121 Templates files are generated from mailman.po during the build process.
2126 * Confirmed member change of address is logged in the 'subscribe' log, and if
2127 admin_notify_mchanges is true, a notice is sent to the list owner using a
2128 new adminaddrchgack.txt template.
2129 * There is a new list attribute 'subscribe_auto_approval' which is a list of
2130 email addresses and regular expressions matching email addresses whose
2131 subscriptions are exempt from admin approval. RFE 403066.
2133 Command line scripts
2134 --------------------
2136 * Most scripts have grown a -C/--config flag to allow you to specify a
2137 different configuration file. Without this, the default etc/mailman.cfg
2139 * the -V/--virtual-host-overview switch in list_lists has been removed, while
2140 -d/--domain and -f/--full have been added.
2141 * bin/newlist is renamed bin/create_list and bin/rmlist is renamed
2142 bin/remove_list. Both take fully-qualified list names now (i.e. the list's
2143 posting address), but also accept short names, in which case the default
2144 domain is used. newlist's -u/--urlhost and -e/--emailhost switches have
2145 been removed. The domain that the list is being added to must already
2147 * Backport the ability to specify additional footer interpolation variables
2148 by the message metadata 'decoration-data' key.
2150 Bug fixes and other patches
2151 ---------------------------
2153 * Removal of DomainKey/DKIM signatures is now controlled by Defaults.py
2154 mm_cfg.py variable REMOVE_DKIM_HEADERS (default = No).
2155 * Queue runner processing is improved to log and preserve for analysis in the
2156 shunt queue certain bad queue entries that were previously logged but lost.
2157 Also, entries are preserved when an attempt to shunt throws an exception
2159 * The processing of Topics regular expressions has changed. Previously the
2160 Topics regexp was compiled in verbose mode but not documented as such which
2161 caused some confusion. Also, the documentation indicated that topic
2162 keywords could be entered one per line, but these entries were not handled
2163 properly. Topics regexps are now compiled in non-verbose mode and multi-
2164 line entries are 'ored'. Existing Topics regexps will be converted when
2165 the list is updated so they will continue to work.
2166 * The List-Help, List-Subscribe, and List-Unsubscribe headers were
2167 incorrectly suppressed in messages that Mailman sends directly to users.
2168 * The 'adminapproved' metadata key is renamed 'moderator_approved'.