Email:...:Reader(3pm)

💌 Email::Folder::Reader — the manual, but make it make sense

okay bestie, so this is Email::Folder::Reader, a Perl module (that's the (3pm) bit) that reads raw RFC822 mails out of a box. Like, straight off the rack, unprocessed, <rainbow>raw</rainbow>. No vibes-based interpretation, just the actual message bytes. 🦋

---

✨ NAME ✨

Email::Folder::Reader — reads raw RFC822 mails from a box 💅

🌸 VERSION 🌸

version 0.860 🎀

---

✨ SYNOPSIS ✨

okay so here's the moment, the main character entrance. you pull messages out one big pile at a time:

 use Email::Folder::Reader;
 my $box = Email::Folder::Reader->new('somebox');
 print $box->messages;

or, and this is the iykyk route, you go as an iterator:

 use Email::Folder::Reader;
 my $box = Email::Folder::Reader->new('somebox');
 while ( my $mail = $box->next_message ) {
     print $mail;
 }

both serve. both eat. choose your fighter. 💖

---

🫶 METHODS 🫶

new($filename, %options)

your standard class-method constructor 🎀. yes bestie, it's the constructor. give it a filename, optionally hand it some %options, and it hands you back a box object. no cap, that's the whole thing.

->next_message

returns the next message from the box — or false if there are no more 👑. so like, when it goes false, that's the end, that's it, the box is empty, we're done here. lowkey perfect for a while loop ngl.

->messages

Returns all the messages in a box ✨. every single one. the whole roster. 💜

---

💖 AUTHORS 💖

• Simon Wistow <simon@thegestalt.org>
• Richard Clamp <richardc@unixbeard.net>
• Pali <pali@cpan.org>

the girls that built her 🥹🫶

---

📜 COPYRIGHT AND LICENSE 📜

This software is copyright (c) 2006 by Simon Wistow.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. 💅 (so like, free software, do your thing, just keep it on the same terms as Perl 5 itself. periodt.)

---

okay and for the little sign-off moment 🎀 this page was rendered with perl v5.36.0, dated 2022-10-14, and yes it's the User Contributed Perl Documentation corner of the internet, which is exactly as chaotic and iconic as it sounds 🌈✨ bye bestie, go read some mail 💌