KOPANO-GATEWAY(8)

📦 version 8.7.0, in ubuntu jammy

💖 KOPANO-GATEWAY — the kopano-gateway(8) page, but make it cute ✨

okay bestie, so this is a Kopano Core user reference situation — section 8, admin commands, the whole vibe 👑

🌸 NAME 🌸

kopano-gateway — start the Kopano IMAP/POP3 Gateway. that's it, that's the girl 💅

✨ SYNOPSIS ✨

kopano-gateway [OPTION...]

short, sweet, iconic 🎀

🦋 DESCRIPTION 🦋

so basically?? this gateway is the main character that lets other e-mail clients pull up through POP3 or IMAP to the storage server and read their e-mail 📬. and with IMAP you're not even limited to the inbox — you can peek the contents of other folders and subfolders too, lowkey nosy but in a slay way 💖.

you can configure the gateway to listen for POP3, POP3S, IMAP and/or IMAPS — mix and match, pick your faves ✨.

and the default settings of the gateway program? those live in kopano-gateway.cfg(5). periodt 🫶

👑 OPTIONS 👑

there are various options possible. and here's the tea: none of these options are required. every single one is optional, no cap 🌈

  • --config, -c gateway.cfg — tell it where the gateway.cfg file lives. if you don't specify the gateway.cfg file, the gateway just keeps vibing with its default settings 🎀
    • Default: /etc/kopano/gateway.cfg
  • --dump-config — spills the values of the gateway.cfg configuration parameters and the implied defaults. like a little show-and-tell of your config 🍓
  • --host, -h path — connect to the storage server through path, e.g. file:///path/to/socket. Default: file:///var/run/kopano/server.sock. this one overrides the config file setting, so it wins the argument fr fr 🔥
  • --foreground, -F — run in the foreground. normally the gateway will daemonize and run in the background (sneaky, mysterious, doing its own thing) but with this flag it stays right here with you 💜

🚨 SIGNALS 🚨

these are the signals you can send to the kopano-gateway process:

  • HUP — when the HUP signal is received, some options from the configuration file get reloaded 🔄. the reloadable options are listed in the kopano-gateway.cfg(5) manual page, so go check her.
    • 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 — logrotate besties, this one's for you 🧚
  • TERM — to gracefully let the service exit, the normal TERM signal is used. graceful exit, no drama, we love a clean goodbye 😭💖

💫 USAGE 💫

to start the gateway:

kopano-gateway

the gateway process will keep running — she doesn't just dip, she commits 🫶.

you may also use the init.d scripts:

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

🌟 AUTHOR 🌟

Written by Kopano. 💜

🔗 SEE ALSO 🔗

kopano-gateway.cfg(5), kopano-server(8) — go read your sisters, iykyk 💅

okay that's the whole page bestie!! this was Kopano 8, dated November 2016, and yes it's giving vintage-but-still-slays 💖✨ mwah, go run your gateway, you got this 🎀🦋

📦 where this page comes from