REST Resource: customers.quarantinedMessages

Zasób: QuarantinedMessage

Zasób QuarantinedMessage reprezentuje wiadomość e-mail przechowywaną w kwarantannie administracyjnej.

Zapis 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
}
Pola
name

string

Identyfikator. Nazwa zasobu wiadomości poddanej kwarantannie. Format: customers/{customer_id}/quarantinedMessages/{quarantined_message_id}

messageId

string

Tylko dane wyjściowe. Niezmienny identyfikator wiadomości Gmail.

messageOwner

string

Tylko dane wyjściowe. Adres e-mail właściciela tej wiadomości.

quarantines[]

string

Tylko dane wyjściowe. Nazwy zasobów kwarantann, do których należy ta wiadomość. Format: customers/{customer_id}/quarantines/{quarantine_id}

receiveTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa odebrania wiadomości.

direction

enum (Direction)

Tylko dane wyjściowe. Kierunek wiadomości (np. WEWNĘTRZNE, ZEWNĘTRZNE).

state

enum (State)

Tylko dane wyjściowe. Bieżący stan przetwarzania wiadomości.

retentionExpireTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa, do której ta wiadomość będzie przechowywana.

triggeredRules[]

object (TriggeredRule)

Tylko dane wyjściowe. Informacje o regułach, które spowodowały umieszczenie wiadomości w kwarantannie.

content

object (MessageContent)

Tylko dane wyjściowe. szczegółową treść i metadane e-maila umieszczonego w kwarantannie;

rawMessage

string (bytes format)

Tylko dane wyjściowe. Cała wiadomość e-mail w formacie RFC 2822 i ciągu tekstowym zakodowanym w standardzie base64url. Zwraca tę wartość, jeśli wybrano typ treści RAW.

Kierunek

Kierunek wiadomości.

Wartości w polu enum
DIRECTION_UNSPECIFIED Nie określono.
INBOUND Wiadomość umieszczona w kwarantannie została odebrana przez użytkownika.
OUTBOUND Wiadomość umieszczona w kwarantannie została wysłana przez użytkownika.

Stan

Bieżący stan przetwarzania wiadomości.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono.
PENDING_TRIAGE Wiadomość jest w kwarantannie.
RELEASED Wiadomość została zwolniona z kwarantanny.
DENIED Wiadomość została odrzucona podczas kwarantanny.

TriggeredRule

Informacje o konkretnej regule, która spowodowała umieszczenie wiadomości w kwarantannie.

Zapis JSON
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
Pola
policyId

string

Identyfikator zasady, z którą jest powiązana utworzona reguła.

ruleId

string

Identyfikator konkretnej utworzonej reguły.

displayName

string

Nazwa lub opis utworzonej reguły.

MessageContent

Szczegółowe informacje o treści wiadomości e-mail umieszczonej w kwarantannie.

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

object (Header)

Nagłówki wiadomości e-mail.

attachments[]

object (Attachment)

Załączniki znalezione w wiadomości e-mail.

body

string

Treść lub fragment wiadomości e-mail w formacie zwykłego tekstu.

subject

string

Temat wiadomości e-mail.

labels[]

string

Standardowe etykiety zastosowane do wiadomości (np. „KWARANTANNA”).

classificationLabelValues[]

object (ClassificationLabelValue)

Wartości etykiet klasyfikacji zastosowane do wiadomości. Ta opcja jest dostępna tylko na kontach Google Workspace.

Załącznik

załącznik w wiadomości e-mail,

Zapis JSON
{
  "filename": string,
  "mimeType": string,
  "sizeBytes": string,
  "attachmentId": string
}
Pola
filename

string

Nazwa pliku załącznika.

mimeType

string

Typ MIME załącznika (np. „application/pdf”).

sizeBytes

string (int64 format)

Rozmiar załącznika w bajtach.

attachmentId

string

Unikalny identyfikator używany do pobierania zawartości załącznika.

ClassificationLabelValue

Etykiety klasyfikacji zastosowane do wiadomości e-mail.

Zapis JSON
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
Pola
labelId

string

Identyfikator etykiety klasyfikacji kanonicznej lub nieprzetworzonej etykiety alfanumerycznej.

fields[]

object (ClassificationLabelFieldValue)

Wartości pól dla danego identyfikatora etykiety klasyfikacji.

ClassificationLabelFieldValue

Wartości pól etykiety klasyfikacji.

Zapis JSON
{
  "fieldId": string,
  "selection": string
}
Pola
fieldId

string

Identyfikator pola wartości etykiety klasyfikacji.

selection

string

Identyfikator wyboru opcji wyboru.

Metody

batchDeny

Asynchronicznie odrzuca listę wiadomości.

batchRelease

Asynchronicznie zwalnia listę wiadomości.

deny

Odrzuca wiadomość z kwarantanny.

get

Pobiera metadane i treść wiadomości umieszczonej w kwarantannie.

list

Zapytania dotyczące wiadomości poddanych kwarantannie z użyciem określonych warunków filtra.

release

Zwalnia wiadomość z kwarantanny, aby została dostarczona do odbiorców.
Wyszukuje wiadomości w kwarantannie za pomocą określonych zapytań.