summaryrefslogtreecommitdiffstats
path: root/html/regexp_table.5.html
blob: 05cda133d0038d5a808d06ba76a83d40435f5eb2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<html> <head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
<title> Postfix manual - regexp_table(5) </title>
</head> <body> <pre>
REGEXP_TABLE(5)                                                REGEXP_TABLE(5)

<b>NAME</b>
       regexp_table - format of Postfix regular expression tables

<b>SYNOPSIS</b>
       <b>postmap -q "</b><i>string</i><b>" <a href="regexp_table.5.html">regexp</a>:/etc/postfix/</b><i>filename</i>

       <b>postmap -q - <a href="regexp_table.5.html">regexp</a>:/etc/postfix/</b><i>filename</i> &lt;<i>inputfile</i>

<b>DESCRIPTION</b>
       The  Postfix  mail  system  uses optional tables for address rewriting,
       mail routing, or access control. These tables are usually in <b>dbm</b> or  <b>db</b>
       format.

       Alternatively,  lookup tables can be specified in POSIX regular expres-
       sion form. In this case, each input is compared against a list of  pat-
       terns.  When a match is found, the corresponding result is returned and
       the search is terminated.

       To find out what types of lookup tables your  Postfix  system  supports
       use the "<b>postconf -m</b>" command.

       To test lookup tables, use the "<b>postmap -q</b>" command as described in the
       SYNOPSIS above. Use "<b>postmap -hmq -</b> &lt;<i>file</i>"  for  <a href="header_checks.5.html">header_checks(5)</a>  pat-
       terns,  and  "<b>postmap -bmq -</b> &lt;<i>file</i>" for <a href="header_checks.5.html">body_checks(5)</a> (Postfix 2.6 and
       later).

<b>COMPATIBILITY</b>
       With Postfix version 2.2 and earlier specify "<b>postmap -fq</b>" to  query  a
       table that contains case sensitive patterns. Patterns are case insensi-
       tive by default.

