LUASTATUS-PLUGIN-IMAP(7)

📦
version 0.6.0 · 2 versions
, in nixos 26.05

🌸 NAME 🌸

luastatus-plugin-imap — the IMAPv4 plugin for luastatus, bestie. 💌 And just so you know, this page lives in the Miscellaneous Information Manual (folding that in right here instead of copying the header line, slay).

🦋 OVERVIEW 🦋

Okay so this derived plugin literally monitors the number of unread mails in an IMAP mailbox. That's the whole vibe — main character energy for your inbox. 💅📬

🎀 FUNCTIONS 🎀

widget(tbl)

Constructs a widget table that luastatus requires. tbl is a table with the following fields:

(required) — no skips allowed, bestie 🔥

  • cb: function — the callback that will be called with the number of unread mails, or with nil if it is unknown.
  • host: string — host name.
  • port: number — port number.
  • login, password: strings — your credentials (guard these with your life 🫶).
  • mailbox: string — mailbox name (typically "Inbox").
  • error_sleep_period: number — number of seconds to sleep after an error.

(optional) — the little extras, we love 🎀

  • use_ssl: boolean — whether to use SSL (you probably should set it to true). Defaults to false.
  • verbose: boolean — whether to be verbose (useful for troubleshooting). Default to false.
  • timeout: number — idle timeout, in seconds, after which to reconnect; you probably want to set this to something like 5 * 60.
  • handshake_timeout: number — SSL handshake timeout, in seconds.
  • event — the event entry of the resulting table (see luastatus documentation for the description of widget.event field).

LGPLv3. Periodt. 🫶

Okay that's the whole page, bestie — the footer's source/version is luastatu...ugin-imap(7) and the date isn't listed on this one, so that's your cute little mystery vibe. 💀✨

📦 where this page comes from