Получение объекта mailFolder
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение свойств и связей объекта папки сообщений.
В следующем списке показаны два существующих сценария, в которых приложение может получить папку почты другого пользователя:
- У приложения есть разрешения для приложений; или
- У приложения есть соответствующие делегированные разрешения от одного пользователя, а другой пользователь поделился с ним папкой почты или предоставил ему делегированный доступ. Дополнительные сведения см. в разделе Получение сообщений Outlook в общей или делегированной папке.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | Mail.ReadBasic | Mail.ReadWrite, Mail.Read |
Делегированные (личная учетная запись Майкрософт) | Mail.ReadBasic | Mail.ReadWrite, Mail.Read |
Приложение | Mail.ReadBasic.All | Mail.ReadWrite, Mail.Read |
HTTP-запрос
GET /me/mailFolders/{id}
GET /users/{id | userPrincipalName}/mailFolders/{id}
Необязательные параметры запросов
Этот метод поддерживает параметры запросов OData для настройки ответа.
Заголовки запросов
Имя | Описание |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успешного выполнения этот метод возвращает код отклика 200 OK
и объект mailFolder в тексте ответа.
Примеры
Пример 1. Получение папки почты
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkAGVmMDEzM",
"displayName": "Inbox",
"parentFolderId": "AAMkAGVmMDEzI",
"childFolderCount": 2,
"unreadItemCount": 59,
"totalItemCount": 60,
"wellKnownName": "inbox",
"isHidden": false
}
Пример 2. Получение папки поиска почты
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzN
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.type": "#microsoft.graph.mailSearchFolder",
"id": "AAMkAGVmMDEzN",
"displayName": "Get MyAnalytics",
"parentFolderId": "AAMkAGVmMDEzI",
"childFolderCount": 0,
"unreadItemCount": 6,
"totalItemCount": 6,
"wellKnownName": null,
"isHidden": false,
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": [
"AAMkAGVmMDEzM"
],
"filterQuery": "contains(subject, 'MyAnalytics')"
}