Mail::Box::MH::Index - keep index files for messages.

 Mail::Box::MH::Index
   is a Mail::Reporter

 my $index = Mail::Box::MH::Index->new;
 $index->read(...)
 $index->write(...)

Message folders which store their data in one single file per message are very inefficient for producing subject overviews and for computing message threads. The CWMail::Box::MH::Index object is able to store and read a the headers of a set of CWMail::Box::MH::Message messages which are part of a single CWMail::Box::MH folder in one file.

When the CWMail::Box::MH::Index functionality is enabled by specifying Mail::Box::MH::new(keep_index) when opening a folder, the index file is automatically read. When the folder is closed, a new index file is created.

Special care is taken to avoid problems which occur when the user changes or removes message files without updating the index. If the index is not trustworthy it will not be used (costing some performance for the reader of the folder).

Mail::Box::MH::Index->new(OPTIONS)

 Option     Defined in       Default                                                   
 filename                    <required>                                                
 head_type                   L<Mail::Message::Head::Subset|Mail::Message::Head::Subset>
 head_wrap                   72                                                        
 log        L<Mail::Reporter>  C<'WARNINGS'>                                             
 trace      L<Mail::Reporter>  C<'WARNINGS'>

$obj->filename Returns the name of the index file.

$obj->get(MSGFILE) Look if there is header info for the specified MSGFILE. The filename represents one message in folder type which are organized as directory. This method will return an object of the new(head_type) as specified during creation of the index object, or CWundef if the information is not known or not trustworthy -i.e. the file size changed.

$obj->read Read the index file. The header objects can after this be requested with the get() method.

$obj->write(MESSAGES) Write an index file containing the headers specified MESSAGES (Mail::Message objects).

$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::Box::MH::Index->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::Box::MH::Index->log([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter

$obj->logPriority(LEVEL)

Mail::Box::MH::Index->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

$obj->DESTROY See Cleanup in Mail::Reporter

$obj->inGlobalDestruction See Cleanup in Mail::Reporter

Error: Package CW$package does not implement CW$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 the MailBox website at <http://perl.overmeer.net/mailbox/> for more details.

Distribution version 2.063. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.

Copyright (c) 2001-2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.