REST Resource: customers.quarantinedMessages

Recurso: QuarantinedMessage

El recurso QuarantinedMessage representa un mensaje de correo electrónico retenido en una cuarentena administrativa.

Representación JSON 
{
  "name": string,
  "messageId": string,
  "messageOwner": string,
  "quarantines": [
    string
  ],
  "receiveTime": string,
  "direction": enum (Direction),
  "state": enum (State),
  "retentionExpireTime": string,
  "triggeredRules": [
    {
      object (TriggeredRule)
    }
  ],
  "content": {
    object (MessageContent)
  },
  "rawMessage": string
}
Campos
name

string

Es el identificador. Es el nombre del recurso del mensaje en cuarentena. Formato: customers/{customer_id}/quarantinedMessages/{quarantined_message_id}
messageId

string

Solo salida. Es el ID inmutable del mensaje de Gmail subyacente.
messageOwner

string

Solo salida. Es la dirección de correo electrónico del propietario de este mensaje.
quarantines[]

string

Solo salida. Son los nombres de los recursos de las cuarentenas a las que pertenece este mensaje. Formato: customers/{customer_id}/quarantines/{quarantine_id}
receiveTime

string (Timestamp format)

Solo salida. Es la marca de tiempo del momento en que se recibió el mensaje.
direction

enum (Direction)

Solo salida. La dirección del mensaje (p.ej., ENTRANTE, SALIENTE).
state

enum (State)

Solo salida. Es el estado de procesamiento actual del mensaje.
retentionExpireTime

string (Timestamp format)

Solo salida. Es la marca de tiempo hasta la que se conservará este mensaje.
triggeredRules[]

object (TriggeredRule)

Solo salida. Información sobre las reglas que causaron la cuarentena.
content

object (MessageContent)

Solo salida. El contenido y los metadatos detallados del correo electrónico en cuarentena
rawMessage

string (bytes format)

Solo salida. Es todo el mensaje de correo electrónico en una cadena con formato RFC 2822 y codificación base64url. Devuelve este valor si se selecciona el tipo de contenido RAW.

Dirección

Es la dirección del mensaje.

Enums
DIRECTION_UNSPECIFIED Sin especificar.
INBOUND El usuario recibió el mensaje en cuarentena.
OUTBOUND El usuario envió el mensaje que se puso en cuarentena.

Estado

Es el estado de procesamiento actual del mensaje.

Enums
STATE_UNSPECIFIED Sin especificar.
PENDING_TRIAGE El mensaje está en cuarentena.
RELEASED Se liberó el mensaje de la cuarentena.
DENIED Se rechazó el mensaje mientras estaba en cuarentena.

TriggeredRule

Información sobre una regla específica que provocó que un mensaje se pusiera en cuarentena.

Representación JSON 
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
Campos
policyId

string

Es el ID de la política con la que se correlaciona la regla establecida.
ruleId

string

Es el ID de la regla establecida específica.
displayName

string

Es el nombre o la descripción de la regla establecida.

MessageContent

Información detallada sobre el contenido de un mensaje de correo electrónico en cuarentena.

Representación JSON 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "body": string,
  "subject": string,
  "labels": [
    string
  ],
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Campos
headers[]

object (Header)

Son los encabezados del mensaje de correo electrónico.
attachments[]

object (Attachment)

Son los archivos adjuntos que se encuentran en el mensaje de correo electrónico.
body

string

Es el cuerpo o el fragmento de texto sin formato del mensaje de correo electrónico.
subject

string

Es el asunto del mensaje de correo electrónico.
labels[]

string

Son las etiquetas estándar que se aplican al mensaje (p.ej., "CUARENTENA").
classificationLabelValues[]

object (ClassificationLabelValue)

Son los valores de la etiqueta de clasificación que se aplicaron al mensaje. Solo está presente en las cuentas de Google Workspace.

Archivo adjunto

Un archivo adjunto en un mensaje de correo electrónico.

Representación JSON 
{
  "filename": string,
  "mimeType": string,
  "sizeBytes": string,
  "attachmentId": string
}
Campos
filename

string

Es el nombre del archivo adjunto.
mimeType

string

Es el tipo de MIME del archivo adjunto (p.ej., "application/pdf").
sizeBytes

string (int64 format)

Es el tamaño del archivo adjunto en bytes.
attachmentId

string

Es un identificador único que se usa para recuperar el contenido del archivo adjunto.

ClassificationLabelValue

Son las etiquetas de clasificación que se aplican al mensaje de correo electrónico.

Representación JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Campos
labelId

string

Es el ID de la etiqueta de clasificación alfanumérica canónica o sin procesar.
fields[]

object (ClassificationLabelFieldValue)

Son los valores de campo para el ID de etiqueta de clasificación determinado.

ClassificationLabelFieldValue

Son los valores de campo de una etiqueta de clasificación.

Representación JSON 
{
  "fieldId": string,
  "selection": string
}
Campos
fieldId

string

Es el ID del campo para el valor de la etiqueta de clasificación.
selection

string

Es el ID de la opción de selección.

Métodos

batchDeny

 Rechaza una lista de mensajes de forma asíncrona.

batchRelease

 Libera una lista de mensajes de forma asíncrona.

deny

 Rechaza un mensaje de una cuarentena.

get

 Obtiene los metadatos y el contenido de un mensaje en cuarentena.

list

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

release

 Libera un mensaje de la cuarentena para que se entregue a los destinatarios.
Busca mensajes en cuarentena con consultas de búsqueda específicas.