Home | History | Annotate | Line # | Download | only in conf
aliases revision 1.1.1.5
      1      1.1      tron #
      2      1.1      tron # Sample aliases file. Install in the location as specified by the
      3      1.1      tron # output from the command "postconf alias_maps". Typical path names
      4      1.1      tron # are /etc/aliases or /etc/mail/aliases.
      5      1.1      tron #
      6      1.1      tron #	>>>>>>>>>>      The program "newaliases" must be run after
      7      1.1      tron #	>> NOTE >>      this file is updated for any changes to
      8      1.1      tron #	>>>>>>>>>>      show through to Postfix.
      9      1.1      tron #
     10      1.1      tron 
     11      1.1      tron # Person who should get root's mail. Don't receive mail as root!
     12      1.1      tron #root:		you
     13      1.1      tron 
     14      1.1      tron # Basic system aliases -- these MUST be present
     15      1.1      tron MAILER-DAEMON:	postmaster
     16      1.1      tron postmaster:	root
     17      1.1      tron 
     18      1.1      tron # General redirections for pseudo accounts
     19      1.1      tron bin:		root
     20      1.1      tron daemon:		root
     21      1.1      tron named:		root
     22      1.1      tron nobody:		root
     23      1.1      tron uucp:		root
     24      1.1      tron www:		root
     25      1.1      tron ftp-bugs:	root
     26      1.1      tron postfix:	root
     27      1.1      tron 
     28      1.1      tron # Put your local aliases here.
     29      1.1      tron 
     30      1.1      tron # Well-known aliases
     31      1.1      tron manager:	root
     32      1.1      tron dumper:		root
     33      1.1      tron operator:	root
     34      1.1      tron abuse:		postmaster
     35      1.1      tron 
     36      1.1      tron # trap decode to catch security attacks
     37      1.1      tron decode:		root
     38      1.1      tron 
     39      1.1      tron # ALIASES(5)                                                          ALIASES(5)
     40      1.1      tron # 
     41      1.1      tron # NAME
     42      1.1      tron #        aliases - Postfix local alias database format
     43      1.1      tron # 
     44      1.1      tron # SYNOPSIS
     45      1.1      tron #        newaliases
     46      1.1      tron # 
     47      1.1      tron # DESCRIPTION
     48      1.1      tron #        The  aliases(5)  table provides a system-wide mechanism to
     49      1.1      tron #        redirect mail for local recipients. The  redirections  are
     50      1.1      tron #        processed by the Postfix local(8) delivery agent.
     51      1.1      tron # 
     52      1.1      tron #        Normally, the aliases(5) table is specified as a text file
     53      1.1      tron #        that serves as input  to  the  postalias(1)  command.  The
     54      1.1      tron #        result,  an  indexed file in dbm or db format, is used for
     55      1.1      tron #        fast lookup  by  the  mail  system.  Execute  the  command
     56      1.1      tron #        newaliases  in  order  to  rebuild  the indexed file after
     57      1.1      tron #        changing the Postfix alias database.
     58      1.1      tron # 
     59  1.1.1.2      tron #        When the table is provided via other means  such  as  NIS,
     60  1.1.1.2      tron #        LDAP  or  SQL,  the  same lookups are done as for ordinary
     61  1.1.1.2      tron #        indexed files.
     62  1.1.1.2      tron # 
     63  1.1.1.3  christos #        Alternatively, the  table  can  be  provided  as  a  regu-
     64  1.1.1.3  christos #        lar-expression  map  where  patterns  are given as regular
     65  1.1.1.3  christos #        expressions. In this case,  the  lookups  are  done  in  a
     66  1.1.1.3  christos #        slightly  different  way as described below under "REGULAR
     67  1.1.1.3  christos #        EXPRESSION TABLES".
     68      1.1      tron # 
     69      1.1      tron #        Users can control delivery of their own mail by setting up
     70      1.1      tron #        .forward files in their home directory.  Lines in per-user
     71      1.1      tron #        .forward files have the same syntax as the right-hand side
     72      1.1      tron #        of aliases(5) entries.
     73      1.1      tron # 
     74      1.1      tron #        The format of the alias database input file is as follows:
     75      1.1      tron # 
     76      1.1      tron #        o      An alias definition has the form
     77      1.1      tron # 
     78      1.1      tron #                    name: value1, value2, ...
     79      1.1      tron # 
     80      1.1      tron #        o      Empty lines and whitespace-only lines are  ignored,
     81      1.1      tron #               as  are  lines whose first non-whitespace character
     82      1.1      tron #               is a `#'.
     83      1.1      tron # 
     84      1.1      tron #        o      A logical line starts with non-whitespace  text.  A
     85      1.1      tron #               line  that starts with whitespace continues a logi-
     86      1.1      tron #               cal line.
     87      1.1      tron # 
     88      1.1      tron #        The name is a local address (no domain part).  Use  double
     89      1.1      tron #        quotes  when the name contains any special characters such
     90      1.1      tron #        as whitespace, `#', `:', or `@'. The  name  is  folded  to
     91      1.1      tron #        lowercase, in order to make database lookups case insensi-
     92      1.1      tron #        tive.
     93      1.1      tron # 
     94  1.1.1.4  christos #        In addition, when an alias  exists  for  owner-name,  this
     95  1.1.1.4  christos #        will  override the envelope sender address, so that deliv-
     96  1.1.1.4  christos #        ery diagnostics are directed to owner-name, instead of the
     97  1.1.1.4  christos #        originator    of    the    message   (for   details,   see
     98  1.1.1.4  christos #        owner_request_special,       expand_owner_alias        and
     99  1.1.1.4  christos #        reset_owner_alias).   This  is  typically  used  to direct
    100  1.1.1.4  christos #        delivery errors to the maintainer of a mailing  list,  who
    101  1.1.1.4  christos #        is in a better position to deal with mailing list delivery
    102  1.1.1.4  christos #        problems than the originator of the undelivered mail.
    103      1.1      tron # 
    104      1.1      tron #        The value contains one or more of the following:
    105      1.1      tron # 
    106      1.1      tron #        address
    107      1.1      tron #               Mail is forwarded to address, which  is  compatible
    108      1.1      tron #               with the RFC 822 standard.
    109      1.1      tron # 
    110      1.1      tron #        /file/name
    111  1.1.1.5  christos #               Mail  is appended to /file/name. For details on how
    112  1.1.1.5  christos #               a file is written see the sections  "EXTERNAL  FILE
    113  1.1.1.5  christos #               DELIVERY"  and  "DELIVERY  RIGHTS"  in the local(8)
    114  1.1.1.5  christos #               documentation.  Delivery is not limited to  regular
    115  1.1.1.5  christos #               files.   For  example, to dispose of unwanted mail,
    116  1.1.1.5  christos #               deflect it to /dev/null.
    117      1.1      tron # 
    118      1.1      tron #        |command
    119      1.1      tron #               Mail is piped into command. Commands  that  contain
    120      1.1      tron #               special  characters,  such as whitespace, should be
    121  1.1.1.5  christos #               enclosed between double quotes. For details on  how
    122  1.1.1.5  christos #               a  command is executed see "EXTERNAL COMMAND DELIV-
    123  1.1.1.5  christos #               ERY" and "DELIVERY RIGHTS" in the local(8) documen-
    124  1.1.1.5  christos #               tation.
    125      1.1      tron # 
    126      1.1      tron #               When the command fails, a limited amount of command
    127      1.1      tron #               output is mailed back  to  the  sender.   The  file
    128      1.1      tron #               /usr/include/sysexits.h  defines  the expected exit
    129      1.1      tron #               status codes. For example, use "|exit 67" to  simu-
    130      1.1      tron #               late  a  "user  unknown"  error,  and  "|exit 0" to
    131      1.1      tron #               implement an expensive black hole.
    132      1.1      tron # 
    133      1.1      tron #        :include:/file/name
    134      1.1      tron #               Mail is sent to  the  destinations  listed  in  the
    135      1.1      tron #               named file.  Lines in :include: files have the same
    136      1.1      tron #               syntax as the right-hand side of alias entries.
    137      1.1      tron # 
    138      1.1      tron #               A  destination  can  be  any  destination  that  is
    139      1.1      tron #               described in this manual page. However, delivery to
    140      1.1      tron #               "|command" and /file/name is disallowed by default.
    141      1.1      tron #               To  enable,  edit  the  allow_mail_to_commands  and
    142      1.1      tron #               allow_mail_to_files configuration parameters.
    143      1.1      tron # 
    144      1.1      tron # ADDRESS EXTENSION
    145      1.1      tron #        When alias database search fails, and the recipient local-
    146      1.1      tron #        part  contains  the  optional  recipient  delimiter (e.g.,
    147      1.1      tron #        user+foo), the  search  is  repeated  for  the  unextended
    148      1.1      tron #        address (e.g., user).
    149      1.1      tron # 
    150      1.1      tron #        The   propagate_unmatched_extensions   parameter  controls
    151      1.1      tron #        whether an unmatched address extension  (+foo)  is  propa-
    152      1.1      tron #        gated to the result of table lookup.
    153      1.1      tron # 
    154      1.1      tron # CASE FOLDING
    155      1.1      tron #        The local(8) delivery agent always folds the search string
    156      1.1      tron #        to lowercase before database lookup.
    157      1.1      tron # 
    158  1.1.1.2      tron # REGULAR EXPRESSION TABLES
    159  1.1.1.2      tron #        This section describes how the table lookups  change  when
    160  1.1.1.2      tron #        the table is given in the form of regular expressions. For
    161  1.1.1.2      tron #        a description of regular expression lookup  table  syntax,
    162  1.1.1.2      tron #        see  regexp_table(5) or pcre_table(5). NOTE: these formats
    163  1.1.1.2      tron #        do not use ":" at the end of a pattern.
    164  1.1.1.2      tron # 
    165  1.1.1.2      tron #        Each regular expression is applied to  the  entire  search
    166  1.1.1.2      tron #        string.  Thus,  a  search string user+foo is not broken up
    167  1.1.1.2      tron #        into user and foo.
    168  1.1.1.2      tron # 
    169  1.1.1.2      tron #        Regular expressions are applied in the order as  specified
    170  1.1.1.2      tron #        in  the  table,  until  a regular expression is found that
    171  1.1.1.2      tron #        matches the search string.
    172  1.1.1.2      tron # 
    173  1.1.1.2      tron #        Lookup results are the same as with indexed file  lookups.
    174  1.1.1.2      tron #        For  security  reasons there is no support for $1, $2 etc.
    175  1.1.1.2      tron #        substring interpolation.
    176  1.1.1.2      tron # 
    177      1.1      tron # SECURITY
    178      1.1      tron #        The local(8) delivery agent disallows  regular  expression
    179      1.1      tron #        substitution  of $1 etc. in alias_maps, because that would
    180      1.1      tron #        open a security hole.
    181      1.1      tron # 
    182      1.1      tron #        The local(8) delivery agent will silently ignore  requests
    183      1.1      tron #        to  use  the proxymap(8) server within alias_maps. Instead
    184      1.1      tron #        it will open the table directly.  Before  Postfix  version
    185      1.1      tron #        2.2,  the  local(8)  delivery  agent will terminate with a
    186      1.1      tron #        fatal error.
    187      1.1      tron # 
    188      1.1      tron # CONFIGURATION PARAMETERS
    189      1.1      tron #        The following main.cf parameters are especially  relevant.
    190      1.1      tron #        The  text  below  provides  only  a parameter summary. See
    191      1.1      tron #        postconf(5) for more details including examples.
    192      1.1      tron # 
    193  1.1.1.4  christos #        alias_database (see 'postconf -d' output)
    194  1.1.1.4  christos #               The alias databases for local(8) delivery that  are
    195  1.1.1.4  christos #               updated with "newaliases" or with "sendmail -bi".
    196  1.1.1.4  christos # 
    197  1.1.1.4  christos #        alias_maps (see 'postconf -d' output)
    198  1.1.1.4  christos #               The  alias  databases  that  are  used for local(8)
    199  1.1.1.4  christos #               delivery.
    200  1.1.1.4  christos # 
    201  1.1.1.4  christos #        allow_mail_to_commands (alias, forward)
    202  1.1.1.4  christos #               Restrict local(8) mail delivery  to  external  com-
    203  1.1.1.4  christos #               mands.
    204  1.1.1.4  christos # 
    205  1.1.1.4  christos #        allow_mail_to_files (alias, forward)
    206  1.1.1.4  christos #               Restrict  local(8) mail delivery to external files.
    207  1.1.1.4  christos # 
    208  1.1.1.4  christos #        expand_owner_alias (no)
    209  1.1.1.4  christos #               When delivering to an alias "aliasname" that has an
    210  1.1.1.4  christos #               "owner-aliasname" companion alias, set the envelope
    211  1.1.1.4  christos #               sender   address   to   the   expansion   of    the
    212  1.1.1.4  christos #               "owner-aliasname" alias.
    213  1.1.1.4  christos # 
    214  1.1.1.4  christos #        propagate_unmatched_extensions (canonical, virtual)
    215  1.1.1.4  christos #               What  address  lookup tables copy an address exten-
    216  1.1.1.4  christos #               sion from the lookup key to the lookup result.
    217  1.1.1.4  christos # 
    218  1.1.1.4  christos #        owner_request_special (yes)
    219  1.1.1.4  christos #               Enable special treatment for owner-listname entries
    220  1.1.1.4  christos #               in the aliases(5) file, and don't split owner-list-
    221  1.1.1.4  christos #               name and listname-request address  localparts  when
    222  1.1.1.4  christos #               the recipient_delimiter is set to "-".
    223  1.1.1.4  christos # 
    224  1.1.1.4  christos #        recipient_delimiter (empty)
    225  1.1.1.5  christos #               The  set  of  characters that can separate an email
    226  1.1.1.5  christos #               address localpart, user name, or  a  .forward  file
    227  1.1.1.5  christos #               name from its extension.
    228      1.1      tron # 
    229      1.1      tron #        Available in Postfix version 2.3 and later:
    230      1.1      tron # 
    231  1.1.1.4  christos #        frozen_delivered_to (yes)
    232  1.1.1.5  christos #               Update  the  local(8)  delivery agent's idea of the
    233  1.1.1.5  christos #               Delivered-To:    address    (see     prepend_deliv-
    234  1.1.1.5  christos #               ered_header)  only once, at the start of a delivery
    235  1.1.1.5  christos #               attempt; do not update  the  Delivered-To:  address
    236  1.1.1.4  christos #               while expanding aliases or .forward files.
    237      1.1      tron # 
    238      1.1      tron # STANDARDS
    239      1.1      tron #        RFC 822 (ARPA Internet Text Messages)
    240      1.1      tron # 
    241      1.1      tron # SEE ALSO
    242      1.1      tron #        local(8), local delivery agent
    243      1.1      tron #        newaliases(1), create/update alias database
    244      1.1      tron #        postalias(1), create/update alias database
    245      1.1      tron #        postconf(5), configuration parameters
    246      1.1      tron # 
    247      1.1      tron # README FILES
    248  1.1.1.5  christos #        Use  "postconf  readme_directory" or "postconf html_direc-
    249      1.1      tron #        tory" to locate this information.
    250      1.1      tron #        DATABASE_README, Postfix lookup table overview
    251      1.1      tron # 
    252      1.1      tron # LICENSE
    253  1.1.1.5  christos #        The Secure Mailer license must be  distributed  with  this
    254      1.1      tron #        software.
    255      1.1      tron # 
    256      1.1      tron # AUTHOR(S)
    257      1.1      tron #        Wietse Venema
    258      1.1      tron #        IBM T.J. Watson Research
    259      1.1      tron #        P.O. Box 704
    260      1.1      tron #        Yorktown Heights, NY 10598, USA
    261      1.1      tron # 
    262  1.1.1.3  christos #        Wietse Venema
    263  1.1.1.3  christos #        Google, Inc.
    264  1.1.1.3  christos #        111 8th Avenue
    265  1.1.1.3  christos #        New York, NY 10011, USA
    266  1.1.1.3  christos # 
    267      1.1      tron #                                                                     ALIASES(5)
    268