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::Cache

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

NAME

Mail::Mbox::MessageParser::Cache - A cache-based mbox folder reader 

SYNOPSIS

  #!/usr/bin/perl  use Mail::Mbox::MessageParser;  my $filename = 'mail/saved-mail';  my $filehandle = new FileHandle($filename);  # Set up cache  Mail::Mbox::MessageParser::SETUP_CACHE(    { 'file_name' => '/tmp/cache' } );  my $folder_reader =    new Mail::Mbox::MessageParser( {      'file_name' => $filename,      'file_handle' => $filehandle,      'enable_cache' => 1,    } );  die $folder_reader unless ref $folder_reader;    warn "No cached information"    if $Mail::Mbox::MessageParser::Cache::UPDATING_CACHE;  # Any newlines or such before the start of the first email  my $prologue = $folder_reader->prologue;  print $prologue;  # This is the main loop. It's executed once for each email  while(!$folder_reader->end_of_file());  {    my $email = $folder_reader->read_next_email();    print $email;  }
 

DESCRIPTION

This module implements a cached-based mbox folder reader. It can only be usedwhen cache information already exists. Users must not instantiate this classdirectly---use Mail::Mbox::MessageParser instead. The base MessageParser modulewill automatically manage the use of cache and non-cache implementations. 

METHODS AND FUNCTIONS

The following methods and functions are specific to theMail::Mbox::MessageParser::Cache package. For additional inherited ones, seethe Mail::Mbox::MessageParser documentation.
$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
SYNOPSIS
DESCRIPTION
METHODS AND FUNCTIONS
BUGS
AUTHOR
LICENSE
HISTORY
SEE ALSO

This document was created byman2html,using the manual pages.