REST Resource: customers.quarantinedMessages

Ressource: QuarantinedMessage

Die Ressource „QuarantinedMessage“ steht für eine E‑Mail-Nachricht, die sich in einer Administratorquarantäne befindet.

JSON-Darstellung 
{
  "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
}
Felder
name

string

ID. Der Ressourcenname der unter Quarantäne gestellten Nachricht. Format: customers/{customer_id}/quarantinedMessages/{quarantined_message_id}
messageId

string

Nur Ausgabe. Die unveränderliche ID der zugrunde liegenden Gmail-Nachricht.
messageOwner

string

Nur Ausgabe. Die E-Mail-Adresse des Inhabers dieser Nachricht.
quarantines[]

string

Nur Ausgabe. Die Ressourcennamen der Quarantänen, zu denen diese Nachricht gehört. Format: customers/{customer_id}/quarantines/{quarantine_id}
receiveTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, der angibt, wann die Nachricht empfangen wurde.
direction

enum (Direction)

Nur Ausgabe. Die Richtung der Nachricht (z.B. INBOUND, OUTBOUND).
state

enum (State)

Nur Ausgabe. Der aktuelle Verarbeitungsstatus der Nachricht.
retentionExpireTime

string (Timestamp format)

Nur Ausgabe. Der Zeitstempel, bis zu dem diese Nachricht aufbewahrt wird.
triggeredRules[]

object (TriggeredRule)

Nur Ausgabe. Informationen zu den Regeln, die zur Quarantäne geführt haben.
content

object (MessageContent)

Nur Ausgabe. Die detaillierten Inhalte und Metadaten der unter Quarantäne gestellten E‑Mail.
rawMessage

string (bytes format)

Nur Ausgabe. Die gesamte E‑Mail-Nachricht in einem RFC 2822-formatierten und base64url-codierten String. Wird zurückgegeben, wenn der Inhaltstyp RAW ausgewählt ist.

Richtung

Die Richtung der Nachricht.

Enums
DIRECTION_UNSPECIFIED Nicht angegeben
INBOUND Die unter Quarantäne gestellte Nachricht wurde vom Nutzer empfangen.
OUTBOUND Die unter Quarantäne gestellte Nachricht wurde vom Nutzer gesendet.

Bundesland

Der aktuelle Verarbeitungsstatus der Nachricht.

Enums
STATE_UNSPECIFIED Nicht angegeben
PENDING_TRIAGE Die Nachricht befindet sich in der Quarantäne.
RELEASED Die Nachricht wurde aus der Quarantäne freigegeben.
DENIED Die Nachricht wurde abgelehnt, während sie sich in der Quarantäne befand.

TriggeredRule

Informationen zu einer bestimmten Regel, die dazu geführt hat, dass eine Nachricht unter Quarantäne gestellt wurde.

JSON-Darstellung 
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
Felder
policyId

string

Die Richtlinien-ID, der die festgelegte Regel entspricht.
ruleId

string

Die ID für die spezifische festgelegte Regel.
displayName

string

Der Name oder die Beschreibung der festgelegten Regel.

MessageContent

Detaillierte Informationen zum Inhalt einer in Quarantäne befindlichen E‑Mail-Nachricht.

JSON-Darstellung 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "body": string,
  "subject": string,
  "labels": [
    string
  ],
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
Felder
headers[]

object (Header)

Die Header der E‑Mail-Nachricht.
attachments[]

object (Attachment)

Die in der E‑Mail-Nachricht enthaltenen Anhänge.
body

string

Der Nur-Text-Inhalt oder das Snippet der E‑Mail-Nachricht.
subject

string

Der Betreff der E‑Mail-Nachricht.
labels[]

string

Standardlabels, die auf die Nachricht angewendet wurden (z.B. „QUARANTÄNE“).
classificationLabelValues[]

object (ClassificationLabelValue)

Auf die Nachricht angewendete Klassifizierungslabelwerte. Nur für Google Workspace-Konten vorhanden.

Anhang

Ein Anhang in einer E‑Mail-Nachricht.

JSON-Darstellung 
{
  "filename": string,
  "mimeType": string,
  "sizeBytes": string,
  "attachmentId": string
}
Felder
filename

string

Der Dateiname des Anhangs.
mimeType

string

Der MIME-Typ des Anhangs (z.B. „application/pdf“).
sizeBytes

string (int64 format)

Die Größe des Anhangs in Byte.
attachmentId

string

Eine eindeutige Kennung, mit der der Inhalt des Anhangs abgerufen wird.

ClassificationLabelValue

Klassifizierungslabels, die auf die E‑Mail-Nachricht angewendet wurden.

JSON-Darstellung 
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Felder
labelId

string

Die kanonische oder rohe alphanumerische Klassifizierungslabel-ID.
fields[]

object (ClassificationLabelFieldValue)

Feldwerte für die angegebene Klassifizierungslabel-ID.

ClassificationLabelFieldValue

Feldwerte für ein Klassifizierungslabel.

JSON-Darstellung 
{
  "fieldId": string,
  "selection": string
}
Felder
fieldId

string

Die Feld-ID für den Wert des Klassifizierungslabels.
selection

string

Auswahl-ID für die Auswahloption.

Methoden

batchDeny

 Lehnt eine Liste von Nachrichten asynchron ab.

batchRelease

 Gibt eine Liste von Nachrichten asynchron frei.

deny

 Lehnt eine Nachricht aus einer Quarantäne ab.

get

 Ruft Metadaten und Inhalte für eine unter Quarantäne gestellte Nachricht ab.

list

 Fragt nach Nachrichten in Quarantäne mit bestimmten Filterbedingungen ab.

release

 Nachricht aus der Quarantäne freigeben, damit sie an die Empfänger zugestellt wird.
Sucht mithilfe bestimmter Suchanfragen nach Nachrichten in Quarantäne.