Method: customers.quarantinedMessages.list

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

בקשת HTTP

GET https://mailadminquarantine.googleapis.com/v1/{parent=customers/*}/quarantinedMessages

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של הנתיב

פרמטרים
parent

string

חובה. משאב ההורה, שהוא הבעלים של אוסף ההודעות הזה. פורמט: customers/{customer_id}

פרמטרים של שאילתה

פרמטרים
pageSize

integer

אופציונלי. המספר המקסימלי של פריטים שיוחזרו.
pageToken

string

אופציונלי. הערך של nextPageToken שהוחזר מבקשת List קודמת.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

הודעת תגובה ל-[quarantinedMessages.list][].

אם הפעולה מצליחה, גוף התשובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "quarantinedMessages": [
    {
      object (QuarantinedMessage)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
שדות
quarantinedMessages[]

object (QuarantinedMessage)

רשימת ההודעות בהסגר שתואמות לבקשה.
nextPageToken

string

אסימון לאחזור של דף התוצאות הבא.
unreachable[]

string

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

היקפי הרשאות

צריך אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/gmail.admin.quarantine
  • https://www.googleapis.com/auth/gmail.admin.quarantine.readonly

מידע נוסף זמין במדריך ההרשאות.