Method: users.messages.batchDelete
بسیاری از پیام ها را با شناسه پیام حذف می کند. هیچ تضمینی ارائه نمی کند که پیام ها قبلاً حذف نشده اند یا اصلا وجود نداشته اند.
درخواست HTTP
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchDelete
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها |
---|
userId | string آدرس ایمیل کاربر. مقدار ویژه me می تواند برای نشان دادن کاربر تأیید شده استفاده شود. |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"ids": [
string
]
} |
فیلدها |
---|
ids[] | string شناسه پیام هایی که باید حذف شوند. |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-14 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2024-11-14 بهوقت ساعت هماهنگ جهانی."],[[["This endpoint allows you to delete multiple messages in Gmail by providing a list of message IDs."],["The request is sent as a POST request to a specific URL with the user's email address as a path parameter."],["The request body requires a JSON object containing an array of message IDs to be deleted."],["Although it doesn't guarantee the existence or prior deletion status of the messages, it efficiently processes bulk message deletions."],["Proper authorization with the `https://mail.google.com/` scope is necessary for successful execution."]]],["This document details the process of batch deleting messages in Gmail via an API. It uses a `POST` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/batchDelete`, specifying the user via the `userId` path parameter. The request body, in JSON format, contains an array `ids` of message IDs to be deleted. The response body is empty upon successful deletion. This action requires the `https://mail.google.com/` OAuth scope. No guarantees are made about the existence or prior deletion of specified message IDs.\n"]]