.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Mail::Box::Parser::Perl 3pm"
.TH Mail::Box::Parser::Perl 3pm "2014-08-24" "perl v5.20.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::Box::Parser::Perl \- reading messages from file using Perl
.SH "INHERITANCE"
.IX Header "INHERITANCE"
.Vb 3
\& Mail::Box::Parser::Perl
\&   is a Mail::Box::Parser
\&   is a Mail::Reporter
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Mail::Box::Parser::Perl\*(C'\fR implements parsing of messages
in Perl.  This may be a little slower than the \f(CW\*(C`C\*(C'\fR based parser
Mail::Box::Parser::C, but will also work on platforms where no C
compiler is available.
.PP
Extends \*(L"\s-1DESCRIPTION\*(R"\s0 in Mail::Box::Parser.
.SH "METHODS"
.IX Header "METHODS"
Extends \*(L"\s-1METHODS\*(R"\s0 in Mail::Box::Parser.
.SS "Constructors"
.IX Subsection "Constructors"
Extends \*(L"Constructors\*(R" in Mail::Box::Parser.
.IP "Mail::Box::Parser::Perl\->\fBnew\fR(%options)" 4
.IX Item "Mail::Box::Parser::Perl->new(%options)"
.Vb 8
\& \-Option           \-\-Defined in       \-\-Default
\&  file               Mail::Box::Parser  undef
\&  filename           Mail::Box::Parser  <required>
\&  fix_header_errors                     <false>
\&  log                Mail::Reporter     \*(AqWARNINGS\*(Aq
\&  mode               Mail::Box::Parser  \*(Aqr\*(Aq
\&  trace              Mail::Reporter     \*(AqWARNINGS\*(Aq
\&  trusted                               <false>
.Ve
.RS 4
.IP "file => FILE-HANDLE" 2
.IX Item "file => FILE-HANDLE"
.PD 0
.IP "filename => \s-1FILENAME\s0" 2
.IX Item "filename => FILENAME"
.IP "fix_header_errors => \s-1BOOLEAN\s0" 2
.IX Item "fix_header_errors => BOOLEAN"
.PD
When header errors are detected, the parsing of the header will
be stopped.  Other header lines will become part of the body of
the message.  Set this flag to have the erroneous line added to
the previous header line.
.IP "log => \s-1LEVEL\s0" 2
.IX Item "log => LEVEL"
.PD 0
.IP "mode => \s-1OPENMODE\s0" 2
.IX Item "mode => OPENMODE"
.IP "trace => \s-1LEVEL\s0" 2
.IX Item "trace => LEVEL"
.IP "trusted => \s-1BOOLEAN\s0" 2
.IX Item "trusted => BOOLEAN"
.PD
Is the input from the file to be trusted, or does it require extra
tests.  Related to Mail::Box::new(trusted).
.RE
.RS 4
.RE
.SS "The parser"
.IX Subsection "The parser"
Extends \*(L"The parser\*(R" in Mail::Box::Parser.
.ie n .IP "$obj\->\fBfileChanged\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBfileChanged\fR()" 4
.IX Item "$obj->fileChanged()"
Inherited, see \*(L"The parser\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBfilename\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBfilename\fR()" 4
.IX Item "$obj->filename()"
Inherited, see \*(L"The parser\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBfixHeaderErrors\fR( [\s-1BOOLEAN\s0] )" 4
.el .IP "\f(CW$obj\fR\->\fBfixHeaderErrors\fR( [\s-1BOOLEAN\s0] )" 4
.IX Item "$obj->fixHeaderErrors( [BOOLEAN] )"
If set to \f(CW\*(C`true\*(C'\fR, parsing of a header will not stop on an error, but
attempt to add the erroneous this line to previous field.  Without \s-1BOOLEAN,\s0
the current setting is returned.
.Sp
example:
.Sp
.Vb 2
\& $folder\->parser\->fixHeaderErrors(1);
\& my $folder = $mgr\->open(\*(Aqfolder\*(Aq, fix_header_errors => 1);
.Ve
.ie n .IP "$obj\->\fBrestart\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBrestart\fR()" 4
.IX Item "$obj->restart()"
Inherited, see \*(L"The parser\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBstart\fR(%options)" 4
.el .IP "\f(CW$obj\fR\->\fBstart\fR(%options)" 4
.IX Item "$obj->start(%options)"
Inherited, see \*(L"The parser\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBstop\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBstop\fR()" 4
.IX Item "$obj->stop()"
Inherited, see \*(L"The parser\*(R" in Mail::Box::Parser
.SS "Parsing"
.IX Subsection "Parsing"
Extends \*(L"Parsing\*(R" in Mail::Box::Parser.
.ie n .IP "$obj\->\fBbodyAsFile\fR( $fh [$chars, [$lines]] )" 4
.el .IP "\f(CW$obj\fR\->\fBbodyAsFile\fR( \f(CW$fh\fR [$chars, [$lines]] )" 4
.IX Item "$obj->bodyAsFile( $fh [$chars, [$lines]] )"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBbodyAsList\fR( [$chars, [$lines]] )" 4
.el .IP "\f(CW$obj\fR\->\fBbodyAsList\fR( [$chars, [$lines]] )" 4
.IX Item "$obj->bodyAsList( [$chars, [$lines]] )"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBbodyAsString\fR( [$chars, [$lines]] )" 4
.el .IP "\f(CW$obj\fR\->\fBbodyAsString\fR( [$chars, [$lines]] )" 4
.IX Item "$obj->bodyAsString( [$chars, [$lines]] )"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBbodyDelayed\fR( [$chars, [$lines]] )" 4
.el .IP "\f(CW$obj\fR\->\fBbodyDelayed\fR( [$chars, [$lines]] )" 4
.IX Item "$obj->bodyDelayed( [$chars, [$lines]] )"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBfilePosition\fR( [$position] )" 4
.el .IP "\f(CW$obj\fR\->\fBfilePosition\fR( [$position] )" 4
.IX Item "$obj->filePosition( [$position] )"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBlineSeparator\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBlineSeparator\fR()" 4
.IX Item "$obj->lineSeparator()"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBpopSeparator\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBpopSeparator\fR()" 4
.IX Item "$obj->popSeparator()"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBpushSeparator\fR(STRING|Regexp)" 4
.el .IP "\f(CW$obj\fR\->\fBpushSeparator\fR(STRING|Regexp)" 4
.IX Item "$obj->pushSeparator(STRING|Regexp)"
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBreadHeader\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBreadHeader\fR()" 4
.IX Item "$obj->readHeader()"
.PD 0
.ie n .IP "$obj\->\fBreadSeparator\fR(%options)" 4
.el .IP "\f(CW$obj\fR\->\fBreadSeparator\fR(%options)" 4
.IX Item "$obj->readSeparator(%options)"
.PD
Inherited, see \*(L"Parsing\*(R" in Mail::Box::Parser
.SS "Internals"
.IX Subsection "Internals"
Extends \*(L"Internals\*(R" in Mail::Box::Parser.
.ie n .IP "$obj\->\fBcloseFile\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBcloseFile\fR()" 4
.IX Item "$obj->closeFile()"
Inherited, see \*(L"Internals\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBdefaultParserType\fR( [$class] )" 4
.el .IP "\f(CW$obj\fR\->\fBdefaultParserType\fR( [$class] )" 4
.IX Item "$obj->defaultParserType( [$class] )"
.PD 0
.IP "Mail::Box::Parser::Perl\->\fBdefaultParserType\fR( [$class] )" 4
.IX Item "Mail::Box::Parser::Perl->defaultParserType( [$class] )"
.PD
Inherited, see \*(L"Internals\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBopenFile\fR($args)" 4
.el .IP "\f(CW$obj\fR\->\fBopenFile\fR($args)" 4
.IX Item "$obj->openFile($args)"
Inherited, see \*(L"Internals\*(R" in Mail::Box::Parser
.ie n .IP "$obj\->\fBtakeFileInfo\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBtakeFileInfo\fR()" 4
.IX Item "$obj->takeFileInfo()"
Inherited, see \*(L"Internals\*(R" in Mail::Box::Parser
.SS "Error handling"
.IX Subsection "Error handling"
Extends \*(L"Error handling\*(R" in Mail::Box::Parser.
.ie n .IP "$obj\->\fB\s-1AUTOLOAD\s0\fR()" 4
.el .IP "\f(CW$obj\fR\->\fB\s-1AUTOLOAD\s0\fR()" 4
.IX Item "$obj->AUTOLOAD()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBaddReport\fR($object)" 4
.el .IP "\f(CW$obj\fR\->\fBaddReport\fR($object)" 4
.IX Item "$obj->addReport($object)"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4
.el .IP "\f(CW$obj\fR\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4
.IX Item "$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )"
.PD 0
.ie n .IP "Mail::Box::Parser::Perl\->\fBdefaultTrace\fR( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )" 4
.el .IP "Mail::Box::Parser::Perl\->\fBdefaultTrace\fR( [$level]|[$loglevel, \f(CW$tracelevel\fR]|[$level, \f(CW$callback\fR] )" 4
.IX Item "Mail::Box::Parser::Perl->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )"
.PD
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBerrors\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBerrors\fR()" 4
.IX Item "$obj->errors()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBlog\fR( [$level, [$strings]] )" 4
.el .IP "\f(CW$obj\fR\->\fBlog\fR( [$level, [$strings]] )" 4
.IX Item "$obj->log( [$level, [$strings]] )"
.PD 0
.IP "Mail::Box::Parser::Perl\->\fBlog\fR( [$level, [$strings]] )" 4
.IX Item "Mail::Box::Parser::Perl->log( [$level, [$strings]] )"
.PD
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBlogPriority\fR($level)" 4
.el .IP "\f(CW$obj\fR\->\fBlogPriority\fR($level)" 4
.IX Item "$obj->logPriority($level)"
.PD 0
.IP "Mail::Box::Parser::Perl\->\fBlogPriority\fR($level)" 4
.IX Item "Mail::Box::Parser::Perl->logPriority($level)"
.PD
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBlogSettings\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBlogSettings\fR()" 4
.IX Item "$obj->logSettings()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBnotImplemented\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBnotImplemented\fR()" 4
.IX Item "$obj->notImplemented()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBreport\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBreport\fR( [$level] )" 4
.IX Item "$obj->report( [$level] )"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBreportAll\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBreportAll\fR( [$level] )" 4
.IX Item "$obj->reportAll( [$level] )"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBtrace\fR( [$level] )" 4
.el .IP "\f(CW$obj\fR\->\fBtrace\fR( [$level] )" 4
.IX Item "$obj->trace( [$level] )"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.ie n .IP "$obj\->\fBwarnings\fR()" 4
.el .IP "\f(CW$obj\fR\->\fBwarnings\fR()" 4
.IX Item "$obj->warnings()"
Inherited, see \*(L"Error handling\*(R" in Mail::Reporter
.SS "Cleanup"
.IX Subsection "Cleanup"
Extends \*(L"Cleanup\*(R" in Mail::Box::Parser.
.ie n .IP "$obj\->\fB\s-1DESTROY\s0\fR()" 4
.el .IP "\f(CW$obj\fR\->\fB\s-1DESTROY\s0\fR()" 4
.IX Item "$obj->DESTROY()"
Inherited, see \*(L"Cleanup\*(R" in Mail::Reporter
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP "Warning: File $filename changed during access." 4
.el .IP "Warning: File \f(CW$filename\fR changed during access." 4
.IX Item "Warning: File $filename changed during access."
When a message parser starts working, it takes size and modification time
of the file at hand.  If the folder is written, it checks wether there
were changes in the file made by external programs.
.Sp
Calling \fIMail::Box::update()\fR on a folder before it being closed
will read these new messages.  But the real source of this problem is
locking: some external program (for instance the mail transfer agent,
like sendmail) uses a different locking mechanism as you do and therefore
violates your rights.
.ie n .IP "Error: Package $package does not implement $method." 4
.el .IP "Error: Package \f(CW$package\fR does not implement \f(CW$method\fR." 4
.IX Item "Error: Package $package does not implement $method."
Fatal error: the specific package (or one of its superclasses) does not
implement this method where it should. This message means that some other
related classes do implement this method however the class at hand does
not.  Probably you should investigate this and probably inform the author
of the package.
.ie n .IP "Warning: Unexpected end of header in $source: $line" 4
.el .IP "Warning: Unexpected end of header in \f(CW$source:\fR \f(CW$line\fR" 4
.IX Item "Warning: Unexpected end of header in $source: $line"
While parsing a message from the specified source (usually a file name),
the parser found a syntax error.  According to the \s-1MIME\s0 specification in the
RFCs, each header line must either contain a colon, or start with a blank
to indicate a folded field.  Apparently, this header contains a line which
starts on the first position, but not with a field name.
.Sp
By default, parsing of the header will be stopped.  If there are more header
lines after the erroneous line, they will be added to the body of the message.
In case of new(fix_headers) set, the parsing of the header will be continued.
The erroneous line will be added to the preceding field.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Mail-Box distribution version 2.117,
built on August 24, 2014. Website: \fIhttp://perl.overmeer.net/mailbox/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2001\-2014 by [Mark Overmeer]. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR