1 ================= |
|
2 Managing accounts |
|
3 ================= |
|
4 useradd |
|
5 ------- |
|
6 Syntax: |
|
7 | **vmm useradd** *address* [*password*] |
|
8 | **vmm ua** *address* [*password*] |
|
9 |
|
10 Use this subcommand to create a new e-mail account for the given *address*. |
|
11 |
|
12 If the password is not provided, :command:`vmm` will prompt for it |
|
13 interactively. |
|
14 When no *password* is provided and *account.random_password* is set to |
|
15 **true**, :command:`vmm` will generate a random password and print it to |
|
16 stdout after the account has been created. |
|
17 |
|
18 Example: |
|
19 |
|
20 .. code-block:: console |
|
21 |
|
22 root@host:~# vmm ua d.user@example.com "A 5ecR3t P4s5\/\/0rd" |
|
23 root@host:~# vmm useradd e.user@example.com |
|
24 Enter new password: |
|
25 Retype new password: |
|
26 |
|
27 userdelete |
|
28 ---------- |
|
29 Syntax: |
|
30 | **vmm userdelete** *address* [*force*] |
|
31 | **vmm ud** *address* [*force*] |
|
32 |
|
33 Use this subcommand to delete the account with the given *address*. |
|
34 |
|
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. |
|
37 To prevent this, specify the optional keyword **force**. |
|
38 |
|
39 userinfo |
|
40 -------- |
|
41 Syntax: |
|
42 | **vmm userinfo** *address* [*details*] |
|
43 | **vmm ui** *address* [*details*] |
|
44 |
|
45 This subcommand displays some information about the account specified by |
|
46 *address*. |
|
47 |
|
48 If the optional argument *details* is given some more information will be |
|
49 displayed. |
|
50 Possible values for *details* are: |
|
51 |
|
52 ======= ============================================================== |
|
53 value description |
|
54 ======= ============================================================== |
|
55 aliases to list all alias addresses with the destination *address* |
|
56 du to display the disk usage of the user's mail directory. |
|
57 In order to summarize the disk usage each time this subcommand |
|
58 is executed automatically, set *account.disk_usage* in your |
|
59 :file:`vmm.cfg` to **true**. |
|
60 full to list all information mentioned above |
|
61 ======= ============================================================== |
|
62 |
|
63 Example: |
|
64 |
|
65 .. code-block:: console |
|
66 |
|
67 root@host:~# vmm ui d.user@example.com |
|
68 Account information |
|
69 ------------------- |
|
70 Address..........: d.user@example.com |
|
71 Name.............: None |
|
72 UID..............: 79881 |
|
73 GID..............: 70704 |
|
74 Home.............: /srv/mail/2/70704/79881 |
|
75 Mail_Location....: mdbox:~/mdbox |
|
76 Quota Storage....: [ 0.00%] 0/500.00 MiB [domain default] |
|
77 Quota Messages...: [ 0.00%] 0/10,000 [domain default] |
|
78 Transport........: lmtp:unix:private/dovecot-lmtp [domain default] |
|
79 SMTP.............: disabled [domain default] |
|
80 POP3.............: disabled [domain default] |
|
81 IMAP.............: enabled [domain default] |
|
82 SIEVE............: enabled [domain default] |
|
83 |
|
84 username |
|
85 -------- |
|
86 Syntax: |
|
87 | **vmm username** *address* [*name*] |
|
88 | **vmm un** *address* [*name*] |
|
89 |
|
90 The user's real *name* can be set/updated with this subcommand. |
|
91 |
|
92 If no *name* is given, the value stored for the account is erased. |
|
93 |
|
94 Example: |
|
95 |
|
96 .. code-block:: console |
|
97 |
|
98 root@host:~# vmm un d.user@example.com "John Doe" |
|
99 |
|
100 usernote |
|
101 -------- |
|
102 Syntax: |
|
103 | **vmm usernote** *address* [*note*] |
|
104 | **vmm uo** *address* [*note*] |
|
105 |
|
106 With this subcommand, it is possible to attach a note to the specified |
|
107 account. |
|
108 Without an argument, an existing note is removed. |
|
109 |
|
110 Example: |
|
111 |
|
112 .. code-block:: console |
|
113 |
|
114 root@host:~# vmm uo d.user@example.com Only needed until end of May 2012 |
|
115 |
|
116 .. versionadded:: 0.6.0 |
|
117 |
|
118 userpassword |
|
119 ------------ |
|
120 Syntax: |
|
121 | **vmm userpassword** *address* [*password*] |
|
122 | **vmm up** *address* [*password*] |
|
123 |
|
124 The password of an account can be updated with this subcommand. |
|
125 |
|
126 If no *password* was provided, :command:`vmm` will prompt for it interactively. |
|
127 |
|
128 Example: |
|
129 |
|
130 .. code-block:: console |
|
131 |
|
132 root@host:~# vmm up d.user@example.com "A |\/|0r3 5ecur3 P4s5\/\/0rd?" |
|
133 |
|
134 userquota |
|
135 --------- |
|
136 Syntax: |
|
137 | **vmm userquota** *address storage* [*messages*] |
|
138 | **vmm uq** *address storage* [*messages*] |
|
139 |
|
140 This subcommand is used to set a new quota limit for the given account. |
|
141 |
|
142 When the argument *messages* was omitted the default number of messages |
|
143 **0** (zero) will be applied. |
|
144 |
|
145 Instead of *storage* pass **domain** to remove the account-specific |
|
146 override, causing the domain's value to be in effect. |
|
147 |
|
148 Example: |
|
149 |
|
150 .. code-block:: console |
|
151 |
|
152 root@host:~# userquota d.user@example.com 750m |
|
153 |
|
154 .. versionadded:: 0.6.0 |
|
155 |
|
156 userservices |
|
157 ------------ |
|
158 Syntax: |
|
159 | **vmm userservices** *address* [*service ...*] |
|
160 | **vmm us** *address* [*service ...*] |
|
161 |
|
162 To grant a user access to the specified services, use this command. |
|
163 |
|
164 All omitted services will be deactivated/unusable for the user with the |
|
165 given *address*. |
|
166 |
|
167 Instead of *service* pass **domain** to remove the account-specific override, |
|
168 causing the domain's value to be in effect. |
|
169 |
|
170 Example: |
|
171 |
|
172 .. code-block:: console |
|
173 |
|
174 root@host:~# userservices d.user@example.com SMTP IMAP |
|
175 |
|
176 .. _usertransport: |
|
177 |
|
178 usertransport |
|
179 ------------- |
|
180 Syntax: |
|
181 | **vmm usertransport** *address transport* |
|
182 | **vmm ut** *address transport* |
|
183 |
|
184 A different *transport* for an account can be specified with this subcommand. |
|
185 |
|
186 Instead of *transport* pass **domain** to remove the account-specific |
|
187 override, causing the domain's value to be in effect. |
|
188 |
|
189 Example: |
|
190 |
|
191 .. code-block:: console |
|
192 |
|
193 root@host:~# ut c.user@example.com smtp:[pc105.it.example.com] |
|