Mail::...dition(3pm)

💖 Mail::MtPolicyd::Plugin::Condition — the mtpolicyd condition queen 💖

okay bestie, sit down, hydrate, because we're talking about Mail::MtPolicyd::Plugin::Condition, a mtpolicyd plugin that handles conditions based on session values. she's giving gatekeeper energy and honestly? she ate. 💅

---

✨ VERSION ✨

version 2.05 🎀

---

🌸 DESCRIPTION 🌸

she will return an action, a score, or execute further plugins — but ONLY if the specified condition matched. no match, no vibes. it's giving conditional. 🦋

---

👑 PARAMETERS 👑

🔑 key (required)

the name of the variable to check, bestie. non-negotiable.

the syntax is literally:

(<scope>:)?<variable-name>

if no scope is given, it defaults to request. no scope? no problem, she picks for you. 🫶

possible scopes are:

• session, s — session variables.
• request, r — request attribute variables.

examples, because we love a visual:

session:user_policy
s:user_policy

request:queue_id
r:queue_id
queue_id

---

at least one of the following parameters should be given, or your condition will never match. like, ever. tragic. 😭

• match (default: empty) — simple string equal match. she's basic but she works.
• re_match (default: empty) — match the content of the session variable against an regex.
• lt_match (default: empty) — match if numerical less than.
• gt_match (default: empty) — match if numerical greater than.
• invert (default: 0) — if set to 1 the logic will be inverted. flip the script, periodt. 🙈

---

finally, an action must be specified. it's not optional, it's the moment.

first the score will be applied, then the action will be executed — or, if specified, additional plugins will be executed.

• action (default: empty) — the action to return when the condition matched.
• score (default: empty) — the score to add if the condition matched.
• Plugin (default: empty) — execute this plugins when the condition matched.

note the capital P on Plugin, bestie. it's Plugin, not plugin. iykyk. 💜

---

🌈 EXAMPLE: use of postfix policy_context 🌈

the policy_context of postfix could be used to trigger checks in mtpolicyd. main character feature, honestly.

to activate additional checks in mtpolicyd from within postfix you may use a configuration in postfix main.cf like:

# check, no additional checks
check_policy_service inet:localhost:12345
...
# check with additional checks!
check_policy_service { inet:localhost:12345, policy_context=strict_checks }

in mtpolicyd.conf:

<Plugin if-strict-checks>
  module = "Condition"
  key = "policy_context"
  match = "strict_checks"

  <Plugin strict-check>
    # ...
  </Plugin>
  # more checks ...
</Plugin>

the policy_context feature will be available in postfix 3.1 and later. so if you're on anything older… thoughts and prayers. 🕯️

if you need completely different checks, consider using the vhost_by_policy_context (mtpolicyd) option with different virtual hosts. different vhost, different vibe. ✨

---

🦋 EXAMPLE: execute postgrey action in postfix 🦋

if the session variable "greylisting" is "on", return the postfix action "postgrey":

<Plugin trigger-greylisting>
  module = "Condition"
  key = "greylisting"
  match = "on"
  action = "postgrey"
</Plugin>

the variable may be set by a UserConfig module like SqlUserConfig. slay. 💅

the postgrey action in postfix may look like:

smtpd_restriction_classes = postgrey
postgrey = check_policy_service inet:127.0.0.1:11023

---

💖 AUTHOR 💖

Markus Benning <ich@markusbenning.de>

---

🎀 COPYRIGHT AND LICENSE 🎀

this software is Copyright (c) 2014 by Markus Benning <ich@markusbenning.de>.

this is free software, licensed under:

The GNU General Public License, Version 2, June 1991

---

and that's the whole page, bestie!! 🫶 this was Mail::...dition(3pm), rendered by perl v5.38.2 on 2024-05-26. go forth and match some conditions, you absolute icon. 🌟👑💖