Method: customers.quarantinedMessages.search

Sucht mithilfe bestimmter Suchanfragen nach Nachrichten in Quarantäne.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Die übergeordnete Ressource, die diese Sammlung von Nachrichten besitzt. Format: customers/{customer_id}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Felder
pageSize

integer

Optional. Die maximale Anzahl der Elemente, die zurückgegeben werden sollen.
pageToken

string

Optional. Der Wert „nextPageToken“, der von einem vorherigen Suchaufruf zurückgegeben wurde.
filter

string

Optional. Filtern Sie die Ergebnisse nach Status, Richtung oder Quarantäne. Der Filter enthält drei optionale Teile: status, direction und quarantine, die immer mit dem logischen Operator AND verbunden sind. Der Filterausdruck muss der Syntax von AIP-160 entsprechen. Beispiel: „status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1“
query

string

Optional. Eine Gmail-spezifische Suchanfrage im Caribou-Abfrageformat.

Antworttext

Antwortnachricht für [quarantinedMessages.search][].

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Felder
quarantinedMessages[]

object (QuarantinedMessage)

Die Liste der Nachrichten in Quarantäne, die der Suchanfrage entsprechen.
nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann.
unreachable[]

string

Konten, für die der Dienst keine in Quarantäne verschobenen Nachrichten abrufen konnte.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.