.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::Mbox::MessageParser::MetaInfo 3pm"
.TH Mail::Mbox::MessageParser::MetaInfo 3pm "2023-08-06" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::Mbox::MessageParser::MetaInfo \- A cache for folder metadata
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a cache for meta-information for mbox folders. The
information includes such items such as the file position, the line number,
and the byte offset of the start of each email.
.SS "\s-1METHODS AND FUNCTIONS\s0"
.IX Subsection "METHODS AND FUNCTIONS"
.IP "\s-1SETUP_CACHE\s0(...)" 4
.IX Item "SETUP_CACHE(...)"
.Vb 1
\&  SETUP_CACHE( { \*(Aqfile_name\*(Aq => <cache file name> } );
\&
\&  <cache file name> \- the file name of the cache
.Ve
.Sp
Call this function once to set up the cache before creating any parsers. You
must provide the location to the cache file. There is no default value.
.Sp
Returns an error string or 1 if there is no error.
.IP "\s-1\fBCLEAR_CACHE\s0()\fR;" 4
.IX Item "CLEAR_CACHE();"
Use this function to clear the cache and delete the cache file.  Normally you
should not need to clear the cache\*(--the module will automatically update the
cache when the mailbox changes. Call this function after \fI\s-1SETUP_CACHE\s0\fR.
.IP "\s-1\fBWRITE_CACHE\s0()\fR;" 4
.IX Item "WRITE_CACHE();"
Use this function to force the module to write the in-memory cache information
to the cache file. Normally you do not need to do this\*(--the module will
automatically write the information when the program exits.
.ie n .IP "$ref = new( { 'file_name' => <mailbox file name>, 'file_handle' => <mailbox file handle>, });" 4
.el .IP "\f(CW$ref\fR = new( { 'file_name' => <mailbox file name>, 'file_handle' => <mailbox file handle>, });" 4
.IX Item "$ref = new( { 'file_name' => <mailbox file name>, 'file_handle' => <mailbox file handle>, });"
.Vb 2
\&    <file_name> \- The full filename of the mailbox
\&    <file_handle> \- An opened file handle for the mailbox
.Ve
.Sp
The constructor for the class takes two parameters. \fIfile_name\fR is the
filename of the mailbox. This will be used as the cache key, so it's important
that it fully defines the path to the mailbox. The \fIfile_handle\fR argument is
the opened file handle to the mailbox. Both arguments are required.
.Sp
Returns a reference to a Mail::Mbox::MessageParser object, or a string
describing the error.
.SH "BUGS"
.IX Header "BUGS"
No known bugs.
.PP
Contact david@coppit.org for bug reports and suggestions.
.SH "AUTHOR"
.IX Header "AUTHOR"
David Coppit <david@coppit.org>.
.SH "LICENSE"
.IX Header "LICENSE"
This code is distributed under the \s-1GNU\s0 General Public License (\s-1GPL\s0) Version 2.
See the file \s-1LICENSE\s0 in the distribution for details.
.SH "HISTORY"
.IX Header "HISTORY"
This code was originally part of the grepmail distribution. See
http://grepmail.sf.net/ for previous versions of grepmail which included early
versions of this code.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::Mbox::MessageParser