mail::server::imap4::fetch(3pm) [debian man page]

Mail::Server::IMAP4::Fetch(3pm) 			User Contributed Perl Documentation			   Mail::Server::IMAP4::Fetch(3pm)

NAME

       Mail::Server::IMAP4::Fetch - message info for IMAP protocol speed-up

SYNOPSIS

	my $imap = Mail::Server::IMAP4::Fetch->new($msg);
	print $imap->fetchBody(1);   # for FETCH BODYSTRUCTURE
	print $imap->fetchBody;      # for FETCH BODY
	print $imap->fetchEnvelope;  # for FETCH ENVELOPE
	print $imap->fetchSize;

DESCRIPTION

       Create a new object hierarchy, which contains information to capture the most important details about the message.  The object can be used
       to speed-up IMAP-server implementations, as Mail::Box::Netzwert.

       The object used here is a simplified representation of a Mail::Box::Message object.  It does not maintain headers and does not refer to the
       folder.	It only works with messages stored in a file.  Therefore, this object can be frozen by Storable if you want to.

METHODS

   Constructors
       Mail::Server::IMAP4::Fetch->new(MESSAGE|PART, OPTIONS)
	    -Option	 --Default
	     md5checksums  0

	   md5checksums => BOOLEAN

   Attributes
       $obj->bodyLocation()
       $obj->headLocation()
       $obj->partLocation()

   IMAP Commands
       $obj->fetchBody(EXTENDED)
	   Returns one string, representing the message's structure as defined by the IMAP protocol.  The boolean argument indicates whether you
	   like to have the EXTENDED information, as the imap command 'FETCH BODYSTRUCTURE' defines or the limited information of 'FETCH BODY'.

       $obj->fetchEnvelope()
	   Returns a string representation of some header information.

       $obj->fetchSize()
	   Returns the size of the message body.

       $obj->part([PARTNR])
	   The partnummer is a list of dot-separated positive integers, numbering (nested) parts in multi-part message bodies.	By default, the
	   info of the main message is returned.

	   example:

	    my $partinfo = $msg->info->part('1.2.1');
	    print $msg->info->part('3.3')->fetchBody;

       $obj->printStructure([FILEHANDLE|undef, [NUMBER]])
	   Print the structure of the fetch data to the specified FILEHANDLE or the selected filehandle.  When explicitly "undef" is specified as
	   handle, then the output will be returned as string.	Only a limited set of the information is displayed.

	   example:

	    my $imap = ...;
	    $imap->printStructure(*OUTPUT);
	    $imap->printStructure;
	    my $struct = $imap->printStructure(undef);

   Internals
DETAILS

       See

       RFC2060: "Internet Message Access Protocol IMAP4v1" section 7.4.2
       RFC2045: "MIME Part One: Format of Internet Message Bodies".

SEE ALSO

       This module is part of Mail-Box distribution version 2.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/

LICENSE

       Copyrights 2001-2012 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.14.2							    2012-05-07					   Mail::Server::IMAP4::Fetch(3pm)

Mail::Server::IMAP4(3pm)				User Contributed Perl Documentation				  Mail::Server::IMAP4(3pm)

NAME

       Mail::Server::IMAP4 - IMAP4 server implementation (not completed)

INHERITANCE

	Mail::Server::IMAP4
	  is a Mail::Server
	  is a Mail::Reporter

SYNOPSIS

	!!!Partially implemented!!!!
	my $server = Mail::Server::IMAP4->new($msg);

DESCRIPTION

       This module is a place-holder, which can be used to grow code which is needed to implement a full IMAP4 server.

       Although the server is not implemented, parts of this server are already available.

       o   Mail::Server::IMAP4::Fetch

	   used to capture "FETCH" related information from a message, and produce server-side FETCH answers.

       o   Mail::Server::IMAP4::List

	   produce LIST reponses about existing folders.  This works in combination with a Mail::Box::Manage::User object.

       o   Mail::Server::IMAP4::Search

	   the SEARCH request.	Not implemented yet... looking for a volunteer.

METHODS

   Constructors
       Mail::Server::IMAP4->new(OPTIONS)
	   See "Constructors" in Mail::Reporter

   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::Server::IMAP4->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::Server::IMAP4->log([LEVEL [,STRINGS]])
	   See "Error handling" in Mail::Reporter

       $obj->logPriority(LEVEL)
       Mail::Server::IMAP4->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

DETAILS

       See

       RFC2060: "Internet Message Access Protocol IMAP4v1"

DIAGNOSTICS

       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.105, built on May 07, 2012. Website: http://perl.overmeer.net/mailbox/

LICENSE

       Copyrights 2001-2012 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.14.2							    2012-05-07						  Mail::Server::IMAP4(3pm)