Создание объекта MailFolder
Пространство имен: microsoft.graph
Важно!
API версии /beta
в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
С помощью этого API можно создать папку почты в корневой папке почтового ящика пользователя.
Если предполагается, что новая папка будет скрыта, необходимо присвоить свойству isHidden значение true
при создании.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.
Тип разрешения | Разрешения (в порядке повышения привилегий) |
---|---|
Делегированные (рабочая или учебная учетная запись) | Mail.ReadWrite |
Делегированные (личная учетная запись Майкрософт) | Mail.ReadWrite |
Для приложений | Mail.ReadWrite |
HTTP-запрос
POST /me/mailFolders
POST /users/{id | userPrincipalName}/mailFolders
Заголовки запросов
Заголовок | Значение |
---|---|
Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Content-Type | application/json |
Текст запроса
В тексте запроса предоставьте JSON-объект с указанными ниже параметрами. displayName и isHidden являются единственными записываемыми свойствами для объекта mailFolder .
Параметр | Тип | Описание |
---|---|---|
displayName | String | Отображаемое имя новой папки. |
isHidden | Логический | Указывает, скрыта ли новая папка. Значение по умолчанию — false . Задание свойства является необязательным. После установки этого свойства невозможно обновить. Дополнительные сведения см. в статье Скрытые почтовые папки |
Отклик
В случае успешного выполнения этот метод возвращает 201 Created
код ответа и объект mailFolder в тексте ответа.
Пример
Запрос
Ниже показан пример запроса.
POST https://graph.microsoft.com/beta/me/mailFolders
Content-type: application/json
{
"displayName": "Clutter",
"isHidden": true
}
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 201 Created
Content-type: application/json
{
"id": "hN2Y5OGRhNGYwODEALgAAA0DAKbvJvFhJgcT3lZpkhNQBAA1",
"displayName": "Clutter",
"parentFolderId": "AQMkADlmOGQwZmU3LWVjOWMtNDhiYgAtODcxNy1",
"childFolderCount": 99,
"unreadItemCount": 99,
"totalItemCount": 99,
"wellKnownName": null,
"isHidden": true
}