Method: customers.quarantinedMessages.list

Consulta los mensajes en cuarentena con condiciones de filtro específicas.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. El recurso superior, que es propietario de esta colección de mensajes. Formato: customers/{customer_id}

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. La cantidad máxima de elementos que se mostrarán.

pageToken

string

Opcional. Es el valor de nextPageToken que se muestra de una solicitud de lista anterior.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para [quarantinedMessages.list][].

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
quarantinedMessages[]

object (QuarantinedMessage)

Es la lista de mensajes en cuarentena que coinciden con la solicitud.

nextPageToken

string

Un token para recuperar los resultados de la página siguiente.

unreachable[]

string

Son las cuentas para las que el servicio no pudo recuperar los mensajes en cuarentena.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la guía de autorización.