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