Mail::...r::Perl(3pm)

💖 NAME 💖

ok so Mail::Mbox::MessageParser::Perl — it's a Perl-based mbox folder reader. yes bestie, that's the whole vibe. it reads mbox folders. in Perl. iconic. ✨

---

🌸 SYNOPSIS 🌸

here's the whole thing, no notes, just vibes:

#!/usr/bin/perl

use Mail::Mbox::MessageParser;

my $filename = 'mail/saved-mail';
my $filehandle = new FileHandle($filename);

my $folder_reader =
  new Mail::Mbox::MessageParser( {
    'file_name' => $filename,
    'file_handle' => $filehandle,
  } );

die $folder_reader unless ref $folder_reader;

# 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;
}

like. it's literally: open the thing, make the reader, print whatever's chilling before the first email, then loop through every email one at a time. slay. 💅

---

🦋 DESCRIPTION 🦋

this module implements a Perl-based mbox folder reader. 💖

ok but listen — users must not instantiate this class directly. use Mail::Mbox::MessageParser instead, fr fr. the base MessageParser module will automatically manage the use of faster implementations if they can be used. let the base module do its thing, it knows what it's doing. 👑

---

✨ METHODS AND FUNCTIONS ✨

the following methods and functions are specific to the Mail::Mbox::MessageParser::Perl package. for the additional inherited ones, go peek at the 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

so the constructor takes two parameters, bestie. the file_name parameter is optional and it's the filename of the mailbox. the file_handle argument is required and it's the opened file handle to the mailbox. 🙈

it returns a reference to a Mail::Mbox::MessageParser object — or, if things go sideways, a string describing the error. so like, check your refs. 💀

• end_of_file()
• reset()
• read_next_email()

these methods are overridden in this subclass of Mail::Mbox::MessageParser. that's it, that's the tea. 🍓

---

💀 BUGS 💀

no known bugs. not a single one. we're clean, we're pristine, we're that girl. 🧚

contact david@coppit.org for bug reports and suggestions. slide into the inbox, it's fine.

---

👑 AUTHOR 👑

David Coppit <david@coppit.org>. periodt.

---

🌈 LICENSE 🌈

this code is distributed under the GNU General Public License (GPL) Version 2. see the file LICENSE in the distribution for details. read it, it's good for you. ✨

---

💜 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. a little origin story, we love that for it. 🫶

---

⭐ SEE ALSO ⭐

• Mail::Mbox::MessageParser

---

and that's the whole page, bestie — this one shipped in perl v5.36.0, dated 2023-08-06, under the manual name Mail::...r::Perl(3pm) from the User Contributed Perl Documentation. go forth and parse some mailboxes 💖✨🎀