dist/html/MYSQL_README.html

<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
        "https://www.w3.org/TR/html4/loose.dtd">

<html>

<head>

<title>Postfix MySQL/MariaDB Howto</title>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel='stylesheet' type='text/css' href='postfix-doc.css'>

</head>

<body>

<h1><img src="postfix-logo.jpg" width="203" height="98" ALT="">Postfix MySQL/MariaDB Howto</h1>

<hr>

<h2>Introduction</h2>

<p> The Postfix mysql map type allows you to hook up Postfix to
MySQL or MariaDB databases. This implementation allows for multiple
databases: you can use one for a <a href="virtual.5.html">virtual(5)</a> table, one for an
<a href="access.5.html">access(5)</a> table, and one for an <a href="aliases.5.html">aliases(5)</a> table if you want.  You
can specify multiple servers for the same database, so that Postfix
can switch to a good database server if one goes bad.  </p>

<p> Even though the component name is 'mysql' in Postfix, MariaDB/MySQL
client and servers can be used interchangeably as the functionality
Postfix relies on is available in both. However, the code bases may
still diverge in the future. </p>

<p> Busy mail servers using mysql maps will generate lots of
concurrent mysql clients, so the mysql server(s) should be run with
this fact in mind.  You can reduce the number of concurrent mysql
clients by using the Postfix <a href="proxymap.8.html">proxymap(8)</a> service. </p>

<h2>Building Postfix with MySQL support</h2>

<p> These instructions assume that you build Postfix from source
code as described in the <a href="INSTALL.html">INSTALL</a> document. Some modification may
be required if you build Postfix from a vendor-specific source
package.  </p>

<p> Note: to use mysql with Debian GNU/Linux's Postfix, all you
need is to install the postfix-mysql package and you're done.
There is no need to recompile Postfix. </p>

<p> The Postfix MySQL client utilizes the mysql client library,
which can be obtained from: </p>

<blockquote>
    <p> <a href="https://www.mysql.com/downloads/">https://www.mysql.com/downloads/</a> </p>
</blockquote>

<p> Many Linux distributions compile Postfix MySQL support using
the equivalent client library from MariaDB: </p>

<blockquote>
    <p> <a href="https://mariadb.org/connector-c/">https://mariadb.org/connector-c/</a> </p>
</blockquote>

<p> In order to build Postfix with mysql map support, you will need to add
-DHAS_MYSQL and -I for the directory containing the mysql headers, and
the mysqlclient library (and libm) to <a href="MYSQL_README.html">AUXLIBS_MYSQL</a>, for example: </p>

<blockquote>
<pre>
make -f Makefile.init makefiles \
    "CCARGS=-DHAS_MYSQL -I/usr/local/mysql/include" \
    "<a href="MYSQL_README.html">AUXLIBS_MYSQL</a>=-L/usr/local/mysql/lib -lmysqlclient -lz -lm"
</pre>
</blockquote>

<p> If your MySQL shared library is in a directory that the RUN-TIME
linker does not know about, add a "-Wl,-R,/path/to/directory" option after
"-lmysqlclient". </p>

<p> Postfix versions before 3.0 use AUXLIBS instead of <a href="MYSQL_README.html">AUXLIBS_MYSQL</a>.
With Postfix 3.0 and later, the old AUXLIBS variable still supports
building a statically-loaded MySQL database client, but only the new
<a href="MYSQL_README.html">AUXLIBS_MYSQL</a> variable supports building a dynamically-loaded or
statically-loaded MySQL database client.  </p>

<blockquote>

<p> Failure to use the <a href="MYSQL_README.html">AUXLIBS_MYSQL</a> variable will defeat the purpose
of dynamic database client loading. Every Postfix executable file
will have MYSQL database library dependencies. And that was exactly
what dynamic database client loading was meant to avoid. </p>

</blockquote>

<p> On Solaris, use this instead: </p>

<blockquote>
<pre>
make -f Makefile.init makefiles \
    "CCARGS=-DHAS_MYSQL -I/usr/local/mysql/include" \
    "<a href="MYSQL_README.html">AUXLIBS_MYSQL</a>=-L/usr/local/mysql/lib -R/usr/local/mysql/lib \
        -lmysqlclient -lz -lm"
</pre>
</blockquote>

<p> Then, just run 'make'. This requires libz, the compression
library.  Older mysql implementations build without libz. </p>

<h2>Using MySQL tables</h2>

<p> Once Postfix is built with mysql support, you can specify a
map type in <a href="postconf.5.html">main.cf</a> like this: </p>

<blockquote>
<pre>
<a href="postconf.5.html#alias_maps">alias_maps</a> = <a href="mysql_table.5.html">mysql</a>:/etc/postfix/mysql-aliases.cf
</pre>
</blockquote>

<p> The file /etc/postfix/mysql-aliases.cf specifies lots of
information telling Postfix how to reference the mysql database.
For a complete description, see the <a href="mysql_table.5.html">mysql_table(5)</a> manual page. </p>

<h2>Example: local aliases </h2>

<pre>
#
# mysql config file for <a href="local.8.html">local(8)</a> <a href="aliases.5.html">aliases(5)</a> lookups
#

# The user name and password to log into the mysql server.
user = someone
password = some_password

# The database name on the servers.
dbname = customer_database

# For Postfix 2.2 and later The SQL query template.
# See <a href="mysql_table.5.html">mysql_table(5)</a> for details.
query = SELECT forw_addr FROM mxaliases WHERE alias='%s' AND status='paid'

# For Postfix releases prior to 2.2. See <a href="mysql_table.5.html">mysql_table(5)</a> for details.
select_field = forw_addr
table = mxaliases
where_field = alias
# Don't forget the leading "AND"!
additional_conditions = AND status = 'paid'

# This is necessary to make UTF8 queries work for Postfix 2.11 .. 3.1,
# and is the default setting as of Postfix 3.2.
option_group = client
</pre>

<h2>Additional notes</h2>

<p> Postfix 3.2 and later read <b>[client]</b> option group settings
by default. To disable this, specify no <b>option_file</b> and
specify "<b>option_group =</b>" (i.e. an empty value).  </p>

<p> Postfix 3.1 and earlier don't read <b>[client]</b> option group
settings unless a non-empty <b>option_file</b> or <b>option_group</b>
value are specified. To enable this, specify, for example
"<b>option_group = client</b>".  </p>

<p> The MySQL configuration interface setup allows for multiple
mysql databases: you can use one for a virtual table, one for an
access table, and one for an aliases table if you want. </p>

<p> Since sites that have a need for multiple mail exchangers may
enjoy the convenience of using a networked mailer database, but do
not want to introduce a single point of failure to their system,
we've included the ability to have Postfix reference multiple hosts
for access to a single mysql map.  This will work if sites set up
mirrored mysql databases on two or more hosts.  Whenever queries
fail with an error at one host, the rest of the hosts will be tried
in random order.  If no mysql server hosts are reachable, then mail
will be deferred until at least one of those hosts is reachable.
</p>

<h2>Credits</h2>

<ul>

<li> The initial version was contributed by Scott Cotton and Joshua
Marcus, IC Group, Inc.</li>

<li> Liviu Daia revised the configuration interface and added the
<a href="postconf.5.html">main.cf</a> configuration feature.</li>

<li> Liviu Daia with further refinements from Jose Luis Tallon and
Victor Duchovni developed the common query, result_format, domain and
expansion_limit interface for LDAP, MySQL and PostgreSQL.</li>

</ul>

</body>

</html>