aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 6eadaa89fc223e7a7d929fe04cfaf0073a6ff95e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
mm3mod: Command line list moderation for mailman3
=================================================

Prerequisites
-------------

You need a working mailman3 install, and python modules
``mailmanclient`` and ``cmd2``.

Installation
------------

To try it out, you can just clone it and run

::

   python3 mm3mod/__init___.py

To do things the pythonic way

::
  
   python3 -m pip install git+https://git.tethera.net/mm3mod.git


Configuration
-------------

Create $XDG_CONFIG_DIR/mm3mod/config.ine with at least

.. code-block:: ini
   
   [rest]
   password=<your REST admin password>

   [list]
   name=<fqdn>

The password is output by ``mailman info`` or ``mailmain-wrapper info``

Use
---

Run

::

   $ mm3mod

This will put you in a loop that

1. Prints the first page of held messages
2. Allows you to ``accept`` or ``discard`` by request-id, or to discard the whole page.

Other useful commands include ``quit`` and ``help``

Tab completion is available for commands and request-ids.