.\" 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::Header 3pm"
.TH Courriel::Header 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::Header \- A single header's name and value
.SH "VERSION"
.IX Header "VERSION"
version 0.49
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  my $subject = $headers\->get(\*(Aqsubject\*(Aq);
\&  print $subject\->value;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents a single header, which consists of a name and value.
.SH "API"
.IX Header "API"
This class supports the following methods:
.SH "Courriel::Header\->new( ... )"
.IX Header "Courriel::Header->new( ... )"
This method requires two attributes, \f(CW\*(C`name\*(C'\fR and \f(CW\*(C`value\*(C'\fR. Both must be
strings. The \f(CW\*(C`name\*(C'\fR cannot be empty, but the \f(CW\*(C`value\*(C'\fR can.
.ie n .SS "$header\->\fBname()\fP"
.el .SS "\f(CW$header\fP\->\fBname()\fP"
.IX Subsection "$header->name()"
The header name as passed to the constructor.
.ie n .SS "$header\->\fBvalue()\fP"
.el .SS "\f(CW$header\fP\->\fBvalue()\fP"
.IX Subsection "$header->value()"
The header value as passed to the constructor.
.ie n .SS "$header\->as_string( charset => $charset )"
.el .SS "\f(CW$header\fP\->as_string( charset => \f(CW$charset\fP )"
.IX Subsection "$header->as_string( charset => $charset )"
Returns the header name and value with any necessary \s-1MIME\s0 encoding and folding.
.PP
The \f(CW\*(C`charset\*(C'\fR parameter specifies what character set to use for MIME-encoding
non-ASCII values. This defaults to \*(L"utf8\*(R". The charset name must be one
recognized by the Encode module.
.ie n .SS "$header\->stream_to( output => $output, charset => ... )"
.el .SS "\f(CW$header\fP\->stream_to( output => \f(CW$output\fP, charset => ... )"
.IX Subsection "$header->stream_to( output => $output, charset => ... )"
This method will send the stringified header 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.
.PP
See the \f(CW\*(C`as_string()\*(C'\fR method for documentation on the \f(CW\*(C`charset\*(C'\fR parameter.
.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.