Method: customers.quarantinedMessages.search

Pesquisa mensagens em quarentena usando consultas de pesquisa específicas.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O recurso pai, que é proprietário dessa coleção de mensagens. Formato: customers/{customer_id}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "filter": string,
  "query": string
}
Campos
pageSize

integer

Opcional. O número máximo de itens para retornar.
pageToken

string

Opcional. O valor nextPageToken retornado de uma chamada de pesquisa anterior.
filter

string

Opcional. Filtre os resultados por status, direção ou quarentena. O filtro inclui três partes opcionais: status, direction e quarantine, que estão sempre conectadas usando o operador lógico AND. A expressão de filtro precisa seguir a sintaxe de AIP-160. Exemplo: "status = PENDING_TRIAGE AND direction = OUTBOUND AND quarantine = customers/123/quarantines/1"
query

string

Opcional. Uma consulta de pesquisa específica do Gmail no formato de consulta do Caribou.

Corpo da resposta

Mensagem de resposta para [quarantinedMessages.search][].

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
quarantinedMessages[]

object (QuarantinedMessage)

A lista de mensagens em quarentena que correspondem à consulta de pesquisa.
nextPageToken

string

Um token para recuperar a próxima página de resultados.
unreachable[]

string

Contas em que o serviço não conseguiu recuperar mensagens em quarentena.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o guia de autorização.