The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Mail::Builder::Attachment - Class for handling e-mail attachments

SYNOPSIS

  use Mail::Builder::Attachment;
  
  my $attachment1 = Mail::Builder::Attachment->new({
      file  => 'path/to/attachment.pdf',
      name  => 'LoveLetter.txt.vbs',
  });
  
  my $attachment2 = Mail::Builder::Attachment->new($fh);
  
  my $attachment_entity = $attachment1->serialize;

DESCRIPTION

This class handles e-mail attachments for Mail::Builder.

METHODS

Constructor

new

The constructor can be called in multiple ways

 Mail::Builder::Attachment->new({
     file       => Path | Path::Class::File | IO::File | FH | ScalarRef,
     [ name     => Attachment filename, ]
     [ mimetype => MIME type, ]
 })
 OR
 Mail::Builder::Image->new(
    Path | Path::Class::File | IO::File | FH | ScalarRef
    [, Attachment filename [, MIME type ]]
 )

See Accessors for more details.

Public Methods

serialize

Returns the attachment as a MIME::Entity object.

filename

If possible, returns the filename of the attachment file as a Path::Class::File object.

filecontent

Returns the content of the attachment file.

filehandle

If possible, returns a filehandle for the attachment file as a IO::File object.

Accessors

name

Name of the attachment as used in the e-mail message. If no name is provided the current filename will be used.

mimetype

Mime type of the attachment.

If not provided the mime type is determined by analyzing the filename extension.

file

Attachment file. Can be a

  • Path (or a Path::Class::File object)

  • Filehandle (or an IO::File object)

  • ScalarRef containing the attachment data

AUTHOR

    Maroš Kollár
    CPAN ID: MAROS
    maros [at] k-1.com
    http://www.k-1.com