Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Представляет папку в почтовом ящике пользователя, например "Входящие" или "Черновики". Почтовые папки могут содержать сообщения, другие элементы Outlook и дочерние почтовые папки.
Этот ресурс поддерживает отслеживание добавлений, удалений и обновлений с помощью разностного запроса с функцией delta.
Известные имена папок
Outlook создает определенные папки для пользователей по умолчанию. Для удобства вместо указания соответствующего идентификатора папки можно использовать известные имена папок из таблицы ниже. Например, вы можете получить папку черновиков, использовав ее известное имя со следующим запросом.
GET /me/mailFolders/drafts
Известные имена работают независимо от языкового стандарта почтового ящика пользователя, поэтому предыдущий запрос всегда возвращает папку "Черновики" пользователя, независимо от ее имени.
| Известное имя папки | Описание |
|---|---|
| archive | Папка архива отправляется при использовании функции One-Click Архив в клиентах Outlook, которые ее поддерживают. Примечание. Это свойство отличается от функции "Архив почтового ящика" в Exchange Online. |
| clutter | Папка "Несрочные", в которую перемещаются сообщения низкой важности при использовании функции "Несрочные". |
| conflicts | Папка, содержащая конфликтующие элементы почтового ящика. |
| conversationhistory | Папка, в которой Skype сохраняет беседы при обмене мгновенными сообщениями (если Skype настроен для этого). |
| deleteditems | Элементы папки перемещаются при удалении. |
| drafts | Папка, содержащая неотправленные сообщения. |
| inbox | Папка "Входящие". |
| junkemail | Папка нежелательной почты. |
| localfailures | Папка, содержащая элементы, которые существуют в локальном клиенте, но не могут быть отправлены на сервер. |
| msgfolderroot | Папка "Корневой уровень хранилища". Эта папка является родительской для папок, отображаемых в обычных почтовых клиентах, например в папке "Входящие". |
| outbox | Папка "Исходящие". |
| recoverableitemsdeletions | Папка, содержащая обратимо удаленные элементы: удаленные из папки "Удаленные" или путем нажатия клавиш SHIFT+DELETE в Outlook. Эта папка не отображается ни в одном почтовом клиенте Outlook, но конечные пользователи могут взаимодействовать с ней с помощью функции "Восстановить удаленные элементы с сервера" в Outlook или Outlook в Интернете. |
| scheduled | Папка, содержащая сообщения, запланированные для повторного отображения в папке "Входящие" с помощью функции "Расписание" в Outlook для iOS. |
| searchfolders | Родительская папка для всех папок поиска, определенных в почтовом ящике пользователя. |
| sentitems | Папка "Отправленные". |
| serverfailures | Папка, содержащая элементы, существующие на сервере, но не синхронизированные с локальным клиентом. |
| syncissues | Папка, содержащая журналы синхронизации, созданные в Outlook. |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Список папок поиска почты | Коллекция mailFolder | Получение всех папок почты в указанном почтовом ящике пользователя, включая все папки поиска почты. |
| Получение папки поиска почты | mailFolder | Чтение свойств и связей объекта mailFolder. |
| Создание папки почты | mailFolder | Создание папки почты в корневой папке почтового ящика пользователя. |
| Перечисление дочерних папок | Коллекция mailFolder | Получение коллекции папок в указанной папке. С помощью ярлыка .../me/MailFolders вы можете получить коллекцию папок верхнего уровня и перейти к другой папке. |
| Создание дочерней папки | mailFolder | Создание объекта mailFolder в текущем объекте путем публикации в коллекции элементов childFolder. |
| Создание сообщения в папке | message | Создание сообщения в текущем элементе mailFolder путем его публикации в коллекции сообщений. |
| Перечисление сообщений в папке | Коллекция message | Получение всех сообщений в почтовом ящике пользователя, вошедшего в систему, или в указанной папке почтового ящика. |
| Обновление папки почты | mailFolder | Обновление указанного объекта mailFolder. |
| Удаление папки поиска почты | Нет | Удаление указанного объекта mailFolder. |
| Копирование папки с почтой | mailFolder | Копирование элемента mailFolder и его содержимого в другой элемент mailFolder. |
| Вывод дельты папки | Коллекция mailFolder | Получение набора папок почты, которые были добавлены в почтовый ящик пользователя или удалены из него. |
| Перемещение папки с почтой | mailFolder | Перемещение элемента mailFolder и его содержимого в другой элемент mailFolder. |
| Удалить без возможности восстановления | Нет | Окончательное удаление папки почты и удаление ее элементов из почтового ящика пользователя. |
| Обновить все сообщения состояния чтения | mailFolder | Обновление состояния чтения всех сообщений в объекте mailFolder . |
| Операции со списком | Сбор mailFolderOperation | Список длительных операций с папками объекта mailFolder . |
| Расширенные свойства | ||
| Создание однозначного свойства | mailFolder | Создание одного или нескольких расширенных свойств с одним значением в новом или существующем элементе mailFolder. |
| Получение однозначного свойства | mailFolder | Получение элементов mailFolder, которые содержат расширенное свойство с одним значением, с помощью параметра $expand или $filter. |
| Создание многозначного свойства | mailFolder | Создание одного или нескольких расширенных свойств с несколькими значениями в новом или существующем элементе mailFolder. |
| Получение многозначного свойства | mailFolder | Получение элемента mailFolder, который содержит расширенное свойство с несколькими значениями, с помощью параметра $expand. |
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| childFolderCount | Int32 | Количество непосредственных дочерних элементов mailFolder в текущем элементе mailFolder. |
| displayName | Строка | Отображаемое имя элемента mailFolder. |
| id | Строка | Уникальный идентификатор элемента mailFolder. |
| isHidden | Логический | Указывает, скрыт ли объект mailFolder. Это свойство можно установить только при создании папки. Дополнительные сведения см. в разделе Скрытые папки почты. |
| parentFolderId | Строка | Уникальный идентификатор родительского элемента mailFolder для элемента mailFolder. |
| totalItemCount | Int32 | Количество элементов в элементе mailFolder. |
| unreadItemCount | Int32 | Количество элементов, помеченных как непрочитанные, в элементе mailFolder. |
| wellKnownName | String | Известное имя папки для папки. Возможные значения указаны выше. Это свойство задано только для папок по умолчанию, создаваемых приложением Outlook. Для других папок это свойство равно нулю. |
Эффективный доступ к сведениям о количестве элементов
Используя такие свойства папки, как TotalItemCount и UnreadItemCount, можно удобно вычислять количество прочитанных элементов в папке.
Благодаря им можно не использовать запросы (например, указанный ниже), выполнение которых может привести к значительным задержкам.
https://outlook.office.com/api/beta/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false
Почтовые папки в Outlook могут содержать элементы нескольких типов, например папка "Входящие" может содержать элементы приглашений на собрания, которые отличаются от почтовых сообщений. Свойства TotalItemCount и UnreadItemCount включают элементы из папки почты вне зависимости от их типов.
Скрытые папки почты
Значение свойства isHidden по умолчанию: false. Вы можете задать isHidden только один раз при создании объекта mailFolder. Свойство нельзя обновить с помощью операции PATCH. Чтобы изменить свойство isHidden папки, удалите существующую папку и создайте новую с нужным значением.
Скрытые папки почты поддерживают все операции, поддерживаемые обычной почтовой папкой.
По умолчанию при указании mailFolders возвращаются только те папки, которые не скрыты. Чтобы включить скрытые папки почты в отклик, используйте параметр запроса includeHiddenFolders=true. Затем используйте свойство isHidden, чтобы определить, скрыта ли папка почты.
Связи
| Связь | Тип | Описание |
|---|---|---|
| childFolders | Коллекция mailFolder | Коллекция дочерних папок в mailFolder. |
| messageRules | Коллекция messageRule | Коллекция правил, которые применяются к папке пользователя "Входящие". |
| messages | Коллекция message | Коллекция сообщений в mailFolder. |
| multiValueExtendedProperties | Коллекция multiValueLegacyExtendedProperty | Коллекция многозначных расширенных свойств, определенных для mailFolder. Только для чтения. Допускается значение null. |
| operations | Сбор mailFolderOperation | Коллекция длительных операций в mailFolder. |
| singleValueExtendedProperties | Коллекция singleValueLegacyExtendedProperty | Коллекция расширенных свойств с одним значением, определенных для mailFolder. Только для чтения. Допускается значение null. |
| userConfigurations | Коллекция userConfiguration | Объекты конфигурации пользователя, связанные с mailFolder. |
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"childFolderCount": 1024,
"displayName": "string",
"id": "string (identifier)",
"parentFolderId": "string",
"totalItemCount": 1024,
"unreadItemCount": 1024,
"wellKnownName": "string",
"isHidden": false,
"childFolders": [ { "@odata.type": "microsoft.graph.mailFolder" } ],
"messageRules": [ { "@odata.type": "microsoft.graph.messageRule" } ],
"messages": [ { "@odata.type": "microsoft.graph.message" } ],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }]
}