Method: users.messages.list

پیام‌های موجود در صندوق پستی کاربر را فهرست می‌کند. برای مثال، به فهرست پیام‌های Gmail مراجعه کنید.

درخواست HTTP

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

این 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 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
فیلدها
messages[]

object ( Message )

فهرست پیام‌ها. توجه داشته باشید که هر منبع پیام فقط شامل یک id و یک threadId است. جزئیات بیشتر پیام را می‌توان با استفاده از متد messages.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 .