kopano-oof(1)

🎀 kopano-oof — the manual, but make it cute 🎀

hi bestie 💖 you've landed on kopano-oof(1), straight outta the Kopano Core user reference. yes, section 1, user commands, we love that for us. sit down, grab a strawberry 🍓, and let's talk about Out Of Office settings.

---

🌸 NAME 🌸

kopano-oof — control a user/store's Out Of Office settings.

---

✨ SYNOPSIS ✨

kopano-oof [-Px] [-h uri] [-m {0|1}] [-n msgfile] [-s sslkeyfile] [-t subject] [-u username] [--from iso8601] [--until iso8601]

---

💖 DESCRIPTION 💖

so this program does exactly one thing and it does it well: it changes and/or displays a user's Out Of Office settings, aka OOF. these settings are the ones that decide whether kopano-dagent(8) will, within a certain timeframe, send an automated reply to every message that comes in. no cap.

and it's not just dagent — kopano-spooler(8) can also use the OOF settings to do special handling, like forwarding a message to an alternate account when the original recipient has OOF active. iconic behaviour tbh. 🫶

heads up bestie: the storage server must be running for kopano-oof to function. like, actually running. no server, no OOF, no vibes. 💀

and here's the thing to remember: after it potentially updates the OOF settings with -m, --from and friends, kopano-oof will always output the current/new state of the OOF settings in JSON format. always. every single time. periodt.

---

👑 OPTIONS 👑

• -h uri — connect to the storage server you name here. if you don't say anything, it just contacts the local standard Kopano instance, which is the default vibe.
• -m, --mode {0|1} — clears or sets the Out Of Office flag on the user store. 0 disables it, 1 enables it. when it's enabled, daemons like kopano-dagent(8) and kopano-spooler(8) will, while processing a message, evaluate the OOF time constraints (which you set independently with the further options). ✨
• -n, --message file — updates the message body for Out Of Office messages to the contents of the file you point at. the encoding of that file is expected to be in the current environment's charset — that's the LC_CTYPE variable, bestie. 🎀
• -s, --sslkey-file file — reads the certificate file you specify and uses it while connecting to the storage server. 🔐
• -t, --subject text — updates the subject line for Out Of Office messages to the text you give it. the encoding of the text is expected to be in the environment's charset.
• -P — interactively prompts you for the SSL keyfile password. if neither -P nor -p is specified, kopano-oof will go looking for a password in the OOF_SSL_PASSWORD environment variable.
• -p password — okay so this one exists purely for compatibility with kopano-set-oof(1). you should use the OOF_SSL_PASSWORD environment variable instead to pass the SSL certificate password, because passwords may be visible in the output of ps(1). 😭 please don't put your password on the command line.
• -u, --user username — edit the Out Of Office settings for this user's default store.
• -x — prompts for the user account password. if you don't pass this option, kopano-oof will look for a password in the OOF_PASSWORD environment variable. and if no password was specified in any way at all — -x, -p, environment variables, nothing — then kopano-oof will log in with the "SYSTEM"</> account, which requires appropriate privileges. confer with the "local_admin_users" directive in kopano-server.cfg(5). 👑
• --dump-json — this option is ignored, for compatibility with kopano-set-oof(1). JSON data is always emitted, both when the settings have changed and when they are unmodified. so yeah, it's decorative. cute though.
• --from YYYY-mm-dd HH:MM — limits the Out Of Office mechanism so that it is not active if the time of processing a message is before the specified timepoint. the format for the argument is like "2015-04-01 23:50" (ISO-8601-like). that timepoint is interpreted as being in the current environment's timezone, aka the TZ variable. 🕰️
• --to YYYY-mm-dd HH:MM — limits the Out Of Office mechanism so that it is not active if the time of processing a message is after this timepoint. same format as --from. alternatively, the special value "infinite" may be used to say that OOF is open-ended. 🌈

---

🦋 JSON OUTPUT 🦋

this is what it spits out:

{
    "active" : false,
    "from" : "2019-01-01 00:00:00",
    "set" : true,
    "subject" : "outtahere",
    "until" : "infinite"
}

let's decode the vibes 💅:

• set tells you whether the Out Of Office feature has been enabled at all.
• from and until specify the time range in which OOF will be considered active (if and only if it is enabled) by dagent, spooler, and so on. the special value "infinite" expresses that it's open-ended.
• active flags whether OOF is active right now given these conditions.
• subject and message contain the OOF message subject and body data.

---

🌈 USAGE EXAMPLES 🌈

1. non-SSL login with password, and enabling OOF over a certain period, sourcing the body text from a file:

OOF_PASSWORD=xfoo kopano-oof -u foo -m 1 -t "Outta here for a while" --from "2017-12-23 00:00" --until "2018-01-02 00:00" --message long_explanation.txt

2. pseudo-disablement of one's mailbox (the "idk when I'm back" classic):

kopano-oof -u foo -m 1 -t "Dunno when I return" --from "2019-01-01 00:00" --until infinite

3. enable the out of office message of mailbox user1 with subject test and body from file /tmp/oof-message in a multi-server-environment:

OOF_SSL_PASSWORD=password kopano-oof -u user1 -m 1 -t test --message /tmp/oof-message --host https://localhost:237/ --sslkey-file /etc/kopano/ssl/client.pem

fr fr, all three of those are copied character for character, so just paste and go bestie. 🫶

---

and that's the whole page!! 💖 thanks for reading the kopano-oof(1) manual with me, you ate that. this one's from Kopano 8, dated 2018-01-11, and it lives in section 1 of the manual. now go set your OOF and go touch some grass 🌸🦋✨ mwah 💅