Тип ресурса mailFolder

  • Статья

Пространство имен: microsoft.graph

Почтовая папка в почтовом ящике пользователя, например "Входящие" или "Черновики". Почтовые папки могут содержать сообщения, другие элементы Outlook и дочерние почтовые папки.

Этот ресурс поддерживает отслеживание добавлений, удалений и обновлений с помощью разностного запроса с функцией delta.

Известные имена папок

Outlook создает определенные папки для пользователей по умолчанию. Для удобства вместо значения id для доступа к папкам можно использовать известные имена папок из таблицы ниже. Например, вы можете получить папку черновиков, использовав ее известное имя со следующим запросом.

GET /me/mailFolders/drafts

Известные имена работают независимо от языкового стандарта почтового ящика пользователя, поэтому приведенный выше запрос всегда вернет папку "Черновики" пользователя независимо от того, как она называется.

Известное имя папки Описание
archive Архивная папка, в которую отправляются сообщения при использовании функции архивации одним щелчком в клиентах 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.
Создание объекта mailFolder mailFolder Создание папки почты в корневой папке почтового ящика пользователя.
Вывод списка объектов childFolder Коллекция MailFolder Получение коллекции папок в указанной папке. С помощью ярлыка .../me/MailFolders вы можете получить коллекцию папок верхнего уровня и перейти к другой папке.
Создание объекта childFolder mailFolder Создание объекта mailFolder в текущем объекте путем публикации в коллекции элементов childFolder.
Создание сообщения Message Создание сообщения в текущем элементе mailFolder путем его публикации в коллекции сообщений.
Вывод списка сообщений Коллекция объектов Message Получение всех сообщений в почтовом ящике пользователя, вошедшего в систему, или в указанной папке почтового ящика.
Обновление mailFolder Обновление указанного объекта mailFolder.
Удаление Нет Удаление указанного объекта mailFolder.
copy MailFolder Копирование элемента mailFolder и его содержимого в другой элемент mailFolder.
delta Коллекция mailFolder Получение набора папок почты, которые были добавлены в почтовый ящик пользователя или удалены из него.
move MailFolder Перемещение элемента mailFolder и его содержимого в другой элемент mailFolder.
Расширенные свойства
Создание однозначного расширенного свойства mailFolder Создание одного или нескольких расширенных свойств с одним значением в новом или существующем элементе mailFolder.
Получение элемента mailFolder с расширенным свойством с одним значением mailFolder Получение элементов mailFolder, которые содержат расширенное свойство с одним значением, с помощью параметра $expand или $filter.
Создание расширенного свойства с несколькими значениями mailFolder Создание одного или нескольких расширенных свойств с несколькими значениями в новом или существующем элементе mailFolder.
Получение элемента mailFolder с расширенным свойством с несколькими значениями mailFolder Получение элемента mailFolder, который содержит расширенное свойство с несколькими значениями, с помощью параметра $expand.

Свойства

Свойство Тип Описание
childFolderCount Int32 Количество непосредственных дочерних элементов mailFolder в текущем элементе mailFolder.
displayName Строка Отображаемое имя элемента mailFolder.
id Строка Уникальный идентификатор элемента mailFolder.
isHidden Логический Указывает, скрыт ли объект mailFolder. Это свойство можно установить только при создании папки. Дополнительные сведения см. в разделе Скрытые папки почты.
parentFolderId Строка Уникальный идентификатор родительского элемента mailFolder для элемента mailFolder.
totalItemCount Int32 Количество элементов в элементе mailFolder.
unreadItemCount Int32 Количество элементов, помеченных как непрочитанные, в элементе mailFolder.

Эффективный доступ к сведениям о количестве элементов

Используя такие свойства папки, как TotalItemCount и UnreadItemCount, можно удобно вычислять количество прочитанных элементов в папке. Благодаря им можно не использовать запросы (например, указанный ниже), выполнение которых может привести к значительным задержкам.

https://graph.microsoft.com/v1.0/me/mailFolders/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.
singleValueExtendedProperties Коллекция singleValueLegacyExtendedProperty Коллекция расширенных свойств с одним значением, определенных для элемента mailFolder. Только для чтения. Допускается значение null.

Представление JSON

В следующем представлении JSON показан тип ресурса.

{
  "childFolderCount": 1024,
  "displayName": "string",
  "id": "string (identifier)",
  "parentFolderId": "string",
  "totalItemCount": 1024,
  "unreadItemCount": 1024,
  "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" }]
}

Связанные материалы