summaryrefslogtreecommitdiff
path: root/src/mailman/app/docs/pipelines.rst
blob: 46880b225f2fdb564675a760f410d7e2a4469143 (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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
=========
Pipelines
=========

Pipelines process messages that have been accepted for posting, applying any
modifications and also sending copies of the message to the archives, digests,
NNTP, and outgoing queues.  Pipelines are named and consist of a sequence of
handlers, each of which is applied in turn.  Unlike rules and chains, there is
no way to stop a pipeline from processing the message once it's started.

    >>> mlist = create_list('test@example.com')
    >>> print(mlist.posting_pipeline)
    default-posting-pipeline
    >>> from mailman.core.pipelines import process

For the purposes of these examples, we'll enable just one archiver.

    >>> from mailman.interfaces.mailinglist import IListArchiverSet
    >>> for archiver in IListArchiverSet(mlist).archivers:
    ...     archiver.is_enabled = (archiver.name == 'mhonarc')


Processing a message
====================

Messages hit the pipeline after they've been accepted for posting.

    >>> msg = message_from_string("""\
    ... From: aperson@example.com
    ... To: test@example.com
    ... Subject: My first post
    ... Message-ID: <first>
    ... X-Message-ID-Hash: 4CMWUN6BHVCMHMDAOSJZ2Q72G5M32MWB
    ...
    ... First post!
    ... """)
    >>> msgdata = {}
    >>> process(mlist, msg, msgdata, mlist.posting_pipeline)

The message has been modified with additional headers, footer decorations,
etc.

    >>> print(msg.as_string())
    From: aperson@example.com
    To: test@example.com
    Message-ID: <first>
    X-Message-ID-Hash: 4CMWUN6BHVCMHMDAOSJZ2Q72G5M32MWB
    X-Mailman-Version: ...
    Precedence: list
    Subject: [Test] My first post
    List-Id: <test.example.com>
    Archived-At: <http://lists.example.com/.../4CMWUN6BHVCMHMDAOSJZ2Q72G5M32MWB>
    List-Archive: <http://lists.example.com/archives/test@example.com>
    List-Help: <mailto:test-request@example.com?subject=help>
    List-Post: <mailto:test@example.com>
    List-Subscribe: <http://lists.example.com/listinfo/test@example.com>,
     <mailto:test-join@example.com>
    List-Unsubscribe: <http://lists.example.com/listinfo/test@example.com>,
     <mailto:test-leave@example.com>
    MIME-Version: 1.0
    Content-Type: text/plain; charset="us-ascii"
    Content-Transfer-Encoding: 7bit
    <BLANKLINE>
    First post!
    _______________________________________________
    Test mailing list
    test@example.com
    http://lists.example.com/listinfo/test@example.com
    <BLANKLINE>

The message metadata has information about recipients and other stuff.
However there are currently no recipients for this message.

    >>> dump_msgdata(msgdata)
    original_sender : aperson@example.com
    original_subject: My first post
    recipients      : set()
    stripped_subject: My first post

After pipeline processing, the message is now sitting in various other
processing queues.
::

    >>> from mailman.testing.helpers import get_queue_messages
    >>> messages = get_queue_messages('archive')
    >>> len(messages)
    1

    >>> print(messages[0].msg.as_string())
    From: aperson@example.com
    To: test@example.com
    Message-ID: <first>
    X-Message-ID-Hash: 4CMWUN6BHVCMHMDAOSJZ2Q72G5M32MWB
    X-Mailman-Version: ...
    Precedence: list
    Subject: [Test] My first post
    List-Id: <test.example.com>
    ...
    <BLANKLINE>
    First post!
    <BLANKLINE>

    >>> dump_msgdata(messages[0].msgdata)
    _parsemsg       : False
    original_sender : aperson@example.com
    original_subject: My first post
    recipients      : set()
    stripped_subject: My first post
    version         : 3

This mailing list is not linked to an NNTP newsgroup, so there's nothing in
the outgoing nntp queue.

    >>> messages = get_queue_messages('nntp')
    >>> len(messages)
    0

The outgoing queue will hold the copy of the message that will actually get
delivered to end recipients.
::

    >>> messages = get_queue_messages('out')
    >>> len(messages)
    1

    >>> print(messages[0].msg.as_string())
    From: aperson@example.com
    To: test@example.com
    Message-ID: <first>
    X-Message-ID-Hash: 4CMWUN6BHVCMHMDAOSJZ2Q72G5M32MWB
    X-Mailman-Version: ...
    Precedence: list
    Subject: [Test] My first post
    List-Id: <test.example.com>
    ...
    <BLANKLINE>
    First post!
    <BLANKLINE>
    _______________________________________________
    Test mailing list
    test@example.com
    http://lists.example.com/listinfo/test@example.com

    >>> dump_msgdata(messages[0].msgdata)
    _parsemsg       : False
    listid          : test.example.com
    original_sender : aperson@example.com
    original_subject: My first post
    recipients      : set()
    stripped_subject: My first post
    version         : 3

There's now one message in the digest mailbox, getting ready to be sent.
::

    >>> from mailman.testing.helpers import digest_mbox
    >>> digest = digest_mbox(mlist)
    >>> sum(1 for mboxmsg in digest)
    1

    >>> print(list(digest)[0].as_string())
    From: aperson@example.com
    To: test@example.com
    Message-ID: <first>
    X-Message-ID-Hash: 4CMWUN6BHVCMHMDAOSJZ2Q72G5M32MWB
    X-Mailman-Version: ...
    Precedence: list
    Subject: [Test] My first post
    List-Id: <test.example.com>
    ...
    <BLANKLINE>
    First post!
    <BLANKLINE>