NAME

mail2clf - Convert mail into lines for a Web servers common log file format


SYNOPSIS

mail2clf [-v] [mail...]

mail2clf -H


DESCRIPTION

Converts important information from a mail to lines for a common log file. This format is used by web servers and there are a number of programs which create beautiful visualizations. See WEBALIZER for hints for a configuration file for webalizer.

If mail is given at least once, each must be a path to a file containining a single mail. These mail files are converted. Use - to read a single mail from STDIN.

Omitting mail allows a combination of mail2clf with mail2thread. The output of mail2thread -l is expected on STDIN. The result gives a better picture regarding threads in a bunch of mails since all the mail belonging to a single thread is taken as a hit to a single file named as the thread. -l must be given to mail2thread to have long file names instead of just numbers.

The input is expected to be generated by mail2thread -l and thus must follow a simple format of two types of alternating line blocks.


OPTIONS

-v
--verbose

Operate verbose.

-H
--help

Generate the man page for this program on standard output.

If an unknown option such as -. is given, a short usage message is generated.


WEBALIZER

Since webalizer is a free tool to produce nice graphics, it may be used for the visualization.

Configuration file

The following are useful settings in a webalizer configuration file. Only the differences to the sample file found in the webalizer documentation are given.

LogFile

No log file may be given to use STDIN.

HostName

If a mailing list is visualized, the mail address of the list is a good value for this variable.

HTMLExtension

Since the subjects are mapped into file names without any extension, this must be given and it needs to be an empty string.

VisitTimeout 0

The notion of a visit doesn't make much sense for a mailing list, so this should be turned of.

CountryGraph no
TopCountries 0

Since the host names are mail addresses of the senders of the mail, this makes no sense.

So far neither the referrer field nor the client field of the combined log file format is used.

Notion mapping

The notions used by webalizer or other visualization tools are meant to be used for web server statistics of course. However, mail2clf maps mail, so the following notion mapping applies.

        Web             Mail
        --------------------------------------
        URL             (Thread) subject
        Hits            Number of single mails
        Files           dito
        Site            Address of mail author
        KBytes          Size of mail body
        Visits          Makes no sense
        Entry pages     dito
        Exit pages      dito


EXAMPLE

The following pipeline produces a visualization of the mail from a mailing list considering threads.

        mail2thread -p '\[[a-z]?ox\]' -e -l ~/Mail/oekonux/arc/* |
            mail2clf |
            webalizer -i


PREREQUISITES

Because this is a Perl program, Perl (>= V5.005) must be installed.

This program needs the great MailTools package installed. Try

        http://search.cpan.org/search?dist=MailTools

This program needs the Time-modules package installed. Try

        http://search.cpan.org/search?dist=Time-modules


SEE ALSO

mh

mail2thread

the webalizer manpage


AUTHOR

Stefan Merten <smerten@oekonux.de>


LICENSE

This program is licensed under the terms of the GPL. See

        http://www.gnu.org/licenses/gpl.txt


AVAILABILTY

See

        http://www.merten-home.de/FreeSoftware/mail2clf/