17 |
17 |
18 Example: |
18 Example: |
19 |
19 |
20 .. code-block:: console |
20 .. code-block:: console |
21 |
21 |
22 root@host:~# vmm ua d.user@example.com "A 5ecR3t P4s5\/\/0rd" |
22 root@host:~# vmm ua d.user@example.com -p "A 5ecR3t P4s5\/\/0rd" |
23 root@host:~# vmm useradd e.user@example.com |
23 root@host:~# vmm useradd e.user@example.com |
24 Enter new password: |
24 Enter new password: |
25 Retype new password: |
25 Retype new password: |
26 |
26 |
27 userdelete |
27 userdelete |
28 ---------- |
28 ---------- |
29 Syntax: |
29 Syntax: |
30 | **vmm userdelete** *address* [*force*] |
30 | **vmm userdelete** *address* [**‒‒force**] |
31 | **vmm ud** *address* [*force*] |
31 | **vmm ud** *address* [**‒‒force**] |
32 |
32 |
33 Use this subcommand to delete the account with the given *address*. |
33 Use this subcommand to delete the account with the given *address*. |
34 |
34 |
35 If there are one or more aliases with an identical destination address, |
35 If there are one or more aliases with an identical destination address, |
36 :command:`vmm` will abort the requested operation and show an error message. |
36 :command:`vmm` will abort the requested operation and show an error message. |
37 To prevent this, specify the optional keyword **force**. |
37 To prevent this, give the optional argument **‒‒force**. |
38 |
38 |
39 userinfo |
39 userinfo |
40 -------- |
40 -------- |
41 Syntax: |
41 Syntax: |
42 | **vmm userinfo** *address* [*details*] |
42 | **vmm userinfo** *address* [**-d** *details*] |
43 | **vmm ui** *address* [*details*] |
43 | **vmm ui** *address* [**-d** *details*] |
44 |
44 |
45 This subcommand displays some information about the account specified by |
45 This subcommand displays some information about the account specified by |
46 *address*. |
46 *address*. |
47 |
47 |
48 If the optional argument *details* is given some more information will be |
48 If the optional argument *details* is given some more information will be |
82 SIEVE............: enabled [domain default] |
82 SIEVE............: enabled [domain default] |
83 |
83 |
84 username |
84 username |
85 -------- |
85 -------- |
86 Syntax: |
86 Syntax: |
87 | **vmm username** *address* [*name*] |
87 | **vmm username** *address* [**-n** *name*] |
88 | **vmm un** *address* [*name*] |
88 | **vmm un** *address* [**-n** *name*] |
89 |
89 |
90 The user's real *name* can be set/updated with this subcommand. |
90 The user's real *name* can be set/updated with this subcommand. |
91 |
91 |
92 If no *name* is given, the value stored for the account is erased. |
92 If no *name* is given, the value stored for the account is erased. |
93 |
93 |
94 Example: |
94 Example: |
95 |
95 |
96 .. code-block:: console |
96 .. code-block:: console |
97 |
97 |
98 root@host:~# vmm un d.user@example.com "John Doe" |
98 root@host:~# vmm un d.user@example.com -n "John Doe" |
99 |
99 |
100 usernote |
100 usernote |
101 -------- |
101 -------- |
102 Syntax: |
102 Syntax: |
103 | **vmm usernote** *address* [*note*] |
103 | **vmm usernote** *address* [**-n** *note*] |
104 | **vmm uo** *address* [*note*] |
104 | **vmm uo** *address* [**-n** *note*] |
105 |
105 |
106 With this subcommand, it is possible to attach a note to the specified |
106 With this subcommand, it is possible to attach a note to the specified |
107 account. |
107 account. |
108 Without an argument, an existing note is removed. |
108 Without an argument, an existing note is removed. |
109 |
109 |
110 Example: |
110 Example: |
111 |
111 |
112 .. code-block:: console |
112 .. code-block:: console |
113 |
113 |
114 root@host:~# vmm uo d.user@example.com Only needed until end of May 2012 |
114 root@host:~# vmm uo d.user@example.com -n 'Only needed until end of May 2013' |
115 |
115 |
116 .. versionadded:: 0.6.0 |
116 .. versionadded:: 0.6.0 |
117 |
117 |
118 userpassword |
118 userpassword |
119 ------------ |
119 ------------ |
120 Syntax: |
120 Syntax: |
121 | **vmm userpassword** *address* [*password*] |
121 | **vmm userpassword** *address* [**-p** *password*] |
122 | **vmm up** *address* [*password*] |
122 | **vmm up** *address* [**-p** *password*] |
123 |
123 |
124 The password of an account can be updated with this subcommand. |
124 The password of an account can be updated with this subcommand. |
125 |
125 |
126 If no *password* was provided, :command:`vmm` will prompt for it interactively. |
126 If no *password* was provided, :command:`vmm` will prompt for it interactively. |
127 |
127 |
128 Example: |
128 Example: |
129 |
129 |
130 .. code-block:: console |
130 .. code-block:: console |
131 |
131 |
132 root@host:~# vmm up d.user@example.com "A |\/|0r3 5ecur3 P4s5\/\/0rd?" |
132 root@host:~# vmm up d.user@example.com -p "A |\/|0r3 5ecur3 P4s5\/\/0rd?" |
133 |
133 |
134 userquota |
134 userquota |
135 --------- |
135 --------- |
136 Syntax: |
136 Syntax: |
137 | **vmm userquota** *address storage* [*messages*] |
137 | **vmm userquota** *address storage* [**-m** *messages*] |
138 | **vmm uq** *address storage* [*messages*] |
138 | **vmm uq** *address storage* [**-m** *messages*] |
139 |
139 |
140 This subcommand is used to set a new quota limit for the given account. |
140 This subcommand is used to set a new quota limit for the given account. |
141 |
141 |
142 When the argument *messages* was omitted the default number of messages |
142 When the argument *messages* was omitted the default number of messages |
143 **0** (zero) will be applied. |
143 **0** (zero) will be applied. |
144 |
144 |
145 Instead of *storage* pass **domain** to remove the account-specific |
145 Instead of a *storage* limit pass the keyword **domain** to remove the |
146 override, causing the domain's value to be in effect. |
146 account-specific override, causing the domain's value to be in effect. |
147 |
147 |
148 Example: |
148 Example: |
149 |
149 |
150 .. code-block:: console |
150 .. code-block:: console |
151 |
151 |
154 .. versionadded:: 0.6.0 |
154 .. versionadded:: 0.6.0 |
155 |
155 |
156 userservices |
156 userservices |
157 ------------ |
157 ------------ |
158 Syntax: |
158 Syntax: |
159 | **vmm userservices** *address* [*service ...*] |
159 | **vmm userservices** *address* [**-s** *service ...*] |
160 | **vmm us** *address* [*service ...*] |
160 | **vmm us** *address* [**-s** *service ...*] |
161 |
161 |
162 To grant a user access to the specified services, use this command. |
162 To grant a user access to the specified services, use this command. |
163 |
163 |
164 All omitted services will be deactivated/unusable for the user with the |
164 All omitted services will be deactivated/unusable for the user with the |
165 given *address*. |
165 given *address*. |
166 |
166 |
167 Instead of *service* pass **domain** to remove the account-specific override, |
167 Instead of any *service* pass the keyword **domain** to remove the |
168 causing the domain's value to be in effect. |
168 account-specific override, causing the domain's value to be in effect. |
169 |
169 |
170 Example: |
170 Example: |
171 |
171 |
172 .. code-block:: console |
172 .. code-block:: console |
173 |
173 |
174 root@host:~# userservices d.user@example.com SMTP IMAP |
174 root@host:~# userservices d.user@example.com -s smtp imap |
175 |
175 |
176 .. _usertransport: |
176 .. _usertransport: |
177 |
177 |
178 usertransport |
178 usertransport |
179 ------------- |
179 ------------- |