Sisima...:STDIN(3pm)

💖 Sisimai::Mail::STDIN — the mail-reading bestie that lives in your terminal 💖

okay so bestie, pull up a chair 🪑 because this is Sisimai::Mail::STDIN, and she's part of the User Contributed Perl Documentation crew — a 3pm manual page, iykyk. She's a mailbox reader, and her whole thing? She reads email data straight from Standard-In. That's it. That's the vibe. 🌸

---

✨ SYNOPSIS ✨

use Sisimai::Mail::STDIN;
my $mailbox = Sisimai::Mail::STDIN->new();
while( my $r = $mailbox->read ) {
    print $r;   # print data read from STDIN
}

---

🦋 DESCRIPTION 🦋

Sisimai::Mail::STDIN reads email data from Standard-In. Standard input. The classic. The icon. The STDIN girlies know. 💅

---

👑 CLASS METHODS 👑

💜 new()

new() is the constructor of Sisimai::Mail::STDIN — it's giving main character energy, it's how you spin one of these up.

my $mailbox = Sisimai::Mail::STDIN->new();

---

🌈 INSTANCE METHODS 🌈

🎀 path()

path() hands you back a fixed string, and that string is "<STDIN>". She doesn't move, she doesn't change, she just is. Iconic behaviour, honestly.

print $mailbox->path;   # "<STDIN>"

---

🍓 size()

size() spills the tea on the data size that's been read so far. Numbers! We love numbers. ✨

print $mailbox->size;   # 2202

---

🧚 offset()

offset() returns the offset position used for seeking the mbox. That offset value is a count of bytes that have already been read. So when you're like "where are we bestie", this is your answer. 📍

print $mailbox->offset;   # 0

---

🫶 handle()

handle() gives you back the file handle object — an IO::Handle — of the mbox. Raw handle energy. Hold it gently. 🙈

$mailbox->handle;

---

🔥 read()

read() is the iterator bestie — it walks through each email in the mbox one at a time, no cap, no skipping.

my $mailbox = Sisimai::Mail->new();
while( my $r = $mailbox->read ) {
    print $r;   # print data read from STDIN
}

---

💖 AUTHOR 💖

azumakuniyuki

---

⭐ COPYRIGHT ⭐

Copyright (C) 2014-2016,2018-2021,2024,2025 azumakuniyuki, All rights reserved.

---

🌸 LICENSE 🌸

This software is distributed under The BSD 2-Clause License.

---

and that's the whole page, bestie — swerve responsibly 💀

mwah 💋 this one's from perl v5.40.1, dated 2026-07-05, and it goes out to the one and only Sisima...:STDIN(3pm). stay hydrated, read your STDIN, periodt. 💅✨