<b>TABLE FORMAT</b>
       The general form of a Postfix regular expression table is:

       <b>/</b><i>pattern</i><b>/</b><i>flags result</i>
              When <i>pattern</i> matches the input  string,  use  the  corresponding
              <i>result</i> value.

       <b>!/</b><i>pattern</i><b>/</b><i>flags result</i>
              When  <i>pattern</i>  does  <b>not</b>  match the input string, use the corre-
              sponding <i>result</i> value.

       <b>if /</b><i>pattern</i><b>/</b><i>flags</i>

       <b>endif</b>  If the input string matches /<i>pattern</i>/,  then  match  that  input
              string against the patterns between <b>if</b> and <b>endif</b>.  The <b>if</b>..<b>endif</b>
              can nest.

              Note: do not prepend whitespace to patterns inside <b>if</b>..<b>endif</b>.

              This feature is available in Postfix 2.1 and later.

       <b>if !/</b><i>pattern</i><b>/</b><i>flags</i>

       <b>endif</b>  If the input string does not match /<i>pattern</i>/,  then  match  that
              input  string  against  the  patterns  between <b>if</b> and <b>endif</b>. The
              <b>if</b>..<b>endif</b> can nest.

              Note: do not prepend whitespace to patterns inside <b>if</b>..<b>endif</b>.

              This feature is available in Postfix 2.1 and later.

       blank lines and comments
              Empty lines and whitespace-only lines are ignored, as are  lines
              whose first non-whitespace character is a `#'.

       multi-line text
              A  logical  line  starts  with  non-whitespace text. A line that
              starts with whitespace continues a logical line.

       Each pattern is a POSIX regular expression enclosed by a pair of delim-
       iters. The regular expression syntax is documented in <b>re_format</b>(7) with
       4.4BSD, in <b>regex</b>(5) with Solaris, and in  <b>regex</b>(7)  with  Linux.  Other
       systems may use other document names.

       The  expression  delimiter  can  be  any  non-alphanumerical character,
       except whitespace or characters that have special  meaning  (tradition-
       ally  the  forward  slash  is used). The regular expression can contain
       whitespace.

       By default, matching is case-insensitive, and newlines are not  treated
       as  special  characters. The behavior is controlled by flags, which are
       toggled by appending one or more of the following characters after  the
       pattern:

       <b>i</b> (default: on)
              Toggles  the case sensitivity flag. By default, matching is case
              insensitive.

       <b>m</b> (default: off)
              Toggle the multi-line mode flag. When this flag is on, the <b>^</b> and
              <b>$</b>  metacharacters match immediately after and immediately before
              a newline character, respectively, in addition  to  matching  at
              the start and end of the input string.

       <b>x</b> (default: on)
              Toggles the extended expression syntax flag. By default, support
              for extended expression syntax is enabled.

<b>TABLE SEARCH ORDER</b>
       Patterns are applied in the order as specified in the  table,  until  a
       pattern is found that matches the input string.

       Each  pattern  is applied to the entire input string.  Depending on the
       application, that string is an entire client hostname, an entire client
       IP  address, or an entire mail address.  Thus, no parent domain or par-
       ent network search is done, and <i>user@domain</i> mail addresses are not bro-
       ken  up  into  their <i>user</i> and <i>domain</i> constituent parts, nor is <i>user+foo</i>
       broken up into <i>user</i> and <i>foo</i>.

<b>TEXT SUBSTITUTION</b>
       Substitution of substrings (text that  matches  patterns  inside  "()")
       from  the  matched  expression into the result string is requested with
       $1, $2, etc.; specify $$ to produce  a  $  character  as  output.   The
       macros  in  the result string may need to be written as ${n} or $(n) if
       they aren't followed by whitespace.

       Note: since negated patterns (those preceded by <b>!</b>) return a result when
       the  expression  does  not  match,  substitutions are not available for
       negated patterns.

<b>INLINE SPECIFICATION</b>
       The contents of a table may be specified in the table name (Postfix 3.7
       and later).  The basic syntax is:

       <a href="postconf.5.html">main.cf</a>:
           <i>parameter</i> <b>= .. <a href="regexp_table.5.html">regexp</a>:{ {</b> <i>rule-1</i> <b>}, {</b> <i>rule-2</i> <b>} .. } ..</b>

       <a href="master.5.html">master.cf</a>:
           <b>.. -o {</b> <i>parameter</i> <b>= .. <a href="regexp_table.5.html">regexp</a>:{ {</b> <i>rule-1</i> <b>}, {</b> <i>rule-2</i> <b>} .. } .. } ..</b>

       Postfix  ignores  whitespace  after '{' and before '}', and writes each
       <i>rule</i> as one text line to an in-memory file:

       in-memory file:
           rule-1
           rule-2
           ..

       Postfix parses the result as if it is a file in /etc/postfix.

       Note: if a rule contains <b>$</b>, specify <b>$$</b> to keep Postfix from  trying  to
       do <i>$name</i> expansion as it evaluates a parameter value.

<b>EXAMPLE SMTPD ACCESS MAP</b>
       # Disallow sender-specified routing. This is a must if you relay mail
       # for other domains.
       /[%!@].*[%!@]/       550 Sender-specified routing rejected

       # Postmaster is OK, that way they can talk to us about how to fix
       # their problem.
       /^postmaster@/       OK

       # Protect your outgoing majordomo exploders
       if !/^owner-/
       /^(.*)-outgoing@(.*)$/  550 Use ${1}@${2} instead
       endif

<b>EXAMPLE HEADER FILTER MAP</b>
       # These were once common in junk mail.
       /^Subject: make money fast/     REJECT
       /^To: friend@public\.com/       REJECT

<b>EXAMPLE BODY FILTER MAP</b>
       # First skip over base 64 encoded text to save CPU cycles.
       ~^[[:alnum:]+/]{60,}$~          OK

       # Put your own body patterns here.

<b>SEE ALSO</b>
       <a href="postmap.1.html">postmap(1)</a>, Postfix lookup table manager
       <a href="pcre_table.5.html">pcre_table(5)</a>, format of PCRE tables
       <a href="cidr_table.5.html">cidr_table(5)</a>, format of CIDR tables

<b>README FILES</b>
       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview

<b>AUTHOR(S)</b>
       The regexp table lookup code was originally written by:
       LaMont Jones
       lamont@hp.com

       That code was based on the PCRE dictionary contributed by:
       Andrew McNamara
       andrewm@connect.com.au
       connect.com.au Pty. Ltd.
       Level 3, 213 Miller St
       North Sydney, NSW, Australia

       Adopted and adapted by:
       Wietse Venema
       IBM T.J. Watson Research
       P.O. Box 704
       Yorktown Heights, NY 10598, USA

       Wietse Venema
       Google, Inc.
       111 8th Avenue
       New York, NY 10011, USA

                                                               REGEXP_TABLE(5)
</pre> </body> </html>