* ``$cwd`` is now an additional substitution variable for the ``mailman.cfg``

   file's ``[paths.*]`` sections.  A new ``[paths.here]`` section is added,
   which puts the ``var_dir`` in ``$cwd``.  It is made the default layout.

 * You can now view the contents of, inject messages into, and delete messages
   from the various queue directories via the ``<api>/queues`` resource.

Also:

inject_message() and inject_text() now return the filebase of the file
injected into the queue directory.

1 files changed, 10 insertions, 7 deletions

diff --git a/src/mailman/runners/docs/command.rst b/src/mailman/runners/docs/command.rst
index fe3311d87..82ee33fbc 100644
--- a/src/mailman/runners/docs/command.rst
+++ b/src/mailman/runners/docs/command.rst
@@ -27,7 +27,7 @@ the sender.  The command can be in the ``Subject`` header.
     ... """)
 
     >>> from mailman.app.inject import inject_message
-    >>> inject_message(mlist, msg, switchboard='command')
+    >>> filebase = inject_message(mlist, msg, switchboard='command')
     >>> from mailman.runners.command import CommandRunner
     >>> from mailman.testing.helpers import make_testable_runner
     >>> command = make_testable_runner(CommandRunner)
@@ -85,7 +85,7 @@ message is plain text.
     ... echo foo bar
     ... """)
 
-    >>> inject_message(mlist, msg, switchboard='command')
+    >>> filebase = inject_message(mlist, msg, switchboard='command')
     >>> command.run()
     >>> messages = get_queue_messages('virgin')
     >>> len(messages)
@@ -133,7 +133,8 @@ address, and the other is the results of his email command.
     ...
     ... """)
 
-    >>> inject_message(mlist, msg, switchboard='command', subaddress='join')
+    >>> filebase = inject_message(
+    ...     mlist, msg, switchboard='command', subaddress='join')
     >>> command.run()
     >>> messages = get_queue_messages('virgin', sort_on='subject')
     >>> len(messages)
@@ -165,7 +166,8 @@ Similarly, to leave a mailing list, the user need only email the ``-leave`` or
     ...
     ... """)
 
-    >>> inject_message(mlist, msg, switchboard='command', subaddress='leave')
+    >>> filebase = inject_message(
+    ...     mlist, msg, switchboard='command', subaddress='leave')
     >>> command.run()
     >>> messages = get_queue_messages('virgin')
     >>> len(messages)
@@ -200,7 +202,8 @@ The ``-confirm`` address is also available as an implicit command.
     ...
     ... """)
 
-    >>> inject_message(mlist, msg, switchboard='command', subaddress='confirm')
+    >>> filebase = inject_message(
+    ...     mlist, msg, switchboard='command', subaddress='confirm')
     >>> command.run()
     >>> messages = get_queue_messages('virgin')
     >>> len(messages)
@@ -244,7 +247,7 @@ looked at by the command queue.
     ... echo baz qux
     ... """)
 
-    >>> inject_message(mlist, msg, switchboard='command')
+    >>> filebase = inject_message(mlist, msg, switchboard='command')
     >>> command.run()
     >>> messages = get_queue_messages('virgin')
     >>> len(messages)
@@ -276,7 +279,7 @@ The ``stop`` command is an alias for ``end``.
     ... echo baz qux
     ... """)
 
-    >>> inject_message(mlist, msg, switchboard='command')
+    >>> filebase = inject_message(mlist, msg, switchboard='command')
     >>> command.run()
     >>> messages = get_queue_messages('virgin')
     >>> len(messages)