.\" 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 "Email::MIME::Attachment::Stripper 3"
.TH Email::MIME::Attachment::Stripper 3 "2020-07-07" "perl v5.32.0" "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"
Email::MIME::Attachment::Stripper \- strip the attachments from an email
.SH "VERSION"
.IX Header "VERSION"
version 1.317
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $stripper = Email::MIME::Attachment::Stripper\->new($mail);
\&
\&  my $msg = $stripper\->message;
\&  my @attachments = $stripper\->attachments;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Given a Email::MIME object, detach all attachments from the message and make
them available separately.
.PP
The message you're left with might still be multipart, but it should only be
multipart/alternative or multipart/related.
.PP
Given this message:
.PP
.Vb 3
\&  + multipart/mixed
\&    \- text/plain
\&    \- application/pdf; disposition=attachment
.Ve
.PP
The \s-1PDF\s0 will be stripped.  Whether the returned message is a single text/plain
part or a multipart/mixed message with only the text/plain part remaining in it
is not yet guaranteed one way or the other.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&  my $stripper = Email::MIME::Attachment::Stripper\->new($email, %args);
.Ve
.PP
The constructor may be passed an Email::MIME object, a reference to a string,
or any other value that Email::Abstract (if available) can cast to an
Email::MIME object.
.PP
Valid arguments include:
.PP
.Vb 1
\&  force_filename \- try harder to get a filename, making one up if necessary
.Ve
.SS "message"
.IX Subsection "message"
.Vb 1
\&  my $email_mime = $stripper\->message;
.Ve
.PP
This returns the message with all the attachments detached. This will alter
both the body and the header of the message.
.SS "attachments"
.IX Subsection "attachments"
.Vb 1
\&  my @attachments = $stripper\->attachments;
.Ve
.PP
This returns a list of all the attachments we found in the message, as a hash
of { filename, content_type, payload }.
.PP
This may contain parts that might not normally be considered attachments, like
text/html or multipart/alternative.
.SH "ATTENTION!"
.IX Header "ATTENTION!"
This module's behavior has never been very clearly spelled out, and it has led
to misunderstandings and bug reports, which may or may not be actual bugs.  I
plan to take some significant action to address this.  To read more or comment,
please see <https://github.com/rjbs/Email\-MIME\-Attachment\-Stripper/issues/2>
.SH "CREDITS AND LICENSE"
.IX Header "CREDITS AND LICENSE"
This module is incredibly closely derived from Tony Bowden's
Mail::Message::Attachment::Stripper; this derivation was done by Simon
Cozens (\f(CW\*(C`simon@cpan.org\*(C'\fR), and you receive this under the same terms as Tony's
original module.
.SH "AUTHOR"
.IX Header "AUTHOR"
Simon Cozens
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2004 by Simon Cozens.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.