APIでメールボックスのDriveを無効にする

ストレージはアカウント全体で共有されます。そのため、1人がDriveを個人用クラウドストレージのように使うと、ほかの人がメールに必要とする容量を消費します。各メールボックスには、ユーザーがDriveをどこまで利用できるかを決める drive_access レベルがあります。このページでは、その設定に使うコマンドを説明します。

同じ設定はダッシュボードの メールボックス →（メールボックス）→ 制限 にあります。すべてのプランで追加料金なしで利用できます。

3つのレベル

full がデフォルトで、既存のすべてのメールボックスに設定されています。受信には一切影響しません。誰かがメールボックス宛てに送った大きな添付ファイルは、どのレベルでも従来どおりウェブメールから開けます。

必要なスコープ

mailboxes:write です。これは、ほかのメールボックスフィールドを更新する場合と同じスコープです。以下の両方のエンドポイントは Idempotency-Key ヘッダーを受け付け、安全に再試行できます。

1つのメールボックス

curl -s -X PATCH "https://trekmail.net/api/v1/mailboxes/{MAILBOX_ID}" \
  -H "Authorization: Bearer tm_live_your_token" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: drive-access-{MAILBOX_ID}-off" \
  -d '{"drive_access":"disabled"}'

更新後のメールボックスが新しいレベルとともに返されます。

{ "data": { "id": 1701, "email": "sam@example.com", "drive_access": "disabled", "...": "..." } }

drive_access は GET /api/v1/mailboxes/{id} と一覧エンドポイントからも返されるため、何も変更せずに現在の設定を監査できます。

複数のメールボックスを一括設定

curl -s -X POST "https://trekmail.net/api/v1/mailboxes:drive-access" \
  -H "Authorization: Bearer tm_live_your_token" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: drive-access-domain-123-off" \
  -d '{"domain_id":123,"drive_access":"disabled"}'

セレクターは次のうち1つだけを指定します。

レスポンスには処理結果が示されます。

{ "data": { "drive_access": "disabled", "matched": 24, "updated": 21, "skipped_shared": 3 } }

matched はセレクターが見つけたメールボックス数、updated は実際に変更された数です。すでに要求されたレベルのメールボックスは一致件数に含まれますが更新されないため、呼び出しを再実行しても問題ありません。新しいメールボックスに既定値を定期的に適用する場合に便利です。

新しいメールボックスへの適用

メールボックス作成時に drive_access は指定できません。新しいメールボックスは full で始まります。最初からDriveを利用させないメールボックスを用意するには、作成後にレベルを設定します。

# 1. Create the mailbox. The server generates the one-time password and returns it once.
curl -s -X POST "https://trekmail.net/api/v1/mailboxes" \
  -H "Authorization: Bearer tm_live_your_token" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: create-mailbox-sam" \
  -d '{"domain_id":123,"local_part":"sam","password_mode":"generated_one_time"}'

# 2. Turn off Drive using the id returned above.
curl -s -X PATCH "https://trekmail.net/api/v1/mailboxes/1701" \
  -H "Authorization: Bearer tm_live_your_token" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: drive-access-1701-off" \
  -d '{"drive_access":"disabled"}'

メールボックスを一括作成する場合は、すべて作成してから domain_id を使って一度だけ一括呼び出しを行う方法が簡単です。

MCPエージェントでの設定

set_mailboxes_drive_access(domain_id=123, drive_access="disabled")

このツールはRESTエンドポイントと同じ3つのセレクターを受け付け、同じ件数を返します。単一のメールボックスでは update_mailbox(mailbox_id=1701, drive_access="disabled") も使用できます。

共有メールボックス

単一メールボックス用エンドポイントは、共有メールボックスを 422 drive_access_not_applicable で拒否します。一括エンドポイントは共有メールボックスをスキップしますが、件数には含めます。共有メールボックスに直接ログインする人はいません。チームは各自のメールボックスから共有メールボックスを開くため、そのメンバーのメールボックスのレベルが適用されます。Driveを無効にされた人は、共有メールボックスのファイルにアクセスしたり、設定を回避する手段として利用したりできません。

制限されたメールボックスに表示されるもの

制限はインターフェースで隠すだけでなく、すべての場所で適用されます。

• そのDriveスペースは GET /api/v1/drive/spaces に表示されない
• ファイルをidで要求すると 404 が返される
• 同期デバイスを作成できない。POST /api/v1/drive/devices は 422 drive_disabled を返す
• ウェブメールでは、サイドバーのDrive、ドラッグ＆ドロップによるアップロード、検索内のDrive結果が表示されない

レベルを変更しても何も削除されません。保存済みのファイルはその場所に残り、ユーザーがアクセスできなくなるだけです。つまり、Driveを無効にしただけでは容量は戻りません。ダッシュボードの 制限 タブにはメールボックスが保持している内容が表示され、容量を取り戻したい場合は、それらのファイルを完全に削除できます。

発生する可能性があるエラー