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
|
# Copyright (C) 2010 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 to bounce detection components."""
from __future__ import absolute_import, unicode_literals
__metaclass__ = type
__all__ = [
'IBounceDetector',
'NonFatal',
]
from zope.interface import Interface
# Matching addresses were found, but they were determined to be non-fatal. In
# this case, processing is halted but no bounces are registered.
NonFatal = object()
class IBounceDetector(Interface):
"""Detect a bounce in an email message."""
def process(self, msg):
"""Scan an email message looking for bounce addresses.
:param msg: An email message.
:type msg: `Message`
:return: The detected bouncing addresses. When bouncing addresses are
found but are determined to be non-fatal, the special marker
`NonFatal` can be returned to halt any bounce processing
pipeline. None can be returned if no addresses are found.
:rtype: A sequence of strings, None, or NonFatal.
"""
|
