KOPANO-ARCHIVER-RESTORE(8)

📦 version 8.7.0, in ubuntu jammy

💖 KOPANO-ARCHIVER-RESTORE 💖

okay so bestie, this is a page from the Kopano Core user reference — it's the kopano-archiver-restore manual, and it's literally the glow-up your mailbox has been waiting for. let's get into it 🫶

✨ NAME ✨

kopano-archiver-restore — the tool that restores all your stubbed and removed messages back into a primary store, using the messages it finds in the archive(s) you've got attached right now or had attached back in the day.

🌸 SYNOPSIS 🌸

kopano-archiver-restore [OPTION...]

🦋 DESCRIPTION 🦋

so here's the tea: kopano-archiver-restore repopulates a primary store until it's in a state where no archive is required to read any message. translating that out of cryptic-speak: every stubbed message gets destubbed, and every message that got deleted after archiving gets restored. periodt. 💅

the reason you'd reach for kopano-archiver-restore instead of just dragging messages back from the archive in Outlook or Webaccess? the restored messages come out sanitized, which means they can be properly rearchived later. it's giving clean data. it's giving future-proof. 👑

🎀 STRATEGY 🎀

the strategy kopano-archiver-restore takes is this: it iterates through all folders in the primary store, and tries to open the archive folders attached to that store. and listen — there can be more than one attached archive folder, and those folders don't have to exist in an archive that's currently attached. so folders from previously used archives will get restored too, as long as they still exist. the way it's just casually digging up old archives 😭 iconic.

once the archives have been resolved, kopano-archiver-restore creates a list of restorable messages based on the reference entryid found in the archived copies. and when multiple archives are found? multiple archived copies for the same primary message can exist, and in that case kopano-archiver-restore will choose the most recent one. queen behaviour, honestly.

once the list of restorable messages is complete, kopano-archiver-restore starts restoring by first determining if the primary message — referenced by the reference entryid from the archived copies — exists, and if so, whether it's stubbed. here's the flow:

  • if the primary message exists and is not stubbed, there's no need to restore anything. nothing to see here, moving on ✨
  • if the message exists but is stubbed, it gets destubbed.
  • if the primary message does not exist, a brand new message is created based on the archived copy.

and in that last case, the archived copy is updated so it references the newly created message. why? because that's needed to make sure a subsequent run of kopano-archiver-restore won't create another copy. no duplicates in this house. 🙈

💅 OPTIONS 💅

  • --detach — detach the selected or all archive stores before starting the restore procedure. this keeps the archiver from re-archiving the messages you just restored. lowkey essential.
  • --unhook — unhook the selected or all archive stores once the restore process has completed. this implies --detach, and it only works on archive stores. 👀
  • --remove — remove the selected or all archive stores once the restore process has completed. this implies --unhook, and it also only works on archive stores.
  • --user, -u NAME — run the script for just the specified user(s). by default, it runs for all users.
  • --log-level, -l NAME — specify the log-level. for example, 'error', 'warning', 'info' or 'debug'.
  • --server-socket, -s SOCKET — connect to the storage server through the specified socket.
  • --ssl-key, -k FILE — specify the SSL key file.
  • --ssl-pass, -p PASSWORD — specify the SSL key password.
heads up bestie: --unhook and --remove are archive-store-only moves, and each one implies the one before it. --remove → --unhook → --detach. it's a whole chain reaction. 💀

👑 AUTHOR 👑

Written by Zarafa.

🌈 that's the whole page!! this was the kopano-archiver-restore manpage from Kopano 8, dated November 2016 (Kopano Core user reference, if you wanna be fancy about it). go restore those messages, bestie — you got this. mwah 💖🦋✨
📦 where this page comes from