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

标识符。隔离邮件的资源名称。格式: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

用于提取附件内容的唯一标识符。

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

将邮件从隔离区释放,以便递送给收件人。
使用特定搜索查询搜索隔离邮件。