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 زیرین.
messageOwner

string

فقط خروجی. نشانی ایمیل مالک این پیام.
quarantines[]

string

فقط خروجی. نام‌های منبع قرنطینه‌هایی که این پیام به آن‌ها تعلق دارد. قالب: customers/{customer_id}/quarantines/{quarantine_id}
receiveTime

string (Timestamp format)

فقط خروجی. مُهر زمان دریافت پیام.
direction

enum (Direction)

فقط خروجی. جهت پیام (مثلاً، ورودی، خروجی).
state

enum (State)

فقط خروجی. وضعیت پردازش فعلی پیام.
retentionExpireTime

string (Timestamp format)

فقط خروجی. مُهر زمان تا زمانی که این پیام حفظ خواهد شد.
triggeredRules[]

object (TriggeredRule)

فقط خروجی. اطلاعات مربوط به قوانینی که باعث قرنطینه شده‌اند.
content

object (MessageContent)

فقط خروجی. محتوای دقیق و فراداده ایمیل قرنطینه‌شده.
rawMessage

string (bytes format)

فقط خروجی. کل پیام ایمیل در رشته کدبندی‌شده base64url و قالب‌بندی‌شده RFC 2822. اگر نوع محتوای RAW انتخاب شده باشد، این را برمی‌گرداند.

جهت

جهت پیام.

شمارشی‌ها
DIRECTION_UNSPECIFIED نامشخص.
INBOUND پیام قرنطینه‌شده را کاربر دریافت کرد.
OUTBOUND پیام قرنطینه‌شده را کاربر ارسال کرده است.

ایالت

وضعیت پردازش فعلی پیام.

شمارشی‌ها
STATE_UNSPECIFIED نامشخص.
PENDING_TRIAGE پیام در «قرنطینه» است.
RELEASED پیام از قرنطینه آزاد شد.
DENIED پیام درحین قرنطینه رد شد.

TriggeredRule

اطلاعات مربوط به قانون خاصی که باعث قرنطینه شدن پیام شده است.

نمایش JSON 
{
  "policyId": string,
  "ruleId": string,
  "displayName": string
}
فیلدها
policyId

string

شناسه خط‌مشی‌ای که قانون ایجادشده با آن مرتبط است.
ruleId

string

شناسه قانون خاص ایجادشده.
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

برچسب‌های استاندارد اعمال‌شده به پیام (برای نمونه، «قرنطینه»).
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

شناسه برچسب طبقه‌بندی الفباعددی متعارف یا خام.
fields[]

object (ClassificationLabelFieldValue)

مقادیر فیلد برای شناسه برچسب طبقه‌بندی ارائه‌شده.

ClassificationLabelFieldValue

مقادیر فیلد برای برچسب طبقه‌بندی.

نمایش JSON 
{
  "fieldId": string,
  "selection": string
}
فیلدها
fieldId

string

شناسه فیلد برای «مقدار برچسب طبقه‌بندی».
selection

string

شناسه انتخاب گزینش برای گزینه انتخاب.

روش‌ها

batchDeny

 فهرستی از پیام‌ها را به‌صورت ناهمگام رد می‌کند.

batchRelease

 فهرستی از پیام‌ها را به‌صورت ناهمگام منتشر می‌کند.

deny

 پیامی را از قرنطینه رد می‌کند.

get

 فراداده و محتوای پیام قرنطینه‌شده را دریافت می‌کند.

list

 بااستفاده از شرایط فیلتر خاص، پیام‌های قرنطینه‌شده را جستجو می‌کند.

release

 پیامی را از قرنطینه آزاد می‌کند تا به گیرندگان تحویل داده شود.
پیام‌های قرنطینه‌شده را بااستفاده از پُرسمان‌های جستجوی خاص جستجو می‌کند.