.\" 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::Part::Single 3pm"
.TH Courriel::Part::Single 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::Part::Single \- A part which does not contain other parts, only content
.SH "VERSION"
.IX Header "VERSION"
version 0.49
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  my $headers = $part\->headers;
\&  my $ct = $part\->content_type;
\&
\&  my $content = $part\->content;
\&  print ${$content};
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents a single part that does not contain other parts, just
content.
.SH "API"
.IX Header "API"
This class provides the following methods:
.SS "Courriel::Part::Single\->new( ... )"
.IX Subsection "Courriel::Part::Single->new( ... )"
This method creates a new part object. It accepts the following parameters:
.IP "\(bu" 4
content
.Sp
This can either be a string or a reference to a scalar. It should be a
character string, \fInot\fR a byte string.
.Sp
If you pass a reference, then the scalar underlying the reference may be
modified, so don't pass in something you don't want modified.
.IP "\(bu" 4
encoded_content
.Sp
This can either be a string or a reference to a scalar.
.Sp
If you pass a reference, then the scalar underlying the reference may be
modified, so don't pass in something you don't want modified.
.IP "\(bu" 4
content_type
.Sp
A Courriel::Header::ContentType object. This will default to one with the
mime type \*(L"text/plain\*(R".
.IP "\(bu" 4
disposition
.Sp
A Courriel::Header::Disposition object representing this part's content
disposition. This will default to \*(L"inline\*(R" with no other attributes.
.IP "\(bu" 4
encoding
.Sp
The Content-Transfer-Encoding for this part. This defaults to the value found
in the part's headers, or \*(L"8bit\*(R" if no header is found.
.IP "\(bu" 4
headers
.Sp
A Courriel::Headers object containing headers for this part.
.PP
You must pass a \f(CW\*(C`content\*(C'\fR or \f(CW\*(C`encoded_content\*(C'\fR value when creating a new
part, but there's really no point in passing both.
.PP
It is strongly recommended that you pass a \f(CW\*(C`content\*(C'\fR parameter and letting
this module do the encoding for you internally.
.ie n .SS "$part\->\fBcontent()\fP"
.el .SS "\f(CW$part\fP\->\fBcontent()\fP"
.IX Subsection "$part->content()"
This returns returns the decoded content for the part. It will be in Perl's
native utf\-8 encoding, decoded from whatever character set the content is in.
.ie n .SS "$part\->\fBencoded_content()\fP"
.el .SS "\f(CW$part\fP\->\fBencoded_content()\fP"
.IX Subsection "$part->encoded_content()"
This returns returns the encoded content for the part.
.ie n .SS "$part\->\fBmime_type()\fP"
.el .SS "\f(CW$part\fP\->\fBmime_type()\fP"
.IX Subsection "$part->mime_type()"
Returns the mime type for this part.
.ie n .SS "$part\->\fBhas_charset()\fP"
.el .SS "\f(CW$part\fP\->\fBhas_charset()\fP"
.IX Subsection "$part->has_charset()"
Return true if the part has a charset defined. Binary attachments will usually
not have this defined.
.ie n .SS "$part\->\fBcharset()\fP"
.el .SS "\f(CW$part\fP\->\fBcharset()\fP"
.IX Subsection "$part->charset()"
Returns the charset for this part.
.ie n .SS "$part\->\fBis_inline()\fP, $part\->\fBis_attachment()\fP"
.el .SS "\f(CW$part\fP\->\fBis_inline()\fP, \f(CW$part\fP\->\fBis_attachment()\fP"
.IX Subsection "$part->is_inline(), $part->is_attachment()"
These methods return boolean values based on the part's content disposition.
.ie n .SS "$part\->\fBfilename()\fP"
.el .SS "\f(CW$part\fP\->\fBfilename()\fP"
.IX Subsection "$part->filename()"
Returns the filename from the part's content disposition, if any.
.ie n .SS "$part\->\fBcontent_type()\fP"
.el .SS "\f(CW$part\fP\->\fBcontent_type()\fP"
.IX Subsection "$part->content_type()"
Returns the Courriel::Header::ContentType object for this part.
.ie n .SS "$part\->\fBdisposition()\fP"
.el .SS "\f(CW$part\fP\->\fBdisposition()\fP"
.IX Subsection "$part->disposition()"
Returns the Courriel::Header::Disposition object for this part.
.ie n .SS "$part\->\fBencoding()\fP"
.el .SS "\f(CW$part\fP\->\fBencoding()\fP"
.IX Subsection "$part->encoding()"
Returns the encoding for the part.
.ie n .SS "$part\->\fBheaders()\fP"
.el .SS "\f(CW$part\fP\->\fBheaders()\fP"
.IX Subsection "$part->headers()"
Returns the Courriel::Headers object for this part.
.ie n .SS "$part\->\fBis_multipart()\fP"
.el .SS "\f(CW$part\fP\->\fBis_multipart()\fP"
.IX Subsection "$part->is_multipart()"
Returns false.
.ie n .SS "$part\->\fBcontainer()\fP"
.el .SS "\f(CW$part\fP\->\fBcontainer()\fP"
.IX Subsection "$part->container()"
Returns the Courriel or Courriel::Part::Multipart object to which this
part belongs, if any. This is set when the part is added to another object.
.ie n .SS "$part\->\fBcontent_ref()\fP"
.el .SS "\f(CW$part\fP\->\fBcontent_ref()\fP"
.IX Subsection "$part->content_ref()"
This returns returns a reference to a scalar containing the decoded content for
the part.
.ie n .SS "$part\->\fBencoded_content_ref()\fP"
.el .SS "\f(CW$part\fP\->\fBencoded_content_ref()\fP"
.IX Subsection "$part->encoded_content_ref()"
This returns returns a reference to a scalar containing the encoded content for
the part, without any decoding.
.ie n .SS "$part\->\fBas_string()\fP"
.el .SS "\f(CW$part\fP\->\fBas_string()\fP"
.IX Subsection "$part->as_string()"
Returns the part as a string, along with its headers. Lines will be terminated
with \*(L"\er\en\*(R".
.ie n .SS "$part\->stream_to( output => $output )"
.el .SS "\f(CW$part\fP\->stream_to( output => \f(CW$output\fP )"
.IX Subsection "$part->stream_to( output => $output )"
This method will send the stringified part 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::Part\*(C'\fR and \f(CW\*(C`Courriel::Role::Streams\*(C'\fR
roles.
.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.