Using vmm

vmm is the easy to use command-line tool of the Virtual Mail Manager. It allows you to simply and quickly administer your mail server. The general command syntax looks like:

vmm -h|-v|--help|--version
vmm subcommand -h|--help
vmm subcommand arguments [options]

Each subcommand has both a long and a short form. Both forms are case sensitive. The subcommands are categorized by their functionality:

Most of the subcommands take one or more arguments.


The following options are recognized by vmm.

-h, --help

show a list of available subcommands and exit.

-v, --version

show vmm’s version and copyright information and exit.



The complete e-mail address (local-part@fqdn) of an user account, alias address or relocated user.


Is either an e-mail address when used with Alias subcommands. Or a fqdn when used with Alias domain subcommands.


The fully qualified domain name – without the trailing dot – of a domain or alias domain.


An integer value which specifies a quota limit in number of messages. 0 (zero) means unlimited - no quota limit for the number of messages.


Is the name of a configuration option, prefixed with the section name and a dot. For example: misc.transport All configuration options are described in vmm.cfg(5).


The name of a service, commonly used with Dovecot. Supported services are: imap, pop3, sieve and smtp.


Specifies a quota limit in bytes. One of the following prefixes can be appended to the integer value: b (bytes), k (kilobytes), M (megabytes) or G (gigabytes). 0 (zero) means unlimited - no quota limit in bytes.


A transport for Postfix, written as: transport: or transport:nexthop. See transport(5) for more details.


vmm reads its configuration data from vmm.cfg.


will be used when found.


will be used when the above file doesn’t exist.


will be used when none of the both above mentioned files exists.