Method: users.messages.get

پیام مشخص شده را دریافت می کند.

درخواست HTTP

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

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

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

مولفه های
userId

string

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

id

string

شناسه پیام برای بازیابی. این شناسه معمولاً با استفاده از messages.list بازیابی می‌شود. شناسه همچنین هنگام درج پیام ( messages.insert ) یا وارد کردن ( messages.import ) در نتیجه موجود است.

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

مولفه های
format

enum ( Format )

فرمت برای بازگشت پیام

metadataHeaders[]

string

هنگامی که داده می شود و قالب METADATA است، فقط سرصفحه های مشخص شده را شامل شود.

درخواست بدن

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

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Message است.

محدوده مجوز

به یکی از حوزه های 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

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