~robin-jeffries/mailman/dlist-robin

Viewing changes to src/mailman/rest/docs/addresses.rst

Committer: Barry Warsaw
Date: 2012-09-22 21:13:13 UTC
Revision ID: barry@list.org-20120922211313-pzaahwq3glfalj6p

* You can now verify and unverify an email address through the REST API.
   POST to .../addresses/<email>/verify and .../addresses/<email>/unverify
   respectively.  The POST data is ignored.  It is not an error to verify or
   unverify an address more than once, but verifying an already verified
   address does not change its `.verified_on` date.  (LP: #1054730)

files modified:
src/mailman/docs/NEWS.rst

src/mailman/rest/addresses.py

src/mailman/rest/docs/addresses.rst

src/mailman/rest/tests/test_addresses.py

Show diffs side-by-side

added added

removed removed

src/mailman/rest/docs/addresses.rst

When the address gets verified, this attribute is available in the REST

representation.

>>> from mailman.utilities.datetime import now

>>> anne.verified_on = now()

103

102

self_link: http://localhost:9001/3.0/addresses/anne@example.com

104

103

verified_on: 2005-08-01T07:49:23

105

104

105

Addresses can also be verified through the REST API, by POSTing to the

106

'verify' sub-resource. The POST data is ignored.

107

108

>>> dump_json('http://localhost:9001/3.0/addresses/'

109

... 'cris@example.com/verify', {})

110

content-length: 0

111

date: ...

112

server: ...

113

status: 204

114

115

Now Cris's address is verified.

116

117

>>> dump_json('http://localhost:9001/3.0/addresses/cris@example.com')

118

display_name: Cris Person

119

email: cris@example.com

120

http_etag: "..."

121

original_email: cris@example.com

122

registered_on: 2005-08-01T07:49:23

123

self_link: http://localhost:9001/3.0/addresses/cris@example.com

124

verified_on: 2005-08-01T07:49:23

125

126

If you should ever need to 'unverify' an address, POST to the 'unverify'

127

sub-resource. Again, the POST data is ignored.

128

129