diff options
Diffstat (limited to 'mailman/interfaces/handler.py')
| -rw-r--r-- | mailman/interfaces/handler.py | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/mailman/interfaces/handler.py b/mailman/interfaces/handler.py new file mode 100644 index 000000000..5a87bf882 --- /dev/null +++ b/mailman/interfaces/handler.py @@ -0,0 +1,37 @@ +# 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. + +"""Interface describing a pipeline handler.""" + +from zope.interface import Interface, Attribute + + + +class IHandler(Interface): + """A basic pipeline handler.""" + + name = Attribute('Handler name; must be unique.') + + description = Attribute('A brief description of the handler.') + + def process(mlist, msg, msgdata): + """Run the handler. + + :param mlist: The mailing list object. + :param msg: The message object. + :param msgdata: The message metadata. + """ |
