REST Resource: customers.quarantinedMessages

Ressource : QuarantinedMessage

La ressource QuarantinedMessage représente un e-mail placé dans une zone de quarantaine administrative.

Représentation 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
}
Champs
name

string

Identifiant. Nom de ressource du message mis en quarantaine. Format : customers/{customer_id}/quarantinedMessages/{quarantined_message_id}
messageId

string

Uniquement en sortie. ID permanent du message Gmail sous-jacent.
messageOwner

string

Uniquement en sortie. Adresse e-mail du propriétaire de ce message.
quarantines[]

string

Uniquement en sortie. Noms de ressources des quarantaines auxquelles ce message appartient. Format : customers/{customer_id}/quarantines/{quarantine_id}
receiveTime

string (Timestamp format)

Uniquement en sortie. Horodatage de la réception du message.
direction

enum (Direction)

Uniquement en sortie. La direction du message (par exemple, ENTRANT, SORTANT).
state

enum (State)

Uniquement en sortie. État de traitement actuel du message.
retentionExpireTime

string (Timestamp format)

Uniquement en sortie. Horodatage jusqu'auquel ce message sera conservé.
triggeredRules[]

object (TriggeredRule)

Uniquement en sortie. Informations sur les règles qui ont entraîné la mise en quarantaine.
content

object (MessageContent)

Uniquement en sortie. Contenu détaillé et métadonnées de l'e-mail mis en quarantaine.
rawMessage

string (bytes format)

Uniquement en sortie. L'intégralité de l'e-mail dans une chaîne au format RFC 2822 et encodée en base64url. Renvoie cette valeur si le type de contenu RAW est sélectionné.

Direction

Sens du message.

Enums
DIRECTION_UNSPECIFIED Non spécifié.
INBOUND Le message mis en quarantaine a été reçu par l'utilisateur.
OUTBOUND Le message mis en quarantaine a été envoyé par l'utilisateur.

État

État de traitement actuel du message.

Enums
STATE_UNSPECIFIED Non spécifié.
PENDING_TRIAGE Le message est en quarantaine.
RELEASED Le message a été libéré de la zone de quarantaine.
DENIED Le message a été refusé alors qu'il était en quarantaine.

TriggeredRule

Informations sur une règle spécifique ayant causé la mise en quarantaine d'un message.

Représentation JSON 
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
Champs
policyId

string

ID de la règle auquel la règle établie correspond.
ruleId

string

ID de la règle établie spécifique.
displayName

string

Nom ou description de la règle établie.

MessageContent

Informations détaillées sur le contenu d'un e-mail mis en quarantaine.

Représentation JSON 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "body": string,
  "subject": string,
  "labels": [
    string
  ],
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Champs
headers[]

object (Header)

En-têtes de l'e-mail.
attachments[]

object (Attachment)

Pièces jointes trouvées dans l'e-mail.
body

string

Corps ou extrait en texte brut de l'e-mail.
subject

string

Objet de l'e-mail.
labels[]

string

Libellés standards appliqués au message (par exemple, "QUARANTINE").
classificationLabelValues[]

object (ClassificationLabelValue)

Valeurs des libellés de classification appliquées au message. Uniquement présent pour les comptes Google Workspace.

Pièce jointe

Pièce jointe dans un e-mail.

Représentation JSON 
{
  "filename": string,
  "mimeType": string,
  "sizeBytes": string,
  "attachmentId": string
}
Champs
filename

string

Nom du fichier de la pièce jointe.
mimeType

string

Type MIME de la pièce jointe (par exemple, "application/pdf").
sizeBytes

string (int64 format)

Taille de la pièce jointe en octets.
attachmentId

string

Identifiant unique utilisé pour récupérer le contenu de la pièce jointe.

ClassificationLabelValue

Libellés de classification appliqués à l'e-mail.

Représentation JSON 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Champs
labelId

string

ID d'étiquette de classification alphanumérique canonique ou brut.
fields[]

object (ClassificationLabelFieldValue)

Valeurs de champ pour l'ID de libellé de classification donné.

ClassificationLabelFieldValue

Valeurs de champ pour un libellé de classification.

Représentation JSON 
{
  "fieldId": string,
  "selection": string
}
Champs
fieldId

string

ID du champ de la valeur du libellé de classification.
selection

string

ID de choix de sélection pour l'option de sélection.

Méthodes

batchDeny

 Refuse une liste de messages de manière asynchrone.

batchRelease

 Libère une liste de messages de manière asynchrone.

deny

 Refuse un message d'une quarantaine.

get

 Récupère les métadonnées et le contenu d'un message mis en quarantaine.

list

 Recherche les messages mis en quarantaine à l'aide de conditions de filtre spécifiques.

release

 Libère un message de la quarantaine pour qu'il soit distribué aux destinataires.
Rechercher des messages mis en quarantaine à l'aide de requêtes de recherche spécifiques.