doc/web/source/howto/manage_alias_addresses.rst
author Pascal Volk <user@localhost.localdomain.org>
Mon, 27 Jan 2014 21:27:21 +0000
changeset 702 01db2457bbed
parent 622 e60b8ed5fd35
permissions -rw-r--r--
VMM/handler: Improved domaininfo subcommand. Check all labels for ASCII-compatible encoding, not only the first one. If something is in ACE format, convert it to IDNA.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     1
========================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     2
Managing alias addresses
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     3
========================
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     4
aliasadd
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     5
--------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     6
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     7
 | **vmm aliasadd** *address destination ...*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     8
 | **vmm aa** *address destination ...*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
     9
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    10
This subcommand is used to create a new alias *address* with one or more
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    11
*destination* addresses.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    12
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    13
Within the destination address, the placeholders **%n**, **%d**, and **%=**
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    14
will be replaced by the local-part, the domain, or the email address with
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    15
**@** replaced by **=** respectively.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    16
In combination with alias domains, this enables domain-specific destinations.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    17
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    18
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    19
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    20
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    21
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    22
 root@host:~# vmm aliasadd john.doe@example.com d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    23
 root@host:~# vmm aa support@example.com d.user@example.com e.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    24
 root@host:~# vmm aa postmaster@example.com postmaster+%d@example.org
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    25
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    26
aliasdelete
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    27
-----------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    28
Syntax:
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    29
 | **vmm aliasdelete** *address* [*destination* ...]
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    30
 | **vmm ad** *address* [*destination* ...]
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    31
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    32
This subcommand is used to delete one or multiple *destination*\ s from the
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    33
alias with the given *address*.
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    34
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    35
When no *destination* address was specified the alias with all its
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    36
destinations will be deleted.
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    37
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    38
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    39
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    40
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    41
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    42
 root@host:~# vmm ad support@example.com d.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    43
622
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    44
.. versionchanged:: 0.6.1
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    45
   Accept multiple destinations.
e60b8ed5fd35 doc/web: Updated and extended documentation.
Pascal Volk <user@localhost.localdomain.org>
parents: 591
diff changeset
    46
591
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    47
aliasinfo
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    48
---------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    49
Syntax:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    50
 | **vmm aliasinfo** *address*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    51
 | **vmm ai** *address*
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    52
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    53
Information about the alias with the given *address* can be displayed with
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    54
this subcommand.
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    55
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    56
Example:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    57
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    58
.. code-block:: console
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    59
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    60
 root@host:~# vmm aliasinfo support@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    61
 Alias information
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    62
 -----------------
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    63
         Mail for support@example.com will be redirected to:
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    64
              * e.user@example.com
2b165e90e225 doc/web: Added the 'Howto'.
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
    65