Обновление mailSearchFolder
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Обновление записываемых свойств объекта mailSearchFolder .
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.
Тип разрешения | Разрешения (в порядке повышения привилегий) |
---|---|
Делегированные (рабочая или учебная учетная запись) | Mail.ReadWrite |
Делегированные (личная учетная запись Майкрософт) | Mail.ReadWrite |
Для приложений | Mail.ReadWrite |
HTTP-запрос
PATCH /me/mailFolders/{id}
PATCH /users/{id | userPrincipalName}/mailFolders/{id}
Заголовки запросов
Заголовок | Значение |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Content-Type | application/json. Обязательно. |
Текст запроса
В тексте запроса укажите значения для соответствующих полей, которые необходимо обновить. Предыдущие значения существующих свойств, не включенных в текст запроса, останутся прежними или будут повторно вычислены с учетом измененных значений других свойств. Для достижения оптимальной производительности не включайте существующие значения, которые не изменились.
Свойство | Тип | Описание |
---|---|---|
displayName | String | Отображаемое имя объекта mailFolder. |
includeNestedFolders | Логический | Порядок обхода иерархии папок почтовых ящиков. true означает, что должен быть выполнен глубокий поиск, а false означает, что вместо этого должен быть выполнен неглубокий поиск. |
sourceFolderIds | Коллекция строк | Папки почтового ящика, которые должны быть заминированы. |
filterQuery | String | Запрос OData для фильтрации сообщений. |
Отклик
В случае успешного 200 OK
выполнения этот метод возвращает код ответа и обновленный объект mailFolder в тексте ответа.
Пример
Запрос
Ниже приведен пример запроса, который обновляет свойство filterQuery папки поиска.
PATCH https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM
Content-type: application/json
{
"@odata.type": "microsoft.graph.mailSearchFolder",
"filterQuery": "contains(subject, 'Analytics')"
}
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "#microsoft.graph.mailSearchFolder",
"id": "AAMkAGVmMDEzMx",
"displayName": "Get MyAnalytics",
"parentFolderId": "AAMkAGVmMDEzMy",
"childFolderCount": 0,
"unreadItemCount": 0,
"totalItemCount": 0,
"wellKnownName": null,
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": [
"AAMkAGVmMDEzMi"
],
"filterQuery": "contains(subject, 'Analytics')"
}
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по