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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# Copyright (C) 2010-2011 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__ = [
'BounceContext',
'IBounceDetector',
'IBounceEvent',
'IBounceProcessor',
'Stop',
]
from flufl.enum import Enum
from zope.interface import Attribute, Interface
# If a bounce detector returns Stop, that means to just discard the
# message. An example is warning messages for temporary delivery
# problems. These shouldn't trigger a bounce notification, but we also
# don't want to send them on to the list administrator.
Stop = object()
class BounceContext(Enum):
"""The context in which the bounce was detected."""
# This is a normal bounce detection. IOW, Mailman received a bounce in
# response to a mailing list post.
normal = 1
# A probe email bounced. This can be considered a bit more serious, since
# it occurred in response to a specific message to a specific user.
probe = 2
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 value `Stop` is
returned to halt any bounce processing pipeline.
:rtype: A set strings, or `Stop`
"""
class IBounceEvent(Interface):
"""Registration record for a single bounce event."""
list_name = Attribute(
"""The name of the mailing list that received this bounce.""")
email = Attribute(
"""The email address that bounced.""")
timestamp = Attribute(
"""The timestamp for when the bounce was received.""")
message_id = Attribute(
"""The Message-ID of the bounce message.""")
context = Attribute(
"""Where was the bounce detected?""")
processed = Attribute(
"""Has this bounce event been processed?""")
class IBounceProcessor(Interface):
"""Manager/processor of bounce events."""
def register(mlist, email, msg, context=None):
"""Register a bounce event.
:param mlist: The mailing list that the bounce occurred on.
:type mlist: IMailingList
:param email: The email address that is bouncing.
:type email: str
:param msg: The bounce message.
:type msg: email.message.Message
:param context: In what context was the bounce detected? The default
is 'normal' context (i.e. we received a normal bounce for the
address).
:type context: BounceContext
:return: The registered bounce event.
:rtype: IBounceEvent
"""
|
