GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EMAIL::FOLDER (3)

.ds Aq ’

NAME

Email::Folder - read all the messages from a folder as Email::Simple objects.

CONTENTS

SYNOPSIS



 use Email::Folder;

 my $folder = Email::Folder->new("some_file");

 print join "\n", map { $_->header("Subject") } $folder->messages;



METHODS

new($folder, CW%options)

Takes the name of a folder, and a hash of options

If a ’reader’ option is passed in then that is used as the class to read in messages with.

    messages

Returns a list containing all of the messages in the folder. Can only be called once as it drains the iterator.

    next_message

acts as an iterator. reads the next message from a folder. returns false at the end of the folder

    bless_message($message)

Takes a raw RFC822 message and blesses it into a class.

By default this is an Email::Simple object but can easily be overriden in a subclass.

For example, this simple subclass just returns the raw rfc822 messages, and exposes the speed of the parser.



 package Email::RawFolder;
 use base Email::Folder;
 sub bless_message { $_[1] };
 1;



    reader

read-only accessor to the underlying Email::Reader subclass instance

PERL EMAIL PROJECT

This module is maintained by the Perl Email Project

<http://emailproject.perl.org/wiki/Email::Folder>

AUTHORS

Simon Wistow <simon@thegestalt.org>

Richard Clamp <richardc@unixbeard.net>

COPYING

Copyright 2006, Simon Wistow

Distributed under the same terms as Perl itself.

This software is under no warranty and will probably ruin your life, kill your friends, burn your house and bring about the doobie brothers.

SEE ALSO

Email::LocalDelivery, Email::FolderType, Email::Simple
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 EMAIL::FOLDER (3) 2009-07-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.