SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from Fedora 28 perl-Mail-Mbox-MessageParser-1.5105-11.fc28.noarch.rpm

Mail::Mbox::MessageParser::MetaInfo

Section: User Contributed Perl Documentation (3)
Updated: 2015-04-18
Index 

NAME

Mail::Mbox::MessageParser::MetaInfo - A cache for folder metadata 

DESCRIPTION

This module implements a cache for meta-information for mbox folders. Theinformation includes such items such as the file position, the line number,and the byte offset of the start of each email. 

METHODS AND FUNCTIONS

SETUP_CACHE(...)
  SETUP_CACHE( { 'file_name' => <cache file name> } );  <cache file name> - the file name of the cache

Call this function once to set up the cache before creating any parsers. Youmust provide the location to the cache file. There is no default value.

Returns an error string or 1 if there is no error.

CLEAR_CACHE();
Use this function to clear the cache and delete the cache file. Normally youshould not need to clear the cache---the module will automatically update thecache when the mailbox changes. Call this function after SETUP_CACHE.
WRITE_CACHE();
Use this function to force the module to write the in-memory cache informationto the cache file. Normally you do not need to do this---the module willautomatically write the information when the program exits.
$ref = new( { 'file_name' => <mailbox file name>, 'file_handle' => <mailbox file handle>, });
    <file_name> - The full filename of the mailbox    <file_handle> - An opened file handle for the mailbox

The constructor for the class takes two parameters. file_name is thefilename of the mailbox. This will be used as the cache key, so it's importantthat it fully defines the path to the mailbox. The file_handle argument isthe opened file handle to the mailbox. Both arguments are required.

Returns a reference to a Mail::Mbox::MessageParser object, or a stringdescribing the error.

 

BUGS

No known bugs.

Contact davidAATTcoppit.org for bug reports and suggestions. 

AUTHOR

David Coppit <davidAATTcoppit.org>. 

LICENSE

This code is distributed under the GNU General Public License (GPL) Version 2.See the file LICENSE in the distribution for details. 

HISTORY

This code was originally part of the grepmail distribution. Seehttp://grepmail.sf.net/ for previous versions of grepmail which included earlyversions of this code. 

SEE ALSO

Mail::Mbox::MessageParser


 

Index

NAME
DESCRIPTION
METHODS AND FUNCTIONS
BUGS
AUTHOR
LICENSE
HISTORY
SEE ALSO

This document was created byman2html,using the manual pages.