| blob | d4de8fcaca959ad1c795c77519e02555b139cb75 |
1 .\" $NetBSD$
2 .\"
3 .TH POSTSUPER 1
4 .ad
5 .fi
6 .SH NAME
7 postsuper
8 \-
9 Postfix superintendent
10 .SH "SYNOPSIS"
11 .na
12 .nf
13 .fi
14 \fBpostsuper\fR [\fB-psv\fR]
15 [\fB-c \fIconfig_dir\fR] [\fB-d \fIqueue_id\fR]
16 [\fB-h \fIqueue_id\fR] [\fB-H \fIqueue_id\fR]
17 [\fB-r \fIqueue_id\fR] [\fIdirectory ...\fR]
18 .SH DESCRIPTION
19 .ad
20 .fi
21 The \fBpostsuper\fR(1) command does maintenance jobs on the Postfix
22 queue. Use of the command is restricted to the superuser.
23 See the \fBpostqueue\fR(1) command for unprivileged queue operations
24 such as listing or flushing the mail queue.
26 By default, \fBpostsuper\fR(1) performs the operations
27 requested with the
28 \fB-s\fR and \fB-p\fR command-line options on all Postfix queue
29 directories - this includes the \fBincoming\fR, \fBactive\fR and
30 \fBdeferred\fR directories with mail files and the \fBbounce\fR,
31 \fBdefer\fR, \fBtrace\fR and \fBflush\fR directories with log files.
33 Options:
34 .IP "\fB-c \fIconfig_dir\fR"
35 The \fBmain.cf\fR configuration file is in the named directory
36 instead of the default configuration directory. See also the
37 MAIL_CONFIG environment setting below.
38 .IP "\fB-d \fIqueue_id\fR"
39 Delete one message with the named queue ID from the named
40 mail queue(s) (default: \fBhold\fR, \fBincoming\fR, \fBactive\fR and
41 \fBdeferred\fR).
43 If a \fIqueue_id\fR of \fB-\fR is specified, the program reads
44 queue IDs from standard input. For example, to delete all mail
45 with exactly one recipient \fBuser@example.com\fR:
46 .sp
47 .nf
48 mailq | tail +2 | grep -v '^ *(' | awk \'BEGIN { RS = "" }
49 # $7=sender, $8=recipient1, $9=recipient2
50 { if ($8 == "user@example.com" && $9 == "")
51 print $1 }
52 \' | tr -d '*!' | postsuper -d -
53 .fi
54 .sp
55 Specify "\fB-d ALL\fR" to remove all messages; for example, specify
56 "\fB-d ALL deferred\fR" to delete all mail in the \fBdeferred\fR queue.
57 As a safety measure, the word \fBALL\fR must be specified in upper
58 case.
59 .sp
60 Warning: Postfix queue IDs are reused.
61 There is a very small possibility that postsuper deletes the
62 wrong message file when it is executed while the Postfix mail
63 system is delivering mail.
64 .sp
65 The scenario is as follows:
66 .RS
67 .IP 1)
68 The Postfix queue manager deletes the message that \fBpostsuper\fR(1)
69 is asked to delete, because Postfix is finished with the
70 message (it is delivered, or it is returned to the sender).
71 .IP 2)
72 New mail arrives, and the new message is given the same queue ID
73 as the message that \fBpostsuper\fR(1) is supposed to delete.
74 The probability for reusing a deleted queue ID is about 1 in 2**15
75 (the number of different microsecond values that the system clock
76 can distinguish within a second).
77 .IP 3)
78 \fBpostsuper\fR(1) deletes the new message, instead of the old
79 message that it should have deleted.
80 .RE
81 .IP "\fB-h \fIqueue_id\fR"
82 Put mail "on hold" so that no attempt is made to deliver it.
83 Move one message with the named queue ID from the named
84 mail queue(s) (default: \fBincoming\fR, \fBactive\fR and
85 \fBdeferred\fR) to the \fBhold\fR queue.
87 If a \fIqueue_id\fR of \fB-\fR is specified, the program reads
88 queue IDs from standard input.
89 .sp
90 Specify "\fB-h ALL\fR" to hold all messages; for example, specify
91 "\fB-h ALL deferred\fR" to hold all mail in the \fBdeferred\fR queue.
92 As a safety measure, the word \fBALL\fR must be specified in upper
93 case.
94 .sp
95 Note: while mail is "on hold" it will not expire when its
96 time in the queue exceeds the \fBmaximal_queue_lifetime\fR
97 or \fBbounce_queue_lifetime\fR setting. It becomes subject to
98 expiration after it is released from "hold".
99 .sp
100 This feature is available in Postfix 2.0 and later.
101 .IP "\fB-H \fIqueue_id\fR"
102 Release mail that was put "on hold".
103 Move one message with the named queue ID from the named
104 mail queue(s) (default: \fBhold\fR) to the \fBdeferred\fR queue.
106 If a \fIqueue_id\fR of \fB-\fR is specified, the program reads
107 queue IDs from standard input.
108 .sp
109 Note: specify "\fBpostsuper -r\fR" to release mail that was kept on
110 hold for a significant fraction of \fB$maximal_queue_lifetime\fR
111 or \fB$bounce_queue_lifetime\fR, or longer.
112 .sp
113 Specify "\fB-H ALL\fR" to release all mail that is "on hold".
114 As a safety measure, the word \fBALL\fR must be specified in upper
115 case.
116 .sp
117 This feature is available in Postfix 2.0 and later.
118 .IP \fB-p\fR
119 Purge old temporary files that are left over after system or
120 software crashes.
121 .IP "\fB-r \fIqueue_id\fR"
122 Requeue the message with the named queue ID from the named
123 mail queue(s) (default: \fBhold\fR, \fBincoming\fR, \fBactive\fR and
124 \fBdeferred\fR).
125 To requeue multiple messages, specify multiple \fB-r\fR
126 command-line options.
128 Alternatively, if a \fIqueue_id\fR of \fB-\fR is specified,
129 the program reads queue IDs from standard input.
130 .sp
131 Specify "\fB-r ALL\fR" to requeue all messages. As a safety
132 measure, the word \fBALL\fR must be specified in upper case.
133 .sp
134 A requeued message is moved to the \fBmaildrop\fR queue,
135 from where it is copied by the \fBpickup\fR(8) and
136 \fBcleanup\fR(8) daemons to a new queue file. In many
137 respects its handling differs from that of a new local
138 submission.
139 .RS
140 .IP \(bu
141 The message is not subjected to the smtpd_milters or
142 non_smtpd_milters settings. When mail has passed through
143 an external content filter, this would produce incorrect
144 results with Milter applications that depend on original
145 SMTP connection state information.
146 .IP \(bu
147 The message is subjected again to mail address rewriting
148 and substitution. This is useful when rewriting rules or
149 virtual mappings have changed.
150 .sp
151 The address rewriting context (local or remote) is the same
152 as when the message was received.
153 .IP \(bu
154 The message is subjected to the same content_filter settings
155 (if any) as used for new local mail submissions. This is
156 useful when content_filter settings have changed.
157 .RE
158 .IP
159 Warning: Postfix queue IDs are reused.
160 There is a very small possibility that \fBpostsuper\fR(1) requeues
161 the wrong message file when it is executed while the Postfix mail
162 system is running, but no harm should be done.
163 .sp
164 This feature is available in Postfix 1.1 and later.
165 .IP \fB-s\fR
166 Structure check and structure repair. This should be done once
167 before Postfix startup.
168 .RS
169 .IP \(bu
170 Rename files whose name does not match the message file inode
171 number. This operation is necessary after restoring a mail queue
172 from a different machine, or from backup media.
173 .IP \(bu
174 Move queue files that are in the wrong place in the file system
175 hierarchy and remove subdirectories that are no longer needed.
176 File position rearrangements are necessary after a change in the
177 \fBhash_queue_names\fR and/or \fBhash_queue_depth\fR
178 configuration parameters.
179 .RE
180 .IP \fB-v\fR
181 Enable verbose logging for debugging purposes. Multiple \fB-v\fR
182 options make the software increasingly verbose.
183 .SH DIAGNOSTICS
184 .ad
185 .fi
186 Problems are reported to the standard error stream and to
187 \fBsyslogd\fR(8).
189 \fBpostsuper\fR(1) reports the number of messages deleted with \fB-d\fR,
190 the number of messages requeued with \fB-r\fR, and the number of
191 messages whose queue file name was fixed with \fB-s\fR. The report
192 is written to the standard error stream and to \fBsyslogd\fR(8).
193 .SH "ENVIRONMENT"
194 .na
195 .nf
196 .ad
197 .fi
198 .IP MAIL_CONFIG
199 Directory with the \fBmain.cf\fR file.
200 .SH BUGS
201 .ad
202 .fi
203 Mail that is not sanitized by Postfix (i.e. mail in the \fBmaildrop\fR
204 queue) cannot be placed "on hold".
205 .SH "CONFIGURATION PARAMETERS"
206 .na
207 .nf
208 .ad
209 .fi
210 The following \fBmain.cf\fR parameters are especially relevant to
211 this program.
212 The text below provides only a parameter summary. See
213 \fBpostconf\fR(5) for more details including examples.
214 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
215 The default location of the Postfix main.cf and master.cf
216 configuration files.
217 .IP "\fBhash_queue_depth (1)\fR"
218 The number of subdirectory levels for queue directories listed with
219 the hash_queue_names parameter.
220 .IP "\fBhash_queue_names (deferred, defer)\fR"
221 The names of queue directories that are split across multiple
222 subdirectory levels.
223 .IP "\fBqueue_directory (see 'postconf -d' output)\fR"
224 The location of the Postfix top-level queue directory.
225 .IP "\fBsyslog_facility (mail)\fR"
226 The syslog facility of Postfix logging.
227 .IP "\fBsyslog_name (see 'postconf -d' output)\fR"
228 The mail system name that is prepended to the process name in syslog
229 records, so that "smtpd" becomes, for example, "postfix/smtpd".
230 .SH "SEE ALSO"
231 .na
232 .nf
233 sendmail(1), Sendmail-compatible user interface
234 postqueue(1), unprivileged queue operations
235 .SH "LICENSE"
236 .na
237 .nf
238 .ad
239 .fi
240 The Secure Mailer license must be distributed with this software.
241 .SH "AUTHOR(S)"
242 .na
243 .nf
244 Wietse Venema
245 IBM T.J. Watson Research
246 P.O. Box 704
247 Yorktown Heights, NY 10598, USA