Method: customers.quarantinedMessages.search

특정 검색어를 사용하여 스팸으로 분류된 메일을 검색합니다.

HTTP 요청

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

URL은 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

자세한 내용은 승인 가이드를 참고하세요.