Method: users.messages.list

پیام های موجود در صندوق پستی کاربر را فهرست می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

پارامترها
userId

string

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

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

پارامترها
maxResults

integer ( uint32 format)

حداکثر تعداد پیام برای بازگشت. این فیلد به طور پیش فرض 100 است. حداکثر مقدار مجاز برای این فیلد 500 است.

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

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