Method: customers.quarantinedMessages.list

Recherche les messages mis en quarantaine à l'aide de conditions de filtre spécifiques.

Requête HTTP

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

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}

Paramètres de requête

Paramètres
pageSize

integer

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

string

Facultatif. La valeur nextPageToken renvoyée par une requête "List" antérieure.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

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

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.
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.