diff options
| author | Barry Warsaw | 2012-04-07 15:46:05 -0600 |
|---|---|---|
| committer | Barry Warsaw | 2012-04-07 15:46:05 -0600 |
| commit | 98169dac0fc89c4846b8396373b58be34c749f8e (patch) | |
| tree | 1b395d3cee3f18c4957e7c41db95ef6678910ee2 /src/mailman/model/docs | |
| parent | ed3902b06ac0fc9595bbf1d5c17349e3b9735278 (diff) | |
| download | mailman-98169dac0fc89c4846b8396373b58be34c749f8e.tar.gz mailman-98169dac0fc89c4846b8396373b58be34c749f8e.tar.zst mailman-98169dac0fc89c4846b8396373b58be34c749f8e.zip | |
* An `AddressVerificationEvent` is triggered when an `IAddress` is verified
or unverified. (LP: #975698)
Diffstat (limited to 'src/mailman/model/docs')
| -rw-r--r-- | src/mailman/model/docs/addresses.rst | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/src/mailman/model/docs/addresses.rst b/src/mailman/model/docs/addresses.rst index dfeac2b2a..b29ae658b 100644 --- a/src/mailman/model/docs/addresses.rst +++ b/src/mailman/model/docs/addresses.rst @@ -122,8 +122,8 @@ address from the user. bperson@example.com -Registration and validation -=========================== +Registration and verification +============================= Addresses have two dates, the date the address was registered on and the date the address was validated on. The former is set when the address is created, @@ -144,11 +144,36 @@ verification procedure. It takes a datetime object. >>> print address_4.verified_on 2005-08-01 07:49:23 -The address shows the verified status in its repr. +The address shows the verified status in its representation. >>> address_4 <Address: Dan Person <dperson@example.com> [verified] at ...> +An event is triggered when the address gets verified. + + >>> saved_event = None + >>> address_5 = user_manager.create_address( + ... 'eperson@example.com', 'Elle Person') + >>> def save_event(event): + ... global saved_event + ... saved_event = event + >>> from mailman.testing.helpers import event_subscribers + >>> with event_subscribers(save_event): + ... address_5.verified_on = now() + >>> print saved_event + <AddressVerificationEvent eperson@example.com 2005-08-01 07:49:23> + +An event is also triggered when the address is unverified. In this case, +check the event's address's `verified_on` attribute; if this is None, then the +address is being unverified. + + >>> with event_subscribers(save_event): + ... address_5.verified_on = None + >>> print saved_event + <AddressVerificationEvent eperson@example.com unverified> + >>> print saved_event.address.verified_on + None + Case-preserved addresses ======================== |