Method: customers.quarantinedMessages.search

Busca mensajes en cuarentena con consultas de búsqueda específicas.

Solicitud HTTP

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

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}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Campos
pageSize

integer

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

string

Opcional. Es el valor de nextPageToken que se devuelve de una llamada de búsqueda anterior.
filter

string

Opcional. Filtrar los resultados por estado, dirección o cuarentena El filtro incluye tres partes opcionales: status, direction y quarantine, que siempre se conectan con el operador lógico AND. La expresión de filtro debe seguir la sintaxis de AIP-160. Ejemplo: "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

Opcional. Es una consulta de búsqueda específica de Gmail en formato de consulta de Caribou.

Cuerpo de la respuesta

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

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 búsqueda.
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.