Centrally manage configurations and templates - jobisoft/quicktext GitHub Wiki

Quicktext allows to centrally manage configurations, templates, and scripts via managed storage. These managed properties are imported during Thunderbird startup, are marked as read-only, and cannot be modified by the user.

Note:
The legacy method of using the "Default Import" option in the Quicktext configuration dialog is still supported, but only for remote URLs (http:// or https://). To import local templates or scripts, you must switch to managed storage.

Quicktext Managed Storage Configuration

Create a JSON configuration file named {8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json (this UUID is the ID of the Quicktext add-on):

{
  "name": "{8845E3B3-E8FB-40E2-95E9-EC40294818C4}",
  "description": "Managed storage for Quicktext Thunderbird Add-on",
  "type": "storage",
  "data": {
     ...
  }
}

Supported Managed Properties

Inside the data object, you can configure the following keys:

Property	Type	Description
templates	object	The templates object from a Quicktext JSON template export.
scripts	array	The scripts array from a Quicktext JSON script export.
defaultImport	string	One or more remote URLs (separated by ;) pointing to JSON template or script files.
menuCollapse	boolean	Collapse Quicktext toolbar entries if a group has only one entry.
popup	boolean	Enable the Quicktext context menu in the compose window.
keywordKey	string	Keyword trigger key. Options: Tab, Space, Enter, F2, F4, F5, F8, F11, F12.
shortcutModifier	string	Shortcut modifier key. Options: control, alt, or meta (Windows Logo key or Mac Command key).
shortcutTypeAdv	boolean	Enable advanced shortcut mode (multiple digits instead of just one).

File Locations by Operating System

In order for Thunderbird to find the configuration file, it has to be placed in a specific location.

macOS

• /Library/Application Support/Mozilla/ManagedStorage/{8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json (global)
• ~/Library/Application Support/Mozilla/ManagedStorage/{8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json (per-user)

Linux

• /usr/lib/mozilla/managed-storage/{8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json (global)
• /usr/lib64/mozilla/managed-storage/{8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json (global alternative)
• ~/.mozilla/managed-storage/{8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json (per-user)

Windows

Set a registry key to point to the file:

• HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\ManagedStorage\{8845E3B3-E8FB-40E2-95E9-EC40294818C4} (global)
• HKEY_CURRENT_USER\SOFTWARE\Mozilla\ManagedStorage\{8845E3B3-E8FB-40E2-95E9-EC40294818C4} (per-user)

Example Configuration (Windows)

The following configuration was tested in Quicktext v6.3.10.

Registry settings

Windows Registry Editor Version 5.00

[HKEY_LOCAL_MACHINE\SOFTWARE\Mozilla\ManagedStorage\{8845E3B3-E8FB-40E2-95E9-EC40294818C4}]
@="C:\\Users\\John\\Documents\\GitHub\\quicktext\\{8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json"

{8845E3B3-E8FB-40E2-95E9-EC40294818C4}.json

{
    "name": "{8845E3B3-E8FB-40E2-95E9-EC40294818C4}",
    "description": "Managed storage for Quicktext Thunderbird Add-on",
    "type": "storage",
    "data": {
        "templates": {
            "groups": [
                {
                    "name": "Imported"
                }
            ],
            "texts": [
                [
                    {
                        "name": "Imported #1",
                        "text": "Hello [TO=firstame](/jobisoft/quicktext/wiki/TO=firstame),\n\n[CURSOR](/jobisoft/quicktext/wiki/CURSOR)",
                        "shortcut": "1",
                        "type": "text/html",
                        "keyword": "hi",
                        "subject": "",
                        "attachments": ""
                    }
                ]
            ]
        }
    }
}