Courriel::Header - A single header's name and value
Contents
Api
This class supports the following methods:
Copyright And License
This software is Copyright (c) 2021 by Dave Rolsky.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
The full text of the license can be found in the LICENSE file included with this distribution.
perl v5.32.1 2021-08-22 Courriel::Header(3pm)
Courriel::Header->New( ... )
This method requires two attributes, "name" and "value". Both must be strings. The "name" cannot be
empty, but the "value" can.
$header->name()
The header name as passed to the constructor.
$header->value()
The header value as passed to the constructor.
$header->as_string(charset=>$charset)
Returns the header name and value with any necessary MIME encoding and folding.
The "charset" parameter specifies what character set to use for MIME-encoding non-ASCII values. This
defaults to "utf8". The charset name must be one recognized by the Encode module.
$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 "print()" method. The output may be sent as a single string,
as a list of strings, or via multiple calls to the output.
See the "as_string()" method for documentation on the "charset" parameter.
Description
This class represents a single header, which consists of a name and value.
Name
Courriel::Header - A single header's name and value
Roles
This class does the "Courriel::Role::Streams" role.
Source
The source code repository for Courriel can be found at <https://github.com/houseabsolute/Courriel>.
Support
Bugs may be submitted at <https://github.com/houseabsolute/Courriel/issues>.
I am also usually active on IRC as 'autarch' on "irc://irc.perl.org".
Synopsis
my $subject = $headers->get('subject');
print $subject->value;
Version
version 0.49
