- 资源:QuarantinedMessage
- 方向
- 状态
- TriggeredRule
- MessageContent
- Header
- 附件
- ClassificationLabelValue
- ClassificationLabelFieldValue
- 方法
资源:QuarantinedMessage
QuarantinedMessage 资源表示保留在管理隔离区中的电子邮件。
| JSON 表示法 |
|---|
{ "name": string, "messageId": string, "messageOwner": string, "quarantines": [ string ], "receiveTime": string, "direction": enum ( |
| 字段 | |
|---|---|
name |
标识符。隔离邮件的资源名称。格式:customers/{customer_id}/quarantinedMessages/{quarantined_message_id} |
messageId |
仅限输出。底层 Gmail 邮件的不可变 ID。 |
messageOwner |
仅限输出。此邮件所有者的邮箱。 |
quarantines[] |
仅限输出。此邮件所属隔离区的资源名称。格式:customers/{customer_id}/quarantines/{quarantine_id} |
receiveTime |
仅限输出。收到消息时的时间戳。 |
direction |
仅限输出。消息的方向(例如 INBOUND、OUTBOUND)。 |
state |
仅限输出。消息的当前处理状态。 |
retentionExpireTime |
仅限输出。此消息的保留截止时间戳。 |
triggeredRules[] |
仅限输出。导致隔离的规则的相关信息。 |
content |
仅限输出。被隔离电子邮件的详细内容和元数据。 |
rawMessage |
仅限输出。采用 RFC 2822 格式和 base64url 编码字符串的完整电子邮件。如果选择了 RAW 内容类型,则返回此值。 |
方向
消息的方向。
| 枚举 | |
|---|---|
DIRECTION_UNSPECIFIED |
未指定。 |
INBOUND |
用户收到了隔离的邮件。 |
OUTBOUND |
被隔离的邮件是由用户发送的。 |
州
消息的当前处理状态。
| 枚举 | |
|---|---|
STATE_UNSPECIFIED |
未指定。 |
PENDING_TRIAGE |
邮件已放入隔离区。 |
RELEASED |
邮件已从隔离区释放。 |
DENIED |
邮件在隔离区中被拒绝。 |
TriggeredRule
导致邮件被隔离的特定规则的相关信息。
| JSON 表示法 |
|---|
{ "policyId": string, "ruleId": string, "displayName": string } |
| 字段 | |
|---|---|
policyId |
与已建立的规则相关的政策 ID。 |
ruleId |
特定既定规则的 ID。 |
displayName |
已建立规则的名称或说明。 |
MessageContent
有关隔离电子邮件内容的详细信息。
| JSON 表示法 |
|---|
{ "headers": [ { object ( |
| 字段 | |
|---|---|
headers[] |
电子邮件的标头。 |
attachments[] |
在电子邮件中找到的附件。 |
body |
电子邮件消息的纯文本正文或摘要。 |
subject |
邮件的主题。 |
labels[] |
应用于邮件的标准标签(例如“QUARANTINE”)。 |
classificationLabelValues[] |
应用于邮件的分类标签值。仅适用于 Google Workspace 账号。 |
标题
电子邮件中的标头。
| JSON 表示法 |
|---|
{ "name": string, "value": string } |
| 字段 | |
|---|---|
name |
标头的名称,例如“发件人”或“主题”。 |
value |
标头的值,经过 MIME 解码。 |
附件
邮件中的附件。
| JSON 表示法 |
|---|
{ "filename": string, "mimeType": string, "sizeBytes": string, "attachmentId": string } |
| 字段 | |
|---|---|
filename |
附件的文件名。 |
mimeType |
附件的 MIME 类型(例如“application/pdf”)。 |
sizeBytes |
附件的大小(以字节为单位)。 |
attachmentId |
用于提取附件内容的唯一标识符。 |
ClassificationLabelValue
应用于电子邮件的分类标签。
| JSON 表示法 |
|---|
{
"labelId": string,
"fields": [
{
object ( |
| 字段 | |
|---|---|
labelId |
规范或原始字母数字分类标签 ID。 |
fields[] |
给定分类标签 ID 的字段值。 |
ClassificationLabelFieldValue
分类标签的字段值。
| JSON 表示法 |
|---|
{ "fieldId": string, "selection": string } |
| 字段 | |
|---|---|
fieldId |
分类标签值的字段 ID。 |
selection |
选择选项的选择 ID。 |
方法 |
|
|---|---|
|
异步拒绝消息列表。 |
|
异步释放消息列表。 |
|
拒绝隔离区中的邮件。 |
|
获取隔离邮件的元数据和内容。 |
|
使用特定过滤条件查询隔离的邮件。 |
|
将邮件从隔离区释放,以便递送给收件人。 |
|
使用特定搜索查询搜索隔离邮件。 |