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.20120521.etc.tar.gz / bradford.20120521.etc.tar / etc / postfix / access next >
Text File  |  2006-05-02  |  16KB  |  375 lines

  1. # ACCESS(5)                                                            ACCESS(5)
  2. # NAME
  3. #        access - Postfix access table format
  4. # SYNOPSIS
  5. #        postmap /etc/postfix/access
  6. #        postmap -q "string" /etc/postfix/access
  7. #        postmap -q - /etc/postfix/access <inputfile
  8. # DESCRIPTION
  9. #        The  optional  access(5)  table  directs  the Postfix SMTP
  10. #        server to selectively reject or accept mail. Access can be
  11. #        allowed  or  denied for specific host names, domain names,
  12. #        networks, host addresses or mail addresses.
  13. #        For an example, see the EXAMPLE section at the end of this
  14. #        manual page.
  15. #        Normally,  the access(5) table is specified as a text file
  16. #        that serves as  input  to  the  postmap(1)  command.   The
  17. #        result,  an  indexed file in dbm or db format, is used for
  18. #        fast searching by the mail  system.  Execute  the  command
  19. #        "postmap  /etc/postfix/access"  in  order  to  rebuild the
  20. #        indexed file after changing the access table.
  21. #        When the table is provided via other means  such  as  NIS,
  22. #        LDAP  or  SQL,  the  same lookups are done as for ordinary
  23. #        indexed files.
  24. #        Alternatively, the table can be  provided  as  a  regular-
  25. #        expression map where patterns are given as regular expres-
  26. #        sions, or lookups can be directed to TCP-based server.  In
  27. #        that  case,  the  lookups are done in a slightly different
  28. #        way as described below under "REGULAR  EXPRESSION  TABLES"
  29. #        and "TCP-BASED TABLES".
  30. # TABLE FORMAT
  31. #        The input format for the postmap(1) command is as follows:
  32. #        pattern action
  33. #               When pattern matches a mail address, domain or host
  34. #               address, perform the corresponding action.
  35. #        blank lines and comments
  36. #               Empty  lines and whitespace-only lines are ignored,
  37. #               as are lines whose first  non-whitespace  character
  38. #               is a `#'.
  39. #        multi-line text
  40. #               A  logical  line starts with non-whitespace text. A
  41. #               line that starts with whitespace continues a  logi-
  42. #               cal line.
  43. # EMAIL ADDRESS PATTERNS
  44. #        With lookups from indexed files such as DB or DBM, or from
  45. #        networked tables such as NIS, LDAP or  SQL,  patterns  are
  46. #        tried in the order as listed below:
  47. #        user@domain
  48. #               Matches the specified mail address.
  49. #        domain.tld
  50. #               Matches  domain.tld  as the domain part of an email
  51. #               address.
  52. #               The pattern domain.tld also matches subdomains, but
  53. #               only when the string smtpd_access_maps is listed in
  54. #               the Postfix  parent_domain_matches_subdomains  con-
  55. #               figuration  setting  (note that this is the default
  56. #               for some versions of Postfix).  Otherwise,  specify
  57. #               .domain.tld  (note  the  initial  dot)  in order to
  58. #               match subdomains.
  59. #        user@  Matches all mail addresses with the specified  user
  60. #               part.
  61. #        Note:  lookup  of  the null sender address is not possible
  62. #        with some types of lookup table. By default, Postfix  uses
  63. #        <>  as  the  lookup  key  for such addresses. The value is
  64. #        specified with the smtpd_null_access_lookup_key  parameter
  65. #        in the Postfix main.cf file.
  66. # EMAIL ADDRESS EXTENSION
  67. #        When a mail address localpart contains the optional recip-
  68. #        ient delimiter (e.g., user+foo@domain), the  lookup  order
  69. #        becomes:  user+foo@domain, user@domain, domain, user+foo@,
  70. #        and user@.
  71. # HOST NAME/ADDRESS PATTERNS
  72. #        With lookups from indexed files such as DB or DBM, or from
  73. #        networked  tables  such as NIS, LDAP or SQL, the following
  74. #        lookup patterns are examined in the order as listed:
  75. #        domain.tld
  76. #               Matches domain.tld.
  77. #               The pattern domain.tld also matches subdomains, but
  78. #               only when the string smtpd_access_maps is listed in
  79. #               the Postfix  parent_domain_matches_subdomains  con-
  80. #               figuration setting.  Otherwise, specify .domain.tld
  81. #               (note the initial dot) in  order  to  match  subdo-
  82. #               mains.
  83. #        net.work.addr.ess
  84. #        net.work.addr
  85. #        net.work
  86. #        net    Matches  the specified IPv4 host address or subnet-
  87. #               work. An IPv4 host address is a  sequence  of  four
  88. #               decimal octets separated by ".".
  89. #               Subnetworks  are  matched  by repeatedly truncating
  90. #               the last ".octet" from the remote IPv4 host address
  91. #               string  until a match is found in the access table,
  92. #               or until further truncation is not possible.
  93. #               NOTE 1: The information in the access map should be
  94. #               in canonical form, with unnecessary null characters
  95. #               eliminated.   Address  information  must   not   be
  96. #               enclosed with "[]" characters.
  97. #               NOTE  2:  use the cidr lookup table type to specify
  98. #               network/netmask  patterns.  See  cidr_table(5)  for
  99. #               details.
  100. #        net:work:addr:ess
  101. #        net:work:addr
  102. #        net:work
  103. #        net    Matches  the specified IPv6 host address or subnet-
  104. #               work. An IPv6 host address is a sequence  of  three
  105. #               to  eight hexadecimal octet pairs separated by ":".
  106. #               Subnetworks are matched  by  repeatedly  truncating
  107. #               the  last  ":octetpair"  from  the remote IPv6 host
  108. #               address string until a match is found in the access
  109. #               table, or until further truncation is not possible.
  110. #               NOTE 1: the truncation and comparison are done with
  111. #               the string representation of the IPv6 host address.
  112. #               Thus, not all the ":" subnetworks will be tried.
  113. #               NOTE 2: The information in the access map should be
  114. #               in canonical form, with unnecessary null characters
  115. #               eliminated.   Address  information  must   not   be
  116. #               enclosed with "[]" characters.
  117. #               NOTE  3:  use the cidr lookup table type to specify
  118. #               network/netmask  patterns.  See  cidr_table(5)  for
  119. #               details.
  120. #               IPv6 support is available in Postfix 2.2 and later.
  121. # ACCEPT ACTIONS
  122. #        OK     Accept the address etc. that matches the pattern.
  123. #        all-numerical
  124. #               An all-numerical result is treated as OK. This for-
  125. #               mat  is generated by address-based relay authoriza-
  126. #               tion schemes.
  127. # REJECT ACTIONS
  128. #        4NN text
  129. #        5NN text
  130. #               Reject the address etc. that matches  the  pattern,
  131. #               and respond with the numerical three-digit code and
  132. #               text. 4NN means "try again later", while 5NN  means
  133. #               "do not try again".
  134. #        REJECT optional text...
  135. #               Reject  the  address etc. that matches the pattern.
  136. #               Reply with $reject_code optional text...  when  the
  137. #               optional  text is specified, otherwise reply with a
  138. #               generic error response message.
  139. #        DEFER_IF_REJECT optional text...
  140. #               Defer the request if some later  restriction  would
  141. #               result in a REJECT action. Reply with "450 optional
  142. #               text... when the optional text is specified, other-
  143. #               wise reply with a generic error response message.
  144. #               This feature is available in Postfix 2.1 and later.
  145. #        DEFER_IF_PERMIT optional text...
  146. #               Defer the request if some later  restriction  would
  147. #               result  in a an explicit or implicit PERMIT action.
  148. #               Reply with "450 optional text... when the  optional
  149. #               text  is  specified, otherwise reply with a generic
  150. #               error response message.
  151. #               This feature is available in Postfix 2.1 and later.
  152. # OTHER ACTIONS
  153. #        restriction...
  154. #               Apply the named UCE restriction(s) (permit, reject,
  155. #               reject_unauth_destination, and so on).
  156. #        DISCARD optional text...
  157. #               Claim successful delivery and silently discard  the
  158. #               message.   Log the optional text if specified, oth-
  159. #               erwise log a generic message.
  160. #               Note: this action currently affects all  recipients
  161. #               of the message.
  162. #               This feature is available in Postfix 2.0 and later.
  163. #        DUNNO  Pretend that the lookup key  was  not  found.  This
  164. #               prevents  Postfix  from  trying  substrings  of the
  165. #               lookup key (such as a subdomain name, or a  network
  166. #               address subnetwork).
  167. #               This feature is available in Postfix 2.0 and later.
  168. #        FILTER transport:destination
  169. #               After the message is queued, send the  entire  mes-
  170. #               sage through the specified external content filter.
  171. #               The transport:destination syntax  is  described  in
  172. #               the  transport(5)  manual  page.   More information
  173. #               about external content filters is  in  the  Postfix
  174. #               FILTER_README file.
  175. #               Note:   this  action  overrides  the  main.cf  con-
  176. #               tent_filter  setting,  and  currently  affects  all
  177. #               recipients of the message.
  178. #               This feature is available in Postfix 2.0 and later.
  179. #        HOLD optional text...
  180. #               Place the message on the hold queue, where it  will
  181. #               sit  until someone either deletes it or releases it
  182. #               for delivery.  Log the optional text if  specified,
  183. #               otherwise log a generic message.
  184. #               Mail  that  is  placed on hold can be examined with
  185. #               the postcat(1) command, and  can  be  destroyed  or
  186. #               released with the postsuper(1) command.
  187. #               Note:  use  "postsuper -r" to release mail that was
  188. #               kept on hold for a significant fraction  of  $maxi-
  189. #               mal_queue_lifetime  or  $bounce_queue_lifetime,  or
  190. #               longer.
  191. #               Note: this action currently affects all  recipients
  192. #               of the message.
  193. #               This feature is available in Postfix 2.0 and later.
  194. #        PREPEND headername: headervalue
  195. #               Prepend the specified message header  to  the  mes-
  196. #               sage.  When this action is used multiple times, the
  197. #               first prepended header appears  before  the  second
  198. #               etc. prepended header.
  199. #               Note:  this action does not support multi-line mes-
  200. #               sage headers.
  201. #               Note: this action must be used before  the  message
  202. #               content   is   received;   it  cannot  be  used  in
  203. #               smtpd_end_of_data_restrictions.
  204. #               This feature is available in Postfix 2.1 and later.
  205. #        REDIRECT user@domain
  206. #               After  the  message  is queued, send the message to
  207. #               the  specified  address  instead  of  the  intended
  208. #               recipient(s).
  209. #               Note:  this action overrides the FILTER action, and
  210. #               currently affects all recipients of the message.
  211. #               This feature is available in Postfix 2.1 and later.
  212. #        WARN optional text...
  213. #               Log a warning with the optional text, together with
  214. #               client information and  if  available,  with  helo,
  215. #               sender, recipient and protocol information.
  216. #               This feature is available in Postfix 2.1 and later.
  217. # REGULAR EXPRESSION TABLES
  218. #        This section describes how the table lookups  change  when
  219. #        the table is given in the form of regular expressions. For
  220. #        a description of regular expression lookup  table  syntax,
  221. #        see regexp_table(5) or pcre_table(5).
  222. #        Each  pattern  is  a regular expression that is applied to
  223. #        the entire string being looked up. Depending on the appli-
  224. #        cation,  that  string  is  an  entire  client hostname, an
  225. #        entire client IP address, or an entire mail address. Thus,
  226. #        no  parent  domain  or  parent  network  search  is  done,
  227. #        user@domain mail addresses are not broken  up  into  their
  228. #        user@ and domain constituent parts, nor is user+foo broken
  229. #        up into user and foo.
  230. #        Patterns are applied in the order as specified in the  ta-
  231. #        ble,  until  a  pattern  is  found that matches the search
  232. #        string.
  233. #        Actions are the same as with indexed  file  lookups,  with
  234. #        the  additional feature that parenthesized substrings from
  235. #        the pattern can be interpolated as $1, $2 and so on.
  236. # TCP-BASED TABLES
  237. #        This section describes how the table lookups  change  when
  238. #        lookups are directed to a TCP-based server. For a descrip-
  239. #        tion of the TCP client/server lookup protocol, see tcp_ta-
  240. #        ble(5).  This feature is not available up to and including
  241. #        Postfix version 2.2.
  242. #        Each lookup operation uses the entire query  string  once.
  243. #        Depending  on  the  application,  that string is an entire
  244. #        client hostname, an entire client IP address, or an entire
  245. #        mail  address.   Thus,  no parent domain or parent network
  246. #        search is done, user@domain mail addresses are not  broken
  247. #        up  into  their user@ and domain constituent parts, nor is
  248. #        user+foo broken up into user and foo.
  249. #        Actions are the same as with indexed file lookups.
  250. # EXAMPLE
  251. #        The following example uses an indexed file,  so  that  the
  252. #        order  of  table entries does not matter. The example per-
  253. #        mits access by the client at address 1.2.3.4  but  rejects
  254. #        all  other  clients  in 1.2.3.0/24. Instead of hash lookup
  255. #        tables, some systems use dbm.  Use the  command  "postconf
  256. #        -m"  to  find  out  what lookup tables Postfix supports on
  257. #        your system.
  258. #        /etc/postfix/main.cf:
  259. #            smtpd_client_restrictions =
  260. #                check_client_access hash:/etc/postfix/access
  261. #        /etc/postfix/access:
  262. #            1.2.3   REJECT
  263. #            1.2.3.4 OK
  264. #        Execute the command "postmap /etc/postfix/access" after
  265. #        editing the file.
  266. # BUGS
  267. #        The table format does not understand quoting  conventions.
  268. # SEE ALSO
  269. #        postmap(1), Postfix lookup table manager
  270. #        smtpd(8), SMTP server
  271. #        postconf(5), configuration parameters
  272. #        transport(5), transport:nexthop syntax
  273. # README FILES
  274. #        Use  "postconf  readme_directory" or "postconf html_direc-
  275. #        tory" to locate this information.
  276. #        SMTPD_ACCESS_README, built-in SMTP server access control
  277. #        DATABASE_README, Postfix lookup table overview
  278. # LICENSE
  279. #        The Secure Mailer license must be  distributed  with  this
  280. #        software.
  281. # AUTHOR(S)
  282. #        Wietse Venema
  283. #        IBM T.J. Watson Research
  284. #        P.O. Box 704
  285. #        Yorktown Heights, NY 10598, USA
  286. #                                                                      ACCESS(5)
  287.