NAME
mailstats — print mail traffic statistics
SYNOPSIS
mailstats
[-C
cffile]
[-f
stfile]
[-o]
[-p]
DESCRIPTION
mailstats
reads and interprets the
sendmail
statistics file,
and then prints out the mail traffic statistics.
The statistics file is the one set by the
StatusFile
option in the
/etc/mail/sendmail.cf.
The default statistics file is
/etc/mail/sendmail.st.
If the statistics file exists,
sendmail
collects statistics about your mail traffic
and stores them in that file.
This file does not grow.
Statistics are gathered on a per-mailer basis
for each mailer defined in the
sendmail
configuration file.
Statistics are kept on the number of messages
and the number of bytes for all inbound and outbound traffic.
The
mailstats
utility displays the time at
which statistics collection was started on the first line.
Then, the statistics of each mailer is displayed on a
single line, each with the following white space separated fields
(see the "EXAMPLES" section below):
- M
The mailer number.
- msgsfr
Number of messages from the mailer.
- bytes_from
Kbytes from the mailer.
- msgsto
Number of messages to the mailer.
- bytes_to
Kbytes to the mailer.
- msgsrej
Number of messages rejected.
- msgsdis
Number of messages discarded.
- Mailer
The name of the mailer.
After this display, a line totaling the values for all of the mailers
is displayed,
separated from the previous information by a line containing only equals
(``='') characters.
Note
mailstats
can be used by privileged users only.
Options
The options are as follows:
- -C cffile
Read the specified
cffile
instead of the default
/etc/mail/sendmail.cf
file.
- -f stfile
Read the specified statistics file,
stfile,
instead of the statistics file
specified in the
/etc/mail/sendmail.cf
file.
- -o
Do not display the name of the mailer in the output.
- -p
Output information in program-readable mode and clear statistics.
To clear the statistics file, execute, as root:
cp /dev/null statistics-file
RETURN VALUE
The
mailstats
utility exits with 0 on success, and >0 if an error occurs.
DIAGNOSTICS
mailstats
generates error messages if the statistics file is not accessible
or if the size of the statistics file has changed.
Error messages are:
- mailstats: file size changed
Either
statistics-file
is zero length,
meaning that no mail has been transferred since it was cleared out,
or its size has changed.
Since the size of this file is supposed to remain constant,
any change in size means that the file is invalid.
- mailstats: statistics-file: No such file or directory
The statistics file does not exist.
- mailstats: statistics-file: Permission denied
The statistics file's permissions are set so that you cannot read it.
EXAMPLES
Here is a typical example of
mailstats
output:
Statistics from Thu Jul 11 14:12:40 1996
M msgsfr bytes_from msgsto bytes_to msgsrej msgsdis Mailer
0 0 0K 3 4K 0 0 prog
3 3 4K 0 0K 0 0 local
5 2 1K 11 11K 4 0 esmtp
=============================================================
T 13 13K 14 15K 4 0
This example shows that mailers 0, 3 and 5
have handled the given amounts of mail traffic since Thursday, Jul 11th.
Specifically,
sendmail
has sent 11 messages containing 11 kilobytes via mailer esmtp (M 5),
but has 4 messages rejected via mailer esmtp (M 5).
AUTHOR
mailstats
was developed by the University of California, Berkeley.
FILES
- /etc/mail/sendmail.st
default mail traffic statistics file
- /etc/mail/sendmail.cf
sendmail configuration file
Printable version
