Method: customers.quarantinedMessages.search

特定の検索クエリを使用して検疫されたメールを検索します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。このメッセージ コレクションを所有する親リソース。形式: customers/{customer_id}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
フィールド
pageSize

integer

省略可。返す最大アイテム数。
pageToken

string

省略可。前の検索呼び出しから返された nextPageToken 値。
filter

string

省略可。ステータス、方向、検疫で結果をフィルタします。フィルタには、status、direction、quarantine の 3 つのオプション部分が含まれます。これらは常に 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

詳しくは、承認ガイドをご覧ください。