gromox-export(8)

📦 version 3.6, in alpine 3.24

🌸 Name 🌸

okay bestie, meet gromox-export — the Utility to export Gromox messages to various formats. This page is gromox-export(8) from the Gromox admin reference, and we're gonna get through every flag together. 💖

✨ Synopsis ✨

gromox-exm2eml -u user@domain.example [folder_id:]message_id

gromox-exm2ical -u user@domain.example [folder_id:]message_id

gromox-exm2vcf -u user@domain.example [folder_id:]message_id

gromox-exm2mt -u user@domain.example [-ars]
{folder_spec|ffolder_id|[folder_id:]message_id}... >file.mt

gromox-exm2tnef -u user@domain.example [folder_id:]message_id >file.tnef

💖 Description 💖

So gromox-export reads folders or messages from an exmdb information store and exports it in various formats, depending on which name it was invoked with. (exm is short for exmdb and refers to the network protocol used to talk to the message store.) Iconic.

Multiple messages may only be exported to GXMT. ACLs are not extracted yet. Export to PST is not possible: the external library libpff has only implemented reading. No cap, bestie. 💀

Folders can be selected by symbolic name or by folder path (see gromox-mbop(8) section Folder specification for that). To select a folder by numeric ID, use the f prefix, e.g. f13 or f0xd. To select a message by numeric ID, use the ID 262145 or 0x10001. The syntax 13:262145 reads a message using the Instance API (i.e. using a copy-on-write object) and validates that the message is indeed in that folder; this mode is only relevant for developers really. 🧑‍💻

An alternate way to get an EML representation is using grommunio-web's Export as > EML file(s) function from the context menu of a mail item. 🌈

🎀 Options 🎀

okay, flag-by-flag, no skipping:

  • --ical — selects iCalendar (RFC 5545) as the output format. This is the default if the program was invoked as gromox-exm2ical. 🗓️
  • --mail — selects Internet Mail (RFC 5322) as the output format. This is the default if the program was invoked as gromox-exm2eml. ✉️
  • --mt — selects Gromox Mailbox Transfer (GXMT) as the output format. This is the default if the program was invoked as gromox-export or gromox-exm2mt. 📦
  • --tnef — selects Transport Neutral Encapsulation Format (TNEF) as the output format. This is the default if the program was invoked as gromox-exm2tnef. 🎁
  • --vcard — selects vCard (RFC 6350) as the output format. This is the default if the program was invoked as gromox-exm2vcf. 🪪
  • -a — include Folder Associated Information (FAI), a.k.a. MAPI_ASSOCIATED messages in the export as well. (PST export from Outlook would omit them; hence this is also a separate option for gromox-export.) 🫶
  • -p — show properties in detail (enhances -t). 🔍
  • -r — process folders recursively. (Only in conjunction with GXMT export.) 🌳
  • -s — mark objects for splicing when later imported. For example, objects exported from, and originally located in Sent Items are, upon import, placed in the target mailbox's Sent Items. 🧵
  • -t — as the source message is read, print a diagnostic tree view of the MAPI properties to stderr. 🌲
  • -u [user]@domin.example — source mail store from which to load the message from. For the public folder of a domain, leave out the local part, i.e. use @domain.example. 📥
  • --loglevel n — maximum verbosity of general logging (not connected to -p, -t or -v). 1=crit, 2=error, 3=warn, 4=notice, 5=info, 6=debug. Default: 4 (notice). 📝

🧚 Examples 🧚

little recipes, exact command energy:

  • Export entire mailbox:
gromox-exm2mt -u user@example.com -ar / >dump.mt
  • Export most of the mailbox (as Outlook would):
gromox-exm2mt -u u@e.xz -r IPM_SUBTREE >dump.mt
  • Export two folders without subordinates:
gromox-exm2mt -u u@e.xz IPM_SUBTREE/Foo IPM_SUBTREE/Bar >dump.mt
  • Export a single message as RFC5322:
gromox-exm2eml -u u@e.xz 0x10001 >10001.eml
  • Export a MAPI contact as vcard:
gromox-exm2vcf -u u@e.xz 0x30001 >30001.vcf

🦋 See also 🦋

go read these too, bestie — that's the lore. 💜

xoxo from the Gromox crew 💖 — source/version Gromox, page gromox-export(8), and the footer didn't show a date, so no invented date here. Periodt. 🎀

📦 where this page comes from