NAME
Email::Folder::Mbox - reads raw RFC822 mails from an mbox file
SYNOPSIS
This isa Email::Folder::Reader - read about its API there.
DESCRIPTION
Does exactly what it says on the tin - fetches raw RFC822 mails from an mbox.
The mbox format is described at http://www.qmail.org/man/man5/mbox.html
We attempt to read an mbox as through it's the mboxcl2 variant, falling back to regular mbox mode if there is no Content-Length
header to be found.
OPTIONS
The new constructor takes extra options.
eol
-
This indicates what the line-ending style is to be. The default is
"\n"
, but for handling files with mac line-endings you would want to specifyeol => "\x0d"
jwz_From_
-
The value is taken as a boolean that governs what is used match as a message seperator.
If false we use the mutt style
/^From \S+\s+(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun)/
/^From (?:Mon|Tue|Wed|Thu|Fri|Sat|Sun)/;
If true we use
/^From /
In deference to this extract from Content-Length Considered Harmful
Essentially the only safe way to parse that file
format
is to
consider all lines which begin
with
the characters ``From
''
(From-space), which are preceded by a blank line or
beginning-of-file, to be the division between messages. That is, the
delimiter is
"\n\nFrom .*\n"
except
for
the very first message in the
file, where it is
"^From .*\n"
.
Some people will
tell
you that you should
do
stricter parsing on
those lines: check
for
user names and dates and so on. They are
wrong. The random crap that
has
traditionally been dumped into that
line is without bound; comparing the first five characters is the
only safe and portable thing to
do
. Usually, but not always, the
next
token on the line
after
``From
''
will be a user-id, or email
address, or UUCP path, and usually the
next
thing on the line will be
a date specification, in some
format
, and usually there's nothing
after
that. But you can't rely on any of this.
Defaults to false.
seek_to
-
Seek to an offset when opening the mbox. When used in combination with ->tell you may be able to resume reading, with a trailing wind.
AUTHORS
Simon Wistow <simon@thegestalt.org>
Richard Clamp <richardc@unixbeard.net>
COPYING
Copyright 2003, Simon Wistow
Distributed under the same terms as Perl itself.
This software is under no warranty and will probably ruin your life, kill your friends, burn your house and bring about the apocolapyse.