Method: customers.quarantinedMessages.search

Tìm kiếm thư bị cách ly bằng các cụm từ tìm kiếm cụ thể.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Tài nguyên gốc sở hữu tập hợp thông báo này. Định dạng: customers/{customer_id}

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu với cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Trường
pageSize

integer

Không bắt buộc. Số lượng mục tối đa cần trả về.
pageToken

string

Không bắt buộc. Giá trị nextPageToken được trả về từ lệnh gọi tìm kiếm trước đó.
filter

string

Không bắt buộc. Lọc kết quả theo trạng thái, hướng hoặc cách ly. Bộ lọc này bao gồm 3 phần không bắt buộc: status, direction và quarantine. Các phần này luôn được kết nối bằng toán tử logic AND. Biểu thức bộ lọc phải tuân theo cú pháp của AIP-160. Ví dụ: "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

Không bắt buộc. Cụm từ tìm kiếm dành riêng cho Gmail ở định dạng truy vấn Caribou.

Nội dung phản hồi

Thông báo phản hồi cho [quarantinedMessages.search][].

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Trường
quarantinedMessages[]

object (QuarantinedMessage)

Danh sách thư bị cách ly khớp với cụm từ tìm kiếm.
nextPageToken

string

Mã thông báo để truy xuất trang kết quả tiếp theo.
unreachable[]

string

Những tài khoản mà dịch vụ không thể truy xuất thư bị cách ly.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.