|
1 ============================ |
|
2 vmm - a virtual mail manager |
|
3 ============================ |
|
4 |
|
5 Welcome to vmm! |
|
6 |
|
7 vmm is the easy to use command line tool for administrators and postmasters, |
|
8 to manage domains, alias-domains, accounts and relocated mail users. It allows |
|
9 the fast and easy management of mail servers. |
|
10 |
|
11 vmm is written in Python_. It's designed for installations using Dovecot_ and |
|
12 Postfix_ with a PostgreSQL_ backend. |
|
13 |
|
14 Features |
|
15 ======== |
|
16 • General features |
|
17 |
|
18 ‣ Unicode/UTF-8 capable (input/storage/output) |
|
19 ‣ supports IDN_ |
|
20 ‣ supports the mailbox format Maildir_ and Dovecot's own high-performance |
|
21 mailbox formats single- and multi-\ dbox_ |
|
22 ‣ configurable basic mailbox structure, including sub-mailboxes |
|
23 ‣ multilingual (currently: Dutch, English, French and German) |
|
24 |
|
25 • Domain features |
|
26 |
|
27 ‣ configurable transport setting per domain |
|
28 ‣ unique group identifier (GID) per domain |
|
29 ‣ each domain may have one or more alias domain names |
|
30 ‣ configurable quota limits (size and/or number of messages) for the |
|
31 domain's accounts |
|
32 ‣ supports relocated users |
|
33 ‣ the postmaster account can be created automatically when a new domain is |
|
34 created |
|
35 |
|
36 • Alias domain features |
|
37 |
|
38 ‣ alias domain names can be switched between domains |
|
39 |
|
40 • Account features |
|
41 |
|
42 ‣ configurable transport per account |
|
43 ‣ activate or deactivate one/more/all services (SMTP, POP, IMAP and |
|
44 ManageSieve) per account |
|
45 ‣ configurable quota limit (size and/or number of messages) per user |
|
46 ‣ unique user identifier (UID) per user |
|
47 |
|
48 • Alias features |
|
49 |
|
50 ‣ supports multiple destinations per e-mail alias |
|
51 ‣ destinations can be deleted separately |
|
52 |
|
53 Source code |
|
54 =========== |
|
55 vmm's source code is available from the Mercurial_ repositories: |
|
56 |
|
57 • main repository |
|
58 |
|
59 ‣ ``http://hg.localdomain.org/vmm`` |
|
60 |
|
61 • mirror repositories |
|
62 |
|
63 ‣ ``https://bitbucket.org/pvo/vmm`` |
|
64 ‣ ``http://vmm.hg.sourceforge.net/hgweb/vmm/vmm`` |
|
65 |
|
66 Released versions are also available as gzip compressed tar archives at: |
|
67 https://sourceforge.net/projects/vmm/files/vmm/ |
|
68 |
|
69 Installation/Upgrade |
|
70 ==================== |
|
71 For installation or upgrading instructions read the `INSTALL` or `UPGRADE` |
|
72 file. |
|
73 |
|
74 License |
|
75 ======= |
|
76 In short: "**New BSD License**" aka "3-clause license". For a few more |
|
77 details see the `COPYING` file. |
|
78 |
|
79 .. External references |
|
80 .. _dbox: http://wiki2.dovecot.org/MailboxFormat/dbox |
|
81 .. _Dovecot: http://dovecot.org/ |
|
82 .. _IDN: http://en.wikipedia.org/wiki/Internationalized_domain_name |
|
83 .. _Maildir: http://wiki2.dovecot.org/MailboxFormat/Maildir |
|
84 .. _Mercurial: http://mercurial.selenic.com/ |
|
85 .. _Postfix: http://www.postfix.org/ |
|
86 .. _PostgreSQL: http://www.postgresql.org/ |
|
87 .. _Python: http://www.python.org/ |