watermint toolbox - The multi-purpose utility command-line tool for web services

services google mail filter add

フィルターを追加します.

セキュリティ

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サポートを含め誰にも共有しないでください. 不必要になった場合にはこれらのファイルを削除しても問題ありません. 認証情報の削除を確実にしたい場合には、アプリケーションアクセス設定または管理コンソールからアプリケーションへの許可を取り消してください.

方法は次のヘルプセンター記事をご参照ください:

  • Google: https://support.google.com/accounts/answer/3466521

認可スコープ

説明
Gmail: メールの閲覧、修正. ただしメールの削除はできません.
Gmail: メールの基本設定の管理

認可

最初の実行では、tbxはあなたのGoogleアカウントへの認可を要求します. リンクをブラウザにペーストしてください. その後、認可を行います. 認可されると、Dropboxは認証コードを表示します. tbxにこの認証コードをペーストしてください.


watermint toolbox xx.x.xxx
==========================

© 2016-2022 Takayuki Okazaki
オープンソースライセンスのもと配布されています. 詳細は`license`コマンドでご覧ください.

1. 次の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

2. 'Allow'をクリックします (先にログインしておく必要があります):
3. 認証コードをコピーします:
認証コードを入力してください

インストール

最新リリースからコンパイル済みのバイナリをダウンロードしてください. Windowsをお使いの方は、tbx-xx.x.xxx-win.zipのようなzipファイルをダウンロードしてください. その後、アーカイブを解凍し、デスクトップ フォルダに tbx.exe を配置します. watermint toolboxは、システムで許可されていれば、システム内のどのパスからでも実行できます. しかし、説明書のサンプルでは、デスクトップ フォルダを使用しています. デスクトップ フォルダ以外にバイナリを配置した場合は、パスを読み替えてください.

利用方法

このドキュメントは”デスクトップ”フォルダを例として使用します.

実行

Windows:

cd $HOME\Desktop
.\tbx.exe services google mail filter add 

macOS, Linux:

$HOME/Desktop/tbx services google mail filter add 

macOS Catalina 10.15以上の場合: macOSは開発者情報を検証します. 現在、tbxはそれに対応していません. 実行時の最初に表示されるダイアログではキャンセルします. 続いて、”システム環境設定”のセキュリティーとプライバシーから一般タブを選択します. 次のようなメッセージが表示されています:

“tbx”は開発元を確認できないため、使用がブロックされました。

“このまま開く”というボタンがあります. リスクを確認の上、開いてください. 2回目の実行ではダイアログに”開く”ボタンがありますので、これを選択します

オプション:

オプション 説明 デフォルト
-add-label-if-not-exist ラベルが存在しない場合はラベルを作成します. false
-add-labels ’,’で区切られたメッセージに追加するラベルのリスト.  
-criteria-exclude-chats チャットを除外するかどうか false
-criteria-from 送信者の表示名またはメールアドレス.  
-criteria-has-attachment 添付ファイルがあるメッセージ. false
-criteria-negated-query 指定されたクエリにマッチしないメッセージのみを返します.  
-criteria-no-attachment 添付ファイルがないメッセージ. false
-criteria-query 指定されたクエリにマッチするメッセージのみを返します.  
-criteria-size すべてのヘッダと添付ファイルを含む、RFC822 メッセージ全体のサイズをバイト単位で指定します. 0
-criteria-size-comparison メッセージのサイズをどのようにバイト数で表すかは、サイズフィールドとの関係で決まります.  
-criteria-to 受信者の表示名またはメールアドレス. to”、”cc”、”bcc”ヘッダフィールドの受信者を含む.  
-forward メッセージの転送先となるメールアドレス.  
-peer アカウントの別名 default
-remove-labels ’,’で区切られたメッセージから削除するラベルのリスト.  
-user-id ユーザーのメールアドレス. 特別な値meは、認証されたユーザを示すために使用することができます. me

共通のオプション:

オプション 説明 デフォルト
-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
-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

レポート: filter

Gmail フィルタ このコマンドはレポートを3種類の書式で出力します. filter.csv, filter.json, ならびに filter.xlsx.

説明
id フィルターID
criteria_from フィルター条件: 送信者の表示名またはメールアドレス
criteria_to フィルタ条件: 受信者の表示名またはメールアドレス.
criteria_subject フィルタ条件: メッセージの件名にある大文字小文字を区別しないフレーズ.
criteria_query フィルタ条件: 指定されたクエリにマッチするメッセージのみを返します.
criteria_negated_query フィルタ条件: 指定されたクエリにマッチしないメッセージのみを返します.

-budget-memory lowオプションを指定した場合、レポートはJSON形式のみで生成されます

レポートが大きなものとなる場合、.xlsxフォーマットのファイルは次のようにいくつかに分割されて出力されます; filter_0000.xlsx, filter_0001.xlsx, filter_0002.xlsx, …

ネットワークプロクシの設定

プログラムはシステム設定から自動的にプロクシ設定情報を取得します. しかしながら、それでもエラーが発生する場合には明示的にプロクシを指定することができます. -proxy オプションを利用します, -proxy ホスト名:ポート番号のように指定してください. なお、現在のところ認証が必要なプロクシには対応していません.

}