364 lines
12 KiB
Groff
364 lines
12 KiB
Groff
.\" $NetBSD: pgsql_table.5,v 1.1.1.3 2005/08/18 21:03:56 rpaulo Exp $
|
|
.\"
|
|
.TH PGSQL_TABLE 5
|
|
.ad
|
|
.fi
|
|
.SH NAME
|
|
pgsql_table
|
|
\-
|
|
Postfix PostgreSQL client configuration
|
|
.SH "SYNOPSIS"
|
|
.na
|
|
.nf
|
|
\fBpostmap -q "\fIstring\fB" pgsql:/etc/postfix/filename\fR
|
|
|
|
\fBpostmap -q - pgsql:/etc/postfix/\fIfilename\fR <\fIinputfile\fR
|
|
.SH DESCRIPTION
|
|
.ad
|
|
.fi
|
|
The Postfix mail system uses optional tables for address
|
|
rewriting or mail routing. These tables are usually in
|
|
\fBdbm\fR or \fBdb\fR format.
|
|
|
|
Alternatively, lookup tables can be specified as PostgreSQL
|
|
databases. In order to use PostgreSQL lookups, define a
|
|
PostgreSQL source as a lookup table in main.cf, for example:
|
|
.ti +4
|
|
alias_maps = pgsql:/etc/pgsql-aliases.cf
|
|
|
|
The file /etc/postfix/pgsql-aliases.cf has the same format as
|
|
the Postfix main.cf file, and can specify the parameters
|
|
described below.
|
|
.SH "BACKWARDS COMPATIBILITY"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
For compatibility with other Postfix lookup tables, PostgreSQL
|
|
parameters can also be defined in main.cf. In order to do
|
|
that, specify as PostgreSQL source a name that doesn't begin
|
|
with a slash or a dot. The PostgreSQL parameters will then
|
|
be accessible as the name you've given the source in its
|
|
definition, an underscore, and the name of the parameter. For
|
|
example, if the map is specified as "pgsql:\fIpgsqlname\fR",
|
|
the parameter "hosts" below would be defined in main.cf as
|
|
"\fIpgsqlname\fR_hosts".
|
|
|
|
Note: with this form, the passwords for the PostgreSQL sources
|
|
are written in main.cf, which is normally world-readable.
|
|
Support for this form will be removed in a future Postfix
|
|
version.
|
|
|
|
Postfix 2.2 has enhanced query interfaces for MySQL and PostgreSQL,
|
|
these include features previously available only in the Postfix
|
|
LDAP client. In the new interface the SQL query is specified via
|
|
a single \fBquery\fR parameter (described in more detail below).
|
|
In Postfix 2.1 the parameter precedence was, from highest to lowest,
|
|
\fBselect_function\fR, \fBquery\fR and finally \fBselect_field\fR, ...
|
|
|
|
With Postfix 2.2 the \fBquery\fR parameter has highest precedence,
|
|
and is used in preference to the still supported, but slated to be
|
|
phased out, \fBselect_function\fR, \fBselect_field\fR, \fBtable\fR,
|
|
\fBwhere_field\fR and \fBadditional_conditions\fR parameters. To
|
|
migrate to the new interface set:
|
|
|
|
.ti +4
|
|
\fBquery\fR = SELECT \fIselect_function\fR('%s')
|
|
|
|
or in the absence of \fBselection_function\fR, the lower precedence:
|
|
|
|
.ti +4
|
|
\fBquery\fR = SELECT \fIselect_field\fR
|
|
.ti +8
|
|
FROM \fItable\fR
|
|
.ti +8
|
|
WHERE \fIwhere_field\fR = '%s'
|
|
.ti +12
|
|
\fIadditional_conditions\fR
|
|
|
|
Use the value, not the name, of each legacy parameter. Note
|
|
that the \fBadditional_conditions\fR parameter is optional
|
|
and if not empty, will always start with \fBAND\fR.
|
|
.SH "LIST MEMBERSHIP"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
When using SQL to store lists such as $mynetworks,
|
|
$mydestination, $relay_domains, $local_recipient_maps,
|
|
etc., it is important to understand that the table must
|
|
store each list member as a separate key. The table lookup
|
|
verifies the *existence* of the key. See "Postfix lists
|
|
versus tables" in the DATABASE_README document for a
|
|
discussion.
|
|
|
|
Do NOT create tables that return the full list of domains
|
|
in $mydestination or $relay_domains etc., or IP addresses
|
|
in $mynetworks.
|
|
|
|
DO create tables with each matching item as a key and with
|
|
an arbitrary value. With SQL databases it is not uncommon to
|
|
return the key itself or a constant value.
|
|
.SH "PGSQL PARAMETERS"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
.IP "\fBhosts\fR"
|
|
The hosts that Postfix will try to connect to and query from.
|
|
Specify \fIunix:\fR for UNIX-domain sockets, \fIinet:\fR for TCP
|
|
connections (default). Example:
|
|
.ti +4
|
|
hosts = host1.some.domain host2.some.domain
|
|
.ti +4
|
|
hosts = unix:/file/name
|
|
|
|
The hosts are tried in random order, with all connections over
|
|
UNIX domain sockets being tried before those over TCP. The
|
|
connections are automatically closed after being idle for about
|
|
1 minute, and are re-opened as necessary.
|
|
|
|
NOTE: the \fIunix:\fR and \fIinet:\fR prefixes are accepted for
|
|
backwards compatibility reasons, but are actually ignored.
|
|
The PostgreSQL client library will always try to connect to an
|
|
UNIX socket if the name starts with a slash, and will try a TCP
|
|
connection otherwise.
|
|
.IP "\fBuser, password\fR"
|
|
The user name and password to log into the pgsql server.
|
|
Example:
|
|
.in +4
|
|
user = someone
|
|
.br
|
|
password = some_password
|
|
.in -4
|
|
.IP "\fBdbname\fR"
|
|
The database name on the servers. Example:
|
|
.ti +4
|
|
dbname = customer_database
|
|
.IP "\fBquery\fR"
|
|
The SQL query template used to search the database, where \fB%s\fR
|
|
is a substitute for the address Postfix is trying to resolve,
|
|
e.g.
|
|
.ti +4
|
|
query = SELECT replacement FROM aliases WHERE mailbox = '%s'
|
|
|
|
This parameter supports the following '%' expansions:
|
|
.RS
|
|
.IP "\fB\fB%%\fR\fR"
|
|
This is replaced by a literal '%' character. (Postfix 2.2 and later)
|
|
.IP "\fB\fB%s\fR\fR"
|
|
This is replaced by the input key.
|
|
SQL quoting is used to make sure that the input key does not
|
|
add unexpected metacharacters.
|
|
.IP "\fB\fB%u\fR\fR"
|
|
When the input key is an address of the form user@domain, \fB%u\fR
|
|
is replaced by the SQL quoted local part of the address.
|
|
Otherwise, \fB%u\fR is replaced by the entire search string.
|
|
If the localpart is empty, the query is suppressed and returns
|
|
no results.
|
|
.IP "\fB\fB%d\fR\fR"
|
|
When the input key is an address of the form user@domain, \fB%d\fR
|
|
is replaced by the SQL quoted domain part of the address.
|
|
Otherwise, the query is suppressed and returns no results.
|
|
.IP "\fB\fB%[SUD]\fR\fR"
|
|
The upper-case equivalents of the above expansions behave in the
|
|
\fBquery\fR parameter identically to their lower-case counter-parts.
|
|
With the \fBresult_format\fR parameter (see below), they expand the
|
|
input key rather than the result value.
|
|
.IP
|
|
The above %S, %U and %D expansions are available with Postfix 2.2
|
|
and later
|
|
.IP "\fB\fB%[1-9]\fR\fR"
|
|
The patterns %1, %2, ... %9 are replaced by the corresponding
|
|
most significant component of the input key's domain. If the
|
|
input key is \fIuser@mail.example.com\fR, then %1 is \fBcom\fR,
|
|
%2 is \fBexample\fR and %3 is \fBmail\fR. If the input key is
|
|
unqualified or does not have enough domain components to satisfy
|
|
all the specified patterns, the query is suppressed and returns
|
|
no results.
|
|
.IP
|
|
The above %1, ... %9 expansions are available with Postfix 2.2
|
|
and later
|
|
.RE
|
|
.IP
|
|
The \fBdomain\fR parameter described below limits the input
|
|
keys to addresses in matching domains. When the \fBdomain\fR
|
|
parameter is non-empty, SQL queries for unqualified addresses
|
|
or addresses in non-matching domains are suppressed
|
|
and return no results.
|
|
|
|
The precedence of this parameter has changed with Postfix 2.2,
|
|
in prior releases the precedence was, from highest to lowest,
|
|
\fBselect_function\fR, \fBquery\fR, \fBselect_field\fR, ...
|
|
|
|
With Postfix 2.2 the \fBquery\fR parameter has highest precedence,
|
|
see COMPATIBILITY above.
|
|
|
|
NOTE: DO NOT put quotes around the \fBquery\fR parameter.
|
|
.IP "\fBresult_format (default: \fB%s\fR)\fR"
|
|
Format template applied to result attributes. Most commonly used
|
|
to append (or prepend) text to the result. This parameter supports
|
|
the following '%' expansions:
|
|
.RS
|
|
.IP "\fB\fB%%\fR\fR"
|
|
This is replaced by a literal '%' character.
|
|
.IP "\fB\fB%s\fR\fR"
|
|
This is replaced by the value of the result attribute. When
|
|
result is empty it is skipped.
|
|
.IP "\fB%u\fR
|
|
When the result attribute value is an address of the form
|
|
user@domain, \fB%u\fR is replaced by the local part of the
|
|
address. When the result has an empty localpart it is skipped.
|
|
.IP "\fB\fB%d\fR\fR"
|
|
When a result attribute value is an address of the form
|
|
user@domain, \fB%d\fR is replaced by the domain part of
|
|
the attribute value. When the result is unqualified it
|
|
is skipped.
|
|
.IP "\fB\fB%[SUD1-9]\fR\fB"
|
|
The upper-case and decimal digit expansions interpolate
|
|
the parts of the input key rather than the result. Their
|
|
behavior is identical to that described with \fBquery\fR,
|
|
and in fact because the input key is known in advance, queries
|
|
whose key does not contain all the information specified in
|
|
the result template are suppressed and return no results.
|
|
.RE
|
|
.IP
|
|
For example, using "result_format = smtp:[%s]" allows one
|
|
to use a mailHost attribute as the basis of a transport(5)
|
|
table. After applying the result format, multiple values
|
|
are concatenated as comma separated strings. The expansion_limit
|
|
and parameter explained below allows one to restrict the number
|
|
of values in the result, which is especially useful for maps that
|
|
must return at most one value.
|
|
|
|
The default value \fB%s\fR specifies that each result value should
|
|
be used as is.
|
|
|
|
This parameter is available with Postfix 2.2 and later.
|
|
|
|
NOTE: DO NOT put quotes around the result format!
|
|
.IP "\fBdomain (default: no domain list)\fR"
|
|
This is a list of domain names, paths to files, or
|
|
dictionaries. When specified, only fully qualified search
|
|
keys with a *non-empty* localpart and a matching domain
|
|
are eligible for lookup: 'user' lookups, bare domain lookups
|
|
and "@domain" lookups are not performed. This can significantly
|
|
reduce the query load on the PostgreSQL server.
|
|
.ti +4
|
|
domain = postfix.org, hash:/etc/postfix/searchdomains
|
|
|
|
It is best not to use SQL to store the domains eligible
|
|
for SQL lookups.
|
|
|
|
This parameter is available with Postfix 2.2 and later.
|
|
|
|
NOTE: DO NOT define this parameter for local(8) aliases,
|
|
because the input keys are always unqualified.
|
|
.IP "\fBexpansion_limit (default: 0)\fR"
|
|
A limit on the total number of result elements returned
|
|
(as a comma separated list) by a lookup against the map.
|
|
A setting of zero disables the limit. Lookups fail with a
|
|
temporary error if the limit is exceeded. Setting the
|
|
limit to 1 ensures that lookups do not return multiple
|
|
values.
|
|
.PP
|
|
Pre-Postfix 2.2 legacy interfaces:
|
|
.IP "\fBselect_function\fR"
|
|
This parameter specifies a database function name. Example:
|
|
.ti +4
|
|
select_function = my_lookup_user_alias
|
|
|
|
This is equivalent to:
|
|
.ti +4
|
|
query = SELECT my_lookup_user_alias('%s')
|
|
|
|
This parameter overrides the legacy table-related fields (described
|
|
below). With Postfix versions prior to 2.2, it also overrides the
|
|
\fBquery\fR parameter. Starting with Postfix 2.2, the \fBquery\fR
|
|
parameter has highest precedence, and this parameter is deprecated.
|
|
Please migrate to the new \fBquery\fR interface as this interface
|
|
is slated to be phased out.
|
|
.PP
|
|
The following parameters (with lower precedence than the
|
|
\fBselect_function\fR interface described above) can be used to
|
|
build the SQL select statement as follows:
|
|
|
|
.ti +4
|
|
SELECT [\fBselect_field\fR]
|
|
.ti +4
|
|
FROM [\fBtable\fR]
|
|
.ti +4
|
|
WHERE [\fBwhere_field\fR] = '%s'
|
|
.ti +10
|
|
[\fBadditional_conditions\fR]
|
|
|
|
The specifier %s is replaced with each lookup by the lookup key
|
|
and is escaped so if it contains single quotes or other odd
|
|
characters, it will not cause a parse error, or worse, a security
|
|
problem.
|
|
|
|
Starting with Postfix 2.2, this interface is obsoleted by the more
|
|
general \fBquery\fR interface described above. If higher precedence
|
|
the \fBquery\fR or \fBselect_function\fR parameters described above
|
|
are defined, these parameters are ignored. Please migrate to the new
|
|
\fBquery\fR interface as this interface is slated to be phased out.
|
|
.IP "\fBselect_field\fR"
|
|
The SQL "select" parameter. Example:
|
|
.ti +4
|
|
\fBselect_field\fR = forw_addr
|
|
.IP "\fBtable\fR"
|
|
The SQL "select .. from" table name. Example:
|
|
.ti +4
|
|
\fBtable\fR = mxaliases
|
|
.IP "\fBwhere_field\fR
|
|
The SQL "select .. where" parameter. Example:
|
|
.ti +4
|
|
\fBwhere_field\fR = alias
|
|
.IP "\fBadditional_conditions\fR
|
|
Additional conditions to the SQL query. Example:
|
|
.ti +4
|
|
\fBadditional_conditions\fR = AND status = 'paid'
|
|
.SH "SEE ALSO"
|
|
.na
|
|
.nf
|
|
postmap(1), Postfix lookup table manager
|
|
postconf(5), configuration parameters
|
|
ldap_table(5), LDAP lookup tables
|
|
mysql_table(5), MySQL lookup tables
|
|
.SH "README FILES"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
Use "\fBpostconf readme_directory\fR" or
|
|
"\fBpostconf html_directory\fR" to locate this information.
|
|
.na
|
|
.nf
|
|
DATABASE_README, Postfix lookup table overview
|
|
PGSQL_README, Postfix PostgreSQL client guide
|
|
.SH "LICENSE"
|
|
.na
|
|
.nf
|
|
.ad
|
|
.fi
|
|
The Secure Mailer license must be distributed with this software.
|
|
.SH "HISTORY"
|
|
.na
|
|
.nf
|
|
PgSQL support was introduced with Postfix version 2.1.
|
|
.SH "AUTHOR(S)"
|
|
.na
|
|
.nf
|
|
Based on the MySQL client by:
|
|
Scott Cotton, Joshua Marcus
|
|
IC Group, Inc.
|
|
|
|
Ported to PostgreSQL by:
|
|
Aaron Sethman
|
|
|
|
Further enhanced by:
|
|
Liviu Daia
|
|
Institute of Mathematics of the Romanian Academy
|
|
P.O. BOX 1-764
|
|
RO-014700 Bucharest, ROMANIA
|