REST Resource: customers.quarantinedMessages

資源:QuarantinedMessage

QuarantinedMessage 資源代表保留在管理隔離區中的電子郵件訊息。

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
}
欄位
name

string

ID。隔離郵件的資源名稱。格式:customers/{customer_id}/quarantinedMessages/{quarantined_message_id}

messageId

string

僅供輸出。基礎 Gmail 郵件的固定 ID。

messageOwner

string

僅供輸出。這封郵件擁有者的電子郵件地址。

quarantines[]

string

僅供輸出。這封郵件所屬隔離區的資源名稱。格式:customers/{customer_id}/quarantines/{quarantine_id}

receiveTime

string (Timestamp format)

僅供輸出。收到訊息的時間戳記。

direction

enum (Direction)

僅供輸出。訊息方向 (例如 INBOUND、OUTBOUND)。

state

enum (State)

僅供輸出。訊息目前的處理狀態。

retentionExpireTime

string (Timestamp format)

僅供輸出。這則訊息的保留期限時間戳記。

triggeredRules[]

object (TriggeredRule)

僅供輸出。導致郵件遭到隔離的規則相關資訊。

content

object (MessageContent)

僅供輸出。隔離電子郵件的詳細內容和中繼資料。

rawMessage

string (bytes format)

僅供輸出。整封電子郵件訊息,採用 RFC 2822 格式和 base64url 編碼字串。如果選取 RAW 內容類型,則會傳回此值。

方向

訊息方向。

列舉
DIRECTION_UNSPECIFIED 未指明
INBOUND 使用者已收到隔離的郵件。
OUTBOUND 隔離郵件是由使用者傳送。

州

訊息目前的處理狀態。

列舉
STATE_UNSPECIFIED 未指明
PENDING_TRIAGE 郵件已隔離。
RELEASED 郵件已從隔離區釋出。
DENIED 郵件在隔離區時遭到拒絕。

TriggeredRule

導致郵件遭到隔離的特定規則相關資訊。

JSON 表示法
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
欄位
policyId

string

與既定規則相關聯的政策 ID。

ruleId

string

特定既定規則的 ID。

displayName

string

已建立規則的名稱或說明。

MessageContent

隔離電子郵件訊息內容的詳細資訊。

JSON 表示法
{
  "headers": [
    {
      object (Header)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "body": string,
  "subject": string,
  "labels": [
    string
  ],
  "classificationLabelValues": [
    {
      object (ClassificationLabelValue)
    }
  ]
}
欄位
headers[]

object (Header)

電子郵件訊息的標頭。

attachments[]

object (Attachment)

電子郵件訊息中的附件。

body

string

電子郵件訊息的純文字內文或摘要。

subject

string

電子郵件訊息的主旨。

labels[]

string

套用至郵件的標準標籤 (例如「QUARANTINE」)。

classificationLabelValues[]

object (ClassificationLabelValue)

郵件套用的分類標籤值。僅適用於 Google Workspace 帳戶。

附件

電子郵件訊息中的附件。

JSON 表示法
{
  "filename": string,
  "mimeType": string,
  "sizeBytes": string,
  "attachmentId": string
}
欄位
filename

string

附件的檔案名稱。

mimeType

string

附件的 MIME 類型 (例如「application/pdf」)。

sizeBytes

string (int64 format)

附件大小,以位元組為單位。

attachmentId

string

用於擷取附件內容的專屬 ID。

ClassificationLabelValue

套用至電子郵件訊息的分類標籤。

JSON 表示法
{
  "labelId": string,
  "fields": [
    {
      object (ClassificationLabelFieldValue)
    }
  ]
}
欄位
labelId

string

標準或原始英數字元分類標籤 ID。

fields[]

object (ClassificationLabelFieldValue)

指定分類標籤 ID 的欄位值。

ClassificationLabelFieldValue

分類標籤的欄位值。

JSON 表示法
{
  "fieldId": string,
  "selection": string
}
欄位
fieldId

string

分類標籤值的欄位 ID。

selection

string

選取選項的選取項目 ID。

方法

batchDeny

以非同步方式拒絕訊息清單。

batchRelease

以非同步方式釋出一系列訊息。

deny

拒絕隔離區中的郵件。

get

取得隔離郵件的中繼資料和內容。

list

使用特定篩選條件查詢隔離郵件。

release

將郵件從隔離區釋出,傳送給收件者。
使用特定搜尋查詢,搜尋隔離郵件。