1POSTCONF(1) General Commands Manual POSTCONF(1)
2
6 postconf - Postfix configuration utility
7
9 Managing main.cf:
10 postconf [-dfhHnopvx] [-c config_dir] [-C class,...] [parameter ...]
12 postconf [-epv] [-c config_dir] parameter=value ...
14 postconf -# [-pv] [-c config_dir] parameter ...
16 postconf -X [-pv] [-c config_dir] parameter ...
18 Managing master.cf service entries:
20 postconf -M [-fovx] [-c config_dir] [service[/type] ...]
22 postconf -M [-ev] [-c config_dir] service/type=value ...
24 postconf -M# [-v] [-c config_dir] service/type ...
26 postconf -MX [-v] [-c config_dir] service/type ...
28 Managing master.cf service fields:
30 postconf -F [-fhHovx] [-c config_dir] [service[/type[/field]] ...]
32 postconf -F [-ev] [-c config_dir] service/type/field=value ...
34 Managing master.cf service parameters:
36 postconf -P [-fhHovx] [-c config_dir] [service[/type[/parameter]] ...]
38 postconf -P [-ev] [-c config_dir] service/type/parameter=value ...
40 postconf -PX [-v] [-c config_dir] service/type/parameter ...
42 Managing bounce message templates:
44 postconf -b [-v] [-c config_dir] [template_file]
46 postconf -t [-v] [-c config_dir] [template_file]
48 Managing TLS features:
50 postconf -T mode [-v] [-c config_dir]
52 Managing other configuration:
54 postconf -a|-A|-l|-m [-v] [-c config_dir]
56
58 By default, the postconf(1) command displays the values of main.cf con‐
59 figuration parameters, and warns about possible mis-typed parameter
60 names (Postfix 2.9 and later). The command can also change main.cf
61 configuration parameter values, or display other configuration informa‐
62 tion about the Postfix mail system.
63 Options:
65 -a List the available SASL plug-in types for the Postfix SMTP
67 server. The plug-in type is selected with the smtpd_sasl_type
68 configuration parameter by specifying one of the names listed
69 below.
70 cyrus This server plug-in is available when Postfix is built
72 with Cyrus SASL support.
73 dovecot
75 This server plug-in uses the Dovecot authentication
76 server, and is available when Postfix is built with any
77 form of SASL support.
78 This feature is available with Postfix 2.3 and later.
80 -A List the available SASL plug-in types for the Postfix SMTP
82 client. The plug-in type is selected with the smtp_sasl_type or
83 lmtp_sasl_type configuration parameters by specifying one of the
84 names listed below.
85 cyrus This client plug-in is available when Postfix is built
87 with Cyrus SASL support.
88 This feature is available with Postfix 2.3 and later.
90 -b [template_file]
92 Display the message text that appears at the beginning of deliv‐
93 ery status notification (DSN) messages, expanding $name expres‐
94 sions with actual values as described in bounce(5).
95 To override the bounce_template_file parameter setting, specify
97 a template file name at the end of the "postconf -b" command
98 line. Specify an empty file name to display built-in templates
99 (in shell language: "").
100 This feature is available with Postfix 2.3 and later.
102 -c config_dir
104 The main.cf configuration file is in the named directory instead
105 of the default configuration directory.
106 -C class,...
108 When displaying main.cf parameters, select only parameters from
109 the specified class(es):
110 builtin
112 Parameters with built-in names.
113 service
115 Parameters with service-defined names (the first field of
116 a master.cf entry plus a Postfix-defined suffix).
117 user Parameters with user-defined names.
119 all All the above classes.
121 The default is as if "-C all" is specified.
123 This feature is available with Postfix 2.9 and later.
125 -d Print main.cf default parameter settings instead of actual set‐
127 tings. Specify -df to fold long lines for human readability
128 (Postfix 2.9 and later).
129 -e Edit the main.cf configuration file, and update parameter set‐
131 tings with the "name=value" pairs on the postconf(1) command
132 line.
133 With -M, edit the master.cf configuration file, and replace one
135 or more service entries with new values as specified with "ser‐
136 vice/type=value" on the postconf(1) command line.
137 With -F, edit the master.cf configuration file, and replace one
139 or more service fields with new values as specified with "ser‐
140 vice/type/field=value" on the postconf(1) command line. Cur‐
141 rently, the "command" field contains the command name and com‐
142 mand arguments. this may change in the near future, so that the
143 "command" field contains only the command name, and a new "argu‐
144 ments" pseudofield contains the command arguments.
145 With -P, edit the master.cf configuration file, and add or
147 update one or more service parameter settings (-o parame‐
148 ter=value settings) with new values as specified with "ser‐
149 vice/type/parameter=value" on the postconf(1) command line.
150 In all cases the file is copied to a temporary file then renamed
152 into place. Specify quotes to protect special characters and
153 whitespace on the postconf(1) command line.
154 The -e option is no longer needed with Postfix version 2.8 and
156 later.
157 -f Fold long lines when printing main.cf or master.cf configuration
159 file entries, for human readability.
160 This feature is available with Postfix 2.9 and later.
162 -F Show master.cf per-entry field settings (by default all services
164 and all fields), formatted as "service/type/field=value", one
165 per line. Specify -Ff to fold long lines.
166 Specify one or more "service/type/field" instances on the post‐
168 conf(1) command line to limit the output to fields of interest.
169 Trailing parameter name or service type fields that are omitted
170 will be handled as "*" wildcard fields.
171 This feature is available with Postfix 2.11 and later.
173 -h Show parameter or attribute values without the "name = " label
175 that normally precedes the value.
176 -H Show parameter or attribute names without the " = value" that
178 normally follows the name.
179 This feature is available with Postfix 3.1 and later.
181 -l List the names of all supported mailbox locking methods. Post‐
183 fix supports the following methods:
184 flock A kernel-based advisory locking method for local files
186 only. This locking method is available on systems with a
187 BSD compatible library.
188 fcntl A kernel-based advisory locking method for local and
190 remote files.
191 dotlock
193 An application-level locking method. An application locks
194 a file named filename by creating a file named file‐
195 name.lock. The application is expected to remove its own
196 lock file, as well as stale lock files that were left
197 behind after abnormal program termination.
198 -m List the names of all supported lookup table types. In Postfix
200 configuration files, lookup tables are specified as type:name,
201 where type is one of the types listed below. The table name syn‐
202 tax depends on the lookup table type as described in the DATA‐
203 BASE_README document.
204 btree A sorted, balanced tree structure. Available on systems
206 with support for Berkeley DB databases.
207 cdb A read-optimized structure with no support for incremen‐
209 tal updates. Available on systems with support for CDB
210 databases.
211 This feature is available with Postfix 2.2 and later.
213 cidr A table that associates values with Classless
215 Inter-Domain Routing (CIDR) patterns. This is described
216 in cidr_table(5).
217 This feature is available with Postfix 2.2 and later.
219 dbm An indexed file type based on hashing. Available on sys‐
221 tems with support for DBM databases.
222 environ
224 The UNIX process environment array. The lookup key is the
225 environment variable name; the table name is ignored.
226 Originally implemented for testing, someone may find this
227 useful someday.
228 fail A table that reliably fails all requests. The lookup ta‐
230 ble name is used for logging. This table exists to sim‐
231 plify Postfix error tests.
232 This feature is available with Postfix 2.9 and later.
234 hash An indexed file type based on hashing. Available on sys‐
236 tems with support for Berkeley DB databases.
237 inline (read-only)
239 A non-shared, in-memory lookup table. Example: "inline:{
240 key=value, { key = text with whitespace or comma }}".
241 Key-value pairs are separated by whitespace or comma;
242 whitespace after "{" and before "}" is ignored. Inline
243 tables eliminate the need to create a database file for
244 just a few fixed elements. See also the static: map
245 type.
246 This feature is available with Postfix 3.0 and later.
248 internal
250 A non-shared, in-memory hash table. Its content are lost
251 when a process terminates.
252 lmdb OpenLDAP LMDB database (a memory-mapped, persistent
254 file). Available on systems with support for LMDB data‐
255 bases. This is described in lmdb_table(5).
256 This feature is available with Postfix 2.11 and later.
258 ldap (read-only)
260 LDAP database client. This is described in ldap_table(5).
261 memcache
263 Memcache database client. This is described in mem‐
264 cache_table(5).
265 This feature is available with Postfix 2.9 and later.
267 mysql (read-only)
269 MySQL database client. Available on systems with support
270 for MySQL databases. This is described in mysql_ta‐
271 ble(5).
272 pcre (read-only)
274 A lookup table based on Perl Compatible Regular Expres‐
275 sions. The file format is described in pcre_table(5).
276 pgsql (read-only)
278 PostgreSQL database client. This is described in
279 pgsql_table(5).
280 This feature is available with Postfix 2.1 and later.
282 pipemap (read-only)
284 A lookup table that constructs a pipeline of tables.
285 Example: "pipemap:{type_1:name_1, ..., type_n:name_n}".
286 Each "pipemap:" query is given to the first table. Each
287 lookup result becomes the query for the next table in the
288 pipeline, and the last table produces the final result.
289 When any table lookup produces no result, the pipeline
290 produces no result. The first and last characters of the
291 "pipemap:" table name must be "{" and "}". Within these,
292 individual maps are separated with comma or whitespace.
293 This feature is available with Postfix 3.0 and later.
295 proxy Postfix proxymap(8) client for shared access to Postfix
297 databases. The table name syntax is type:name.
298 This feature is available with Postfix 2.0 and later.
300 randmap (read-only)
302 An in-memory table that performs random selection. Exam‐
303 ple: "randmap:{result_1, ..., result_n}". Each table
304 query returns a random choice from the specified results.
305 The first and last characters of the "randmap:" table
306 name must be "{" and "}". Within these, individual
307 results are separated with comma or whitespace. To give a
308 specific result more weight, specify it multiple times.
309 This feature is available with Postfix 3.0 and later.
311 regexp (read-only)
313 A lookup table based on regular expressions. The file
314 format is described in regexp_table(5).
315 sdbm An indexed file type based on hashing. Available on sys‐
317 tems with support for SDBM databases.
318 This feature is available with Postfix 2.2 and later.
320 socketmap (read-only)
322 Sendmail-style socketmap client. The table name is
323 inet:host:port:name for a TCP/IP server, or unix:path‐
324 name:name for a UNIX-domain server. This is described in
325 socketmap_table(5).
326 This feature is available with Postfix 2.10 and later.
328 sqlite (read-only)
330 SQLite database. This is described in sqlite_table(5).
331 This feature is available with Postfix 2.8 and later.
333 static (read-only)
335 A table that always returns its name as lookup result.
336 For example, static:foobar always returns the string foo‐
337 bar as lookup result. Specify "static:{ text with white‐
338 space }" when the result contains whitespace; this form
339 ignores whitespace after "{" and before "}". See also the
340 inline: map.
341 The form "static:{text} is available with Postfix 3.0 and
343 later.
344 tcp (read-only)
346 TCP/IP client. The protocol is described in tcp_table(5).
347 texthash (read-only)
349 Produces similar results as hash: files, except that you
350 don't need to run the postmap(1) command before you can
351 use the file, and that it does not detect changes after
352 the file is read.
353 This feature is available with Postfix 2.8 and later.
355 unionmap (read-only)
357 A table that sends each query to multiple lookup tables
358 and that concatenates all found results, separated by
359 comma. The table name syntax is the same as for pipemap.
360 This feature is available with Postfix 3.0 and later.
362 unix (read-only)
364 A limited view of the UNIX authentication database. The
365 following tables are implemented:
366 unix:passwd.byname
368 The table is the UNIX password database. The key
369 is a login name. The result is a password file
370 entry in passwd(5) format.
371 unix:group.byname
373 The table is the UNIX group database. The key is a
374 group name. The result is a group file entry in
375 group(5) format.
376 Other table types may exist depending on how Postfix was built.
378 -M Show master.cf file contents instead of main.cf file contents.
380 Specify -Mf to fold long lines for human readability.
381 Specify zero or more arguments, each with a service-name or ser‐
383 vice-name/service-type pair, where service-name is the first
384 field of a master.cf entry and service-type is one of (inet,
385 unix, fifo, or pass).
386 If service-name or service-name/service-type is specified, only
388 the matching master.cf entries will be output. For example,
389 "postconf -Mf smtp" will output all services named "smtp", and
390 "postconf -Mf smtp/inet" will output only the smtp service that
391 listens on the network. Trailing service type fields that are
392 omitted will be handled as "*" wildcard fields.
393 This feature is available with Postfix 2.9 and later. The syntax
395 was changed from "name.type" to "name/type", and "*" wildcard
396 support was added with Postfix 2.11.
397 -n Show only configuration parameters that have explicit name=value
399 settings in main.cf. Specify -nf to fold long lines for human
400 readability (Postfix 2.9 and later).
401 -o name=value
403 Override main.cf parameter settings.
404 This feature is available with Postfix 2.10 and later.
406 -p Show main.cf parameter settings. This is the default.
408 This feature is available with Postfix 2.11 and later.
410 -P Show master.cf service parameter settings (by default all ser‐
412 vices and all parameters), formatted as "service/type/parame‐
413 ter=value", one per line. Specify -Pf to fold long lines.
414 Specify one or more "service/type/parameter" instances on the
416 postconf(1) command line to limit the output to parameters of
417 interest. Trailing parameter name or service type fields that
418 are omitted will be handled as "*" wildcard fields.
419 This feature is available with Postfix 2.11 and later.
421 -t [template_file]
423 Display the templates for text that appears at the beginning of
424 delivery status notification (DSN) messages, without expanding
425 $name expressions.
426 To override the bounce_template_file parameter setting, specify
428 a template file name at the end of the "postconf -t" command
429 line. Specify an empty file name to display built-in templates
430 (in shell language: "").
431 This feature is available with Postfix 2.3 and later.
433 -T mode
435 If Postfix is compiled without TLS support, the -T option pro‐
436 duces no output. Otherwise, if an invalid mode is specified,
437 the -T option reports an error and exits with a non-zero status
438 code. The valid modes are:
439 compile-version
441 Output the OpenSSL version that Postfix was compiled with
442 (i.e. the OpenSSL version in a header file). The output
443 format is the same as with the command "openssl version".
444 run-version
446 Output the OpenSSL version that Postfix is linked with at
447 runtime (i.e. the OpenSSL version in a shared library).
448 public-key-algorithms
450 Output the lower-case names of the supported public-key
451 algorithms, one per-line.
452 This feature is available with Postfix 3.1 and later.
454 -v Enable verbose logging for debugging purposes. Multiple -v
456 options make the software increasingly verbose.
457 -x Expand $name in main.cf or master.cf parameter values. The
459 expansion is recursive.
460 This feature is available with Postfix 2.10 and later.
462 -X Edit the main.cf configuration file, and remove the parameters
464 named on the postconf(1) command line. Specify a list of param‐
465 eter names, not "name=value" pairs.
466 With -M, edit the master.cf configuration file, and remove one
468 or more service entries as specified with "service/type" on the
469 postconf(1) command line.
470 With -P, edit the master.cf configuration file, and remove one
472 or more service parameter settings (-o parameter=value settings)
473 as specified with "service/type/parameter" on the postconf(1)
474 command line.
475 In all cases the file is copied to a temporary file then renamed
477 into place. Specify quotes to protect special characters on the
478 postconf(1) command line.
479 There is no postconf(1) command to perform the reverse opera‐
481 tion.
482 This feature is available with Postfix 2.10 and later. Support
484 for -M and -P was added with Postfix 2.11.
485 -# Edit the main.cf configuration file, and comment out the parame‐
487 ters named on the postconf(1) command line, so that those param‐
488 eters revert to their default values. Specify a list of parame‐
489 ter names, not "name=value" pairs.
490 With -M, edit the master.cf configuration file, and comment out
492 one or more service entries as specified with "service/type" on
493 the postconf(1) command line.
494 In all cases the file is copied to a temporary file then renamed
496 into place. Specify quotes to protect special characters on the
497 postconf(1) command line.
498 There is no postconf(1) command to perform the reverse opera‐
500 tion.
501 This feature is available with Postfix 2.6 and later. Support
503 for -M was added with Postfix 2.11.
504
506 Problems are reported to the standard error stream.
507
509 MAIL_CONFIG
510 Directory with Postfix configuration files.
511
513 The following main.cf parameters are especially relevant to this pro‐
514 gram.
515 The text below provides only a parameter summary. See postconf(5) for
517 more details including examples.
518 config_directory (see 'postconf -d' output)
520 The default location of the Postfix main.cf and master.cf con‐
521 figuration files.
522 bounce_template_file (empty)
524 Pathname of a configuration file with bounce message templates.
525
527 /etc/postfix/main.cf, Postfix configuration parameters
528 /etc/postfix/master.cf, Postfix master daemon configuration
529
531 bounce(5), bounce template file format
532 master(5), master.cf configuration file syntax
533 postconf(5), main.cf configuration file syntax
534
536 Use "postconf readme_directory" or "postconf html_directory" to locate
537 this information.
538 DATABASE_README, Postfix lookup table overview
539
541 The Secure Mailer license must be distributed with this software.
542
544 Wietse Venema
545 IBM T.J. Watson Research
546 P.O. Box 704
547 Yorktown Heights, NY 10598, USA
548 Wietse Venema
550 Google, Inc.
551 111 8th Avenue
552 New York, NY 10011, USA
553 POSTCONF(1)