doc/web/source/howto/manage_alias_addresses.rst
author Pascal Volk <user@localhost.localdomain.org>
Sat, 29 Sep 2012 17:13:29 +0000
changeset 622 e60b8ed5fd35
parent 591 2b165e90e225
permissions -rw-r--r--
doc/web: Updated and extended documentation. Updated description of subcommands aliasdelete and catchalldelete. Added description of subcommands listaddresses, listaliases, listrelocated and listusers.

========================
Managing alias addresses
========================
aliasadd
--------
Syntax:
 | **vmm aliasadd** *address destination ...*
 | **vmm aa** *address destination ...*

This subcommand is used to create a new alias *address* with one or more
*destination* addresses.

Within the destination address, the placeholders **%n**, **%d**, and **%=**
will be replaced by the local-part, the domain, or the email address with
**@** replaced by **=** respectively.
In combination with alias domains, this enables domain-specific destinations.

Example:

.. code-block:: console

 root@host:~# vmm aliasadd john.doe@example.com d.user@example.com
 root@host:~# vmm aa support@example.com d.user@example.com e.user@example.com
 root@host:~# vmm aa postmaster@example.com postmaster+%d@example.org

aliasdelete
-----------
Syntax:
 | **vmm aliasdelete** *address* [*destination* ...]
 | **vmm ad** *address* [*destination* ...]

This subcommand is used to delete one or multiple *destination*\ s from the
alias with the given *address*.

When no *destination* address was specified the alias with all its
destinations will be deleted.

Example:

.. code-block:: console

 root@host:~# vmm ad support@example.com d.user@example.com

.. versionchanged:: 0.6.1
   Accept multiple destinations.

aliasinfo
---------
Syntax:
 | **vmm aliasinfo** *address*
 | **vmm ai** *address*

Information about the alias with the given *address* can be displayed with
this subcommand.

Example:

.. code-block:: console

 root@host:~# vmm aliasinfo support@example.com
 Alias information
 -----------------
         Mail for support@example.com will be redirected to:
              * e.user@example.com