summaryrefslogtreecommitdiff
path: root/src/mailman/rules/docs/implicit-dest.rst
blob: 89d2459b06a21651fc01ef0e6b014e8c8df9e46b (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
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
====================
Implicit destination
====================

The ``implicit-dest`` rule matches when the mailing list's posting address is
not explicitly mentioned in the set of message recipients.

    >>> mlist = create_list('_xtest@example.com')
    >>> rule = config.rules['implicit-dest']
    >>> print(rule.name)
    implicit-dest

In order to check for implicit destinations, we need to adapt the mailing list
to the appropriate interface.

    >>> from mailman.interfaces.mailinglist import IAcceptableAliasSet
    >>> alias_set = IAcceptableAliasSet(mlist)

This rule matches messages that have an implicit destination, meaning that the
mailing list's posting address isn't included in the explicit recipients.
::

    >>> mlist.require_explicit_destination = True
    >>> alias_set.clear()

    >>> msg = message_from_string("""\
    ... From: aperson@example.org
    ... Subject: An implicit message
    ...
    ... """)
    >>> rule.check(mlist, msg, {})
    True

You can disable implicit destination checks for the mailing list.

    >>> mlist.require_explicit_destination = False
    >>> rule.check(mlist, msg, {})
    False

Even with some recipients, if the posting address is not included, the rule
will match.

    >>> mlist.require_explicit_destination = True
    >>> msg['To'] = 'myfriend@example.com'
    >>> rule.check(mlist, msg, {})
    True

Add the posting address as a recipient and the rule will no longer match.

    >>> msg['Cc'] = '_xtest@example.com'
    >>> rule.check(mlist, msg, {})
    False

Alternatively, if one of the acceptable aliases is in the recipients list,
then the rule will not match.
::

    >>> del msg['cc']
    >>> rule.check(mlist, msg, {})
    True

    >>> alias_set.add('myfriend@example.com')
    >>> rule.check(mlist, msg, {})
    False

A message gated from NNTP will obviously have an implicit destination.  Such
gated messages will not be held for implicit destination because it's assumed
that Mailman pulled it from the appropriate news group.

    >>> rule.check(mlist, msg, dict(from_usenet=True))
    False

Additional aliases can be added.
::

    >>> alias_set.add('other@example.com')
    >>> del msg['to']
    >>> rule.check(mlist, msg, {})
    True

    >>> msg['To'] = 'other@example.com'
    >>> rule.check(mlist, msg, {})
    False

Aliases can be removed.

    >>> alias_set.remove('other@example.com')
    >>> rule.check(mlist, msg, {})
    True

Aliases can also be cleared.
::

    >>> msg['Cc'] = 'myfriend@example.com'
    >>> rule.check(mlist, msg, {})
    False

    >>> alias_set.clear()
    >>> rule.check(mlist, msg, {})
    True


Alias patterns
==============

It's also possible to specify an alias pattern, i.e. a regular expression to
match against the recipients.  For example, we can say that if there is a
recipient in the ``example.net`` domain, then the rule does not match.
::

    >>> alias_set.add('^.*@example.net')
    >>> rule.check(mlist, msg, {})
    True

    >>> msg['To'] = 'you@example.net'
    >>> rule.check(mlist, msg, {})
    False


Bad aliases
===========

You cannot add an alias that looks like neither a pattern nor an email
address.

    >>> alias_set.add('foobar')
    Traceback (most recent call last):
    ...
    ValueError: foobar