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 with a key-value pair inside "{}", whitespace is ignored
243 after the opening "{", around the "=" between key and
244 value, and before the closing "}". Inline tables elimi‐
245 nate the need to create a database file for just a few
246 fixed elements. See also the static: map type.
247 This feature is available with Postfix 3.0 and later.
249 internal
251 A non-shared, in-memory hash table. Its content are lost
252 when a process terminates.
253 lmdb OpenLDAP LMDB database (a memory-mapped, persistent
255 file). Available on systems with support for LMDB data‐
256 bases. This is described in lmdb_table(5).
257 This feature is available with Postfix 2.11 and later.
259 ldap (read-only)
261 LDAP database client. This is described in ldap_table(5).
262 memcache
264 Memcache database client. This is described in mem‐
265 cache_table(5).
266 This feature is available with Postfix 2.9 and later.
268 mysql (read-only)
270 MySQL database client. Available on systems with support
271 for MySQL databases. This is described in mysql_ta‐
272 ble(5).
273 pcre (read-only)
275 A lookup table based on Perl Compatible Regular Expres‐
276 sions. The file format is described in pcre_table(5).
277 pgsql (read-only)
279 PostgreSQL database client. This is described in
280 pgsql_table(5).
281 This feature is available with Postfix 2.1 and later.
283 pipemap (read-only)
285 A lookup table that constructs a pipeline of tables.
286 Example: "pipemap:{type_1:name_1, ..., type_n:name_n}".
287 Each "pipemap:" query is given to the first table. Each
288 lookup result becomes the query for the next table in the
289 pipeline, and the last table produces the final result.
290 When any table lookup produces no result, the pipeline
291 produces no result. The first and last characters of the
292 "pipemap:" table name must be "{" and "}". Within these,
293 individual maps are separated with comma or whitespace.
294 This feature is available with Postfix 3.0 and later.
296 proxy Postfix proxymap(8) client for shared access to Postfix
298 databases. The table name syntax is type:name.
299 This feature is available with Postfix 2.0 and later.
301 randmap (read-only)
303 An in-memory table that performs random selection. Exam‐
304 ple: "randmap:{result_1, ..., result_n}". Each table
305 query returns a random choice from the specified results.
306 The first and last characters of the "randmap:" table
307 name must be "{" and "}". Within these, individual
308 results are separated with comma or whitespace. To give a
309 specific result more weight, specify it multiple times.
310 This feature is available with Postfix 3.0 and later.
312 regexp (read-only)
314 A lookup table based on regular expressions. The file
315 format is described in regexp_table(5).
316 sdbm An indexed file type based on hashing. Available on sys‐
318 tems with support for SDBM databases.
319 This feature is available with Postfix 2.2 and later.
321 socketmap (read-only)
323 Sendmail-style socketmap client. The table name is
324 inet:host:port:name for a TCP/IP server, or unix:path‐
325 name:name for a UNIX-domain server. This is described in
326 socketmap_table(5).
327 This feature is available with Postfix 2.10 and later.
329 sqlite (read-only)
331 SQLite database. This is described in sqlite_table(5).
332 This feature is available with Postfix 2.8 and later.
334 static (read-only)
336 A table that always returns its name as lookup result.
337 For example, static:foobar always returns the string foo‐
338 bar as lookup result. Specify "static:{ text with white‐
339 space }" when the result contains whitespace; this form
340 ignores whitespace after the opening "{" and before the
341 closing "}". See also the inline: map.
342 The form "static:{text} is available with Postfix 3.0 and
344 later.
345 tcp (read-only)
347 TCP/IP client. The protocol is described in tcp_table(5).
348 texthash (read-only)
350 Produces similar results as hash: files, except that you
351 don't need to run the postmap(1) command before you can
352 use the file, and that it does not detect changes after
353 the file is read.
354 This feature is available with Postfix 2.8 and later.
356 unionmap (read-only)
358 A table that sends each query to multiple lookup tables
359 and that concatenates all found results, separated by
360 comma. The table name syntax is the same as for pipemap.
361 This feature is available with Postfix 3.0 and later.
363 unix (read-only)
365 A limited view of the UNIX authentication database. The
366 following tables are implemented:
367 unix:passwd.byname
369 The table is the UNIX password database. The key
370 is a login name. The result is a password file
371 entry in passwd(5) format.
372 unix:group.byname
374 The table is the UNIX group database. The key is a
375 group name. The result is a group file entry in
376 group(5) format.
377 Other table types may exist depending on how Postfix was built.
379 -M Show master.cf file contents instead of main.cf file contents.
381 Specify -Mf to fold long lines for human readability.
382 Specify zero or more arguments, each with a service-name or ser‐
384 vice-name/service-type pair, where service-name is the first
385 field of a master.cf entry and service-type is one of (inet,
386 unix, fifo, or pass).
387 If service-name or service-name/service-type is specified, only
389 the matching master.cf entries will be output. For example,
390 "postconf -Mf smtp" will output all services named "smtp", and
391 "postconf -Mf smtp/inet" will output only the smtp service that
392 listens on the network. Trailing service type fields that are
393 omitted will be handled as "*" wildcard fields.
394 This feature is available with Postfix 2.9 and later. The syntax
396 was changed from "name.type" to "name/type", and "*" wildcard
397 support was added with Postfix 2.11.
398 -n Show only configuration parameters that have explicit name=value
400 settings in main.cf. Specify -nf to fold long lines for human
401 readability (Postfix 2.9 and later). To show settings that dif‐
402 fer from built-in defaults only, use the following bash syntax:
403 comm -23 <(postconf -n) <(postconf -d)
404 Replace "-23" with "-12" to show settings that duplicate
405 built-in defaults.
406 -o name=value
408 Override main.cf parameter settings.
409 This feature is available with Postfix 2.10 and later.
411 -p Show main.cf parameter settings. This is the default.
413 This feature is available with Postfix 2.11 and later.
415 -P Show master.cf service parameter settings (by default all ser‐
417 vices and all parameters), formatted as "service/type/parame‐
418 ter=value", one per line. Specify -Pf to fold long lines.
419 Specify one or more "service/type/parameter" instances on the
421 postconf(1) command line to limit the output to parameters of
422 interest. Trailing parameter name or service type fields that
423 are omitted will be handled as "*" wildcard fields.
424 This feature is available with Postfix 2.11 and later.
426 -t [template_file]
428 Display the templates for text that appears at the beginning of
429 delivery status notification (DSN) messages, without expanding
430 $name expressions.
431 To override the bounce_template_file parameter setting, specify
433 a template file name at the end of the "postconf -t" command
434 line. Specify an empty file name to display built-in templates
435 (in shell language: "").
436 This feature is available with Postfix 2.3 and later.
438 -T mode
440 If Postfix is compiled without TLS support, the -T option pro‐
441 duces no output. Otherwise, if an invalid mode is specified,
442 the -T option reports an error and exits with a non-zero status
443 code. The valid modes are:
444 compile-version
446 Output the OpenSSL version that Postfix was compiled with
447 (i.e. the OpenSSL version in a header file). The output
448 format is the same as with the command "openssl version".
449 run-version
451 Output the OpenSSL version that Postfix is linked with at
452 runtime (i.e. the OpenSSL version in a shared library).
453 public-key-algorithms
455 Output the lower-case names of the supported public-key
456 algorithms, one per-line.
457 This feature is available with Postfix 3.1 and later.
459 -v Enable verbose logging for debugging purposes. Multiple -v
461 options make the software increasingly verbose.
462 -x Expand $name in main.cf or master.cf parameter values. The
464 expansion is recursive.
465 This feature is available with Postfix 2.10 and later.
467 -X Edit the main.cf configuration file, and remove the parameters
469 named on the postconf(1) command line. Specify a list of param‐
470 eter names, not "name=value" pairs.
471 With -M, edit the master.cf configuration file, and remove one
473 or more service entries as specified with "service/type" on the
474 postconf(1) command line.
475 With -P, edit the master.cf configuration file, and remove one
477 or more service parameter settings (-o parameter=value settings)
478 as specified with "service/type/parameter" on the postconf(1)
479 command line.
480 In all cases the file is copied to a temporary file then renamed
482 into place. Specify quotes to protect special characters on the
483 postconf(1) command line.
484 There is no postconf(1) command to perform the reverse opera‐
486 tion.
487 This feature is available with Postfix 2.10 and later. Support
489 for -M and -P was added with Postfix 2.11.
490 -# Edit the main.cf configuration file, and comment out the parame‐
492 ters named on the postconf(1) command line, so that those param‐
493 eters revert to their default values. Specify a list of parame‐
494 ter names, not "name=value" pairs.
495 With -M, edit the master.cf configuration file, and comment out
497 one or more service entries as specified with "service/type" on
498 the postconf(1) command line.
499 In all cases the file is copied to a temporary file then renamed
501 into place. Specify quotes to protect special characters on the
502 postconf(1) command line.
503 There is no postconf(1) command to perform the reverse opera‐
505 tion.
506 This feature is available with Postfix 2.6 and later. Support
508 for -M was added with Postfix 2.11.
509
511 Problems are reported to the standard error stream.
512
514 MAIL_CONFIG
515 Directory with Postfix configuration files.
516
518 The following main.cf parameters are especially relevant to this pro‐
519 gram.
520 The text below provides only a parameter summary. See postconf(5) for
522 more details including examples.
523 config_directory (see 'postconf -d' output)
525 The default location of the Postfix main.cf and master.cf con‐
526 figuration files.
527 bounce_template_file (empty)
529 Pathname of a configuration file with bounce message templates.
530
532 /etc/postfix/main.cf, Postfix configuration parameters
533 /etc/postfix/master.cf, Postfix master daemon configuration
534
536 bounce(5), bounce template file format
537 master(5), master.cf configuration file syntax
538 postconf(5), main.cf configuration file syntax
539
541 Use "postconf readme_directory" or "postconf html_directory" to locate
542 this information.
543 DATABASE_README, Postfix lookup table overview
544
546 The Secure Mailer license must be distributed with this software.
547
549 Wietse Venema
550 IBM T.J. Watson Research
551 P.O. Box 704
552 Yorktown Heights, NY 10598, USA
553 Wietse Venema
555 Google, Inc.
556 111 8th Avenue
557 New York, NY 10011, USA
558 POSTCONF(1)