NAME

Mail::Box::Parser::C - Parsing folders for MailBox with C routines

INHERITANCE

Mail::Box::Parser::C
  is a Mail::Box::Parser
  is a Mail::Reporter

Mail::Box::Parser::C
  is a DynaLoader

SYNOPSIS

DESCRIPTION

The Mail::Box::Parser::C implements parsing of messages in ANSI C, using Perl's XS extension facility.

This is an optional module for MailBox, and will (once installed) automatically be used by MailBox to parse e-mail message content when the message is supplied as file-handle. In all other cases, MailBox will use Mail::Box::Parser::Perl.

This is a maintenance release for the old interface. Read https://github.com/markov2/perl5-Mail-Box/wiki/ how to move towards version 4.

Extends "DESCRIPTION" in Mail::Box::Parser.

METHODS

Extends "METHODS" in Mail::Box::Parser.

Constructors

Extends "Constructors" in Mail::Box::Parser.

$class->new(%options)

Inherited, see "METHODS" in Mail::Box::Parser

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

file => $filehandle: Any IO::File or GLOB $filehandle which can be used to read the data from. In case this option is specified, the filename is informational only.
filename => $name: The $name of the file to be read.
fix_header_errors => BOOLEAN
log => LEVEL
mode => $mode: File open $mode, which defaults to 'r', which means `read-only'. See perldoc -f open for possible modes. Only applicable when no file is specified.
trace => LEVEL
trusted => BOOLEAN

Attributes

Extends "Attributes" in Mail::Box::Parser.

$obj->boxnr(): The number internally used by the C implementation to administer a single mail folder access.
$any->defaultParserType( [$class] ): Inherited, see "Attributes" in Mail::Box::Parser
$obj->file()
$obj->filename(): Returns the name of the file this parser is working on.
$obj->fixHeaderErrors( [BOOLEAN] ): Inherited, see "Attributes" in Mail::Box::Parser
$obj->logSettings(): Inherited, see "Attributes" in Mail::Reporter
$obj->openMode()
$obj->trusted(): Inherited, see "Attributes" in Mail::Box::Parser

Parsing

Extends "Parsing" in Mail::Box::Parser.

$obj->bodyAsFile( $fh [$chars, [$lines]] )

Inherited, see "Parsing" in Mail::Box::Parser

$obj->bodyAsList( [$chars, [$lines]] )

Inherited, see "Parsing" in Mail::Box::Parser

$obj->bodyAsString( [$chars, [$lines]] )

Inherited, see "Parsing" in Mail::Box::Parser

$obj->bodyDelayed( [$chars, [$lines]] )

Inherited, see "Parsing" in Mail::Box::Parser

$obj->fileChanged()

Returns whether the file which is parsed has changed after the last time takeFileInfo() was called.

$obj->filePosition( [$position] )

Returns the location of the next byte to be used in the file which is parsed. When a $position is specified, the location in the file is moved to the indicated spot first.

$obj->lineSeparator()

Inherited, see "Parsing" in Mail::Box::Parser

$obj->openFile(%options)

[3.013] Open the file to be parsed.

$obj->readHeader()

Inherited, see "Parsing" in Mail::Box::Parser

$obj->restart(%options)

Restart the parser on a certain file, usually because the content has changed. The %options are passed to openFile().

$obj->start(%options)

Start the parser by opening a file.

-Option--Default
 file    undef

file => FILEHANDLE|undef: The file is already open, for instance because the data must be read from STDIN.

$obj->stop()

Stop the parser, which will include a close of the file. The lock on the folder will not be removed (is not the responsibility of the parser). Improves base, see "Parsing" in Mail::Box::Parser

$obj->takeFileInfo()

Capture some data about the file being parsed, to be compared later.

Error handling

Extends "Error handling" in Mail::Box::Parser.

$obj->AUTOLOAD(): Inherited, see "Error handling" in Mail::Reporter
$obj->addReport($object): Inherited, see "Error handling" in Mail::Reporter
$any->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] ): Inherited, see "Error handling" in Mail::Reporter
$obj->errors(): Inherited, see "Error handling" in Mail::Reporter
$any->log( [$level, [$strings]] ): Inherited, see "Error handling" in Mail::Reporter
$any->logPriority($level): Inherited, see "Error handling" in Mail::Reporter
$obj->notImplemented(): Inherited, see "Error handling" in Mail::Reporter
$obj->report( [$level] ): Inherited, see "Error handling" in Mail::Reporter
$obj->reportAll( [$level] ): Inherited, see "Error handling" in Mail::Reporter
$obj->trace( [$level] ): Inherited, see "Error handling" in Mail::Reporter
$obj->warnings(): Inherited, see "Error handling" in Mail::Reporter

Cleanup

Extends "Cleanup" in Mail::Box::Parser.

$obj->DESTROY(): Inherited, see "Cleanup" in Mail::Reporter

DIAGNOSTICS

Warning: File $file 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 whether 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. Cast by stop()

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. Cast by notImplemented()

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_header_errors) set, the parsing of the header will be continued. The erroneous line will be added to the preceding field. Cast by readHeader()

LICENSE

For contributors see file ChangeLog.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install Mail::Box::Parser::C, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Mail::Box::Parser::C

CPAN shell

perl -MCPAN -e shell
install Mail::Box::Parser::C

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

INHERITANCE

SYNOPSIS

DESCRIPTION

METHODS

Constructors

Attributes

Parsing

Error handling

Cleanup

DIAGNOSTICS

SEE ALSO

LICENSE

Module Install Instructions