.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Email::Folder::Mbox 3pm" .TH Email::Folder::Mbox 3pm "2016-03-14" "perl v5.22.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Email::Folder::Mbox \- reads raw RFC822 mails from an mbox file .SH "VERSION" .IX Header "VERSION" version 0.860 .SH "SYNOPSIS" .IX Header "SYNOPSIS" This isa Email::Folder::Reader \- read about its \s-1API\s0 there. .SH "DESCRIPTION" .IX Header "DESCRIPTION" Does exactly what it says on the tin \- fetches raw \s-1RFC822\s0 mails from an mbox. .PP The mbox format is described at http://www.qmail.org/man/man5/mbox.html .PP We attempt to read an mbox as through it's the mboxcl2 variant, falling back to regular mbox mode if there is no \f(CW\*(C`Content\-Length\*(C'\fR header to be found. .SS "\s-1OPTIONS\s0" .IX Subsection "OPTIONS" The new constructor takes extra options. .ie n .IP """fh""" 4 .el .IP "\f(CWfh\fR" 4 .IX Item "fh" When filename is set to \f(CW"FH"\fR than Email::Folder::Mbox will read mbox archive from filehandle \f(CW\*(C`fh\*(C'\fR instead from disk file \f(CW\*(C`filename\*(C'\fR. .ie n .IP """eol""" 4 .el .IP "\f(CWeol\fR" 4 .IX Item "eol" This indicates what the line-ending style is to be. The default is \&\f(CW"\en"\fR, but for handling files with mac line-endings you would want to specify \f(CW\*(C`eol => "\ex0d"\*(C'\fR .ie n .IP """jwz_From_""" 4 .el .IP "\f(CWjwz_From_\fR" 4 .IX Item "jwz_From_" The value is taken as a boolean that governs what is used match as a message separator. .Sp If false we use the mutt style .Sp .Vb 2 \& /^From \eS+\es+(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun)/ \& /^From (?:Mon|Tue|Wed|Thu|Fri|Sat|Sun)/; .Ve .Sp If true we use .Sp .Vb 1 \& /^From / .Ve .Sp In deference to this extract from .Sp .Vb 6 \& Essentially the only safe way to parse that file format is to \& consider all lines which begin with the characters \`\`From \*(Aq\*(Aq \& (From\-space), which are preceded by a blank line or \& beginning\-of\-file, to be the division between messages. That is, the \& delimiter is "\en\enFrom .*\en" except for the very first message in the \& file, where it is "^From .*\en". \& \& 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 \*(Aq\*(Aq 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\*(Aqs nothing \& after that. But you can\*(Aqt rely on any of this. .Ve .Sp Defaults to false. .ie n .IP """unescape""" 4 .el .IP "\f(CWunescape\fR" 4 .IX Item "unescape" This boolean value indicates whenever lines which starts with .Sp .Vb 1 \& /^>+From / .Ve .Sp should be unescaped (= removed leading '>' char). This is needed for mboxrd and mboxcl variants. But there is no way to detect for used mbox variant, so default value is false. .ie n .IP """seek_to""" 4 .el .IP "\f(CWseek_to\fR" 4 .IX Item "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. .ie n .IP """next_message""" 4 .el .IP "\f(CWnext_message\fR" 4 .IX Item "next_message" This returns next message as string .ie n .IP """next_messageref""" 4 .el .IP "\f(CWnext_messageref\fR" 4 .IX Item "next_messageref" This returns next message as ref to string .ie n .IP """tell""" 4 .el .IP "\f(CWtell\fR" 4 .IX Item "tell" This returns the current filehandle position in the mbox. .ie n .IP """next_from""" 4 .el .IP "\f(CWnext_from\fR" 4 .IX Item "next_from" This returns the From_ line for next message. Call it before \->next_message. .ie n .IP """messageid""" 4 .el .IP "\f(CWmessageid\fR" 4 .IX Item "messageid" This returns the messageid of last read message. Call if after \->next_message. .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Simon Wistow .IP "\(bu" 4 Richard Clamp .IP "\(bu" 4 Pali .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2006 by Simon Wistow. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.