blob: 632cc85de239f87fb4f342be112da764a4a1641b (
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
|
# Copyright (C) 2007-2009 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman 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 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman 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
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
"""Interface describing the basics of rules."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'IRule',
]
from zope.interface import Interface, Attribute
class IRule(Interface):
"""A basic rule."""
name = Attribute('Rule name; must be unique.')
description = Attribute('A brief description of the rule.')
record = Attribute(
"""Should this rule's success or failure be recorded?
This is a boolean; if True then this rule's hit or miss will be
recorded in a message header. If False, it won't.
""")
def check(mlist, msg, msgdata):
"""Run the rule.
:param mlist: The mailing list object.
:param msg: The message object.
:param msgdata: The message metadata.
:returns: a boolean specifying whether the rule matched or not.
"""
|
