Method: customers.quarantinedMessages.list

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

درخواست HTTP

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

این نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
parent

string

الزامی. منبع اصلی که مالک این مجموعه پیام‌ها است. قالب: customers/{customer_id}

پارامترهای پُرسمان

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد موارد برای برگرداندن.
pageToken

string

اختیاری. مقدار nextPageToken از درخواست «فهرست» قبلی برگردانده شد.

متن درخواست

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای [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

برای اطلاعات بیشتر، راهنمای مجوز را ببینید.