.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >0, 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 "Mail::Mbox::MessageParser::Perl 3pm"
.TH Mail::Mbox::MessageParser::Perl 3pm "2023-08-06" "perl v5.36.0" "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"
Mail::Mbox::MessageParser::Perl \- A Perl\-based mbox folder reader
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  #!/usr/bin/perl
\&
\&  use Mail::Mbox::MessageParser;
\&
\&  my $filename = \*(Aqmail/saved\-mail\*(Aq;
\&  my $filehandle = new FileHandle($filename);
\&
\&  my $folder_reader =
\&    new Mail::Mbox::MessageParser( {
\&      \*(Aqfile_name\*(Aq => $filename,
\&      \*(Aqfile_handle\*(Aq => $filehandle,
\&    } );
\&
\&  die $folder_reader unless ref $folder_reader;
\&
\&  # Any newlines or such before the start of the first email
\&  my $prologue = $folder_reader\->prologue;
\&  print $prologue;
\&
\&  # This is the main loop. It\*(Aqs executed once for each email
\&  while(!$folder_reader\->end_of_file());
\&  {
\&    my $email = $folder_reader\->read_next_email();
\&    print $$email;
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a Perl-based mbox folder reader.  Users must not
instantiate this class directly\*(--use Mail::Mbox::MessageParser instead. The
base MessageParser module will automatically manage the use of faster
implementations if they can be used.
.SS "\s-1METHODS AND FUNCTIONS\s0"
.IX Subsection "METHODS AND FUNCTIONS"
The following methods and functions are specific to the
Mail::Mbox::MessageParser::Perl package. For additional inherited ones, see
the Mail::Mbox::MessageParser documentation.
.ie n .IP "$ref = new( { 'file_name' => <mailbox file name>, 'file_handle' => <mailbox file handle> });" 4
.el .IP "\f(CW$ref\fR = new( { 'file_name' => <mailbox file name>, 'file_handle' => <mailbox file handle> });" 4
.IX Item "$ref = new( { 'file_name' => <mailbox file name>, 'file_handle' => <mailbox file handle> });"
.Vb 2
\&    <file_name> \- The full filename of the mailbox
\&    <file_handle> \- An opened file handle for the mailbox
.Ve
.Sp
The constructor for the class takes two parameters. The optional \fIfile_name\fR
parameter is the filename of the mailbox. The required \fIfile_handle\fR argument
is the opened file handle to the mailbox.
.Sp
Returns a reference to a Mail::Mbox::MessageParser object, or a string
describing the error.
.IP "\fBend_of_file()\fR" 4
.IX Item "end_of_file()"
.PD 0
.IP "\fBreset()\fR" 4
.IX Item "reset()"
.IP "\fBread_next_email()\fR" 4
.IX Item "read_next_email()"
.PD
These methods are overridden in this subclass of Mail::Mbox::MessageParser.
.SH "BUGS"
.IX Header "BUGS"
No known bugs.
.PP
Contact david@coppit.org for bug reports and suggestions.
.SH "AUTHOR"
.IX Header "AUTHOR"
David Coppit <david@coppit.org>.
.SH "LICENSE"
.IX Header "LICENSE"
This code is distributed under the \s-1GNU\s0 General Public License (\s-1GPL\s0) Version 2.
See the file \s-1LICENSE\s0 in the distribution for details.
.SH "HISTORY"
.IX Header "HISTORY"
This code was originally part of the grepmail distribution. See
http://grepmail.sf.net/ for previous versions of grepmail which included early
versions of this code.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::Mbox::MessageParser