summaryrefslogtreecommitdiff
path: root/mailman/docs/mlist-addresses.txt
blob: fe76fb4d5869776e4b9e298938c0189befd63f9e (plain) (blame)
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
Mailing list addresses
======================

Every mailing list has a number of addresses which are publicly available.
These are defined in the IMailingListAddresses interface.

    >>> mlist = config.db.list_manager.create(u'_xtest@example.com')

The posting address is where people send messages to be posted to the mailing
list.  This is exactly the same as the fully qualified list name.

    >>> mlist.fqdn_listname
    u'_xtest@example.com'
    >>> mlist.posting_address
    u'_xtest@example.com'

Messages to the mailing list's 'no reply' address always get discarded without
prejudice.

    >>> mlist.no_reply_address
    u'noreply@example.com'

The mailing list's owner address reaches the human moderators.

    >>> mlist.owner_address
    u'_xtest-owner@example.com'

The request address goes to the list's email command robot.

    >>> mlist.request_address
    u'_xtest-request@example.com'

The bounces address accepts and processes all potential bounces.

    >>> mlist.bounces_address
    u'_xtest-bounces@example.com'

The join (a.k.a. subscribe) address is where someone can email to get added to
the mailing list.  The subscribe alias is a synonym for join, but it's
deprecated.

    >>> mlist.join_address
    u'_xtest-join@example.com'
    >>> mlist.subscribe_address
    u'_xtest-subscribe@example.com'

The leave (a.k.a. unsubscribe) address is where someone can email to get added
to the mailing list.  The unsubscribe alias is a synonym for leave, but it's
deprecated.

    >>> mlist.leave_address
    u'_xtest-leave@example.com'
    >>> mlist.unsubscribe_address
    u'_xtest-unsubscribe@example.com'


Email confirmations
-------------------

Email confirmation messages are sent when actions such as subscriptions need
to be confirmed.  It requires that a cookie be provided, which will be
included in the local part of the email address.  The exact format of this is
dependent on the VERP_CONFIRM_FORMAT configuration variable.

    >>> mlist.confirm_address('cookie')
    u'_xtest-confirm+cookie@example.com'
    >>> mlist.confirm_address('wookie')
    u'_xtest-confirm+wookie@example.com'

    >>> from mailman import Defaults
    >>> old_format = Defaults.VERP_CONFIRM_FORMAT
    >>> Defaults.VERP_CONFIRM_FORMAT = '$address---$cookie'
    >>> mlist.confirm_address('cookie')
    u'_xtest-confirm---cookie@example.com'
    >>> config.VERP_CONFIRM_FORMAT = old_format