unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (Debian-5.0)
Page:
Section:
Apropos / Subsearch:
optional field

Mail::Message::ConvertUsermContributed)Mail::Message::Convert::MimeEntity(3pm)



NAME
       Mail::Message::Convert::MimeEntity - translate Mail::Message to
       MIME::Entity vv

INHERITANCE
        Mail::Message::Convert::MimeEntity
          is a Mail::Message::Convert
          is a Mail::Reporter

SYNOPSIS
        use Mail::Message::Convert::MimeEntity;
        my $convert = Mail::Message::Convert::MimeEntity->new;

        my Mail::Message $msg    = Mail::Message->new;
        my MIME::Entity  $entity = $convert->export($msg);

        my MIME::Entity  $entity = MIME::Entity->new;
        my Mail::Message $msg    = $convert->from($entity);

        use Mail::Box::Manager;
        my $mgr     = Mail::Box::Manager->new;
        my $folder  = $mgr->open(folder => 'Outbox');
        $folder->addMessage($entity);

DESCRIPTION
       The MIME::Entity extends Mail::Internet message with multiparts and
       more methods.  The Mail::Message objects are more flexible in how the
       message parts are stored, and uses separate header and body objects.

       Converters between message objects

       Other converters

METHODS
       Constructors

       Mail::Message::Convert::MimeEntity->new(OPTIONS)

           See "METHODS" in Mail::Message::Convert

       Converting

       $obj->export(MESSAGE, [PARSER])

           Returns a new MIME::Entity message object based on the information
           from the MESSAGE, which is a Mail::Message object.

           You may want to supply your own PARSER, which is a MIME::Parser
           object, to change the parser flags.  Without a PARSER object, one
           is created for you, with all the default settings.

           If "undef" is passed, in place of a MESSAGE, then an empty list is
           returned.  When the parsing failes, then MIME::Parser throws an
           exception.

           example:

            my $convert = Mail::Message::Convert::MimeEntity->new;
            my Mail::Message $msg  = Mail::Message->new;
            my manual MIME::Entity  $copy = $convert->export($msg);

       $obj->from(MIME-OBJECT)

           Returns a new Mail::Message object based on the information from
           the specified MIME::Entity.  If the conversion fails, the "undef"
           is returned.  If "undef" is passed in place of an OBJECT, then an
           empty list is returned.

           example:

            my $convert = Mail::Message::Convert::MimeEntity->new;
            my MIME::Entity  $msg  = MIME::Entity->new;
            my Mail::Message $copy = $convert->from($msg);

       $obj->selectedFields(HEAD)

           See "Converting" in Mail::Message::Convert

       Error handling

       $obj->AUTOLOAD

           See "Error handling" in Mail::Reporter

       $obj->addReport(OBJECT)

           See "Error handling" in Mail::Reporter

       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])

       Mail::Message::Convert::MimeEntity->defaultTrace([LEVEL]|[LOGLEVEL,
       TRACELEVEL]|[LEVEL, CALLBACK])

           See "Error handling" in Mail::Reporter

       $obj->errors

           See "Error handling" in Mail::Reporter

       $obj->log([LEVEL [,STRINGS]])

       Mail::Message::Convert::MimeEntity->log([LEVEL [,STRINGS]])

           See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)

       Mail::Message::Convert::MimeEntity->logPriority(LEVEL)

           See "Error handling" in Mail::Reporter

       $obj->logSettings

           See "Error handling" in Mail::Reporter

       $obj->notImplemented

           See "Error handling" in Mail::Reporter

       $obj->report([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->reportAll([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->trace([LEVEL])

           See "Error handling" in Mail::Reporter

       $obj->warnings

           See "Error handling" in Mail::Reporter

       Cleanup

       $obj->DESTROY

           See "Cleanup" in Mail::Reporter

       $obj->inGlobalDestruction

           See "Cleanup" in Mail::Reporter

DIAGNOSTICS
       Error: Converting from MIME::Entity but got a $type, return

       Error: Package $package does not implement $method.

           Fatal error: the specific package (or one of its superclasses) does
           not implement this method where it should. This message means that
           some other related classes do implement this method however the
           class at hand does not.  Probably you should investigate this and
           probably inform the author of the package.

SEE ALSO
       This module is part of Mail-Box distribution version 2.082, built on
       April 28, 2008. Website: http://perl.overmeer.net/mailbox/

LICENSE
       Copyrights 2001-2008 by Mark Overmeer. For other contributors see
       ChangeLog.

       This program is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.  See
       http://www.perl.com/perl/misc/Artistic.html



perl v5.10.0                      2008-Mail::Message::Convert::MimeEntity(3pm)