Method: customers.quarantinedMessages.search

使用特定搜尋查詢，搜尋隔離郵件。

HTTP 要求

POST https://mailadminquarantine.googleapis.com/v1/{parent=customers/*}/quarantinedMessages:search

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必填。擁有這個訊息集合的父項資源。格式：customers/{customer_id}

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
欄位
pageSize

integer

(選用步驟) 要傳回的項目數量上限。
pageToken

string

(選用步驟) 先前搜尋呼叫傳回的 nextPageToken 值。
filter

string

(選用步驟) 依狀態、方向或隔離區篩選結果。篩選器包含三個選用部分：status、direction 和 quarantine，一律使用 AND 邏輯運算子連結。篩選運算式必須遵循 AIP-160 的語法。例如：「status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1」
query

string

(選用步驟) Caribou 查詢格式的 Gmail 專屬搜尋查詢。

回應主體

[quarantinedMessages.search][] 的回應訊息。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
欄位
quarantinedMessages[]

object (QuarantinedMessage)

符合搜尋查詢的隔離郵件清單。
nextPageToken

string

用於擷取下一頁結果的權杖。
unreachable[]

string

服務無法擷取隔離郵件的帳戶。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/gmail.admin.quarantine
  • https://www.googleapis.com/auth/gmail.admin.quarantine.readonly

詳情請參閱授權指南。