courriel::header(3pm) [debian man page]

Courriel::Header(3pm)					User Contributed Perl Documentation				     Courriel::Header(3pm)

NAME

       Courriel::Header - A single header's name and value

VERSION

       version 0.29

SYNOPSIS

	 my $subject = $headers->get('subject');
	 print $subject->value();

DESCRIPTION

       This class represents a single header, which consists of a name and value.

API

       This class supports the following methods:

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.

ROLES

       This class does the "Courriel::Role::Streams" role.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2012 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.14.2							    2012-03-07						     Courriel::Header(3pm)

Courriel::HeaderAttribute(3pm)				User Contributed Perl Documentation			    Courriel::HeaderAttribute(3pm)

NAME

       Courriel::HeaderAttribute - A single attribute belonging to a header

VERSION

       version 0.29

SYNOPSIS

	 my $ct = $headers->get('Content-Type');
	 print $ct->get_attribute('charset')->value();

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.

API

       This class supports the following methods:

Courriel::HeaderAttribute->new( ... )
       This method creates a new object. It accepts the following parameters:

       o   name

	   The name of the attribute. This should be a non-empty string.

       o   value

	   The value of the attribute. This can be empty.

       o   charset

	   The charset for the value. If the value contains any non-ASCII data, this will always be "UTF-8", otherwise the default is "us-ascii".

       o   language

	   The language for the attribute's value. It should be a valid ISO language code like "en-us" or "zh". This is optional.

   $attribute->name()
       The attribute name as passed to the constructor.

   $attribute->value()
       The attribute value as passed to the constructor.

   $attribute->charset()
       The attribute's charset.

   $attribute->language()
       The attribute's language.

   $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.

       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.

   $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 "print()" method. The output may be sent as a single string, as a list of strings, or via multiple calls to the output.

ROLES

       This class does the "Courriel::Role::Streams" role.

AUTHOR

       Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

       This software is Copyright (c) 2012 by Dave Rolsky.

       This is free software, licensed under:

	 The Artistic License 2.0 (GPL Compatible)

perl v5.14.2							    2012-03-07					    Courriel::HeaderAttribute(3pm)