Mail::Box::Parser::Perl(3pm)				User Contributed Perl Documentation			      Mail::Box::Parser::Perl(3pm)

NAME

       Mail::Box::Parser::Perl - reading messages from file using Perl

INHERITANCE

	Mail::Box::Parser::Perl
	  is a Mail::Box::Parser
	  is a Mail::Reporter

DESCRIPTION

       The "Mail::Box::Parser::Perl" implements parsing of messages in Perl.  This may be a little slower than the "C" based parser
       Mail::Box::Parser::C, but will also work on platforms where no C compiler is available.

METHODS

   Constructors
       Mail::Box::Parser::Perl->new(OPTIONS)
	    -Option	      --Defined in     --Default
	     file		Mail::Box::Parser  undef
	     filename		Mail::Box::Parser  <required>
	     fix_header_errors			 <false>
	     log		Mail::Reporter	 'WARNINGS'
	     mode		Mail::Box::Parser  'r'
	     trace		Mail::Reporter	 'WARNINGS'
	     trusted				 <false>

	   file => FILE-HANDLE
	   filename => FILENAME
	   fix_header_errors => BOOLEAN
	     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.

	   log => LEVEL
	   mode => OPENMODE
	   trace => LEVEL
	   trusted => BOOLEAN
	     Is the input from the file to be trusted, or does it require extra tests.	Related to Mail::Box::new(trusted).

   The parser
       $obj->fileChanged()
	   See "The parser" in Mail::Box::Parser

       $obj->filename()
	   See "The parser" in Mail::Box::Parser

       $obj->fixHeaderErrors([BOOLEAN])
	   If set to "true", parsing of a header will not stop on an error, but attempt to add the erroneous this line to previous field.  Without
	   BOOLEAN, the current setting is returned.

	   example:

	    $folder->parser->fixHeaderErrors(1);
	    my $folder = $mgr->open('folder', fix_header_errors => 1);

       $obj->restart()
	   See "The parser" in Mail::Box::Parser

       $obj->start(OPTIONS)
	   See "The parser" in Mail::Box::Parser

       $obj->stop()
	   See "The parser" in Mail::Box::Parser

   Parsing
       $obj->bodyAsFile(FILEHANDLE [,CHARS [,LINES]])
	   See "Parsing" in Mail::Box::Parser

       $obj->bodyAsList([,CHARS [,LINES]])
	   See "Parsing" in Mail::Box::Parser

       $obj->bodyAsString([,CHARS [,LINES]])
	   See "Parsing" in Mail::Box::Parser

       $obj->bodyDelayed([,CHARS [,LINES]])
	   See "Parsing" in Mail::Box::Parser

       $obj->filePosition([POSITION])
	   See "Parsing" in Mail::Box::Parser

       $obj->lineSeparator()
	   See "Parsing" in Mail::Box::Parser

       $obj->popSeparator()
	   See "Parsing" in Mail::Box::Parser

       $obj->pushSeparator(STRING|REGEXP)
	   See "Parsing" in Mail::Box::Parser

       $obj->readHeader()
       $obj->readSeparator(OPTIONS)
	   See "Parsing" in Mail::Box::Parser

   Internals
       $obj->closeFile()
	   See "Internals" in Mail::Box::Parser

       $obj->defaultParserType([CLASS])
       Mail::Box::Parser::Perl->defaultParserType([CLASS])
	   See "Internals" in Mail::Box::Parser

       $obj->openFile(ARGS)
	   See "Internals" in Mail::Box::Parser

       $obj->takeFileInfo()
	   See "Internals" in Mail::Box::Parser

   Error handling
       $obj->AUTOLOAD()
	   See "Error handling" in Mail::Reporter

       $obj->addReport(OBJECT)
	   See "Error handling" in Mail::Reporter

       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
       Mail::Box::Parser::Perl->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
	   See "Error handling" in Mail::Reporter

       $obj->errors()
	   See "Error handling" in Mail::Reporter

       $obj->log([LEVEL [,STRINGS]])
       Mail::Box::Parser::Perl->log([LEVEL [,STRINGS]])
	   See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)
       Mail::Box::Parser::Perl->logPriority(LEVEL)
	   See "Error handling" in Mail::Reporter

       $obj->logSettings()
	   See "Error handling" in Mail::Reporter

       $obj->notImplemented()
	   See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->trace([LEVEL])
	   See "Error handling" in Mail::Reporter

       $obj->warnings()
	   See "Error handling" in Mail::Reporter

   Cleanup
       $obj->DESTROY()
	   See "Cleanup" in Mail::Reporter

       $obj->inGlobalDestruction()
	   See "Cleanup" in Mail::Reporter

DIAGNOSTICS

       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.

	   Calling Mail::Box::update() 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.

       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.

       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 MIME
	   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.

	   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.

SEE ALSO

       This module is part of Mail-Box distribution version 2.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/

LICENSE

       Copyrights 2001-2012 by [Mark Overmeer]. For other contributors see ChangeLog.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html

perl v5.14.2							    2012-05-07					      Mail::Box::Parser::Perl(3pm)