Courie...ssassin(3pm)

💖 NAME 💖

Courier::Filter::Module::SpamAssassin — the SpamAssassin message filter module for the Courier::Filter framework. bestie, it's giving "your inbox's personal bouncer" 🫶

(this is the page for Courie...ssassin(3pm), yeah the title got squished, we don't talk about it 💅)

---

✨ SYNOPSIS ✨

use Courier::Filter::Module::SpamAssassin;

my $module = Courier::Filter::Module::SpamAssassin->new(
    prefs_file  => '/etc/courier/filters/courier-filter-spamassassin.cf',
    sa_options  => {
        # any Mail::SpamAssassin options
    },

    logger      => $logger,
    inverse     => 0,
    trusting    => 0,
    testing     => 0,
    debugging   => 0
);

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

---

🌸 DESCRIPTION 🌸

okay so this class is a filter module class, meant to be used with Courier::Filter. What does it do? It's literally a vibe check for spam 💀 — it matches a message if its SpamAssassin spam score exceeds the configured threshold. that's it, that's the whole job, and it ate.

🎀 Constructor 🎀

here's the constructor it serves you:

new(%options): returns Courier::Filter::Module::SpamAssassin

Creates a new SpamAssassin filter module. iconic behavior, no notes.

%options is a list of key/value pairs, and those pairs can be any of the following bestie:

• prefs_file — the path of a SpamAssassin preferences file. If you specify this option, its value gets passed straight to the Mail::SpamAssassin constructor's userprefs_filename option, no cap. If it's undef, SpamAssassin is told not to read any preferences besides its default configuration files. Defaults to undef.
• sa_options — a hash-ref specifying options for the Mail::SpamAssassin object that this filter module uses. Wanna know which options are supported? go see "new" in Mail::SpamAssassin, she'll tell you 🌈

also!! all the options of the Courier::Filter::Module constructor are supported too — every single one. Please see "new" in Courier::Filter::Module for their descriptions, iykyk.

💜 Instance methods 💜

See "Instance methods" in Courier::Filter::Module for a description of the provided instance methods. she's got the details fr fr.

---

👑 SEE ALSO 👑

Courier::Filter::Module, Courier::Filter::Overview.

For AVAILABILITY, SUPPORT, COPYRIGHT, and LICENSE information, see Courier::Filter::Overview. yes bestie, all the legal stuff lives over there, go read it 🫶

---

⭐ AUTHOR ⭐

Julian Mehnle <julian@mehnle.net> — tysm for this one, legend behavior 🙈

---

and that's the whole page, bestie 💖 this absolute masterpiece is User Contributed Perl Documentation, running under perl v5.34.0, dated 2022-10-21 — periodt, no cap, go filter some spam 👑✨