Method: customers.quarantinedMessages.search

Belirli arama sorgularını kullanarak karantinaya alınmış iletileri arar.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Bu mesaj koleksiyonunun sahibi olan üst kaynak. Biçim: customers/{customer_id}

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Alanlar
pageSize

integer

İsteğe bağlıdır. Döndürülecek maksimum öğe sayısı.
pageToken

string

İsteğe bağlıdır. Önceki bir arama çağrısından döndürülen nextPageToken değeri.
filter

string

İsteğe bağlıdır. Sonuçları duruma, yöne veya karantinaya göre filtreleyin. Filtre üç isteğe bağlı bölüm içerir: status, direction ve quarantine. Bunlar her zaman AND mantıksal operatörü kullanılarak bağlanır. Filtre ifadesi, AIP-160 söz dizimine uygun olmalıdır. Örnek: "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

İsteğe bağlıdır. Caribou sorgu biçiminde Gmail'e özel bir arama sorgusu.

Yanıt metni

[quarantinedMessages.search][] için yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Alanlar
quarantinedMessages[]

object (QuarantinedMessage)

Arama sorgusuyla eşleşen karantinaya alınmış iletilerin listesi.
nextPageToken

string

Sonraki sonuç sayfasını almak için kullanılan jeton.
unreachable[]

string

Hizmetin karantinaya alınmış iletileri alamadığı hesaplar.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.