KOPANO-SPOOLER(8)

💌 KOPANO-SPOOLER(8) — kopano-spooler

okay bestie, gather round, because this one is literally the mail room of your entire Kopano setup and she is working. this is the manual page for kopano-spooler, part of the Kopano Core user reference, and yes she's a section 8 page so she means business 💅

---

✨ NAME ✨

kopano-spooler — Start the Kopano spooler.

like. she starts. the spooler. iconic behavior honestly 🎀

---

🌸 SYNOPSIS 🌸

kopano-spooler [OPTION...] [SERVERNAME]

---

🦋 DESCRIPTION 🦋

okay so here's the vibe: the spooler sends all pending Kopano e-mail to the recipients. that's the whole job. that's her whole personality and she eats every time 🔥

when you start her, the program just keeps running and sending messages whenever needed. she doesn't clock out. she's giving main character energy that never leaves the group chat.

the outgoing mailserver can be overwritten from the config file by specifying this on the commandline. yep, you can just say it out loud on the command line and she'll listen.

the default settings of the spooler program are defined in kopano-spooler.cfg(5). so if you're like "where do the defaults even come from" — that's the page, bestie, go read her.

---

💖 OPTIONS 💖

various options are possible. none of these options are required. she's low maintenance, she'll run without any of them. but here they are anyway:

• --config, -c spooler.cfg — specify the location of the spooler.cfg file. if the spooler.cfg file is not specified, the spooler will try to load /etc/kopano/spooler.cfg. and if that file isn't present either? she just continues using her default settings. unbothered. unshaken. 🫶
• --dump-config — displays the values of spooler.cfg configuration parameters and the implied defaults. basically she spills the tea on her own config, no cap.
• --host, -h path — connect to the storage server through path, e.g. file:///path/to/socket. default: file:///var/run/kopano/server.sock. overrides the config file setting. she said "I'll go where you tell me to go" ✨
• --foreground, -F — run in the foreground. normally the spooler will daemonize and run in the background, but this keeps her right there in front of you, staring at you lovingly.

---

🌈 USAGE 🌈

to start the spooler delivering e-mail to recipients:

kopano-spooler

to start the spooler delivering e-mail through smtp.example.com:

kopano-spooler smtp.example.com

the spooler process will keep running and watching the outgoing queue for new mail to send. she's literally just sitting there refreshing the queue like it's her fyp 📱

you may also use the init.d scripts:

/etc/init.d/kopano-spooler [start| stop| restart]

(yeah the spacing in there is a little quirky but we don't fix her, we love her as she is 💜)

---

🎀 SIGNALS 🎀

the following signals can be sent to the kopano-spooler process:

• HUP — when the HUP signal is received, some options from the configuration file are reloaded. the reloadable options are listed in the kopano-spooler.cfg(5) manual page.

also, when using log_method = file, the logfile will be closed and a new logfile will be opened. you can use this signal in your logrotate system. she's flexible like that 💅

• TERM — to gracefully let the service exit, the normal TERM signal is used. because of multiple running threads, it may take up to 60 seconds for the server to completely shutdown. yes, a whole minute. she's not being dramatic, she's just busy. give her a second to finish her sentence 😭

---

👑 AUTHOR 👑

Written by Kopano.

---

⭐ SEE ALSO ⭐

kopano-spooler.cfg(5), kopano-server(8)

---

reminder bestie: keep every flag exactly as written, don't go renaming things, and always read kopano-spooler.cfg(5) before you start messing with defaults 💖

---

and that's the whole page! this one's from Kopano 8, dated November 2016, and it's the KOPANO-SPOOLER(8) page from the Kopano Core user reference. go forth and deliver that mail, queen 🦋💖✨