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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: users.messages.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets the specified message.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n| `id` | `string` The ID of the message to retrieve. This ID is usually retrieved using `messages.list`. The ID is also contained in the result when a message is inserted (`messages.insert`) or imported (`messages.import`). |\n\n### Query parameters\n\n| Parameters ||\n|---------------------|---------------------------------------------------------------------------------------------------------|\n| `format` | `enum (`[Format](/workspace/gmail/api/reference/rest/v1/Format)`)` The format to return the message in. |\n| `metadataHeaders[]` | `string` When given and format is `METADATA`, only include headers specified. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Message](/workspace/gmail/api/reference/rest/v1/users.messages#Message).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n- `\n https://www.googleapis.com/auth/gmail.metadata`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]