summaryrefslogtreecommitdiff
path: root/src/mailman/docs/mlist-addresses.txt
blob: 3f44008fbc8bc318288d071a48a5ecebc4646987 (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
======================
Mailing list addresses
======================

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

    >>> mlist = create_list('_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.

    >>> print mlist.fqdn_listname
    _xtest@example.com
    >>> print mlist.posting_address
    _xtest@example.com

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

    >>> print mlist.no_reply_address
    noreply@example.com

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

    >>> print mlist.owner_address
    _xtest-owner@example.com

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

    >>> print mlist.request_address
    _xtest-request@example.com

The bounces address accepts and processes all potential bounces.

    >>> print mlist.bounces_address
    _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.

    >>> print mlist.join_address
    _xtest-join@example.com
    >>> print mlist.subscribe_address
    _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.

    >>> print mlist.leave_address
    _xtest-leave@example.com
    >>> print mlist.unsubscribe_address
    _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.

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

    >>> config.push('test config', """
    ... [mta]
    ... verp_confirm_format: $address---$cookie
    ... """)
    >>> print mlist.confirm_address('cookie')
    _xtest-confirm---cookie@example.com
    >>> config.pop('test config')