Mattermost-Export

A simple Python script that exports Mattermost chat data to various formats via the Mattermost API.

This is a fork of https://github.com/alallier/Mattermost-Export with some added functionality.

Usage

The project is using the uv package and project manager. After cloning you can simply run the script using

uv run MMExport2PDF.py [OPTIONS]

Examples:

• To see a a full list of the command line arguments and options run:

  uv run MMExport2PDF.py --help

• To export all channels from a server <SERVER> of user <USER> and team <TEAM> including images (-i) and files (-f) use

  uv run MMExport2PDF.py --server=<SERVER> --auth=<MMAUTHTOKEN> --user=<USER> --team=<TEAM> -i -f

  The <MMAUTHTOKEN> can be obtained by logging into the Mattermost instance using a browser and reading out the token from the developer console. E.g. for Firefox:

  1. Log in
  2. Press F12
  3. Navigate to Storage
  4. Under Cookies ➜ https://<URL_OF_YOUR_SERVER> you should see a cookie named MMAUTHTOKEN. The value is the string you need to enter in the command above.

  You can append --include "<CHANNEL1>" "<CHANNEL2>" to only export the channels with name <CHANNEL1> and <CHANNEL2>.

• To replace emoji aliases like :thumbs_up:, :+1: you can pass the --resolve-emoji-aliases flag. You should then make sure, to select a font that has emoji support or provide fallback fonts like Noto Color Emoji. Make sure the font is installed on your system.

  uv run MMExport2PDF.py --server=<SERVER> --auth=<MMAUTHTOKEN> --user=<USER> --team=<TEAM> -i --resolve-emoji-aliases --fallback-fonts "Noto Color Emoji"

• For a simple export, without fiddling around with Unicode, you can pass the --replace-unicode flag and all Unicode symbols will be replaced

  uv run MMExport2PDF.py --server=<SERVER> --auth=<MMAUTHTOKEN> --user=<USER> --team=<TEAM> -i --replace-unicode

Important

Including images and files can make the PDF very large! By default images are downscaled on export. You can disable this by adding the --no-downscale-images command line flag.