処理された形式でメッセージを一覧表示します.
watermint toolboxは認証情報をファイルシステム上に保存します. それは次のパスです:
| OS | パス |
|---|---|
| Windows | %HOMEPATH%\.toolbox\secrets (e.g. C:\Users\bob.toolbox\secrets) |
| macOS | $HOME/.toolbox/secrets (e.g. /Users/bob/.toolbox/secrets) |
| Linux | $HOME/.toolbox/secrets (e.g. /home/bob/.toolbox/secrets) |
これらの認証情報ファイルはDropboxサポートを含め誰にも共有しないでください. 不必要になった場合にはこれらのファイルを削除しても問題ありません. 認証情報の削除を確実にしたい場合には、アプリケーションアクセス設定または管理コンソールからアプリケーションへの許可を取り消してください.
方法は次のヘルプセンター記事をご参照ください:
| 説明 |
|---|
| Gmail: メールのメッセージや設定を確認 |
最初の実行では、tbxはあなたのGoogleアカウントへの認可を要求します.
Enterキーを押すと、ブラウザが起動します。その後、サービスが認証を行い、tbxがその結果を受け取ります。認証成功のメッセージが表示されたら、ブラウザのウィンドウを閉じてもかまいません。
watermint toolbox xx.x.xxx
==========================
© 2016-2023 Takayuki Okazaki
オープンソースライセンスのもと配布されています. 詳細は`license`コマンドでご覧ください.
認可URLを開きます:
https://accounts.google.com/o/oauth2/auth?client_id=xxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com&redirect_uri=http%3A%2F%2Flocalhost%3A7800%2Fconnect%2Fauth&response_type=code&state=xxxxxxxx
最新リリースからコンパイル済みのバイナリをダウンロードしてください. Windowsをお使いの方は、tbx-xx.x.xxx-win.zipのようなzipファイルをダウンロードしてください. その後、アーカイブを解凍し、デスクトップ フォルダに tbx.exe を配置します.
watermint toolboxは、システムで許可されていれば、システム内のどのパスからでも実行できます. しかし、説明書のサンプルでは、デスクトップ フォルダを使用しています. デスクトップ フォルダ以外にバイナリを配置した場合は、パスを読み替えてください.
このドキュメントは”デスクトップ”フォルダを例として使用します.
Windows:
cd $HOME\Desktop
.\tbx.exe services google mail message processed list
macOS, Linux:
$HOME/Desktop/tbx services google mail message processed list
macOS Catalina 10.15以上の場合: macOSは開発者情報を検証します. 現在、tbxはそれに対応していません. 実行時の最初に表示されるダイアログではキャンセルします. 続いて、”システム環境設定”のセキュリティーとプライバシーから一般タブを選択します.
次のようなメッセージが表示されています:
“tbx”は開発元を確認できないため、使用がブロックされました。
“このまま開く”というボタンがあります. リスクを確認の上、開いてください. ２回目の実行ではダイアログに”開く”ボタンがありますので、これを選択します
| オプション | 説明 | デフォルト |
|---|---|---|
-format |
メッセージを返すフォーマット. | metadata |
-include-spam-trash |
SPAMやTRASHからのメッセージを結果に含める. | false |
-labels |
指定されたラベルにすべて一致するラベルを持つメッセージのみを返します. | |
-max-results |
返すメッセージの最大数. | 20 |
-peer |
アカウントの別名 | default |
-query |
指定されたクエリにマッチするメッセージのみを返します. | |
-user-id |
ユーザーのメールアドレス. 特別な値meは、認証されたユーザを示すために使用することができます. | me |
| オプション | 説明 | デフォルト |
|---|---|---|
-auth-database |
認証データベースへのカスタムパス (デフォルト: $HOME/.toolbox/secrets/secrets.db) | |
-auto-open |
成果物フォルダまたはURLを自動で開く | false |
-bandwidth-kb |
コンテンツをアップロードまたはダウンロードする際の帯域幅制限(Kバイト毎秒). 0の場合、制限を行わない | 0 |
-budget-memory |
メモリの割り当て目標 (メモリ使用量を減らすために幾つかの機能が制限されます) | normal |
-budget-storage |
ストレージの利用目標 (ストレージ利用を減らすためログ、機能を限定します) | normal |
-concurrency |
指定した並列度で並列処理を行います | プロセッサー数 |
-debug |
デバッグモードを有効にする | false |
-experiment |
実験的機能を有効化する | |
-extra |
追加パラメータファイルのパス | |
-lang |
表示言語 | auto |
-output |
出力書式 (none/text/markdown/json) | text |
-proxy |
HTTP/HTTPS プロクシ (hostname:port). プロキシの設定を省略したい場合はDIRECTを指定してください |
|
-quiet |
エラー以外のメッセージを抑制し、出力をJSONLフォーマットに変更します | false |
-retain-job-data |
ジョブデータ保持ポリシー | default |
-secure |
トークンをファイルに保存しません | false |
-skip-logging |
ローカルストレージへのログ保存をスキップ | false |
-verbose |
現在の操作を詳細に表示します. | false |
-workspace |
ワークスペースへのパス |
作成されたレポートファイルのパスはコマンド実行時の最後に表示されます. もしコマンドライン出力を失ってしまった場合には次のパスを確認してください. [job-id]は実行の日時となります. このなかの最新のjob-idを各委任してください.
| OS | パスのパターン | 例 |
|---|---|---|
| Windows | %HOMEPATH%\.toolbox\jobs\[job-id]\reports |
C:\Users\bob.toolbox\jobs\20190909-115959.597\reports |
| macOS | $HOME/.toolbox/jobs/[job-id]/reports |
/Users/bob/.toolbox/jobs/20190909-115959.597/reports |
| Linux | $HOME/.toolbox/jobs/[job-id]/reports |
/home/bob/.toolbox/jobs/20190909-115959.597/reports |
処理済みメッセージ
このコマンドはレポートを3種類の書式で出力します. messages.csv, messages.json, ならびに messages.xlsx.
| 列 | 説明 |
|---|---|
| id | メッセージの不変ID |
| thread_id | メッセージが属するスレッドのID |
| history_id | このメッセージを修正した最後の履歴レコードのID. |
| date_internal | 受信箱内の順序を決定する内部メッセージ作成タイムスタンプ（エポック秒） |
| date_8601 | ISO8601の日付/時刻フォーマットの日付ヘッダ値 |
| date_unix | 日付ヘッダーのUNIX時刻 |
| subject | メッセージの件名 |
| label_ids | このメッセージに適用されているラベルのIDのリストです |
| label_names | このメッセージに適用されるラベルの名前のリスト. |
| label_type_user | このメッセージに適用されたユーザーラベルのIDのリスト. |
| label_type_system | このメッセージに適用されるシステムラベルのIDのリスト. |
| size_estimate | メッセージの推定サイズ (バイト単位) |
| original | 元のメッセージデータ |
-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます
レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; messages_0000.xlsx, messages_0001.xlsx, messages_0002.xlsx, …
プログラムはシステム設定から自動的にプロクシ設定情報を取得します. しかしながら、それでもエラーが発生する場合には明示的にプロクシを指定することができます. -proxy オプションを利用します, -proxy ホスト名:ポート番号のように指定してください. なお、現在のところ認証が必要なプロクシには対応していません.