~barry/mailman/events-and-web

« back to all changes in this revision

Viewing changes to Mailman/rules/docs/implicit-dest.txt

  • Committer: Barry Warsaw
  • Date: 2008-02-03 04:03:19 UTC
  • mfrom: (6581.1.27 rules)
  • Revision ID: barry@python.org-20080203040319-mnb1sar9bumaih01
Merge the 'rules' branch.

Give the first alpha a code name.

This branch mostly gets rid of all the approval oriented handlers in favor of
a chain-of-rules based approach.  This will be much more powerful and
extensible, allowing rule definition by plugin and chain creation via web
page.

When a message is processed by the incoming queue, it gets sent through a
chain of rules.  The starting chain is defined on the mailing list object, and
there is a built-in default starting chain, called 'built-in'.  Each chain is
made up of links, which describe a rule and an action, along with possibly
some other information.  Actions allow processing to take a detour through
another chain, jump to another chain, stop processing, run a function, etc.

The built-in chain essentially implements the original early part of the
handler pipeline.  If a message makes it through the built-in chain, it gets
sent to the prep queue, where the message is decorated and such before sending
out to the list membership.  The 'accept' chain is what moves the message into
the prep queue.

There are also 'hold', 'discard', and 'reject' chains, which do what you would
expect them to.  There are lots of built-in rules, implementing everything
from the old emergency handler to new handlers such as one not allowing empty
subject headers.

IMember grows an is_moderated attribute.

The 'adminapproved' metadata key is renamed 'moderator_approved'.

Fix some bogus uses of noreply_address to no_reply_address.

Stash an 'original_size' attribute on the message after parsing its plain
text.  This can be used later to ensure the original message does not exceed a
specified size without have to flatten the message again.

The KNOWN_SPAMMERS global variable is replaced with HEADER_MATCHES.  The
mailing list's header_filter_rules variable is replaced with header_matches
which has the same semantics as HEADER_MATCHES, but is list-specific.

DEFAULT_MAIL_COMMANDS_MAX_LINES -> EMAIL_COMMANDS_MAX_LINES.

Update smtplistener.py to be much better, to use maildir format instead of
mbox format, to respond to RSET commands by clearing the maildir, and by
silencing annoying asyncore error messages.

Extend the doctest runner so that it will run .txt files in any docs
subdirectory in the code tree.

Add plugable keys 'mailman.mta' and 'mailman.rules'.  The latter may have only
one setting while the former is extensible.

There are lots of doctests which should give all the gory details.

Mailman/Post.py -> Mailman/inject.py and the command line usage of this module
is removed.

SQLALCHEMY_ECHO, which was unused, is removed.

Backport the ability to specify additional footer interpolation variables by
the message metadata 'decoration-data' key.

can_acknowledge() defines whether a message can be responded to by the email
robot.

Simplify the implementation of _reset() based on Storm fixes.  Be able to
handle lists in Storm values.

Do some reorganization.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Implicit destination
 
2
====================
 
3
 
 
4
The 'implicit-dest' rule matches when the mailing list's posting address is
 
5
not explicitly mentioned in the set of message recipients.
 
6
 
 
7
    >>> from Mailman.configuration import config
 
8
    >>> mlist = config.db.list_manager.create(u'_xtest@example.com')
 
9
    >>> rule = config.rules['implicit-dest']
 
10
    >>> rule.name
 
11
    'implicit-dest'
 
12
 
 
13
This rule matches messages that have implicit destination, meaning that the
 
14
mailing list's posting address isn't included in the explicit recipients.
 
15
 
 
16
    >>> mlist.require_explicit_destination = True
 
17
    >>> mlist.acceptable_aliases = u''
 
18
    >>> msg = message_from_string(u"""\
 
19
    ... From: aperson@example.org
 
20
    ... Subject: An implicit message
 
21
    ...
 
22
    ... """)
 
23
    >>> rule.check(mlist, msg, {})
 
24
    True
 
25
 
 
26
You can disable implicit destination checks for the mailing list.
 
27
 
 
28
    >>> mlist.require_explicit_destination = False
 
29
    >>> rule.check(mlist, msg, {})
 
30
    False
 
31
 
 
32
Even with some recipients, if the posting address is not included, the rule
 
33
will match.
 
34
 
 
35
    >>> mlist.require_explicit_destination = True
 
36
    >>> msg['To'] = 'myfriend@example.com'
 
37
    >>> rule.check(mlist, msg, {})
 
38
    True
 
39
 
 
40
Add the posting address as a recipient and the rule will no longer match.
 
41
 
 
42
    >>> msg['Cc'] = '_xtest@example.com'
 
43
    >>> rule.check(mlist, msg, {})
 
44
    False
 
45
 
 
46
Alternatively, if one of the acceptable aliases is in the recipients list,
 
47
then the rule will not match.
 
48
 
 
49
    >>> del msg['cc']
 
50
    >>> rule.check(mlist, msg, {})
 
51
    True
 
52
    >>> mlist.acceptable_aliases = u'myfriend@example.com'
 
53
    >>> rule.check(mlist, msg, {})
 
54
    False
 
55
 
 
56
A message gated from NNTP will obviously have an implicit destination.  Such
 
57
gated messages will not be held for implicit destination because it's assumed
 
58
that Mailman pulled it from the appropriate news group.
 
59
 
 
60
    >>> rule.check(mlist, msg, dict(fromusenet=True))
 
61
    False
 
62
 
 
63
 
 
64
Alias patterns
 
65
--------------
 
66
 
 
67
It's also possible to specify an alias pattern, i.e. a regular expression to
 
68
match against the recipients.  For example, we can say that if there is a
 
69
recipient in the example.net domain, then the rule does not match.
 
70
 
 
71
    >>> mlist.acceptable_aliases = u'^.*@example.net'
 
72
    >>> rule.check(mlist, msg, {})
 
73
    True
 
74
    >>> msg['To'] = 'you@example.net'
 
75
    >>> rule.check(mlist, msg, {})
 
76
    False