← Back to branch summary

~barry/mailman/events-and-web

« back to all changes in this revision

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

  • Committer: Barry Warsaw
  • Date: 2012-04-07 21:46:05 UTC
  • Revision ID: barry@list.org-20120407214605-th680lxpag471tdr
 * An `AddressVerificationEvent` is triggered when an `IAddress` is verified
   or unverified.  (LP: #975698)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/mailman/model/docs/addresses.rst
122
122
    bperson@example.com
123
123
 
124
124
 
125
 
Registration and validation
126
 
===========================
 
125
Registration and verification
 
126
=============================
127
127
 
128
128
Addresses have two dates, the date the address was registered on and the date
129
129
the address was validated on.  The former is set when the address is created,
144
144
    >>> print address_4.verified_on
145
145
    2005-08-01 07:49:23
146
146
 
147
 
The address shows the verified status in its repr.
 
147
The address shows the verified status in its representation.
148
148
 
149
149
    >>> address_4
150
150
    <Address: Dan Person <dperson@example.com> [verified] at ...>
151
151
 
 
152
An event is triggered when the address gets verified.
 
153
 
 
154
    >>> saved_event = None
 
155
    >>> address_5 = user_manager.create_address(
 
156
    ...     'eperson@example.com', 'Elle Person')
 
157
    >>> def save_event(event):
 
158
    ...     global saved_event
 
159
    ...     saved_event = event
 
160
    >>> from mailman.testing.helpers import event_subscribers
 
161
    >>> with event_subscribers(save_event):
 
162
    ...     address_5.verified_on = now()
 
163
    >>> print saved_event
 
164
    <AddressVerificationEvent eperson@example.com 2005-08-01 07:49:23>
 
165
 
 
166
An event is also triggered when the address is unverified.  In this case,
 
167
check the event's address's `verified_on` attribute; if this is None, then the
 
168
address is being unverified.
 
169
 
 
170
    >>> with event_subscribers(save_event):
 
171
    ...     address_5.verified_on = None
 
172
    >>> print saved_event
 
173
    <AddressVerificationEvent eperson@example.com unverified>
 
174
    >>> print saved_event.address.verified_on
 
175
    None
 
176
 
152
177
 
153
178
Case-preserved addresses
154
179
========================