This runner’s purpose is to process and respond to email commands. Commands are extensible using the Mailman plug-in system, but Mailman comes with a number of email commands out of the box. These are processed when a message is sent to the list’s -request address.
>>> mlist = create_list('test@example.com')
>>> mlist.send_welcome_messages = False
For example, the echo command simply echoes the original command back to the sender. The command can be in the Subject header.
>>> msg = message_from_string("""\
... From: aperson@example.com
... To: test-request@example.com
... Subject: echo hello
... Message-ID: <aardvark>
...
... """)
>>> from mailman.app.inject import inject_message
>>> 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)
>>> command.run()
And now the response is in the virgin queue.
>>> from mailman.testing.helpers import get_queue_messages
>>> messages = get_queue_messages('virgin')
>>> len(messages)
1
>>> print(messages[0].msg.as_string())
Subject: The results of your email commands
From: test-bounces@example.com
To: aperson@example.com
...
The results of your email command are provided below.
- Original message details:
From: aperson@example.com
Subject: echo hello
Date: ...
Message-ID: <aardvark>
- Results:
echo hello
- Done.
>>> dump_msgdata(messages[0].msgdata)
_parsemsg : False
listid : test.example.com
nodecorate : True
recipients : {'aperson@example.com'}
reduced_list_headers: True
version : ...
The command can also be found in the body of the message, as long as the message is plain text.
>>> msg = message_from_string("""\
... From: bperson@example.com
... To: test-request@example.com
... Message-ID: <bobcat>
...
... echo foo bar
... """)
>>> filebase = inject_message(mlist, msg, switchboard='command')
>>> command.run()
>>> messages = get_queue_messages('virgin')
>>> len(messages)
1
>>> print(messages[0].msg.as_string())
Subject: The results of your email commands
From: test-bounces@example.com
To: bperson@example.com
...
Precedence: bulk
The results of your email command are provided below.
- Original message details:
From: bperson@example.com
Subject: n/a
Date: ...
Message-ID: <bobcat>
- Results:
echo foo bar
- Done.
For some commands, specifically for joining and leaving a mailing list, there are email aliases that act like commands, even when there’s nothing else in the Subject or body. For example, to join a mailing list, a user need only email the -join address or -subscribe address (the latter is deprecated).
Because Dirk has never registered with Mailman before, he gets two responses. The first is a confirmation message so that Dirk can validate his email address, and the other is the results of his email command.
>>> msg = message_from_string("""\
... From: Dirk Person <dperson@example.com>
... To: test-join@example.com
...
... """)
>>> filebase = inject_message(
... mlist, msg, switchboard='command', subaddress='join')
>>> command.run()
>>> messages = get_queue_messages('virgin', sort_on='subject')
>>> len(messages)
2
>>> from mailman.interfaces.registrar import IRegistrar
>>> registrar = IRegistrar(mlist)
>>> for item in messages:
... subject = item.msg['subject']
... print('Subject:', subject)
... if 'confirm' in str(subject):
... token = str(subject).split()[1].strip()
... new_token, token_owner, member = registrar.confirm(token)
... assert new_token is None, 'Confirmation failed'
Subject: The results of your email commands
Subject: confirm ...
Similarly, to leave a mailing list, the user need only email the -leave or -unsubscribe address (the latter is deprecated).
>>> msg = message_from_string("""\
... From: dperson@example.com
... To: test-leave@example.com
...
... """)
>>> filebase = inject_message(
... mlist, msg, switchboard='command', subaddress='leave')
>>> command.run()
>>> messages = get_queue_messages('virgin')
>>> len(messages)
1
>>> print(messages[0].msg.as_string())
Subject: The results of your email commands
From: test-bounces@example.com
To: dperson@example.com
...
The results of your email command are provided below.
- Original message details:
From: dperson@example.com
Subject: n/a
Date: ...
Message-ID: ...
- Results:
Dirk Person <dperson@example.com> left test@example.com
- Done.
The -confirm address is also available as an implicit command.
>>> msg = message_from_string("""\
... From: dperson@example.com
... To: test-confirm+123@example.com
...
... """)
>>> filebase = inject_message(
... mlist, msg, switchboard='command', subaddress='confirm')
>>> command.run()
>>> messages = get_queue_messages('virgin')
>>> len(messages)
1
>>> print(messages[0].msg.as_string())
Subject: The results of your email commands
From: test-bounces@example.com
To: dperson@example.com
...
The results of your email command are provided below.
- Original message details:
From: dperson@example.com
Subject: n/a
Date: ...
Message-ID: ...
- Results:
Confirmation token did not match
- Done.
The end command stops email processing, so that nothing following is looked at by the command queue.
>>> msg = message_from_string("""\
... From: cperson@example.com
... To: test-request@example.com
... Message-ID: <caribou>
...
... echo foo bar
... end ignored
... echo baz qux
... """)
>>> filebase = inject_message(mlist, msg, switchboard='command')
>>> command.run()
>>> messages = get_queue_messages('virgin')
>>> len(messages)
1
>>> print(messages[0].msg.as_string())
Subject: The results of your email commands
...
- Results:
echo foo bar
- Unprocessed:
echo baz qux
- Done.
The stop command is an alias for end.
>>> msg = message_from_string("""\
... From: cperson@example.com
... To: test-request@example.com
... Message-ID: <caribou>
...
... echo foo bar
... stop ignored
... echo baz qux
... """)
>>> filebase = inject_message(mlist, msg, switchboard='command')
>>> command.run()
>>> messages = get_queue_messages('virgin')
>>> len(messages)
1
>>> print(messages[0].msg.as_string())
Subject: The results of your email commands
...
- Results:
echo foo bar
- Unprocessed:
echo baz qux
- Done.