Quick Navigator

Search Site

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

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  MAIL::BOX::MH::INDEX (3)

.ds Aq ’


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



   is a Mail::Reporter


 my $index = Mail::Box::MH::Index->new;


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 Mail::Box::MH::Index object is able to store and read a the headers of a set of Mail::Box::MH::Message messages which are part of a single Mail::Box::MH folder in one file.

When the Mail::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).

See documentation in the base class.


See documentation in the base class.


See documentation in the base class.

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

filename => FILENAME The FILENAME which is used to store the headers of all the e-mails for one folder. This must be an absolute pathname.
head_type => CLASS The type of headers which will be used to store header information when it is read from the index file. You can not be sure the index contains all header line (the mailbox may have been updated without updating the index) so this will usually be (an sub-class of) Mail::Message::Head::Subset.
head_wrap => INTEGER The preferred number of character in each header line.
log => LEVEL
trace => LEVEL

    The Index

$obj-><B>appendB>(MESSAGES) Append MESSAGES to the index file.
$obj-><B>filenameB>() Returns the name of the index file.
$obj-><B>getB>(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 undef if the information is not known or not trustworthy -i.e. the file size changed.
$obj-><B>readB>() Read the index file. The header objects can after this be requested with the get() method.
$obj-><B>writeB>(MESSAGES) Write an index file containing the headers specified MESSAGES (Mail::Message objects).

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
Mail::Box::MH::Index-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::MH::Index-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
Mail::Box::MH::Index-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter


See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Reporter


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.


This module is part of Mail-Box distribution version 2.109, built on August 19, 2013. Website:


Copyrights 2001-2013 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

Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 MAIL::BOX::MH::INDEX (3) 2013-08-19

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