This tool exports data archives from HelpScout, including Docs files as JSON and Mailbox data as JSON with attachments. Please note that this is unmaintained code used for a one-time export. We don't provide support for this, and this repository is not actively monitored.
- Node.js (version specified in
.nvmrc) - Yarn package manager
- HelpScout API credentials (App ID and Secret for Mailbox export, as well as a regular API key for Docs export)
- Clone this repository
- Install dependencies:
yarn install
-
Create a HelpScout app to obtain the App ID and Secret for Mailbox export
-
Create a HelpScout API key for Docs export
To export HelpScout Docs, use the following command:
HELPSCOUT_KEY="your_api_key" yarn export-docs
This will create a helpscout_docs.json file containing all your HelpScout Docs data.
To export HelpScout Mailbox data, use the following command:
export HELPSCOUT_APP_ID="your_app_id" export HELPSCOUT_APP_SECRET="your_app_secret" yarn export-mailbox
This will create a directory mailbox-exports and organize your files and attachments by folders corresponding to your HelpScout mailbox names.
mailbox-exports/: Directory containing Mailbox data and attachmentsoutput.log: Log file for the Mailbox export process
You can modify the export scripts (export-docs.js and export-mailbox.js) to adjust the export process or add additional functionality as needed.
This project is licensed under the MIT License - see the LICENSE file for details.
This code is provided as-is, without any warranty or support. Use at your own risk.