Sympa::Spool::Outgoing(3Sympa)

👑 NAME

Sympa::Spool::Outgoing — bestie, it's the spool for outgoing messages 💌 (from the sympa manual, section 3Sympa, iykyk)

---

✨ SYNOPSIS ✨

use Sympa::Spool::Outgoing;
my $bulk = Sympa::Spool::Outgoing->new;

$bulk->store($message, ['user@dom.ain', 'user@other.dom.ain']);

my ($message, $handle) = $bulk->next;

---

🌸 DESCRIPTION 🌸

Sympa::Spool::Outgoing implements the spool for outgoing messages. That's it, that's the whole vibe: it's where messages go when they're headed out the door. 🚪💨

🎀 Methods 🎀

• new ( ) — the constructor, obviously. Creates a brand new instance of Sympa::Spool::Outgoing. main character energy from the jump 💅
• next ( [ no_filter => 1 ] ) — instance method. Grabs the next packet for processing. The order is controlled by, in this exact sequence: message priority first, then packet priority, then delivery date, then reception date. Packets with a future delivery date get ignored — unless the no_filter option is set, then they're fair game. The packet gets locked so nobody else can process the same one twice (no double-dipping bestie 🫶).

Parameters:

None. (Nada. Zero. Zilch. 😌)

Returns:

A two-elements list: a Sympa::Message instance and a filehandle locking that packet.

• quarantine ( $handle ) — instance method. Quarantines a packet — as in, sends it to the naughty corner, AKA the bad/ subdirectory of the spool. 🚫📦

Parameter:

• $handle — filehandle, a Sympa::LockedFile instance, locking the packet.

Returns:

True value if the packet could be quarantined. False value otherwise. Simple as. ✨

• remove ( $handle ) — instance method. Removes a packet. And plot twist: if that packet is the last one of a bulk sending, the corresponding message also gets removed from the spool. bye bestie 👋💀

Parameter:

• $handle — filehandle, a Sympa::LockedFile instance, locking the packet.

Returns:

True value if the packet could be removed. False value otherwise.

• store ( $message, $rcpt, [ original => $original ], [ tag => $tag ] ) — instance method. Stores the message into the message spool. The recipients get split into multiple packets, and those packets go into the packet spool. It's giving assembly line but make it cute 🧚

Parameters:

• $message — the message to be stored. These following attributes and metadata are the ones it actually reads:
  • {envelope_sender} — the SMTP "MAIL FROM:" field.
  • {priority} — message priority.
  • {packet_priority} — packet priority, assigned as the "sympa_packet_priority" parameter by each robot. 🤖
  • {date} — Unix time when the message would be delivered.
  • {time} — Unix time as a floating point number, for when the message was stored.
• $rcpt — scalar, scalarref or arrayref, for the SMTP "RCPT TO:" field(s).
• original => $original — if the message was decrypted, this stores the original encrypted form. (keeping the receipts, literally 🫶)
• tag => $tag — TBD. (mysterious. iconic. we simply do not know yet 🔮)

Returns:

If storing succeeded, the marshalled metadata (the file name) of the message. Otherwise "undef". 😭

• too_much_remaining_packets ( ) — instance method. Returns a true value if the number of remaining packets exceeds the value of the "bulk_fork_threshold" config parameter. basically an "am I over capacity bestie" check 🫣

---

⚙️ CONFIGURATION PARAMETERS ⚙️

These following site configuration parameters in sympa.conf will be referred to. No cap. 📋

• queuebulk — directory path of the outgoing spool.

Note: it's named this way for historical reasons. Do not confuse it with "queueoutgoing", which is the archive spool (go check Sympa::Spool::Archive). Two different girls, same-ish name, don't mix them up bestie 😭

• umask — the umask to make the directory. (yes it's about permissions, no we don't make the rules 💅)

---

💀 CAVEAT 💀

Sympa::Spool::Outgoing is not a real subclass of Sympa::Spool. Not even a little bit. It said "I'm built different" and meant it. 🙈

---

🔥 SEE ALSO 🔥

bulk(8), Sympa::Mailer, Sympa::Message.

---

📜 HISTORY 📜

The Bulk module was initially written by Serge Aumont and appeared on Sympa 6.0. Back then it used database tables to store and fetch packets and messages. old school, honestly kinda impressive 🫡

Support for DKIM signing was added on Sympa 6.1. slay. ✨

The rewritten Sympa::Bulk appeared on Sympa 6.2, using spools based on the filesystem — glow up fr fr. Then it was renamed to Sympa::Spool::Outgoing on Sympa 6.2.45b.3. character development, we love to see it 👑

---

that's the whole page bestie, go forth and spool responsibly 🎀✨

~ this was Sympa::Spool::Outgoing(3Sympa) from sympa 6.2.80, dated 2026-10-19 ~ 💖🦋🌸