Method: users.threads.list

فهرستی از موضوعات موجود در صندوق پستی کاربر را نمایش می‌دهد.

درخواست HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
userId

string

آدرس ایمیل کاربر. مقدار ویژه me می‌تواند برای نشان دادن کاربر احراز هویت شده استفاده شود.

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

پارامترها
maxResults

integer ( uint32 format)

حداکثر تعداد نخ‌های قابل بازگشت. این فیلد به صورت پیش‌فرض ۱۰۰ است. حداکثر مقدار مجاز برای این فیلد ۵۰۰ است.

pageToken

string

توکن صفحه برای بازیابی یک صفحه خاص از نتایج در لیست.

q

string

فقط رشته‌هایی را برمی‌گرداند که با عبارت جستجوی مشخص‌شده مطابقت دارند. از همان قالب جستجوی کادر جستجوی Gmail پشتیبانی می‌کند. برای مثال، "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread" . هنگام دسترسی به API با استفاده از دامنه gmail.metadata نمی‌توان از پارامتر استفاده کرد.

labelIds[]

string

فقط رشته‌هایی را برگردانید که برچسب‌هایشان با تمام شناسه‌های برچسب مشخص‌شده مطابقت دارد.

includeSpamTrash

boolean

موضوعات مربوط به SPAM و TRASH را در نتایج لحاظ کنید.

درخواست بدنه

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

بدنه پاسخ

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

نمایش JSON 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
فیلدها
threads[]

object ( Thread )

فهرست نخ‌ها. توجه داشته باشید که هر منبع نخ شامل فهرستی از messages نیست. فهرست messages یک نخ مشخص را می‌توان با استفاده از متد threads.get دریافت کرد.

nextPageToken

string

توکن صفحه برای بازیابی صفحه بعدی نتایج در لیست.

resultSizeEstimate

integer ( uint32 format)

تعداد کل نتایج تخمینی.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .