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 / generic < prev    next >
Text File  |  2006-05-02  |  10KB  |  235 lines
  1. # GENERIC(5)                                             GENERIC(5)
  2. # 
  3. # NAME
  4. #        generic - Postfix generic table format
  5. # 
  6. # SYNOPSIS
  7. #        postmap /etc/postfix/generic
  8. # 
  9. #        postmap -q "string" /etc/postfix/generic
  10. # 
  11. #        postmap -q - /etc/postfix/generic <inputfile
  12. # 
  13. # DESCRIPTION
  14. #        The optional generic(5) table specifies an address mapping
  15. #        that applies when mail is delivered. This is the  opposite
  16. #        of  canonical(5)  mapping,  which  applies  when  mail  is
  17. #        received.
  18. # 
  19. #        Typically, one would use the generic(5) table on a  system
  20. #        that  does  not have a valid Internet domain name and that
  21. #        uses  something  like  localdomain.local   instead.    The
  22. #        generic(5)  table  is  then  used by the smtp(8) client to
  23. #        transform local mail addresses into  valid  Internet  mail
  24. #        addresses  when  mail  has to be sent across the Internet.
  25. #        See the EXAMPLE section at the end of this document.
  26. # 
  27. #        The  generic(5)  mapping  affects  both   message   header
  28. #        addresses (i.e. addresses that appear inside messages) and
  29. #        message envelope addresses  (for  example,  the  addresses
  30. #        that are used in SMTP protocol commands).
  31. # 
  32. #        Normally, the generic(5) table is specified as a text file
  33. #        that serves as  input  to  the  postmap(1)  command.   The
  34. #        result,  an  indexed file in dbm or db format, is used for
  35. #        fast searching by the mail  system.  Execute  the  command
  36. #        "postmap  /etc/postfix/generic"  in  order  to rebuild the
  37. #        indexed file after changing the text file.
  38. # 
  39. #        When the table is provided via other means  such  as  NIS,
  40. #        LDAP  or  SQL,  the  same lookups are done as for ordinary
  41. #        indexed files.
  42. # 
  43. #        Alternatively, the table can be  provided  as  a  regular-
  44. #        expression map where patterns are given as regular expres-
  45. #        sions, or lookups can be directed to TCP-based server.  In
  46. #        that  case,  the  lookups are done in a slightly different
  47. #        way as described below under "REGULAR  EXPRESSION  TABLES"
  48. #        and "TCP-BASED TABLES".
  49. # 
  50. # TABLE FORMAT
  51. #        The input format for the postmap(1) command is as follows:
  52. # 
  53. #        pattern result
  54. #               When pattern matches a mail address, replace it  by
  55. #               the corresponding result.
  56. # 
  57. #        blank lines and comments
  58. #               Empty  lines and whitespace-only lines are ignored,
  59. #               as are lines whose first  non-whitespace  character
  60. #               is a `#'.
  61. # 
  62. #        multi-line text
  63. #               A  logical  line starts with non-whitespace text. A
  64. #               line that starts with whitespace continues a  logi-
  65. #               cal line.
  66. # 
  67. # TABLE SEARCH ORDER
  68. #        With lookups from indexed files such as DB or DBM, or from
  69. #        networked tables such as NIS, LDAP or  SQL,  patterns  are
  70. #        tried in the order as listed below:
  71. # 
  72. #        user@domain address
  73. #               Replace  user@domain  by address. This form has the
  74. #               highest precedence.
  75. # 
  76. #        user address
  77. #               Replace user@site by address when site is equal  to
  78. #               $myorigin,  when  site is listed in $mydestination,
  79. #               or  when  it  is  listed  in  $inet_interfaces   or
  80. #               $proxy_interfaces.
  81. # 
  82. #        @domain address
  83. #               Replace other addresses in domain by address.  This
  84. #               form has the lowest precedence.
  85. # 
  86. # RESULT ADDRESS REWRITING
  87. #        The lookup result is subject to address rewriting:
  88. # 
  89. #        o      When the result  has  the  form  @otherdomain,  the
  90. #               result becomes the same user in otherdomain.
  91. # 
  92. #        o      When  "append_at_myorigin=yes", append "@$myorigin"
  93. #               to addresses without "@domain".
  94. # 
  95. #        o      When "append_dot_mydomain=yes", append ".$mydomain"
  96. #               to addresses without ".domain".
  97. # 
  98. # ADDRESS EXTENSION
  99. #        When a mail address localpart contains the optional recip-
  100. #        ient delimiter (e.g., user+foo@domain), the  lookup  order
  101. #        becomes: user+foo@domain, user@domain, user+foo, user, and
  102. #        @domain.
  103. # 
  104. #        The  propagate_unmatched_extensions   parameter   controls
  105. #        whether  an  unmatched  address extension (+foo) is propa-
  106. #        gated to the result of table lookup.
  107. # 
  108. # REGULAR EXPRESSION TABLES
  109. #        This section describes how the table lookups  change  when
  110. #        the table is given in the form of regular expressions. For
  111. #        a description of regular expression lookup  table  syntax,
  112. #        see regexp_table(5) or pcre_table(5).
  113. # 
  114. #        Each  pattern  is  a regular expression that is applied to
  115. #        the entire address being looked up. Thus, user@domain mail
  116. #        addresses  are  not  broken up into their user and @domain
  117. #        constituent parts, nor is user+foo broken up into user and
  118. #        foo.
  119. # 
  120. #        Patterns  are  applied  in  the  order as specified in the
  121. #        table, until a pattern is found that  matches  the  search
  122. #        string.
  123. # 
  124. #        Results  are  the  same as with indexed file lookups, with
  125. #        the additional feature that parenthesized substrings  from
  126. #        the pattern can be interpolated as $1, $2 and so on.
  127. # 
  128. # TCP-BASED TABLES
  129. #        This  section  describes how the table lookups change when
  130. #        lookups are directed to a TCP-based server. For a descrip-
  131. #        tion   of  the  TCP  client/server  lookup  protocol,  see
  132. #        tcp_table(5).  This feature is not  available  up  to  and
  133. #        including Postfix version 2.2.
  134. # 
  135. #        Each lookup operation uses the entire address once.  Thus,
  136. #        user@domain mail addresses are not broken  up  into  their
  137. #        user and @domain constituent parts, nor is user+foo broken
  138. #        up into user and foo.
  139. # 
  140. #        Results are the same as with indexed file lookups.
  141. # 
  142. # EXAMPLE
  143. #        The following shows a  generic  mapping  with  an  indexed
  144. #        file.   When  mail is sent to a remote host via SMTP, this
  145. #        replaces his@localdomain.local by his  ISP  mail  address,
  146. #        replaces  her@localdomain.local  by  her ISP mail address,
  147. #        and replaces other local addresses  by  his  ISP  account,
  148. #        with  an address extension of +local (this example assumes
  149. #        that the ISP supports "+" style address extensions).
  150. # 
  151. #        /etc/postfix/main.cf:
  152. #                smtp_generic_maps = hash:/etc/postfix/generic
  153. # 
  154. #        /etc/postfix/generic:
  155. #                his@localdomain.local   hisaccount@hisisp.example
  156. #                her@localdomain.local   heraccount@herisp.example
  157. #                @localdomain.local      hisaccount+local@hisisp.example
  158. # 
  159. #        Execute the command "postmap  /etc/postfix/generic"  when-
  160. #        ever  the table is changed.  Instead of hash, some systems
  161. #        use dbm database files. To find out what tables your  sys-
  162. #        tem supports use the command "postconf -m".
  163. # 
  164. # BUGS
  165. #        The  table format does not understand quoting conventions.
  166. # 
  167. # CONFIGURATION PARAMETERS
  168. #        The following main.cf parameters are especially  relevant.
  169. #        The  text  below  provides  only  a parameter summary. See
  170. #        postconf(5) for more details including examples.
  171. # 
  172. #        smtp_generic_maps
  173. #               Address  mapping  lookup  table  for  envelope  and
  174. #               header  sender and recipient addresses while deliv-
  175. #               ering mail via SMTP.
  176. # 
  177. #        propagate_unmatched_extensions
  178. #               A list of address rewriting  or  forwarding  mecha-
  179. #               nisms  that propagate an address extension from the
  180. #               original address to the result.   Specify  zero  or
  181. #               more   of   canonical,   virtual,  alias,  forward,
  182. #               include, or generic.
  183. # 
  184. #        Other parameters of interest:
  185. # 
  186. #        inet_interfaces
  187. #               The network interface addresses  that  this  system
  188. #               receives mail on.  You need to stop and start Post-
  189. #               fix when this parameter changes.
  190. # 
  191. #        proxy_interfaces
  192. #               Other interfaces that this machine receives mail on
  193. #               by way of a proxy agent or network address transla-
  194. #               tor.
  195. # 
  196. #        mydestination
  197. #               List of domains that  this  mail  system  considers
  198. #               local.
  199. # 
  200. #        myorigin
  201. #               The domain that is appended to locally-posted mail.
  202. # 
  203. #        owner_request_special
  204. #               Give special treatment to owner-xxx and xxx-request
  205. #               addresses.
  206. # 
  207. # SEE ALSO
  208. #        postmap(1), Postfix lookup table manager
  209. #        postconf(5), configuration parameters
  210. #        smtp(8), Postfix SMTP client
  211. # 
  212. # README FILES
  213. #        Use  "postconf  readme_directory" or "postconf html_direc-
  214. #        tory" to locate this information.
  215. #        ADDRESS_REWRITING_README, address rewriting guide
  216. #        DATABASE_README, Postfix lookup table overview
  217. #        STANDARD_CONFIGURATION_README, configuration examples
  218. # 
  219. # LICENSE
  220. #        The Secure Mailer license must be  distributed  with  this
  221. #        software.
  222. # 
  223. # HISTORY
  224. #        A genericstable feature appears in the Sendmail MTA.
  225. # 
  226. #        This feature is available in Postfix 2.2 and later.
  227. # 
  228. # AUTHOR(S)
  229. #        Wietse Venema
  230. #        IBM T.J. Watson Research
  231. #        P.O. Box 704
  232. #        Yorktown Heights, NY 10598, USA
  233. # 
  234. #                                                        GENERIC(5)
  235.