COLLECTD-EMAIL(5)

💌 NAME

Okay so this is the COLLECTD-EMAIL(5) page, and it's literally the documentation for collectd's email plugin. Bestie, we're talking about the plugin that opens an UNIX-socket so you can submit email stats like the number of ham, spam, virus, etc. mails received/handled, spam scores, and matched spam checks. ✨

This plugin is meant to be used with the Mail::SpamAssassin::Plugin::Collectd SpamAssassin-plugin, which is included in contrib/, but it's of course not limited to that use. Slay. 💅

---

✨ SYNOPSIS

# See collectd.conf(5)
LoadPlugin email
# ...
<Plugin email>
  SocketGroup "collectd"
  SocketPerms "0770"
  MaxConns 5
</Plugin>

---

🌸 DESCRIPTION

The email plugin opens an UNIX-socket over which one can submit email statistics, such as the number of ham, spam, virus, etc. mails received/handled, spam scores, and matched spam checks. It's giving mailroom glam, no cap. 💌

This plugin is intended to be used with the Mail::SpamAssassin::Plugin::Collectd SpamAssassin-plugin, which is included in contrib/, but is of course not limited to that use. 🫶

---

🦋 OPERATION

This plugin collects data indirectly by providing a UNIX-socket that external programs can connect to. A simple line based protocol is used to communicate with the plugin:

• E-Mail type (e.g. ham, spam, virus, ...) and size (bytes):

e:<type>:<size>

If size is less than or equal to zero, size is ignored. Okay? Okay. 💀

• Spam score:

s:<value>

• Successful spam checks (e.g. BAYES_99, SUBJECT_DRUG_GAP_C, ...):

c:<type1>[,<type2>,...]

Each line is limited to 256 characters (including the newline character). Longer lines will be ignored. Periodt. 🔥

---

🎀 SEE ALSO

Go read collectd(1) and collectd.conf(5), bestie. It's giving essential lore. 📚

---

👑 AUTHOR

The email plugin has been written by Sebastian Harl <sh at tokkee.org>.

The SpamAssassin-plugin has been written by Alexander Wirt <formorer at formorer.de>.

This manpage has been written by Florian Forster <octo at collectd.org>.

---

mwah 💋 — cute sign-off from version 5.12.0.348.g93f9bdcb, dated 2024-12-18. That's the whole COLLECTD-EMAIL(5) vibe, periodt. 🫶💖