diff options
Diffstat (limited to 'src/mailman/commands/docs/echo.txt')
| -rw-r--r-- | src/mailman/commands/docs/echo.txt | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/src/mailman/commands/docs/echo.txt b/src/mailman/commands/docs/echo.txt new file mode 100644 index 000000000..181cc58c8 --- /dev/null +++ b/src/mailman/commands/docs/echo.txt @@ -0,0 +1,30 @@ +The 'echo' command +================== + +The mail command 'echo' simply replies with the original command and arguments +to the sender. + + >>> command = config.commands['echo'] + >>> command.name + 'echo' + >>> command.argument_description + '[args]' + >>> command.description + u'Echo an acknowledgement. Arguments are return unchanged.' + +The original message is ignored, but the results receive the echoed command. + + >>> from mailman.app.lifecycle import create_list + >>> mlist = create_list(u'test@example.com') + + >>> from mailman.queue.command import Results + >>> results = Results() + + >>> from mailman.Message import Message + >>> print command.process(mlist, Message(), {}, ('foo', 'bar'), results) + ContinueProcessing.yes + >>> print unicode(results) + The results of your email command are provided below. + <BLANKLINE> + echo foo bar + <BLANKLINE> |
