Method: customers.quarantinedMessages.get

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

בקשת HTTP

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

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

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

פרמטרים
name

string

חובה. שם המשאב של ההודעה בהסגר שרוצים לאחזר. פורמט: customers/{customer_id}/quarantinedMessages/{quarantined_message_id}

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

פרמטרים
view

enum (MessageView)

אופציונלי. תצוגת תוכן ההודעה.

גוף הבקשה

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של QuarantinedMessage.

היקפי הרשאות

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

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

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

MessageView

אופציונלי. התצוגה של תוכן ההודעה שרוצים לאחזר.

טיפוסים בני מנייה (enum)
MESSAGE_VIEW_UNSPECIFIED ברירת מחדל. החזרת ההודעה עם מטא-נתונים בסיסיים.
MESSAGE_VIEW_BASIC הפונקציה מחזירה רק מטא-נתונים של הודעה.
MESSAGE_VIEW_RAW הפונקציה מחזירה את כל הודעת האימייל בפורמט RFC 2822 ובמחרוזת בקידוד base64url.
MESSAGE_VIEW_DETAILS החזרת מבנה ההודעה המלא לאחר ניתוח, כולל כותרות, גוף ההודעה וקבצים מצורפים.