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)

פלט בלבד. הודעת האימייל המלאה בפורמט RFC 2822 ובמחרוזת בקידוד base64url. הערך הזה מוחזר אם נבחר סוג התוכן RAW.

כיוון

כיוון ההודעה.

טיפוסים בני מנייה (enum)
DIRECTION_UNSPECIFIED לא צוין.
INBOUND ההודעה שהועברה להסגר התקבלה על ידי המשתמש.
OUTBOUND ההודעה שהועברה להסגר נשלחה על ידי המשתמש.

מדינה (State)

מצב העיבוד הנוכחי של ההודעה.

טיפוסים בני מנייה (enum)
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

מזהה הבחירה של אפשרות הבחירה.

Methods

batchDeny

 דחייה של רשימת הודעות באופן אסינכרוני.

batchRelease

 שחרור רשימה של הודעות באופן אסינכרוני.

deny

 דחיית הודעה מהסגר.

get

 אחזור מטא-נתונים ותוכן של הודעה בהסגר.

list

 שאילתות לגבי הודעות בהסגר באמצעות תנאי סינון ספציפיים.

release

 שחרור הודעה מהסגר כדי שתישלח לנמענים.
חיפוש הודעות בהסגר באמצעות שאילתות חיפוש ספציפיות.