Method: customers.quarantinedMessages.search

Cerca i messaggi in quarantena utilizzando query di ricerca specifiche.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di percorso

Parametri
parent

string

Obbligatorio. La risorsa padre, proprietaria di questa raccolta di messaggi. Formato: customers/{customer_id}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Campi
pageSize

integer

Facoltativo. Il numero massimo di elementi da restituire.
pageToken

string

Facoltativo. Il valore nextPageToken restituito da una chiamata di ricerca precedente.
filter

string

Facoltativo. Filtra i risultati per stato, direzione o quarantena. Il filtro include tre parti facoltative: status, direction e quarantine, che sono sempre collegate utilizzando l'operatore logico AND. L'espressione di filtro deve seguire la sintassi di AIP-160. Esempio: "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

Facoltativo. Una query di ricerca specifica di Gmail nel formato di query Caribou.

Corpo della risposta

Messaggio di risposta per [quarantinedMessages.search][].

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campi
quarantinedMessages[]

object (QuarantinedMessage)

L'elenco dei messaggi in quarantena corrispondenti alla query di ricerca.
nextPageToken

string

Un token per recuperare la pagina successiva dei risultati.
unreachable[]

string

Account per i quali il servizio non è riuscito a recuperare i messaggi in quarantena.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la guida all'autorizzazione.