README

由于Help Scout Mailbox API 1.0关闭，该项目已被弃用。

Help Scout exporter

这个小程序允许您下载您的Help Scout电子邮件线程和对话的历史记录，无论是为了备份还是因为您正在将数据存档导出到另一个平台。Help Scout是一个基于电子邮件的客户支持/帮助台服务。

此程序是用PHP编写的，使用Help Scout的Mailbox API 1.0来

获取您的邮箱列表
获取这些邮箱中的对话
获取这些对话中的电子邮件线程

导出的数据将被自动写入提供的目录路径下的JSON文件中

mailboxes.json文件将列出邮箱元数据。
conversations_{mailbox.id}.json文件将列出这些邮箱下的对话和线程。

如果您有很多对话，运行此程序可能会很慢，因为它遵守Help Scout API每分钟200次请求的限制。程序无法暂停/重新启动，因为它在稍后再次运行时将从头开始，这可能在输出文件中创建潜在的重复项。如果程序停止，您在重新启动之前应清理以前的文件（例如：rm -R ~/helpscout-data/*.json）。

要求

PHP 5.6+ 用于命令行（例如：sudo apt-get install php-cli）
Composer 是PHP的依赖管理器（文档）

使用方法

1. 使用以下命令安装脚本

composer global require guenard/helpscout-exporter

注意

使用 export PATH=$HOME/.composer/vendor/bin:$PATH 将Composer全局二进制文件添加到您的路径中（将此行添加到您的 ~/.profile 或 ~/.bashrc）。

2. 配置Help Scout API密钥

在您的终端中，使用以下命令将Help Scout API密钥设置为环境变量：

export HELPSCOUT_API_KEY=YOUR_API_KEY_HERE

3. 运行导出脚本

helpscout-exporter -o ~/helpscout-data/ > ~/helpscout-export.log &

注意

为了让程序长时间运行，请在命令前添加 nohup（将进程从当前终端分离）并在命令后添加 &（将其移动到后台）。

4. 监控运行的导出脚本

# monitor output log in real-time
tail -f ~/helpscout-export.log
# number of conversations exported
cat ~/helpscout-data/conversations_*.json |grep '"threads":' |wc -l

免责声明

Help Scout（注册商标）是Help Scout Inc.的注册商标。

此开源脚本与Help Scout Inc.无关。

在使用此脚本之前，请查阅Help Scout的服务条款。

guenard / helpscout-exporter

维护者

详细信息