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 subcommand [argument …]

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.

Arguments

address
The complete e-mail address (local-part@fqdn) of an user account, alias address or relocated user.
destination
Is either an e-mail address when used with Alias subcommands. Or a fqnd when used with Alias domain subcommands.
fqdn
The fully qualified domain name – without the trailing dot – of a domain or alias domain.
messages
An integer value which specifies a quota limit in number of messages. 0 (zero) means unlimited - no quota limit for the number of messages.
option
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).
service
The name of a service, commonly used with Dovecot. Supported services are: imap, pop3, sieve and smtp.
storage
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.
transport
A transport for Postfix, written as: transport: or transport:nexthop. See transport(5) for more details.

Files

vmm reads its configuration data from vmm.cfg.

/root/vmm.cfg
will be used when found.
/usr/local/etc/vmm.cfg
will be used when the above file doesn’t exist.
/etc/vmm.cfg
will be used when none of the both above mentioned files exists.

Table Of Contents

Previous topic

Upgrading to vmm 0.5.x

Next topic

General subcommands