.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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 "Mail::AuthenticationResults::Parser 3"
.TH Mail::AuthenticationResults::Parser 3 2024-09-01 "perl v5.40.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::AuthenticationResults::Parser \- Class for parsing Authentication Results Headers
.SH VERSION
.IX Header "VERSION"
version 2.20231031
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Class for parsing Authentication Results headers into objects.
.PP
takes a string and returns a Mail::AuthenticationResults::Header object
.SH METHODS
.IX Header "METHODS"
.ie n .SS "new( $header )"
.el .SS "new( \f(CW$header\fP )"
.IX Subsection "new( $header )"
Return a new Parser instance.
.PP
If \f(CW$header\fR is supplied then parse it and return the parsed object.
.ie n .SS "parse( $header )"
.el .SS "parse( \f(CW$header\fP )"
.IX Subsection "parse( $header )"
Parse \f(CW$header\fR and return the parsed object.
.ie n .SS "from_authentication_results_json( $json )"
.el .SS "from_authentication_results_json( \f(CW$json\fP )"
.IX Subsection "from_authentication_results_json( $json )"
Parse \f(CW$json\fR as the json returned from an as_json method call and return the parsed object.
.ie n .SS "tokenise( $header )"
.el .SS "tokenise( \f(CW$header\fP )"
.IX Subsection "tokenise( $header )"
Tokenise the given \f(CW$header\fR string
.SS \fBparsed()\fP
.IX Subsection "parsed()"
Return the parsed object tree
.SH AUTHOR
.IX Header "AUTHOR"
Marc Bradshaw <marc@marcbradshaw.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2021 by Marc Bradshaw.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.