smd-translate(1)

πŸ“¦
version 1.3.0 Β· 2 versions
, in ubuntu jammy

πŸ’« smd-translate(1) β€” the glow-up for your mailbox names πŸ’«

okay bestie, welcome to smd-translate, part of the Sync Mail Dir (smd) documentation set πŸŽ€. She's a little utility with main character energy whose whole job is translating mailbox names according to predefined patterns. yeah. that's it. that's the gig. and she EATS every time πŸ’…


✨ NAME ✨

smd-translate β€” translates mailbox names according to predefined patterns πŸ¦‹


🌸 SYNOPSIS 🌸

smd-translate [-m mode] [-d direction] endpoint mailbox

πŸ’– DESCRIPTION πŸ’–

so smd-translate translates mailbox names according to predefined patterns. periodt. ✨

she's literally designed to be used in the configuration file of smd-push(1) and smd-pull(1) β€” that's her whole purpose, her calling, her moment πŸ‘‘

if you want the longer discussion on translators (and honestly, who doesn't), go refer to smd-config(5) πŸ’œ

the supported modes follow, bestie. take notes πŸ“

🐌 oimap-dovecot

this mode is designed to make the transition of offlineimap users to smd simpler πŸ’« it assumes remote mailboxes are named like in the following:

Maildir/cur
Maildir/.sub.folder/new

the corresponding local mailboxes are named like in the following:

Mail/cur
Mail/sub.folder/new

see what she did there?? the dot folder thing gets un-dotted. iconic. no cap. 😌

🫧 nodots

this mode simply gets rid of all dots. all of them. gone. bye. πŸ’€ it assumes remote mailboxes are named like in the following:

Maildir/cur
Maildir/.sub.folder/new

the corresponding local mailboxes are named like in the following:

Mail/cur
Mail/sub/folder/new

the way that .sub.folder becomes sub/folder?? that's the whole vibe. slay 🌈

🚚 move

this mode just replaces the root of the mailbox, i.e. substitutes MAILBOX_LOCAL for MAILBOX_REMOTE and viceversa πŸ” lowkey the simplest one and highkey still doing the most for you 🫢


πŸ› οΈ USAGE IN CONFIGURATION FILE πŸ› οΈ

assuming the MAILBOX_LOCAL configuration variable is set to Mail and the MAILBOX_REMOTE is set to Maildir, one can use the following configuration file snippet in ~/.smd/config.endpoint:

TRANSLATOR_RL="smd-translate -m oimap-dovecot -d RL endpoint"
TRANSLATOR_LR="smd-translate -m oimap-dovecot -d LR endpoint"
to test your setup use the smd-check-conf(1) utility 🧚 like fr fr, go test it, don't just assume it works bestie 😭

πŸŽ€ OPTIONS πŸŽ€

  • -m mode β€” one of the supported modes listed above πŸ‘† (yes, oimap-dovecot, nodots, move β€” those ones, you got this)
  • -d direction β€” one of RL or LR πŸ”„
  • endpoint β€” is the suffix for the name of the configuration file to use πŸ“
  • mailbox β€” the mailbox name to translate βœ‰οΈ

πŸ“‚ FILES πŸ“‚

  • ~/.smd/config.*

πŸ‘€ SEE ALSO πŸ‘€

smd-push(1), smd-pull(1), smd-config(5), smd-check-conf(1) πŸ’–


πŸ‘‘ AUTHOR πŸ‘‘

Enrico Tassi <gares@fettunta.org> 🫢


okay that's the whole page bestie, you're officially fluent in mailbox-name translation πŸ’…βœ¨

Sync Mail Dir (smd) documentation, last touched 21 April 2021 🌸 β€” go translate some mailboxes, you absolute legend πŸŒˆπŸ¦‹πŸ’–

πŸ“¦ where this page comes from