xref: /illumos-gate/usr/src/man/man1/mailstats.1 (revision bbf21555)
te
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
MAILSTATS 1 "Jun 24, 2004"
NAME
mailstats - print statistics collected by sendmail
SYNOPSIS

mailstats [-o] [-c ] [-C configfile] [-f statisticsfile]
 [-p] [-P]
DESCRIPTION

The mailstats utility prints out the statistics collected by the sendmail(8) program on mailer usage. These statistics are collected if the file indicated by the StatusFile configuration option of sendmail (defined in /etc/mail/sendmail.cf) exists. The default statistics file is /etc/mail/statistics.

To enable mailstats, you must, as root, touch /etc/mail/statistics. See the StatusFile processing option in sendmail(8).

mailstats first prints the time that the statistics file was created and the last time it was modified. Then, the statistics for each mailer are displayed on a single line, each with the following whitespace-separated fields: 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 by the mailer.

msgsdis

Number of messages discarded by the mailer.

msgsqur

Number of messages quarantined by the mailer.

Mailer

The name of the mailer.

The display of statistics described above is followed by a separation line containing only equal sign (=) characters. After the separation line, a line preceded with a "T" and totaling the values for all of the mailers is displayed. This is followed by another line preceded with a "C" that lists the number of TCP connections.

To reinitialize the statistics file once a night, add an entry to root's crontab(1):

mailstats -p > /dev/null
OPTIONS

The following options are supported: -c

Try to use submit.cf instead of the default sendmail configuration file.

-C configfile

Specify a sendmail configuration file.

-f statisticsfile

Specify a sendmail statistics file.

-o

Do not display the name of the mailer in the output.

-p

Output information in program-readable mode and clear statistics.

-P

Output information in program-readable mode without clearing statistics.

USAGE

See largefile(7) for the description of the behavior of mailstats when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).

FILES
/dev/null

Zero-lined file

/etc/mail/statistics

Default sendmail statistics file

/etc/mail/sendmail.cf

Default sendmail configuration file

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Output Stability Unstable
SEE ALSO

crontab (1), attributes (7), largefile (7), cron (8), sendmail (8)