Test::M...::Tmpdir(3)

💅 Test::Mailmunge::Tmpdir — from the User Contributed Perl Documentation ✨

okay bestie, so the actual name of this page is Test::M...::Tmpdir(3) (it's been abbreviated, iykyk) but the module we're actually talking about is Test::Mailmunge::Tmpdir, and honestly? it's such a handy little thing.

---

🌸 NAME 🌸

Test::Mailmunge::Tmpdir — creates you a temporary directory and (usually) cleans it up after itself, like a well-behaved roommate 🧹✨

🎀 ABSTRACT 🎀

So here's the tea: Test::Mailmunge::Tmpdir spins up a temporary directory under "./t/tmp" and — unless you tell it otherwise — deletes that whole thing right before the program exits. 🗑️

But like, more specifically (because the details matter, bestie): the directory gets removed when the Test::Mailmunge::Tmpdir object goes out of scope. That's the actual trigger. Out of scope → cleanup. Periodt. 👑

✨ SYNOPSIS ✨

use Test::Mailmunge::Tmpdir;

my $tmp_obj = Test::Mailmunge::Tmpdir->new();
my $dir = $tmp_obj->{dir};

# Create files, etc in $dir

if (something_went_horribly_wrong()) {
    # Oh no!  Don't clean up the temp dir
    $tmp_obj->{cleanup} = 0;
}

# Directory will be cleaned up prior to exit
# unless we set $tmp_obj->{cleanup} to 0.
exit(0);

like, it's giving "I made a mess but I'll handle it" energy, and then ✨plot twist✨ — if something_went_horribly_wrong() you just flip $tmp_obj->{cleanup} to 0 and the directory stays put for your forensic investigation 🔍💀

🌈 CONSTRUCTOR 🌈

Test::Mailmunge::Tmpdir->new()

Gives you back a fresh new object called $tmp_obj 🫶 The brand-new temporary directory lives in "$tmp_obj->{dir}", and the "cleanup" flag lives in "$tmp_obj->{cleanup}". That's it, that's the whole vibe check — no cap.

💖 quick reminder: $tmp_obj->{dir} = your directory, $tmp_obj->{cleanup} = whether it gets yeeted on scope exit. Don't lose track of either, bestie.

---

👑 AUTHOR 👑

Dianne Skoll <dianne@skollsoft.com> — literal icon, we stan 💜

💅 LICENSE 💅

This code is licensed under the terms of the GNU General Public License, version 2. fr fr, respect the license.

---

and that's the whole page, bestie 🦋 — source & version check: perl v5.42.2, dated 2025-10-05, brought to you by Test::M...::Tmpdir(3) ✨ mwah 💋