.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Courriel::Header::ContentType 3pm"
.TH Courriel::Header::ContentType 3pm "2016-12-28" "perl v5.24.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::ContentType \- The content type for an email part
.SH "VERSION"
.IX Header "VERSION"
version 0.44
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    my $ct = $part\->content_type();
\&    print $ct\->mime_type();
\&    print $ct\->charset();
\&
\&    my %attr = $ct\->attributes();
\&    while ( my ( $k, $v ) = each %attr ) {
\&        print "$k => $v\en";
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents the contents of a \*(L"Content-Type\*(R" header attached to an
email part. Such headers always include a mime type, and may also include
additional information such as a charset or other attributes.
.PP
Here are some typical headers:
.PP
.Vb 1
\&  Content\-Type: text/plain; charset=utf\-8
\&
\&  Content\-Type: multipart/alternative; boundary=abcdefghijk
\&
\&  Content\-Type: image/jpeg; name="Filename.jpg"
.Ve
.SH "API"
.IX Header "API"
This class supports the following methods:
.SS "Courriel::Header::ContentType\->new_from_value( ... )"
.IX Subsection "Courriel::Header::ContentType->new_from_value( ... )"
This takes two parameters, \f(CW\*(C`name\*(C'\fR and \f(CW\*(C`value\*(C'\fR. The \f(CW\*(C`name\*(C'\fR is optional, and
defaults to \*(L"Content-Type\*(R".
.PP
The \f(CW\*(C`value\*(C'\fR is parsed and split up into the mime type and attributes.
.SS "Courriel::Header::ContentType\->new( ... )"
.IX Subsection "Courriel::Header::ContentType->new( ... )"
This method creates a new object. It accepts the following parameters:
.IP "\(bu" 4
name
.Sp
This defaults to 'Content\-Type'.
.IP "\(bu" 4
value
.Sp
This is the full header value.
.IP "\(bu" 4
mime_type
.Sp
A string like \*(L"text/plain\*(R" or \*(L"multipart/alternative\*(R". This is required.
.IP "\(bu" 4
attributes
.Sp
A hash reference of attributes from the header, such as a boundary, charset,
etc. The keys are attribute names and the values can either be strings or
Courriel::HeaderAttribute objects. Values which are strings will be
inflated into objects by the constructor.
.Sp
This is optional, and can be an empty hash reference or omitted entirely.
.ie n .SS "$ct\->\fIname()\fP"
.el .SS "\f(CW$ct\fP\->\fIname()\fP"
.IX Subsection "$ct->name()"
The header name, usually \*(L"Content-Type\*(R".
.ie n .SS "$ct\->\fIvalue()\fP"
.el .SS "\f(CW$ct\fP\->\fIvalue()\fP"
.IX Subsection "$ct->value()"
The raw header value.
.ie n .SS "$ct\->\fImime_type()\fP"
.el .SS "\f(CW$ct\fP\->\fImime_type()\fP"
.IX Subsection "$ct->mime_type()"
Returns the mime type value passed to the constructor. However, this value
will be in all lower-case, regardless of the original casing passed to the
constructor.
.ie n .SS "$ct\->\fIcharset()\fP"
.el .SS "\f(CW$ct\fP\->\fIcharset()\fP"
.IX Subsection "$ct->charset()"
Returns the charset for the content type, which will be the value found in the
\&\f(CW\*(C`attributes\*(C'\fR, if one exists.
.ie n .SS "$ct\->\fIattributes()\fP"
.el .SS "\f(CW$ct\fP\->\fIattributes()\fP"
.IX Subsection "$ct->attributes()"
Returns a hash (not a reference) of the attributes passed to the constructor.
.PP
Attributes are Courriel::HeaderAttribute objects.
.PP
The keys of the hash are all lower case, though the original casing is
preserved in the \f(CW\*(C`name()\*(C'\fR returned by the Courriel::HeaderAttribute
object.
.ie n .SS "$ct\->\fIis_binary()\fP"
.el .SS "\f(CW$ct\fP\->\fIis_binary()\fP"
.IX Subsection "$ct->is_binary()"
Returns true unless the attachment looks like text data. Currently, this means
that is has a charset defined and the charset is not \*(L"binary\*(R".
.ie n .SS "$ct\->attribute($key)"
.el .SS "\f(CW$ct\fP\->attribute($key)"
.IX Subsection "$ct->attribute($key)"
Given a key, returns the named Courriel::HeaderAttribute object. Obviously,
this value can be \f(CW\*(C`undef\*(C'\fR if the attribute doesn't exist. Name lookup is
case-insensitive.
.ie n .SS "$ct\->attribute_value($key)"
.el .SS "\f(CW$ct\fP\->attribute_value($key)"
.IX Subsection "$ct->attribute_value($key)"
Given a key, returns the named attribute's value as a string. Obviously, this
value can be \f(CW\*(C`undef\*(C'\fR if the attribute doesn't exist. Name lookup is
case-insensitive.
.PP
The attribute is a Courriel::HeaderAttribute object.
.ie n .SS "$ct\->\fIas_header_value()\fP"
.el .SS "\f(CW$ct\fP\->\fIas_header_value()\fP"
.IX Subsection "$ct->as_header_value()"
Returns the object as a string suitable for a header value (but not
folded). Note that this uses the original casing of the mime type as passed to
the constructor.
.SH "EXTENDS"
.IX Header "EXTENDS"
This class extends Courriel::Header.
.SH "ROLES"
.IX Header "ROLES"
This class does the \f(CW\*(C`Courriel::Role::HeaderWithAttributes\*(C'\fR role.
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted through the \s-1RT\s0 bug tracker <http://rt.cpan.org/Public/Dist/Display.html?Name=Courriel>
(or bug\-courriel@rt.cpan.org <mailto:bug-courriel@rt.cpan.org>).
.PP
I am also usually active on \s-1IRC\s0 as 'autarch' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2016 by Dave Rolsky.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Artistic License 2.0 (GPL Compatible)
.Ve