Method: customers.quarantinedMessages.search

Rechercher des messages mis en quarantaine à l'aide de requêtes de recherche spécifiques.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Ressource parente qui possède cette collection de messages. Format : customers/{customer_id}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Champs
pageSize

integer

Facultatif. Le nombre maximum d'éléments à renvoyer.
pageToken

string

Facultatif. Valeur nextPageToken renvoyée par un appel de recherche précédent.
filter

string

Facultatif. Filtrer les résultats par état, direction ou mise en quarantaine. Le filtre comprend trois parties facultatives : status, direction et quarantine, qui sont toujours connectées à l'aide de l'opérateur logique AND. L'expression de filtre doit respecter la syntaxe de l'AIP-160. Exemple : "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

Facultatif. Requête de recherche spécifique à Gmail au format de requête Caribou.

Corps de la réponse

Message de réponse pour [quarantinedMessages.search][].

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Champs
quarantinedMessages[]

object (QuarantinedMessage)

Liste des messages mis en quarantaine correspondant à la requête de recherche.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante.
unreachable[]

string

Comptes pour lesquels le service n'a pas pu récupérer les messages mis en quarantaine.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide d'autorisation.