Method: customers.quarantinedMessages.list

Consulta mensagens em quarentena usando condições de filtro específicas.

Solicitação HTTP

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

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}

Parâmetros de consulta

Parâmetros
pageSize

integer

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

string

Opcional. O valor nextPageToken retornado de uma solicitação List anterior.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

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 à solicitação.
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.