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
|
# Copyright (C) 2008 by the Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
# USA.
"""Interfaces defining email commands."""
from munepy import Enum
from zope.interface import Interface, Attribute
class ContinueProcessing(Enum):
"""Should `IEmailCommand.process()` continue or not."""
no = 0
yes = 1
class IEmailResults(Interface):
"""The email command results object."""
output = Attribute('An output file object for printing results to.')
class IEmailCommand(Interface):
"""An email command."""
name = Attribute('Command name as seen in a -request email.')
argument_description = Attribute('Description of command arguments.')
description = Attribute('Command help.')
def process(mlist, msg, msgdata, arguments, results):
"""Process the email command.
:param mlist: The mailing list target of the command.
:param msg: The original message object.
:param msgdata: The message metadata.
:param arguments: The command arguments tuple.
:param results: An IEmailResults object for these commands.
:return: A `ContinueProcessing` enum specifying whether to continue
processing or not.
"""
|
