← Back to branch summary

~flo-fuchs/mailman.client/1066343

« back to all changes in this revision

Viewing changes to mailman/client/docs/using.txt

  • Committer: Florian Fuchs
  • Date: 2012-09-25 14:26:58 UTC
  • Revision ID: flo.fuchs@gmail.com-20120925142658-sdkqsbqqougrqky3
- addresses can now be accessed as objects (client.get_address(...))
- addresses can be (un)verified with object.verify()/unverify()

Show diffs side-by-side

added added

removed removed

Lines of Context:
mailman/client/docs/using.txt
282
282
    Cris
283
283
    ...
284
284
 
 
285
Addresses can be accessed directly:
 
286
 
 
287
    >>> address = client.get_address('cris@example.com')
 
288
    >>> print address
 
289
    cris@example.com
 
290
    >>> print address.display_name
 
291
    Cris
 
292
 
 
293
The address has not been verified:
 
294
 
 
295
    >>> print address.verified_on is None
 
296
    True
 
297
 
 
298
But that can be done via the address object:
 
299
 
 
300
    >>> address.verify()
 
301
    >>> address.verified_on is None
 
302
    False
 
303
 
 
304
It can also be unverified:
 
305
 
 
306
    >>> address.unverify()
 
307
    >>> address.verified_on is None
 
308
    True
 
309
 
 
310
 
285
311
Users can be added using ``create_user``. The display_name is optional:
286
312
    >>> client.create_user(email='ler@primus.org',
287
313
    ...                    password='somepass',