Courie...endCopy(3pm)

💖 Courier::Filter::Module::SendCopy — the manual, but make it make sense 💖

okay bestie, so this is Courie...endCopy(3pm) — the 3pm is the man section, meaning it's a Perl module page, and the name got absolutely chopped by the terminal like it owed somebody money. The real one is Courier::Filter::Module::SendCopy, and it's the cute little pseudo-filter that goes "hey, I'm not gonna block anything, I'm just gonna quietly send a copy of some messages to some extra people." Sneaky? No. Iconic? Yes. 👑

---

✨ NAME ✨

Courier::Filter::Module::SendCopy — a Pseudo-filter for the Courier::Filter framework that sends a copy of certain messages to additional recipients. That's the whole job, and it does it flawlessly. 💅

---

🦋 SYNOPSIS 🦋

use Courier::Filter::Module::SendCopy;

my $module = Courier::Filter::Module::SendCopy->new(
    # One or more of the following criteria:
    match_sender                => qr/\@office\.example\.net$/,
    match_recipients            => qr/\@customer\.example\.com$/,
    match_authenticated_user    => 'my-smtp-user-name',

    # One or several copy recipients:
    copy_recipients => [
        'el-cheffe@office.example.net',
        'archives@customer.example.com',
    ],

    # Send a copy to the sender? (always/never/indifferent)
    copy_to_sender  => TRUE,    # TRUE/FALSE/undef
)

my $filter = Courier::Filter->new(
    ...
    modules     => [ $module ],
    ...
);

the way that copy_to_sender has a lil comment like # TRUE/FALSE/undef because undef is a whole third vibe? obsessed. anyway.

---

🌸 DESCRIPTION 🌸

This class is a filter module for use with Courier::Filter. And here's the tea: if a message matches a given set of criteria, a blind carbon copy of the message is sent to a configured list of additional recipients — and how does it do that, you ask? By adding them to the message's control file. That's the mechanism. No extra SMTP drama, just a lil control-file edit. 🎀

And the plot twist that makes it a pseudo-filter: this module never matches. Like, it will never be the reason a message gets rejected. It's just here to sip its drink and quietly cc people. 💀

🫶 Constructor

The following constructor is provided:

• new(%options): returns Courier::Filter::Module::SendCopy — Creates a new SendCopy filter module.

%options is a list of key/value pairs representing any of the following options:

• match_sender — A pattern matched against the message's envelope sender. If not specified, any sender qualifies. no gatekeeping, everyone's welcome. 🌈
• match_recipients — A pattern matched against all of the message's envelope recipients. Any of the envelope recipients may match. If no pattern is specified, any recipient qualifies.
• match_authenticated_user — A pattern matched against the user name that was used for authentication during submission of the message. If no pattern is specified, any user or none at all qualifies. But if a pattern is specified and no authentication took place during submission of the message, then the message does not qualify. periodt, no auth no match. 💅
• copy_recipients — One or several addresses a copy of every matching message is sent to in addition to the original recipients. A single address can be specified as a simple scalar; a list of several addresses must be specified as an array reference. And important: any address matching exactly one of the original recipient addresses is skipped. if they're already getting it, we're not double-sending, that would be embarrassing fr. 🙈
• copy_to_sender — Specifies whether a copy of the message should be sent to its envelope sender. If false, no message is ever sent back in copy to its sender, even if the sender is included in the copy_recipients list. If true, the sender is always sent a copy of the message. If undef (the default), the sender must be included in the copy_recipients list to receive a copy of the message. so: undef = "only if you asked for it", TRUE = "yes bestie always", FALSE = "girl never". ✅❌🤷

Patterns may either be simple strings (for exact, case-sensitive matches) or regular expression objects created by the qr// operator (for partial matches).

All options of the Courier::Filter::Module constructor are also supported. Please see "new" in Courier::Filter::Module for their descriptions. 🧚

💜 Instance methods

See "Instance methods" in Courier::Filter::Module for a description of the provided instance methods. (Spoiler: they're inherited, it keeps things tidy, we love a reusable queen.)

---

👑 SEE ALSO 👑

• Courier::Filter::Module
• Courier::Filter::Overview

For AVAILABILITY, SUPPORT and LICENSE information, see Courier::Filter::Overview. (those are real section names in there, go look, they're not lowercase in the original, I'm just matching the vibe) 🌈

---

💖 AUTHOR 💖

Michael Buschbeck <michael@buschbeck.net> — credited, respected, and forever in our hearts for writing this thing. 🫶

---

⭐ cute sign-off time: this absolute banger of a page ships as perl v5.34.0, dated 2022-10-21, and it's part of the User Contributed Perl Documentation, which is basically the group chat of Perl docs. 💅✨ bye bestie, go cc somebody responsibly 🎀