summaryrefslogtreecommitdiff
path: root/src/mailman/model
diff options
context:
space:
mode:
authorBarry Warsaw2015-04-15 22:51:39 -0400
committerBarry Warsaw2015-04-15 22:51:39 -0400
commit08f457799cd36349a4fd22642f4c05b4eabb306d (patch)
treec4d2270bce3862e71a252d941e3942860a8c8565 /src/mailman/model
parent6c094ce9d81cd5e12ba13c851cbd1018ca3fb935 (diff)
downloadmailman-08f457799cd36349a4fd22642f4c05b4eabb306d.tar.gz
mailman-08f457799cd36349a4fd22642f4c05b4eabb306d.tar.zst
mailman-08f457799cd36349a4fd22642f4c05b4eabb306d.zip
Plumb the subscription policy through the REST API.
Diffstat (limited to 'src/mailman/model')
-rw-r--r--src/mailman/model/docs/registration.rst18
1 files changed, 14 insertions, 4 deletions
diff --git a/src/mailman/model/docs/registration.rst b/src/mailman/model/docs/registration.rst
index fc7ad6f1a..4b1e13520 100644
--- a/src/mailman/model/docs/registration.rst
+++ b/src/mailman/model/docs/registration.rst
@@ -35,11 +35,13 @@ which represents this work flow.
Anne attempts to join the mailing list.
- >>> token = registrar.register(anne)
+ >>> token, token_owner, member = registrar.register(anne)
Because her email address has not yet been verified, she has not yet become a
member of the mailing list.
+ >>> print(member)
+ None
>>> print(mlist.members.get_member('anne@example.com'))
None
@@ -47,7 +49,10 @@ Once she verifies her email address, she will become a member of the mailing
list. In this case, verifying implies that she also confirms her wish to join
the mailing list.
- >>> registrar.confirm(token)
+ >>> token, token_owner, member = registrar.confirm(token)
+ >>> member
+ <Member: Anne Person <anne@example.com> on ant@example.com
+ as MemberRole.member>
>>> mlist.members.get_member('anne@example.com')
<Member: Anne Person <anne@example.com> on ant@example.com
as MemberRole.member>
@@ -78,13 +83,18 @@ Now when Bart registers as a user for the mailing list, a token will still be
generated, but this is only used by the moderator. At first, Bart is not
subscribed to the mailing list.
- >>> token = registrar.register(bart)
+ >>> token, token_owner, member = registrar.register(bart)
+ >>> print(member)
+ None
>>> print(mlist.members.get_member('bart@example.com'))
None
When the moderator confirms Bart's subscription, he joins the mailing list.
- >>> registrar.confirm(token)
+ >>> token, token_owner, member = registrar.confirm(token)
+ >>> member
+ <Member: Bart Person <bart@example.com> on ant@example.com
+ as MemberRole.member>
>>> mlist.members.get_member('bart@example.com')
<Member: Bart Person <bart@example.com> on ant@example.com
as MemberRole.member>