.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Courriel::HeaderAttribute 3pm"
.TH Courriel::HeaderAttribute 3pm "2021-08-22" "perl v5.32.1" "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"
Courriel::HeaderAttribute \- A single attribute belonging to a header
.SH "VERSION"
.IX Header "VERSION"
version 0.49
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  my $ct = $headers\->get(\*(AqContent\-Type\*(Aq);
\&  print $ct\->get_attribute(\*(Aqcharset\*(Aq)\->value;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents a single attribute belonging to a header. An attribute
consists of a name and value, with optional charset and language information.
.SH "API"
.IX Header "API"
This class supports the following methods:
.SH "Courriel::HeaderAttribute\->new( ... )"
.IX Header "Courriel::HeaderAttribute->new( ... )"
This method creates a new object. It accepts the following parameters:
.IP "\(bu" 4
name
.Sp
The name of the attribute. This should be a non-empty string.
.IP "\(bu" 4
value
.Sp
The value of the attribute. This can be empty.
.IP "\(bu" 4
charset
.Sp
The charset for the value. If the value contains any non-ASCII data, this will
always be \*(L"\s-1UTF\-8\*(R",\s0 otherwise the default is \*(L"us-ascii\*(R".
.IP "\(bu" 4
language
.Sp
The language for the attribute's value. It should be a valid \s-1ISO\s0 language code
like \*(L"en-us\*(R" or \*(L"zh\*(R". This is optional.
.ie n .SS "$attribute\->\fBname()\fP"
.el .SS "\f(CW$attribute\fP\->\fBname()\fP"
.IX Subsection "$attribute->name()"
The attribute name as passed to the constructor.
.ie n .SS "$attribute\->\fBvalue()\fP"
.el .SS "\f(CW$attribute\fP\->\fBvalue()\fP"
.IX Subsection "$attribute->value()"
The attribute value as passed to the constructor.
.ie n .SS "$attribute\->\fBcharset()\fP"
.el .SS "\f(CW$attribute\fP\->\fBcharset()\fP"
.IX Subsection "$attribute->charset()"
The attribute's charset.
.ie n .SS "$attribute\->\fBlanguage()\fP"
.el .SS "\f(CW$attribute\fP\->\fBlanguage()\fP"
.IX Subsection "$attribute->language()"
The attribute's language.
.ie n .SS "$attribute\->\fBas_string()\fP"
.el .SS "\f(CW$attribute\fP\->\fBas_string()\fP"
.IX Subsection "$attribute->as_string()"
This returns the attribute in a form suitable for putting in an email. This may
involve escaping, quoting, splitting up, and otherwise messing with the value.
.PP
If the value needs to be split across continuations, each name/value pair is
returned separate by a space, but not folded across multiple lines.
.ie n .SS "$attribute\->stream_to( output => $output )"
.el .SS "\f(CW$attribute\fP\->stream_to( output => \f(CW$output\fP )"
.IX Subsection "$attribute->stream_to( output => $output )"
This method will send the stringified attribute to the specified output. The
output can be a subroutine reference, a filehandle, or an object with a
\&\f(CW\*(C`print()\*(C'\fR method. The output may be sent as a single string, as a list of
strings, or via multiple calls to the output.
.SH "ROLES"
.IX Header "ROLES"
This class does the \f(CW\*(C`Courriel::Role::Streams\*(C'\fR role.
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted at <https://github.com/houseabsolute/Courriel/issues>.
.PP
I am also usually active on \s-1IRC\s0 as 'autarch' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR.
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Courriel can be found at <https://github.com/houseabsolute/Courriel>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2021 by Dave Rolsky.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Artistic License 2.0 (GPL Compatible)
.Ve
.PP
The full text of the license can be found in the
\&\fI\s-1LICENSE\s0\fR file included with this distribution.