1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
================
The user manager
================
The IUserManager is how you create, delete, and manage users. The Mailman
system instantiates an IUserManager for you based on the configuration
variable MANAGERS_INIT_FUNCTION. The instance is accessible on the global
config object.
>>> from mailman.interfaces.usermanager import IUserManager
>>> from zope.component import getUtility
>>> user_manager = getUtility(IUserManager)
Creating users
==============
There are several ways you can create a user object. The simplest is to
create a 'blank' user by not providing an address or real name at creation
time. This user will have an empty string as their real name, but will not
have a password.
>>> from mailman.interfaces.user import IUser
>>> from zope.interface.verify import verifyObject
>>> user = user_manager.create_user()
>>> verifyObject(IUser, user)
True
>>> sorted(address.address for address in user.addresses)
[]
>>> user.real_name
u''
>>> print user.password
None
The user has preferences, but none of them will be specified.
>>> print user.preferences
<Preferences ...>
A user can be assigned a real name.
>>> user.real_name = 'Anne Person'
>>> sorted(user.real_name for user in user_manager.users)
[u'Anne Person']
A user can be assigned a password.
>>> user.password = 'secret'
>>> sorted(user.password for user in user_manager.users)
[u'secret']
You can also create a user with an address to start out with.
>>> user_2 = user_manager.create_user('bperson@example.com')
>>> verifyObject(IUser, user_2)
True
>>> sorted(address.address for address in user_2.addresses)
[u'bperson@example.com']
>>> sorted(user.real_name for user in user_manager.users)
[u'', u'Anne Person']
As above, you can assign a real name to such users.
>>> user_2.real_name = 'Ben Person'
>>> sorted(user.real_name for user in user_manager.users)
[u'Anne Person', u'Ben Person']
You can also create a user with just a real name.
>>> user_3 = user_manager.create_user(real_name='Claire Person')
>>> verifyObject(IUser, user_3)
True
>>> sorted(address.address for address in user.addresses)
[]
>>> sorted(user.real_name for user in user_manager.users)
[u'Anne Person', u'Ben Person', u'Claire Person']
Finally, you can create a user with both an address and a real name.
>>> user_4 = user_manager.create_user('dperson@example.com', 'Dan Person')
>>> verifyObject(IUser, user_3)
True
>>> sorted(address.address for address in user_4.addresses)
[u'dperson@example.com']
>>> sorted(address.real_name for address in user_4.addresses)
[u'Dan Person']
>>> sorted(user.real_name for user in user_manager.users)
[u'Anne Person', u'Ben Person', u'Claire Person', u'Dan Person']
Deleting users
==============
You delete users by going through the user manager. The deleted user is no
longer available through the user manager iterator.
>>> user_manager.delete_user(user)
>>> sorted(user.real_name for user in user_manager.users)
[u'Ben Person', u'Claire Person', u'Dan Person']
Finding users
=============
You can ask the user manager to find the IUser that controls a particular
email address. You'll get back the original user object if it's found. Note
that the .get_user() method takes a string email address, not an IAddress
object.
>>> address = list(user_4.addresses)[0]
>>> found_user = user_manager.get_user(address.address)
>>> found_user
<User "Dan Person" at ...>
>>> found_user is user_4
True
If the address is not in the user database or does not have a user associated
with it, you will get None back.
>>> print user_manager.get_user('zperson@example.com')
None
>>> user_4.unlink(address)
>>> print user_manager.get_user(address.address)
None
|
