summaryrefslogtreecommitdiffstats
path: root/contrib/sendmail/src/mailq.1
blob: 6b2136f6e3eff7e4dcfc2b4246203390bdb37762 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.\" Copyright (c) 1998-2000, 2002, 2007 Sendmail, Inc. and its suppliers.
.\"	 All rights reserved.
.\" Copyright (c) 1983, 1997 Eric P. Allman.  All rights reserved.
.\" Copyright (c) 1985, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" By using this file, you agree to the terms and conditions set
.\" forth in the LICENSE file which can be found at the top level of
.\" the sendmail distribution.
.\"
.\"
.\"     $Id: mailq.1,v 8.21 2007/03/22 18:21:27 ca Exp $
.\"
.TH MAILQ 1 "$Date: 2007/03/22 18:21:27 $"
.SH NAME
mailq
\- print the mail queue
.SH SYNOPSIS
.B mailq
.RB [ \-Ac ]
.RB [ \-q... ]
.RB [ \-v ]
.SH DESCRIPTION
.B Mailq
prints a summary of the mail messages queued for future delivery.
.PP
The first line printed for each message 
shows the internal identifier used on this host 
for the message with a possible status character, 
the size of the message in bytes,
the date and time the message was accepted into the queue, 
and the envelope sender of the message.  
The second line shows the error message that caused this message 
to be retained in the queue; 
it will not be present if the message is being processed 
for the first time.  
The status characters are either
.B *
to indicate the job is being processed;
.B X
to indicate that the load is too high to process the job; and
.B -
to indicate that the job is too young to process.
The following lines show message recipients, 
one per line.
.PP
.B Mailq
is identical to ``sendmail -bp''.
.PP
The relevant options are as follows:
.TP
.B \-Ac
Show the mail submission queue specified in
.I /etc/mail/submit.cf
instead of the MTA queue specified in
.IR /etc/mail/sendmail.cf .
.TP
.B \-qL
Show the "lost" items in the mail queue instead of the normal queue items.
.TP
.B \-qQ
Show the quarantined items in the mail queue instead of the normal queue
items.
.TP
\fB\-q\fR[\fI!\fR]I substr
Limit processed jobs to those containing
.I substr
as a substring of the queue id or not when
.I !
is specified.
.TP
\fB\-q\fR[\fI!\fR]Q substr
Limit processed jobs to quarantined jobs containing
.I substr
as a substring of the quarantine reason or not when
.I !
is specified.
.TP
\fB\-q\fR[\fI!\fR]R substr
Limit processed jobs to those containing
.I substr
as a substring of one of the recipients or not when
.I !
is specified.
.TP
\fB\-q\fR[\fI!\fR]S substr
Limit processed jobs to those containing
.I substr
as a substring of the sender or not when
.I !
is specified.
.TP
.B \-v
Print verbose information.  
This adds the priority of the message and 
a single character indicator (``+'' or blank) 
indicating whether a warning message has been sent 
on the first line of the message.
Additionally, extra lines may be intermixed with the recipients
indicating the ``controlling user'' information; 
this shows who will own any programs that are executed 
on behalf of this message 
and the name of the alias this command expanded from, if any.
Moreover, status messages for each recipient are printed
if available.
.PP
Several sendmail.cf options influence the behavior of the
.B mailq
utility:
The number of items printed per queue group is restricted by
.B MaxQueueRunSize
if that value is set.
The status character
.B *
is not printed for some values of
.B QueueSortOrder,
e.g.,
filename,
random,
modification, and
none,
unless a
.B -q
option is used to limit the processed jobs.
.PP
The
.B mailq
utility exits 0 on success, and >0 if an error occurs.
.SH SEE ALSO
sendmail(8)
.SH HISTORY
The
.B mailq
command appeared in 
4.0BSD.
.\" $FreeBSD$
OpenPOWER on IntegriCloud