/usr/share/perl5/Mail/Box/Parser/Perl.pod is in libmail-message-perl 3.006-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 | =encoding utf8
=head1 NAME
Mail::Box::Parser::Perl - reading messages from file using Perl
=head1 INHERITANCE
Mail::Box::Parser::Perl
is a Mail::Box::Parser
is a Mail::Reporter
=head1 SYNOPSIS
=head1 DESCRIPTION
The C<Mail::Box::Parser::Perl> implements parsing of messages
in Perl. This may be a little slower than the C<C> based parser
L<Mail::Box::Parser::C|Mail::Box::Parser::C>, but will also work on platforms where no C
compiler is available.
Extends L<"DESCRIPTION" in Mail::Box::Parser|Mail::Box::Parser/"DESCRIPTION">.
=head1 METHODS
Extends L<"METHODS" in Mail::Box::Parser|Mail::Box::Parser/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Mail::Box::Parser|Mail::Box::Parser/"Constructors">.
=over 4
=item Mail::Box::Parser::Perl-E<gt>B<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>
=over 2
=item file => FILE-HANDLE
=item filename => FILENAME
=item 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.
=item log => LEVEL
=item mode => OPENMODE
=item trace => LEVEL
=item trusted => BOOLEAN
Is the input from the file to be trusted, or does it require extra
tests. Related to L<Mail::Box::new(trusted)|Mail::Box/"Constructors">.
=back
=back
=head2 The parser
Extends L<"The parser" in Mail::Box::Parser|Mail::Box::Parser/"The parser">.
=over 4
=item $obj-E<gt>B<fileChanged>()
Inherited, see L<Mail::Box::Parser/"The parser">
=item $obj-E<gt>B<filename>()
Inherited, see L<Mail::Box::Parser/"The parser">
=item $obj-E<gt>B<fixHeaderErrors>( [BOOLEAN] )
If set to C<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);
=item $obj-E<gt>B<restart>()
Inherited, see L<Mail::Box::Parser/"The parser">
=item $obj-E<gt>B<start>(%options)
Inherited, see L<Mail::Box::Parser/"The parser">
=item $obj-E<gt>B<stop>()
Inherited, see L<Mail::Box::Parser/"The parser">
=back
=head2 Parsing
Extends L<"Parsing" in Mail::Box::Parser|Mail::Box::Parser/"Parsing">.
=over 4
=item $obj-E<gt>B<bodyAsFile>( $fh [$chars, [$lines]] )
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<bodyAsList>( [$chars, [$lines]] )
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<bodyAsString>( [$chars, [$lines]] )
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<bodyDelayed>( [$chars, [$lines]] )
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<filePosition>( [$position] )
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<lineSeparator>()
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<popSeparator>()
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<pushSeparator>(STRING|Regexp)
Inherited, see L<Mail::Box::Parser/"Parsing">
=item $obj-E<gt>B<readHeader>()
=item $obj-E<gt>B<readSeparator>(%options)
Inherited, see L<Mail::Box::Parser/"Parsing">
=back
=head2 Internals
Extends L<"Internals" in Mail::Box::Parser|Mail::Box::Parser/"Internals">.
=over 4
=item $obj-E<gt>B<closeFile>()
Inherited, see L<Mail::Box::Parser/"Internals">
=item $obj-E<gt>B<defaultParserType>( [$class] )
=item Mail::Box::Parser::Perl-E<gt>B<defaultParserType>( [$class] )
Inherited, see L<Mail::Box::Parser/"Internals">
=item $obj-E<gt>B<openFile>($args)
Inherited, see L<Mail::Box::Parser/"Internals">
=item $obj-E<gt>B<takeFileInfo>()
Inherited, see L<Mail::Box::Parser/"Internals">
=back
=head2 Error handling
Extends L<"Error handling" in Mail::Box::Parser|Mail::Box::Parser/"Error handling">.
=over 4
=item $obj-E<gt>B<AUTOLOAD>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<addReport>($object)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
=item Mail::Box::Parser::Perl-E<gt>B<defaultTrace>( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<errors>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<log>( [$level, [$strings]] )
=item Mail::Box::Parser::Perl-E<gt>B<log>( [$level, [$strings]] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logPriority>($level)
=item Mail::Box::Parser::Perl-E<gt>B<logPriority>($level)
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<logSettings>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<notImplemented>()
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<report>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<reportAll>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<trace>( [$level] )
Inherited, see L<Mail::Reporter/"Error handling">
=item $obj-E<gt>B<warnings>()
Inherited, see L<Mail::Reporter/"Error handling">
=back
=head2 Cleanup
Extends L<"Cleanup" in Mail::Box::Parser|Mail::Box::Parser/"Cleanup">.
=over 4
=item $obj-E<gt>B<DESTROY>()
Inherited, see L<Mail::Reporter/"Cleanup">
=back
=head1 DIAGNOSTICS
=over 4
=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 whether there
were changes in the file made by external programs.
Calling L<Mail::Box::update()|Mail::Box/"The folder"> 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.
=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.
=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 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.
=back
=head1 SEE ALSO
This module is part of Mail-Message distribution version 3.006,
built on January 24, 2018. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
Copyrights 2001-2018 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 F<http://dev.perl.org/licenses/>
|