.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Header::ParameterHeader 3"
.TH Mail::SpamAssassin::Header::ParameterHeader 3 2025-12-13 "perl v5.42.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::SpamAssassin::Header::ParameterHeader \- a header with an optional main value and subsequent name=value pairs
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    my $header = Mail::SpamAssassin::Header::ParameterHeader\->new(\*(Aqtext/plain; charset="utf\-8"\*(Aq);
\&    print $header\->value; # text/plain
\&    print $header\->parameter(\*(Aqcharset\*(Aq); # utf\-8
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class is used internally by SpamAssassin to parse headers that contain a main value followed by name=value pairs.
.SH METHODS
.IX Header "METHODS"
.IP new($value,[$opts]) 4
.IX Item "new($value,[$opts])"
Creates a new instance of the class. Accepts the raw header value as a string and an optional hash reference of options.
.Sp
The following options are available:
.RS 4
.IP "keep_comments (0|1) default: 0" 4
.IX Item "keep_comments (0|1) default: 0"
If set to a false value (default), all comments will be removed from the header value.
Otherwise, comments will be preserved.
.RE
.RS 4
.RE
.IP \fBvalue()\fR 4
.IX Item "value()"
Returns the main value of the header.
.IP \fBparameters()\fR 4
.IX Item "parameters()"
Returns a list of parameter names.
.IP parameter($name) 4
.IX Item "parameter($name)"
Returns the value(s) of the parameter with the given name. If there are multiple parameters with the same name,
and the method is called in scalar context, only the first value is returned. If called in list context,
all values are returned.