Mail::...etaInfo(3pm)

💖 Mail::...etaInfo(3pm) — bestie's guide to Mail::Mbox::MessageParser::MetaInfo 💖

okay so like, picture this: you're out here parsing mbox folders, and every single time you do it you're re-reading the same bytes like a clown 😭. This module said "not on my watch" and built you a whole cache for folder metadata so you never have to do that again. Iconic behaviour fr fr.

---

✨ NAME ✨

Mail::Mbox::MessageParser::MetaInfo — a cache for folder metadata. she's the girl who remembers where everything is so you don't have to 🎀

---

🦋 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.

basically it's keeping receipts on your mailbox so the next parse is a little speedrun 💅

---

🌸 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. You must provide the location to the cache file. There is no default value — like, none, zero, nada, you have to tell her where to put it bestie 🫶.

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 you should not need to clear the cache — the module will automatically update the cache when the mailbox changes. Call this function after SETUP_CACHE.

it's giving "nuclear option" ngl 💀 but sometimes you just gotta ✨reset✨

💫 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.

so like, she handles it herself, but if you're the impatient type, here's your button 🎀

💫 $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 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 file_handle argument is the opened file handle to the mailbox. Both arguments are required.

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

lowkey the cache key thing matters so much — if your path isn't the full path, she's gonna think it's a whole different mailbox and you'll be so confused. give her the WHOLE path bestie 😤

---

🙈 BUGS 🙈

No known bugs. she's perfect, she's booked, she's busy 💅

Contact david@coppit.org for bug reports and suggestions.

---

👑 AUTHOR 👑

David Coppit <david@coppit.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. See http://grepmail.sf.net/ for previous versions of grepmail which included early versions of this code.

glow up story honestly, from grepmail side quest to main character energy ✨

---

🔥 SEE ALSO 🔥

• Mail::Mbox::MessageParser

---

and that's the whole vibe check, bestie — go forth and cache responsibly 🧚💖

this page came to you via perl v5.36.0, dated 2023-08-06, from the Mail::...etaInfo(3pm) manual — mwah, stan, bye 🎀