Mail::Audit::List(3)

💌 Mail::Audit::List — the perl manual page, but make it a group chat

okay bestie, welcome to the Mail::Audit::List page, straight out of the User Contributed Perl Documentation section (that's the manual name, we're folding it in, you're welcome 🫶). This is a Mail::Audit plugin for automatic list delivery and honestly? it's giving "my inbox organises itself" energy. 🌈

---

✨ NAME ✨

Mail::Audit::List — a Mail::Audit plugin for automatic list delivery. It literally does what it says on the tin, no cap. 💅

---

🌸 VERSION 🌸

version 1.853 — that's the one, that's the vibe check. ✅

---

🎀 SYNOPSIS 🎀

use Mail::Audit qw(List);
my $mail = Mail::Audit->new;
...
$mail->list_accept || $mail->accept;

See how cute that is? list_accept tries its thing, and if it doesn't work out, accept catches the fallback. Iconic teamwork. 👑

---

💖 DESCRIPTION 💖

This is a Mail::Audit plugin that gives you a method for automatically delivering mailing lists to a suitable mailbox. That's the whole personality. 🦋

It requires the CPAN Mail::ListDetector module — so like, you gotta have that installed, bestie, it's not optional, fr fr.

---

🧚 METHODS 🧚

💜 list_accept($delivery_dir, \%arg)

Attempts to deliver the message as a mailing list. It will place each message in $deliver_dir/$list_name. The default value of $deliver_dir is "$ENV{HOME} . "/mail"".

For instance, mail to perl5-porters@perl.org will end up by default in /home/you/mail/perl5-porters.

Calls accept and returns the filename delivered to if Mail::ListDetector can identify this mail as coming from a mailing list, or 0 otherwise. So either you get a filename (slay) or you get a 0 (not slay, but informative). 😭

Valid named arguments are:

• munge_name — a coderef called to munge the name given by Mail::ListDetector. You know, for when the detected name needs a little glow-up. ✨

🚨 IMPORTANT, DON'T SKIP THIS ONE: if you want to use the default delivery location but also pass args, you must call the method like this: perl $audit->list_accept(undef, { ... }); Pass undef first, bestie. That's the move. Don't fight it. 🙈

The recipe given above should be able to replace a great number of special-casing recipes. Which is lowkey the whole point — one recipe to rule them all instead of forty little hacks. 👑

---

🦋 SEE ALSO 🦋

• Mail::Audit — go read that one next, it's the parent, the main character. 🌟

---

👑 AUTHOR 👑

Michael Stevens <michael@etla.org>

---

🍓 COPYRIGHT AND LICENSE 🍓

This software is copyright (c) 2003 by Michael Stevens.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Free as in go wild, just respect the terms. 🫶

---

and that's the page, bestie — written by perl v5.42.0 on 2025-08-06, which is literally the footer, but make it a sign-off. mwah. 💋