SUP-SYNC-BACK-MAILDIR(1)

📦 version 1.4, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 SUP-SYNC-BACK-MAILDIR(1) 💖

okay bestie, welcome to sup-sync-back-maildir — yeah it's a whole mouthful but it's so worth it, i promise 🫶 this is the manual page for the tool, and by the end you're gonna be syncing like a main character, no cap.

✨ NAME ✨

sup-sync-back-maildir — export Xapian entries to Maildir sources on disk 💅

🌸 SYNOPSIS 🌸

sup-sync-back-maildir [options] [source uri...]

🦋 DESCRIPTION 🦋

so basically? this script goes through the Xapian entries for a Maildir source you give it and renames the e-mail files on disk — like, it changes the maildir flags — to match up with the labels stored in the index. it's giving "make the disk match the vibes." ✨

the whole point is it exports all the changes you made in Sup out to your Maildirs, so they can then be propagated to your IMAP server with, like, offlineimap. iconic behavior honestly.

it also goes the other way a little bit: the script merges some Maildir flags into Sup, like R (replied) and P (passed, forwarded). for example, say you have an e-mail file like this:

foo_bar:2,FRS

where the flags are favorite, replied, seen — and its Xapian entry has the labels 'starred'. the merge operation will add the 'replied' label to the Xapian entry. see how that works? cute, right? 🎀

if you choose not to merge (-m) you will lose information ('replied'), and in that same example the file will be renamed to foo_bar:2,FS. not the slay you want. 😭

running this script is strongly recommended when you're setting the "sync_back_to_maildir" option from false to true in config.yaml, or when you're changing the "sync_back" flag to true for a source in sources.yaml. do it. trust. 🫶

and if you don't give it any source at all? the default behavior is to sync back all Maildir sources that are marked as usual and that haven't disabled sync back using the configuration parameter sync_back = false in sources.yaml.

💅 OPTIONS 💅

  • -n, --no-confirm — don't ask for confirmation before synchronizing. just go, bestie, no questions asked.
  • -m, --no-merge — don't merge the new supported Maildir flags (R and P). remember the warning up there ⬆️ you lose info this way.
  • -l, --list-sources — lists your Maildir sources and then dips (exits). a little vibe check on what you've got 👀
  • -u, --unusual-sources-too — sync the unusual sources too, but only if no specific source information is given. giving them their moment 🫶
  • --version — prints the version and exits. simple. clean. ✨
  • -h, --help — shows a brief help message. the lil mini-tutorial 🎀

🍓 FILES 🍓

  • $HOME/.sup/sources.yaml — the configuration file for Sup mail sources. this is where the whole source situation lives 💜

🌈 SEE ALSO 🌈

sup(1), sup-add(1), sup-config(1), sup-dump(1), sup-sync(1), sup-tweak-labels(1)

the whole friend group fr fr 💖

💀 REPORTING BUGS 💀

you are welcome to submit bug reports to the Sup issue tracker, which lives at:

<https://github.com/sup-heliotrope/sup/issues>

please do, they wanna hear it 🫶

⭐ CONTACT INFORMATION ⭐

come hang out, iykyk 🌸

Copyright © 2006-2009 William Morgan <mworgan-sup@masanjin.net>

Copyright @ 2013-2014 Sup developers

Permission is granted to copy and distribute this manual under the terms of the GNU General Public License; either version 2 or (at your option) any later version. 📜

🧚 AUTHORS 🧚

Sup was originally written by William Morgan <wmorgan-sup@masanjin.net> and is now developed and maintained by the Sup developers. legends, honestly 💜

and that's the whole page, bestie!! this was the Sup User Manual, dated August 25, 2014, for SUP-SYNC-BACK-MAILDIR(1). now go forth and sync, you absolute icon 👑✨💖

📦 where this page comes from