.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "MIME::Parser::Results 3pm"
.TH MIME::Parser::Results 3pm 2024-04-27 "perl v5.38.2" "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
MIME::Parser::Results \- results of the last entity parsed
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Before reading further, you should see MIME::Parser to make sure that
you understand where this module fits into the grand scheme of things.
Go on, do it now.  I'll wait.
.PP
Ready?  Ok...
.PP
.Vb 3
\&   ### Do parse, get results:
\&   my $entity = eval { $parser\->parse(\e*STDIN); };
\&   my $results  = $parser\->results;
\&
\&   ### Get all messages logged:
\&   @msgs = $results\->msgs;
\&
\&   ### Get messages of specific types (also tests if there were problems):
\&   $had_errors   = $results\->errors;
\&   $had_warnings = $results\->warnings;
\&
\&   ### Get outermost header:
\&   $top_head  = $results\->top_head;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Results from the last MIME::Parser parse.
.SH "PUBLIC INTERFACE"
.IX Header "PUBLIC INTERFACE"
.IP new 4
.IX Item "new"
\&\fIConstructor.\fR
.IP msgs 4
.IX Item "msgs"
\&\fIInstance method.\fR
Return all messages that we logged, in order.
Every message is a string beginning with its type followed by \f(CW": "\fR;
the current types are \f(CW\*(C`debug\*(C'\fR, \f(CW\*(C`warning\*(C'\fR, and \f(CW\*(C`error\*(C'\fR.
.IP errors 4
.IX Item "errors"
\&\fIInstance method.\fR
Return all error messages that we logged, in order.
A convenience front-end onto \fBmsgs()\fR.
.IP warnings 4
.IX Item "warnings"
\&\fIInstance method.\fR
Return all warning messages that we logged, in order.
A convenience front-end onto \fBmsgs()\fR.
.IP top_head 4
.IX Item "top_head"
\&\fIInstance method.\fR
Return the topmost header, if we were able to read it.
This may be useful if the parse fails.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MIME::Tools, MIME::Parser
.SH AUTHOR
.IX Header "AUTHOR"
Eryq (\fIeryq@zeegee.com\fR), ZeeGee Software Inc (\fIhttp://www.zeegee.com\fR).
.PP
All rights reserved.  This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.