home *** CD-ROM | disk | FTP | other *** search
/ chilidog.highland.cc.ks.us / chilidog.highland.cc.ks.us.zip / chilidog.highland.cc.ks.us / backup / bradford.20110725.etc.tar.gz / bradford.20110725.etc.tar / etc / postfix / virtual < prev    next >
Text File  |  2006-05-02  |  12KB  |  280 lines
  1. # VIRTUAL(5)                                                          VIRTUAL(5)
  2. # 
  3. # NAME
  4. #        virtual - Postfix virtual alias table format
  5. # 
  6. # SYNOPSIS
  7. #        postmap /etc/postfix/virtual
  8. # 
  9. #        postmap -q "string" /etc/postfix/virtual
  10. # 
  11. #        postmap -q - /etc/postfix/virtual <inputfile
  12. # 
  13. # DESCRIPTION
  14. #        The  optional  virtual(5)  alias  table rewrites recipient
  15. #        addresses for all local, virtual and remote mail  destina-
  16. #        tions.   This is unlike the aliases(5) table which is used
  17. #        only for local(8) delivery.  Virtual  aliasing  is  recur-
  18. #        sive,  and is implemented by the Postfix cleanup(8) daemon
  19. #        before mail is queued.
  20. # 
  21. #        The main applications of virtual aliasing are:
  22. # 
  23. #        o      To redirect mail for one address  to  one  or  more
  24. #               addresses.
  25. # 
  26. #        o      To   implement  virtual  alias  domains  where  all
  27. #               addresses  are  aliased  to  addresses   in   other
  28. #               domains.
  29. # 
  30. #               Virtual  alias  domains are not to be confused with
  31. #               the virtual mailbox domains  that  are  implemented
  32. #               with  the  Postfix  virtual(8) mail delivery agent.
  33. #               With  virtual  mailbox  domains,   each   recipient
  34. #               address can have its own mailbox.
  35. # 
  36. #        Virtual  aliasing  is  applied  only to recipient envelope
  37. #        addresses, and does not  affect  message  headers.   Think
  38. #        Sendmail  rule  set S0, if you like. Use canonical(5) map-
  39. #        ping to rewrite header and envelope addresses in  general.
  40. # 
  41. #        Normally,  the  virtual(5)  alias  table is specified as a
  42. #        text file that serves as input to the postmap(1)  command.
  43. #        The  result,  an indexed file in dbm or db format, is used
  44. #        for fast searching by the mail system. Execute the command
  45. #        "postmap  /etc/postfix/virtual"  in  order  to rebuild the
  46. #        indexed file after changing the text file.
  47. # 
  48. #        When the table is provided via other means  such  as  NIS,
  49. #        LDAP  or  SQL,  the  same lookups are done as for ordinary
  50. #        indexed files.
  51. # 
  52. #        Alternatively, the table can be  provided  as  a  regular-
  53. #        expression map where patterns are given as regular expres-
  54. #        sions, or lookups can be directed to TCP-based server.  In
  55. #        that  case,  the  lookups are done in a slightly different
  56. #        way as described below under "REGULAR  EXPRESSION  TABLES"
  57. #        and "TCP-BASED TABLES".
  58. # 
  59. # TABLE FORMAT
  60. #        The input format for the postmap(1) command is as follows:
  61. # 
  62. #        pattern result
  63. #               When pattern matches a mail address, replace it  by
  64. #               the corresponding result.
  65. # 
  66. #        blank lines and comments
  67. #               Empty  lines and whitespace-only lines are ignored,
  68. #               as are lines whose first  non-whitespace  character
  69. #               is a `#'.
  70. # 
  71. #        multi-line text
  72. #               A  logical  line starts with non-whitespace text. A
  73. #               line that starts with whitespace continues a  logi-
  74. #               cal line.
  75. # 
  76. # TABLE SEARCH ORDER
  77. #        With lookups from indexed files such as DB or DBM, or from
  78. #        networked tables such as NIS, LDAP or  SQL,  patterns  are
  79. #        tried in the order as listed below:
  80. # 
  81. #        user@domain address, address, ...
  82. #               Redirect  mail  for  user@domain  to address.  This
  83. #               form has the highest precedence.
  84. # 
  85. #        user address, address, ...
  86. #               Redirect mail for user@site to address when site is
  87. #               equal  to $myorigin, when site is listed in $mydes-
  88. #               tination, or when it is listed in  $inet_interfaces
  89. #               or $proxy_interfaces.
  90. # 
  91. #               This  functionality  overlaps with functionality of
  92. #               the local aliases(5) database.  The  difference  is
  93. #               that virtual(5) mapping can be applied to non-local
  94. #               addresses.
  95. # 
  96. #        @domain address, address, ...
  97. #               Redirect mail for other users in domain to address.
  98. #               This form has the lowest precedence.
  99. # 
  100. # RESULT ADDRESS REWRITING
  101. #        The lookup result is subject to address rewriting:
  102. # 
  103. #        o      When  the  result  has  the  form @otherdomain, the
  104. #               result becomes the same user in otherdomain.   This
  105. #               works only for the first address in a multi-address
  106. #               lookup result.
  107. # 
  108. #        o      When "append_at_myorigin=yes", append  "@$myorigin"
  109. #               to addresses without "@domain".
  110. # 
  111. #        o      When "append_dot_mydomain=yes", append ".$mydomain"
  112. #               to addresses without ".domain".
  113. # 
  114. # ADDRESS EXTENSION
  115. #        When a mail address localpart contains the optional recip-
  116. #        ient  delimiter  (e.g., user+foo@domain), the lookup order
  117. #        becomes: user+foo@domain, user@domain, user+foo, user, and
  118. #        @domain.
  119. # 
  120. #        The   propagate_unmatched_extensions   parameter  controls
  121. #        whether an unmatched address extension  (+foo)  is  propa-
  122. #        gated to the result of table lookup.
  123. # 
  124. # VIRTUAL ALIAS DOMAINS
  125. #        Besides  virtual aliases, the virtual alias table can also
  126. #        be used to implement virtual alias domains. With a virtual
  127. #        alias  domain,  all  recipient  addresses  are  aliased to
  128. #        addresses in other domains.
  129. # 
  130. #        Virtual alias domains are not to be confused with the vir-
  131. #        tual mailbox domains that are implemented with the Postfix
  132. #        virtual(8)  mail  delivery  agent.  With  virtual  mailbox
  133. #        domains,  each recipient address can have its own mailbox.
  134. # 
  135. #        With a virtual alias domain, the virtual  domain  has  its
  136. #        own  user  name  space. Local (i.e. non-virtual) usernames
  137. #        are not visible in a virtual alias domain. In  particular,
  138. #        local  aliases(5)  and local mailing lists are not visible
  139. #        as localname@virtual-alias.domain.
  140. # 
  141. #        Support for a virtual alias domain looks like:
  142. # 
  143. #        /etc/postfix/main.cf:
  144. #            virtual_alias_maps = hash:/etc/postfix/virtual
  145. # 
  146. #            Note: some systems use dbm databases instead of  hash.
  147. #            See  the output from "postconf -m" for available data-
  148. #            base types.
  149. # 
  150. #        /etc/postfix/virtual:
  151. #            virtual-alias.domain anything (right-hand content does not matter)
  152. #            postmaster@virtual-alias.domain      postmaster
  153. #            user1@virtual-alias.domain   address1
  154. #            user2@virtual-alias.domain   address2, address3
  155. # 
  156. #        The virtual-alias.domain anything entry is required for  a
  157. #        virtual alias domain. Without this entry, mail is rejected
  158. #        with "relay access denied", or bounces  with  "mail  loops
  159. #        back to myself".
  160. # 
  161. #        Do  not  specify virtual alias domain names in the main.cf
  162. #        mydestination or relay_domains configuration parameters.
  163. # 
  164. #        With a virtual  alias  domain,  the  Postfix  SMTP  server
  165. #        accepts   mail  for  known-user@virtual-alias.domain,  and
  166. #        rejects  mail  for  unknown-user@virtual-alias.domain   as
  167. #        undeliverable.
  168. # 
  169. #        Instead  of  specifying  the virtual alias domain name via
  170. #        the virtual_alias_maps table, you may also specify it  via
  171. #        the main.cf virtual_alias_domains configuration parameter.
  172. #        This latter parameter uses the same syntax as the  main.cf
  173. #        mydestination configuration parameter.
  174. # 
  175. # REGULAR EXPRESSION TABLES
  176. #        This  section  describes how the table lookups change when
  177. #        the table is given in the form of regular expressions. For
  178. #        a  description  of regular expression lookup table syntax,
  179. #        see regexp_table(5) or pcre_table(5).
  180. # 
  181. #        Each pattern is a regular expression that  is  applied  to
  182. #        the entire address being looked up. Thus, user@domain mail
  183. #        addresses are not broken up into their  user  and  @domain
  184. #        constituent parts, nor is user+foo broken up into user and
  185. #        foo.
  186. # 
  187. #        Patterns are applied in the order as specified in the  ta-
  188. #        ble,  until  a  pattern  is  found that matches the search
  189. #        string.
  190. # 
  191. #        Results are the same as with indexed  file  lookups,  with
  192. #        the  additional feature that parenthesized substrings from
  193. #        the pattern can be interpolated as $1, $2 and so on.
  194. # 
  195. # TCP-BASED TABLES
  196. #        This section describes how the table lookups  change  when
  197. #        lookups are directed to a TCP-based server. For a descrip-
  198. #        tion of the TCP client/server lookup protocol, see tcp_ta-
  199. #        ble(5).  This feature is not available up to and including
  200. #        Postfix version 2.2.
  201. # 
  202. #        Each lookup operation uses the entire address once.  Thus,
  203. #        user@domain  mail  addresses  are not broken up into their
  204. #        user and @domain constituent parts, nor is user+foo broken
  205. #        up into user and foo.
  206. # 
  207. #        Results are the same as with indexed file lookups.
  208. # 
  209. # BUGS
  210. #        The  table format does not understand quoting conventions.
  211. # 
  212. # CONFIGURATION PARAMETERS
  213. #        The following main.cf parameters are  especially  relevant
  214. #        to  this  topic.  See  the Postfix main.cf file for syntax
  215. #        details and for default values. Use the  "postfix  reload"
  216. #        command after a configuration change.
  217. # 
  218. #        virtual_alias_maps
  219. #               List of virtual aliasing tables.
  220. # 
  221. #        virtual_alias_domains
  222. #               List  of  virtual alias domains. This uses the same
  223. #               syntax as the mydestination parameter.
  224. # 
  225. #        propagate_unmatched_extensions
  226. #               A list of address rewriting  or  forwarding  mecha-
  227. #               nisms  that propagate an address extension from the
  228. #               original address to the result.   Specify  zero  or
  229. #               more   of   canonical,   virtual,  alias,  forward,
  230. #               include, or generic.
  231. # 
  232. #        Other parameters of interest:
  233. # 
  234. #        inet_interfaces
  235. #               The network interface addresses  that  this  system
  236. #               receives mail on.  You need to stop and start Post-
  237. #               fix when this parameter changes.
  238. # 
  239. #        mydestination
  240. #               List of domains that  this  mail  system  considers
  241. #               local.
  242. # 
  243. #        myorigin
  244. #               The  domain  that  is  appended to any address that
  245. #               does not have a domain.
  246. # 
  247. #        owner_request_special
  248. #               Give special treatment to owner-xxx and xxx-request
  249. #               addresses.
  250. # 
  251. #        proxy_interfaces
  252. #               Other interfaces that this machine receives mail on
  253. #               by way of a proxy agent or network address transla-
  254. #               tor.
  255. # 
  256. # SEE ALSO
  257. #        cleanup(8), canonicalize and enqueue mail
  258. #        postmap(1), Postfix lookup table manager
  259. #        postconf(5), configuration parameters
  260. #        canonical(5), canonical address mapping
  261. # 
  262. # README FILES
  263. #        Use  "postconf  readme_directory" or "postconf html_direc-
  264. #        tory" to locate this information.
  265. #        DATABASE_README, Postfix lookup table overview
  266. #        ADDRESS_REWRITING_README, address rewriting guide
  267. #        VIRTUAL_README, domain hosting guide
  268. # 
  269. # LICENSE
  270. #        The Secure Mailer license must be  distributed  with  this
  271. #        software.
  272. # 
  273. # AUTHOR(S)
  274. #        Wietse Venema
  275. #        IBM T.J. Watson Research
  276. #        P.O. Box 704
  277. #        Yorktown Heights, NY 10598, USA
  278. # 
  279. #                                                                     VIRTUAL(5)
  280.