Ссылка на ресурсы REST API почты, календаря, контактов и задач (предварительная версия)

Область применения: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Примечание

Эта документация распространяется на новые или измененные ресурсы, которые имеют отметку «(предварительная версия)» и предназначены для нескольких мест возникновения событий, общего доступа к календарю, @-упоминаний, быстрых ответов, выбора языка, а также часового пояса. До выпуска окончательной версии предварительные версии функций могут измененяться, нарушая код, который их использует. Поэтому в своем производственном коде вы должны использовать только производственную версию API. Версия 2.0 в настоящее время является предпочтительной, если она доступна.

В этой статье описываются объекты, свойства, сложные типы и перечисления REST API, а также параметры запросов OData, которые можно использовать с API почты, календаря, контактов и задач в Outlook, чтобы получить доступ к данным почтового ящика пользователя в Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com и Passport.com.

Примечание

Для упрощения справочной информации в остальной части этой статьи при упоминании «Outlook.com» также подразумеваются и эти домены учетной записи Microsoft.

Дополнительные сведения, общие для всех подразделов API REST Outlook, см. в разделе Использование API REST Outlook.

Не интересуетесь бета-версией API? В оглавлении, слева, перейдите к разделу Справка по API REST Office 365 и выберите нужную версию.

Совет

Вы можете просмотреть полный документ метаданных для модели данных таких объектов, как почта, календарь, контакты и задача, перейдя в конечную точку $metadata в веб-обозревателе (пример: https://outlook.office.com/api/beta/$metadata).

Attachment

Файл, элемент (контакт, событие или сообщение) или ссылка на файл либо папку, которая прикреплена к мероприятию, сообщению или задаче. Соответствующие ресурсы fileAttachment, itemAttachment и referenceAttachment являются производными ресурса Attachment.

Тип: Microsoft.OutlookServices.Entity

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
ContentType	Строка	Тип MIME вложения.	Да	Нет
IsInline	Логическое	true если вложение является встроенным; в противном случае, false.	Да	Да
LastModifiedDateTime	DateTimeOffset	Дата и время последнего изменения вложения. Для даты и времени используется формат ISO 8601, и они всегда представляют собой время UTC. Так, к примеру, полночь 1 января 2014 г. в формате UTC будет выглядеть следующим образом: «2014-01-01T00:00:00Z»	Нет	Да
Name	Строка	Отображаемое имя вложения. Его совпадение с фактическим именем файла не обязательно.	Да	Да
Size	Int32	Размер вложения в байтах.	Нет	Нет

Calendar

Календарь, представляющий собой контейнер для событий.

Тип: Microsoft.OutlookServices.Calendar

Коллекция Calendar возвращает массив календарей в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/calendars/$count

Информацию о поддерживаемых действиях см. в статье Операции календаря.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
CanEdit	Логическое	Значение true, если пользователь может вносить изменения в календарь, в противном случае — значение false. Это свойство имеет значение true для пользователя, создавшего календарь. Это свойство также имеет значение true для пользователей, которые совместно используют календарь и имеют доступ на запись.	Нет	Да
CanShare	Логическое	Значение true, если у пользователя есть разрешение на совместное использование календаря, в противном случае — значение false. Только пользователь, создавший календарь, может предоставлять общий доступ к нему.	Нет	Да
CanViewPrivateItems	Логическое	Значение — true, если пользователь может читать элементы календаря, которые были помечены как частные, в противном случае, значение false.	Нет	Да
ChangeKey	Строка	Определяет версию объекта календаря. При каждом изменении календаря свойство ChangeKey также меняется. Это позволяет Exchange применять изменения к правильной версии объекта.	Нет	Нет
Color	CalendarColor	Задает цветовую тему, отличающую этот календарь от других календарей в пользовательском интерфейсе. Значения свойств: LightBlue = 0, LightGreen = 1, LightOrange = 2, LightGray = 3, LightYellow = 4, LightTeal = 5, LightPink = 6, LightBrown = 7, LightRed = 8, MaxColor = 9, Auto = -1.	Да	Да
Id	Строка	Уникальный идентификатор календаря.	Нет	Нет
IsDefaultCalendar	Логическое	Значение true, если этот календарь является календарем пользователя по умолчанию, в противном случае, значение false.	Да	Да
IsShared	Логическое	Значение true, если пользователь предоставил общий доступ к календарю, в противном случае — значение false. Поскольку общий доступ к календарю может предоставить только создавший его пользователь, свойства IsShared и IsSharedWithMe не могут иметь значение true для одного и того же пользователя.	Нет	Да
IsSharedWithMe	Логическое	Значение true, если пользователю предоставлен общий доступ к этому календарю, в противном случае — значение false. Это свойство всегда имеет значение false для владельца календаря.	Нет	Да
Name	Строка	Имя календаря.	Да	Да
Owner	EmailAddress	Если задано, это свойство представляет пользователя, создавшего или добавившего календарь. Для календаря, который пользователь создал или добавил, свойство Владелец свойство задано пользователю. Для календаря, совместно используемого с другим пользователем, свойство Owner присваивается тому, кто предоставил этому пользователю общий доступ к календарю.	Нет	Да
CalendarView	Коллекция (Event)	Представление календаря для календаря. Свойство навигации.	Нет	Нет
Events	Коллекция (Event)	События в календаре. Свойство навигации.	Нет	Нет
MultiValueExtendedProperties	Коллекция	Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да
SingleValueExtendedProperties	Коллекция	Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да

CalendarGroup

Группа календарей.

Примечание

Outlook.com поддерживает только группу календарей по умолчанию, доступ к которой осуществляется с помощью ярлыка ../me/calendars. Удалить эту группу календарей невозможно.

Тип: Microsoft.OutlookServices.CalendarGroup

Коллекция CalendarGroup возвращает массив групп календарей в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/calendargroups/$count

См. Операции CalendarGroup для получения информации о поддерживаемых действиях.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
Name	Строка	Имя группы.	Да	Да
ChangeKey	Строка	Идентифицирует версию группы календарей. При каждом изменении группы календарей свойство ChangeKey также меняется. Это позволяет Exchange применять изменения к правильной версии объекта.	Нет	Нет
ClassId	Строка	Идентификатор класса.	Нет	Да
Id	Строка	Уникальный идентификатор группы календарей.	Нет	Нет
Calendars	Коллекция (Calendar)	Календари в группе календарей. Свойство навигации.	Нет	Нет

Contact

Контакт, который является элементом Outlook и позволяет пользователям упорядочить и сохранить информацию о людях и организациях, с которыми они общаются. Контакты содержатся в папках контактов.

Тип: Microsoft.OutlookServices.Contact

Коллекция Contact возвращает массив контактов в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/contacts/$count

Информацию о поддерживаемых действиях см. в статье Операции с контактами.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
AssistantName	Строка	Имя помощника контакта.	Да	Да
Birthday	datetimeoffset	Дата рождения контакта.	Да	Да
Categories	Коллекция (Строка)	Категории, связанные с контактом.	Да	Нет
ChangeKey	Строка	Идентифицирует версию контакта. При каждом изменении контакта свойство ChangeKey также меняется. Это позволяет Exchange применять изменения к правильной версии объекта.	Нет	Нет
Children	Коллекция (Строка)	Имена детей контакта.	Да	Да
CompanyName	Строка	Название компании контакта.	Да	Да
CreatedDateTime	datetimeoffset	Время создания контакта.	Нет	Да
Department	Строка	Отдел контакта.	Да	Да
DisplayName	Строка	Отображаемое имя контакта.	Да	Да
EmailAddresses	Коллекция (EmailAddress)	Адреса электронной почты контакта.	Да	Нет
Extensions	Коллекция (Extension)	Коллекция модулей обработки данных открытого типа, определенных для контакта. Свойство навигации.	Нет	Да
FileAs	Строка	Имя, под которым хранится контакт.	Да	Да
Flag	FollowupFlag	Информация о любых подписках на данный контакт.	Да	Да
Gender	Строка	Пол контакта.	Да	Да
Generation	Строка	Поколение контакта.	Да	Да
GivenName	Строка	Имя контакта.	Да	Да
Id	Строка	Уникальный идентификатор контакта.	Нет	Нет
ImAddresses	Коллекция (Строка)	Адреса контакта для обмена мгновенными сообщениями.	Да	Нет
Initials	Строка	Инициалы контакта.	Да	Да
JobTitle	Строка	Должность контакта.	Да	Да
LastModifiedDateTime	datetimeoffset	Время изменения контакта.	Нет	Да
Руководитель	Строка	Имя руководителя контакта.	Да	Да
MiddleName	Строка	Отчество контакта.	Да	Да
NickName	Строка	Псевдоним контакта.	Да	Да
OfficeLocation	Строка	Расположение офиса контакта.	Да	Да
ParentFolderId	Строка	Идентификатор родительской папки контакта.	Нет	Нет
PersonalNotes	Строка	Заметки пользователя о контакте.	Да	Да
Phones	Collection(Phone)	Телефонные номера, связанные с контактом, например, домашний телефон, мобильный телефон и рабочий телефон.	Да	Да
PostalAddresses	Коллекция PhysicalAddress	Адреса, связанные с контактом, например, домашний адрес и рабочий адрес.	Да	Нет
Profession	Строка	Профессия контакта.	Да	Да
SpouseName	Строка	Имя супруга или супруги контакта.	Да	Да
Surname	Строка	Фамилия контакта.	Да	Да
Title	Строка	Форма обращения к контакту.	Да	Нет
Websites	Коллекция (Website)	Веб-сайты, связанные с контактом.	Да	Нет
WeddingAnniversary	Дата	Годовщина свадьбы контакта.	Да	Да
YomiCompanyName	Строка	Название компании контакта, записанное так, как оно звучит по-японски. Это необязательное свойство.	Да	Нет
YomiGivenName	Строка	Имя контакта, записанное так, как оно звучит по-японски. Это необязательное свойство.	Да	Нет
YomiSurname	Строка	Фамилия контакта, записанная так, как она звучит по-японски. Это необязательное свойство.	Да	Нет

Свойства навигации MultiValueExtendedProperties и SingleValueExtendedProperties также доступны для данного ресурса и используются для представления коллекций соответствующих типов расширенных свойств, определенных для экземпляра ресурса. Для получения дополнительной информации см. Расширенные свойства REST API.

ContactFolder

Папка, содержащая контакты.

Тип: Microsoft.OutlookServices.ContactFolder

Коллекция ContactFolder возвращает массив папок контактов в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/contactfolders/$count

См. информацию о поддерживаемых действиях в статье Операции с ContactFolder.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
ChildFolders	Collection(ContactFolder)	Коллекция дочерних папок в папке. Свойство навигации.	Нет	Нет
Contacts	Коллекция (Contact)	Контакты в папке. Свойство навигации.	Нет	Нет
DisplayName	Строка	Отображаемое имя папки.	Да	Да
Id	Строка	Уникальный идентификатор папки с контактами.	Нет	Нет
ParentFolderId	Строка	Идентификатор родительской папки для папки.	Нет	Нет
WellKnownName	Строка	Имя папки, если папка является распознаваемой. В настоящее время contacts является единственной распознаваемой папкой с контактами.	Нет	Нет
MultiValueExtendedProperties	Коллекция	Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да
SingleValueExtendedProperties	Коллекция	Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да

Event

Событие в календаре.

Тип: Microsoft.OutlookServices.Event

Коллекция Event возвращает массив событий в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/events/$count

Информацию о поддерживаемых действиях см. в статье Операции с событиями.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
Attachments	Коллекция (Attachment)	Коллекция вложений FileAttachment, ItemAttachment и ReferenceAttachment для события. Свойство навигации.	Нет	Нет
Attendees	Коллекция (Attendee)	Коллекция участников события.	Да	Нет
Body	ItemBody	Текст сообщения, связанного с событием.	Да	Нет
BodyPreview	Строка	Предварительный просмотр сообщения, связанного с событием.	Нет	Нет
Calendar	Calendar	Календарь, содержащий событие. Свойство навигации.	Нет	Нет
Categories	Коллекция (Строка)	Категории, связанные с событием.	Да	Нет
ChangeKey	Строка	Указывает версию объекта события. При каждом изменении события также меняется значение ChangeKey. Благодаря этому Exchange может применять изменения к правильной версии объекта.	Нет	Нет
CreatedDateTime	datetimeoffset	Дата и время создания события.	Нет	Да
End	DateTimeTimeZone	Дата и время завершения события.	Да	Да
Extensions	Коллекция (Extension)	Коллекция модулей обработки данных открытого типа, определенных для события. Свойство навигации.	Нет	Да
HasAttachments	Логическое	Задайте значение true, если у события есть вложения.	Нет	Да
Id	Строка	Уникальный идентификатор события.	Нет	Нет
Importance	Importance	Важность события: Low, Normal, High.	Да	Да
Instances	Коллекция (Event)	Экземпляры события. Свойство навигации.	Нет	Нет
iCalUID	Строка	Уникальный идентификатор, совместно используемый всеми экземплярами события в разных календарях.	Нет	Да
IsAllDay	Логическое	Задайте значение true, если событие длится весь день. Для настройки этого свойства необходимо настроить свойства Start и End события.	Да	Да
IsCancelled	Логическое	Задайте значение true, если событие отменено.	Да	Да
IsOrganizer	Логическое	Задайте значение true, если отправитель сообщения также является его организатором.	Да	Да
IsReminderOn	Логическое	Задайте значение true, если установлено напоминание пользователю о событии.	Да	Да
LastModifiedDateTime	datetimeoffset	Дата и время последнего изменения события.	Нет	Да
Location	Location	Информация о расположении мероприятия.	Да	Да
Locations	Коллекция (Location)	Места проведения мероприятия или участия в нем.	Да	Да
OnlineMeetingUrl	Строка	URL-адрес для собрания по сети.	Да	Нет
Organizer	Recipient	Организатор события.	Да	Да
OriginalEndTimeZone	Строка	Часовой пояс завершения события, указанный во время его создания. Для получения списка допустимых часовых поясов см. DateTimeTimeZone.	Нет	Да
OriginalStartTimeZone	Строка	Часовой пояс начала события, указанный при его создании. Для получения списка допустимых часовых поясов см. DateTimeTimeZone.	Нет	Да
Recurrence	PatternedRecurrence	Расписание повторения события.	Да	Нет
ReminderMinutesBeforeStart	Int32	Позволяет указать, за сколько минут до начала события появляется напоминание.	Да	Нет
ResponseRequested	Логическое	Задайте значение true, если отправитель желает получить сообщение о согласии участвовать в событии или отклонении соответствующего приглашения.	Да	Да
ResponseStatus	ResponseStatus	Указывает тип отклика, отправленного в ответ на сообщение о событии.	Нет	Да
Sensitivity	Sensitivity	Характеризует уровень конфиденциальности события: Normal, Personal, Private, Confidential.	Да	Да
SeriesMasterId	Строка	Категории, назначенные элементу.	Да	Нет
ShowAs	FreeBusyStatus	Состояние для отображения: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.	Да	Да
Start	DateTimeTimeZone	Время начала события.	Да	Да
Subject	Строка	Текст в строке темы события.	Да	Да
Type	EventType	Тип события: SingleInstance, Occurrence, Exception, SeriesMaster.	Да	Да
WebLink	Строка	URL-адрес для открытия события в Outlook Web App. Событие откроется в браузере, если вы вошли в свой почтовый ящик с помощью Outlook Web App. Если вход с помощью браузера еще не выполнен, вам будет предложено войти. Доступ к этому URL-адресу можно получить из объекта iFrame.	Нет	Нет

Свойства навигации MultiValueExtendedProperties и SingleValueExtendedProperties также доступны для данного ресурса и используются для представления коллекций соответствующих типов расширенных свойств, определенных для экземпляра ресурса. Для получения дополнительной информации см. Расширенные свойства REST API.

EventMessage

Сообщение, которое представляет собой приглашение на собрание, сообщение об отмене собрания, сообщение о принятии приглашения на собрание, сообщение о том, что посещение собрания остается под вопросом, или сообщение об отказе участвовать в собрании.

Базовый тип: Message

Экземпляр EventMessage обычно находится в папке «Входящие», где он появляется в результате создания собрания организатором события или в результате ответа участника на приглашение на собрание. Вы воздействуете на сообщения о событиях так же, как и на тип Message, с некоторыми незначительными отличиями, описанными в следующей таблице.

Действие/команда	Permission	Описание
Создать сообщение о событии (POST)	Н/Д	Запрещено. В результате отобразится код отклика 400.
Обновить сообщение события (PATCH)	Mail.Write	Вы можете обновить свойства From, Sender, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Subject, Body, Importance и Categories.
Удалить сообщение события (DELETE)	Mail.Write	То же действие, что и для Message.
Переместить сообщение события (POST)	Mail.Write	То же действие, что и для Message.
Копировать сообщение события (POST)	Mail.Write	То же действие, что и для Message.
Создать черновик ответного сообщения (POST)	Mail.Write	То же действие, что и для Message.
Создать черновик ответного сообщения для всех (POST)	Mail.Write	То же действие, что и для Message.
Создать ответ (POST)	Mail.Write	То же действие, что и для Message.
Создать ответ всем (POST)	Mail.Write	То же действие, что и для Message.
Отправить существующее сообщение события (POST)	Mail.Write	Вы можете отправлять сообщение события, только когда свойство IsDraft имеет значение true. Копия сообщения сохраняется в папке «Отправленные».
Создать черновик сообщения переадресации события	Mail.Write	То же действие, что и для Message.
Переадресовать сообщение события	Mail.Write	То же действие, что и для Message.

Экземпляр EventMessage включает в себя свойства базового типа Message, а также свойства, перечисленные в следующей таблице.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
EndDateTime	DateTimeTimeZone	Дата и время окончания связанного события.	Да	Да
Event	Event	Событие, связанное с сообщением о событии. Предположение для посетителей или ресурсов комнаты заключается в том, что для помощника по ведению календаря установлено автоматическое обновление календаря событием при поступлении сообщений на событие запроса собрания. Свойство навигации.	Нет	Нет
IsAllDay	Логическое	Указывает, длится ли событие весь день. Для настройки этого свойства необходимо также настроить свойства события StartDateTime и EndDateTime.	Да	Да
IsOutOfDate	Логическое	Указывает, устарел ли этот запрос на собрание в результате появления более нового запроса.	Нет	Нет
Location	Location	Место проведения связанного события.	Да	Да
MeetingMessageType	MeetingMessageType	Тип сообщения о событии: None = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5	Нет	Да
Recurrence	PatternedRecurrence	Расписание повторения связанного события.	Да	Нет
StartDateTime	DateTimeTimeZone	Время начала связанного события.	Да	Да
Type	EventType	Тип связанного события: SingleInstance = 0, Occurrence = 1, Exception = 2, SeriesMaster = 3.	Да	Да

EventMessageRequest (предварительная версия)

Сообщение, представляющее собой приглашение на собрание.

Базовый тип: EventMessage

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
PreviousEndDateTime	DateTimeTimeZone	Предыдущие дата и время окончания запрашиваемого собрания.	Нет	Да
PreviousLocation	Location	Предыдущее расположение запрашиваемого собрания.	Нет	Да
PreviousStartDateTime	DateTimeTimeZone	Предыдущие дата и время начала запрашиваемого собрания.	Нет	Да

Расширенные свойства

Настраиваемое свойство для объекта можно создать в виде MultiValueLegacyExtendedProperty или SingleValueLegacyExtendedProperty, в зависимости от значений, предназначенных для этого свойства.

MultiValueLegacyExtendedProperty

Расширенное свойство, которое может содержать коллекцию, состоящую из нескольких значений.

Тип: Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
Value	Коллекция (Строка)	Коллекция значений свойств.	Да	Нет
PropertyId	Строка	Идентификатор свойства. Используется для идентификации свойства.	Нет	Нет

SingleValueLegacyExtendedProperty

Расширенное свойство, содержащее одно значение.

Тип: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
Value	Строка	Значение свойства.	Да	Нет
PropertyId	Строка	Идентификатор свойства. Используется для идентификации свойства.	Нет	Да

При создании расширенного свойства PropertyId можно задать различными способами. Для получения дополнительной информации см. Форматы PropertyId.

См. Справку по расширенным свойствам REST API, чтобы больше узнать о соответствующих операциях, которые можно использовать.

FileAttachment

Файл (например, текстовый файл или документ Word), прикрепленный к сообщению, событию или задаче. Свойство ContentBytes включает содержимое файла в кодировке base64. Производится из объекта Attachment.

Тип: Microsoft.OutlookServices.FileAttachment

Базовый тип: Microsoft.OutlookServices.Attachment

Свойство	Type	Описание	Подлежит записи?
ContentBytes	Двоичное	Двоичное содержимое файла.	Нет
ContentId	Строка	Идентификатор вложения в хранилище Exchange.	Нет
ContentLocation	Строка	Универсальный код ресурса (URI), который соответствует расположению содержимого вложения.	Нет
ContentType	Строка	Тип содержимого этого вложения.	Да
LastModifiedDateTime	datetimeoffset	Дата и время последнего изменения вложения.	Нет
Id	Строка	Идентификатор вложения.	Нет
IsInline	Логическое	Значение true задается, если вложение является встроенным.	Да
Name	Строка	Имя, представляющее текст, который отображается под значком, представляющим внедренное вложение. Оно может не быть фактическим именем файла.	Да
Size	Int32	Размер вложения в байтах.	Нет

Folder / MailFolder

Примечание

В бета-версии сущность и тип, ранее известные под названием Folder, были переименованы в MailFolder.

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

Тип: Microsoft.OutlookServices.MailFolder

Коллекция MailFolders возвращает массив папок в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/folders/$count

Информацию о поддерживаемых действиях см. в статье Операции с папками.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
ChildFolderCount	Int32	Количество папок, содержащихся в папке.	Нет	Да
ChildFolders	Коллекция(MailFolder)	Коллекция дочерних папок в папке. Свойство навигации.	Нет	Нет
DisplayName	Строка	Отображаемое имя папки.	Да	Да
Id	Строка	Уникальный идентификатор папки. Для доступа к соответствующим папками могут использоваться следующие распространенные имена: Входящие, Черновики, Отправленные, Удаленные.	Нет	Нет
MessageRules	Коллекция(MessageRule)	Коллекция правил, которые применяются к папке «Входящие». Свойство навигации.	Нет	Нет
Messages	Коллекция (Message)	Коллекция сообщений в папке. Свойство навигации.	Нет	Нет
ParentFolderId	Строка	Уникальный идентификатор папки, являющейся родительской для папки.	Нет	Нет
TotalItemCount	Int32	Количество элементов в папке.	Нет	Да
UnreadItemCount	Int32	Количество элементов в папке, помеченных как непрочитанные.	Нет	Да
WellKnownName	Строка	Распространенное имя папки, например clutter, deleteditems, drafts, inbox, junkemail, outbox или sentitems.	Нет	Да
MultiValueExtendedProperties	Коллекция	Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да
SingleValueExtendedProperties	Коллекция	Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да

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

Свойства TotalItemCount и UnreadItemCount папки позволяют без труда определить количество прочитанных элементов в папке. Они позволяют избежать подачи запросов, подобных тем, которые приводятся ниже, и которые могут вызывать значительную задержку:

https://outlook.office.com/api/beta/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false

Папки в Outlook могут содержать несколько типов элементов, например, папка «Входящие» может содержать элементы, представляющие собой приглашение на собрание, которые отличаются от элементов почты. Свойства TotalItemCount и UnreadItemCountучитывают содержащиеся в папке элементы независимо от их типа.

InferenceClassification

Классификация сообщений пользователя, позволяющая сосредоточиться на самых важных сообщениях.

Тип: Microsoft.OutlookServices.InferenceClassification

Свойство	Type	Описание	Подлежит записи?
Overrides	Коллекция (InferenceClassificationOverride)	Набор переопределений для того, чтобы пользователь всегда классифицировал сообщения от определенных отправителей определенным образом в соответствии с возможностями типа InferenceClassificationType. Свойство навигации.	Да

InferenceClassificationOverride

Характеризует пользовательское переопределение того, как должны классифицироваться входящие сообщения от определенного отправителя.

Тип: Microsoft.OutlookServices.InferenceClassificationOverride

Свойство	Type	Описание	Подлежит записи?
ClassifyAs	InferenceClassificationType	Указывает, как должны классифицироваться все входящие сообщения от определенного отправителя. Важное = 0, Другое = 1.	Да
Id	Строка	Уникальный идентификатор переопределения.	Нет
SenderEmailAddress	EmailAddress	Сведения об адресе электронной почты отправителя, для которого создается переопределение.	Да

ItemAttachment

Сообщение, контакт или событие, прикрепленное к другому сообщению, событию или задаче. Производится из объекта Attachment.

Тип: Microsoft.OutlookServices.ItemAttachment

Базовый тип: Microsoft.OutlookServices.Attachment

Свойство	Type	Описание	Подлежит записи?
ContentType	Строка	Тип содержимого этого вложения.	Да
LastModifiedDateTime	datetimeoffset	Время и дата последнего изменения вложения.	Нет
Id	Строка	Идентификатор вложения.	Нет
Item	Item	Вложенное сообщение или событие. Свойство навигации.	Да
IsInline	Логическое	Значение true указывает на то, что вложение является встроенным, например, представляет собой встроенное изображение в теле элемента.	Да
Name	Строка	Отображаемое имя вложения.	Да
Size	Int32	Размер вложения в байтах.	Да

Mention (предварительная версия)

Характеризует уведомление, которое отправляется пользователю, исходя из его адреса электронной почты. Этот тип уведомлений также называется @-упоминанием.

Ресурс Message поддерживает Mention. Он включает свойство MentionsPreview, которое указывает, упомянут ли вошедший пользователь в этом экземпляре, а также свойство навигации Mentions, поддерживающее получение сведений любого упоминания этого экземпляра.

При создании сообщения приложение может создавать упоминание в том же запросе POST, включив упоминание в свойстве Mentions. При использовании запроса GET с параметром $filter приложение может возвращать все сообщения почтового ящика вошедшего в систему пользователя, в которых упоминается пользователь. Запрос GET с параметром $expand позволяет приложению развернуть все упоминания в определенном сообщении.

Данный механизм, предоставляющий приложению возможность задавать и получать упоминания в сообщениях, обеспечивает передачу небольших по размеру уведомлений, которые могут оставляться пользователем, создающим упоминание, в существующем контексте (например, в составе текста сообщения) до настройки приложением базового свойства Mentions. Упомянутые лица могут легко узнать, упоминаются ли они, и где это происходит, с помощью запросов GET с параметром $filter или $expand.

Пример варианта использования API Mentions представлен в почтовом клиенте Outlook. Когда пользователь вводит @ при написании сообщения, Outlook позволяет пользователю просто выбрать или ввести имя для завершения @-упоминания без необходимости выходить из контекста для привлечения внимания нужного лица. В это время Outlook настраивает свойство Mentions перед фактическим созданием и отправкой сообщения. Outlook также использует операции GET с параметрами $filter и $expand, что позволяет вошедшему в систему пользователю найти, в каких сообщениях упоминается (если упоминется) определенный пользователь, и привлечь его внимание к определенным действиям или обсуждениям для более быстрого получения ответа.

Тип: Microsoft.OutlookServices.Mention

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
Application	Строка	Название приложения, в котором создано упоминание. Необязательно. Не используется и по умолчанию имеет значение null для Message.	Да	Нет
ClientReference	Строка	Уникальный идентификатор, характеризующий родительский объект экземпляра ресурса. Необязательно. Не используется и по умолчанию имеет значение null для Message.	Да	Да
CreatedBy	EmailAddress	Информация об электронной почте пользователя, сделавшего упоминание. Обязательно.	Да	Нет
CreatedDateTime	DateTimeOffset	Дата и время создания упоминания в клиенте.	Нет	Нет
DeepLink	Строка	Глубокая веб-ссылка на контекст упоминания в экземпляре ресурса. Необязательно. Не используется и по умолчанию имеет значение null для Message.	Да	Нет
Id	Строка	Уникальный идентификатор упоминания в экземпляре ресурса.	Нет	Нет
Mentioned	EmailAddress	Информация об электронной почте упомянутого пользователя. Обязательно.	Да	Нет
MentionText	Строка	Содержимое упоминания. Необязательно. Не используется и по умолчанию имеет значение null для Message.	Да	Нет
ServerCreatedDateTime	DateTimeOffset	Дата и время создания упоминания на сервере. Необязательно. Не используется и по умолчанию имеет значение null для Message.	Нет	Нет

Message

Сообщение в папке почтового ящика.

Тип: Microsoft.OutlookServices.Message

Коллекция Message возвращает массив сообщений в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/messages/$count

Информацию о поддерживаемых действиях см. в статье Операции с сообщениями.

Свойство	Type	Описание	Доступно для записи?	Фильтрующееся?	Доступно для поиска?
Attachments	Коллекция (Attachment)	Вложения FileAttachment и ItemAttachment сообщения. Свойство навигации.	Да	Нет	Да
BccRecipients	Коллекция (Recipient)	Получатели скрытой копии сообщения.	Да	Нет	Да
Body	ItemBody	Текст сообщения.	Да	Нет	Default (По умолчанию)
BodyPreview	Строка	Первые 255 символов, входящих в состав текста сообщения.	Нет	Нет	Да
Categories	Коллекция (String)	Категории, связанные с сообщением.	Да	Да	Да
CcRecipients	Коллекция (Recipient)	Получатели копии сообщения.	Да	Нет	Да
ChangeKey	Строка	Версия сообщения.	Нет	Нет	Нет
ConversationId	Строка	Идентификатор беседы, которой принадлежит электронное сообщение.	Нет	Да	Нет
ConversationIndex	Двоичный	Указывает на относительное положение элемента в беседе, которой принадлежит электронное сообщение.	Нет	Нет	Нет
CreatedDateTime	datetimeoffset	Дата и время создания сообщения.	Нет	Да	Нет
Extensions	Коллекция (Extension)	Коллекция модулей обработки данных открытого типа, определенных для сообщения. Свойство навигации.	Нет	Да	Нет
Flag	FollowupFlag	Информация о любых дальнейших действиях в отношении сообщения.	Да	Да	Да
From	Recipient	Владелец почтового ящика и отправитель сообщения.	Да	Да	Да
HasAttachments	Логическое	Указывает на наличие вложений в сообщении.	Нет	Да	Да
Id	Строка	Уникальный идентификатор сообщения.	Нет	Нет	Нет
Importance	Importance	Важность сообщения: Низкая = 0, Нормальная = 1, Высокая = 2.	Да	Да	Да
InferenceClassification	InferenceClassificationType	Классификация сообщения для пользователя, основанная на предполагаемой релевантности или важности, либо на явном переопределении.	Да	Да	Нет
InternetMessageId	Строка	Идентификатор сообщения в формате, определенном RFC2822.	Нет	Нет	Нет
InternetMessageHeaders	Коллекция(InternetMessageHeader)	Коллекция заголовков интернет-сообщений в формате, определенном RFC2822.	Нет	Нет	Нет
IsDeliveryReceiptRequested	Логическое	Указывает, запрашивается ли уведомление о прочтении сообщения.	Да	Да	Нет
IsDraft	Логическое	Указывает, является ли сообщение черновиком. Сообщение считается черновиком, если оно еще не отправлено.	Нет	Да	Нет
IsRead	Логическое	Указывает, прочитано ли сообщение.	Да	Да	Нет
IsReadReceiptRequested	Логическое	Указывает, запрашивается ли уведомление о прочтении сообщения.	Да	Да	Нет
LastModifiedDateTime	datetimeoffset	Дата и время последнего изменения сообщения.	Нет	Да	Нет
Mentions	Коллекция (Mention)	Коллекция упоминаний в сообщении, упорядоченных по свойствуCreatedDateTime от самого нового до самого старого. По умолчанию сообщение GET не возвращает данное свойство, пока для свойства не применен параметр $expand. Свойство навигации.	Да	Нет	Нет
MentionsPreview	MentionsPreview	Информация об упоминаниях в сообщении. При обработке запроса GET /messages сервер устанавливает это свойство и включает его в ответ по умолчанию. Сервер возвращает null, если в сообщении нет упоминаний. Необязательно.	Нет	Нет	Нет
MultiValueExtendedProperties	Коллекция	Коллекция многозначных расширенных свойств типа MultiValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да	Нет
ParentFolderId	Строка	Уникальный идентификатор родительской папки сообщения.	Нет	Нет	Нет
ReceivedDateTime	datetimeoffset	Дата и время получения сообщения.	Нет	Да	Да
ReplyTo	Коллекция (Recipient)	Электронные адреса, которые следует использовать при ответе.	Нет	Нет	Нет
Sender	Recipient	Учетная запись, которая фактически используется для создания сообщения.	Да	Да	Default (По умолчанию)
SentDateTime	datetimeoffset	Дата и время отправки сообщения.	Нет	Да	Нет
SingleValueExtendedProperties	Коллекция	Коллекция однозначных расширенных свойств типа SingleValueLegacyExtendedProperty. Это свойство навигации. См. дополнительную информацию о расширенных свойствах.	Да	Да	Нет
Subject	Строка	Тема сообщения.	Да	Да	Default (По умолчанию)
ToRecipients	Коллекция (Recipient)	Получатели сообщения, указанные в поле Кому.	Да	Нет	Да
UniqueBody	ItemBody	Текст сообщения, являющегося уникальным для данной беседы.	Нет	Нет	Нет
UnsubscribeData	Коллекция (String)	Содержит допустимые записи, полученные при анализе заголовка List-Unsubscribe. Если свойство UnsubscribeEnabled имеет значение true, это свойство будет содержать данные для команды mailto: в заголовке List-Unsubscribe. Данные должны соответствовать RFC-2369. Используйте действие Unsubscribe для прекращения отправки сообщений соответствующему списку рассылки.	Нет	Нет	Нет
UnsubscribeEnabled	Логическое	Указывает, разрешает ли получателю это сообщение отписаться и остановить дальнейшие сообщения, отправляемые в соответствии со списком рассылки электронной почты. True если заголовок List-Unsubscribe соответствует RFC-2369.	Нет	Нет	Нет
WebLink	Строка	URL-адрес для открытия сообщения в Outlook Web App. Чтобы изменить способ отображения сообщения, можно добавить аргумент ispopout в конце URL-адреса. Если аргумент ispopout отсутствует или для него задано значение 1, то сообщение откроется во всплывающем окне. Если для аргумента ispopout задано значение 0, то в браузере сообщение будет отображаться в области просмотра Outlook Web App. Сообщение откроется в браузере, если вы вошли в свой почтовый ящик с помощью Outlook Web App. Если вход с помощью браузера еще не выполнен, вам будет предложено войти. Доступ к этому URL-адресу можно получить из объекта iFrame.	Нет	Да	Нет

Удаление сценария из свойства Body (Текст)

Текст сообщения может иметь формат HTML или текстовый. Если текст представлен в формате HTML, то по умолчанию любой потенциально опасный код HTML (например, JavaScript), встроенный в свойство Body удаляется из него до возврата текста в ответе REST.

Чтобы получить все исходное HTML-содержимое, включите следующий заголовок HTTP-запроса:

Prefer: outlook.allow-unsafe-html

Настройка свойств From (От) и Sender (Отправитель)

В большинстве случаев при написании сообщения свойства From и Sender представляют одного вошедшего пользователя, если ни одно из них не было обновлено, как описано ниже.

• Свойство From можно изменить, если администратор Exchange назначил права SendAs почтового ящика другим пользователям. Администратор может сделать это, выбрав Разрешения для почтового ящика владельца почтового ящика на портале управления Azure или с помощью центра администрирования Exchange или командлета Add-ADPermission Windows PowerShell. Затем вы можете программно установить свойство From одному из этих пользователей, которые обладают правами SendAs для этого почтового ящика.

• Свойство Sender можно изменить, если владелец почтового ящика делегировал одному или нескольким пользователям возможность отправлять сообщения с этого почтового ящика. Владелец почтового ящика может делегировать разрешения в Outlook. Когда делегат отправляет сообщение от имени владельца почтового ящика, свойство Sender принимает значение, соответствующее учетной записи делегата, а свойство From сохраняет значение, соответствующее владельцу почтового ящика. Программно можно установить свойство Sender пользователю, который получил право делегата на этот почтовый ящик.

MessageRule (предварительная версия)

Правило, которое применяется к сообщениям в папке «Входящие» пользователя.

Тип: Microsoft.OutlookServices.MessageRule

Свойство	Type	Описание	Подлежит записи?
Actions	MessageRuleActions	Действия, которые нужно применить к сообщению при выполнении определенных условий.	Да
Conditions	MessageRulePredicates	Условия, выполнение которых активирует соответствующие действия для указанного правила.	Да
DisplayName	Строка	Отображаемое имя правила.	Да
Exceptions	MessageRulePredicates	Характеризует условия возникновения исключения из правила.	Да
HasError	Логическое	Указывает, является ли данное правило условием состояния «ошибка».	Нет
IsEnabled	Логическое	Указывает, включено ли применение правила к сообщениям.	Да
IsReadOnly	Логическое	Указывает, является ли правило доступным только для чтения, и можно ли изменить или удалить его с помощью REST API для правил.	Да
Sequence	Int32	Определяет последовательность выполнения правила среди прочих правил.	Да

OutlookCategory (предварительная версия)

Тип: Microsoft.OutlookServices.OutlookCategory

Категория, по которой пользователь может группировать в своем почтовом ящике такие элементы Outlook, как сообщения и события.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
DisplayName	Строка	Уникальное имя для этой категории в почтовом ящике пользователя.	Нет	Да
Color	CategoryColor	Предварительно установленная константа, которая характеризует цвет, сопоставляемый с данной категорией.	Да	Да

Photo

Тип: Microsoft.OutlookServices.Photo

Фотография, доступная из Exchange Online. Это двоичные данные, не закодированные в формате base-64.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
Height	int	Высота фотографии	Нет	Нет
Id	Строка	Уникальный идентификатор фотографии.	Нет	Нет
Width	int	Ширина фотографии.	Нет	Нет

ReferenceAttachment

Тип: Microsoft.OutlookServices.ReferenceAttachment

Базовый тип: Microsoft.OutlookServices.Attachment

Ссылка на файл или папку, прикрепленная к сообщению, событию или задаче. Возможные расположения файла или папки: OneDrive, OneDrive для бизнеса и DropBox. Производится из объекта Attachment.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
ContentType	Строка	Тип MIME вложения. Необязательно.	Да	Нет
Id	Строка	Уникальный идентификатор вложенной ссылки.	Нет	Нет
IsFolder	Логическое	Указывает, является ли вложение ссылкой на папку. Если SourceUrl является ссылкой на папку, то необходимо установить значение true. Необязательно.	Да	Нет
IsInline	Логическое	true если вложение является встроенным; в противном случае, false. Необязательно.	Да	Да
LastModifiedDateTime	DateTimeOffset	Дата и время последнего изменения вложения. Для даты и времени используется формат ISO 8601, и они всегда представляют собой время UTC. Например, полночь 1 января 2014 г. по времени UTC будет выглядеть следующим образом: «2014-01-01T00:00:00Z». Необязательно.	Нет	Да
Name	Строка	Отображаемое имя вложения. Его совпадение с фактическим именем файла не обязательно. Обязательно.	Да	Да
Permission	ReferenceAttachmentPermissions	Характеризует разрешения, предоставленные для вложения по типу поставщика в ProviderType. Возможные значения: Other, View, Edit, AnonymousView, AnonymousEdit, OrganizationView, OrganizationEdit. Необязательно.	Да	Нет
PreviewUrl	Строка	Применяется только для вложенной ссылки на изображение, представляющей собой URL-адрес для предварительного просмотра изображения. Используйте свойства ThumbnailUrl и PreviewUrl, только когда SourceUrl указывает на файл изображения. Необязательно.	Да	Нет
ProviderType	ReferenceAttachmentProviders	Тип поставщика, который поддерживает вложение этого ContentType. Возможные значения: Other, OneDriveBusiness, OneDriveConsumer, Dropbox. Необязательно.	Да	Да
Size	Int32	Размер вложения в байтах. Необязательно.	Нет	Нет
SourceUrl	Строка	URL для получения содержимого вложения. Если это URL-адрес на папку, то для надлежащего отображения папки в Outlook или Outlook в Интернете установите для параметра IsFolder значение true. Обязательно.	Да	Нет
ThumbnailUrl	Строка	Применяется только для вложенной ссылки на изображение, представляющей собой URL-адрес для доступа к эскизу этого изображения. Используйте свойства ThumbnailUrl и PreviewUrl, только когда SourceUrl указывает на файл изображения. Необязательно.	Да	Нет

Задача

Тип: Microsoft.OutlookServices.Task

Элемент Outlook, который может отслеживать рабочий элемент. Задачу можно использовать для отслеживания даты и времени начала, установленного завершения и фактического завершения операции, хода ее выполнения или состояния, независимо от того, является ли она повторяющейся и требует ли напоминания.

Для каждого из следующих свойств, связанных с датой:

• CompletedDateTime
• CreatedDateTime
• DueDateTime
• LastModifiedDateTime
• ReminderDateTime
• StartDateTime

Если данное свойство установлено, то по умолчанию REST API задачи возвращает значение, имеющее формат UTC, в ответе REST. Узнайте больше о настройке StartDateTime и DueDateTime, а также о свойствах, связанных с возвращением даты в настраиваемом часовом поясе.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
AssignedTo	Строка	Имя человека, которому назначена задача.	Нет	Да
Attachments	Коллекция (Attachment)	Коллекция вложений FileAttachment, ItemAttachment и ReferenceAttachment для задачи. Свойство навигации.	Нет	Нет
Body	ItemBody	Тело задачи, которое, как правило, содержит информацию о задаче. Следует помнить о том, что поддерживается только тип HTML.	Да	Нет
Categories	Коллекция (Строка)	Категории, связанные с задачей.	Да	Да
ChangeKey	Строка	Версия задачи.	Нет	Нет
CompletedDateTime	DateTimeTimeZone	Дата завершения задачи в указанном часовом поясе.	Да	Да
CreatedDateTime	DateTimeOffset	Дата и время создания задачи. По умолчанию время указывается в формате UTC. Пользователь может указать настраиваемый часовой пояс в заголовке запроса.	Нет	Да
DueDateTime	DateTimeTimeZone	Дата предполагаемого завершения задачи в указанном часовом поясе.	Да	Да
HasAttachments	Логическое	Если задача имеет вложения, этому свойству присваивается значение true.	Нет	Да
Id	Строка	Уникальный идентификатор задачи.	Нет	Нет
Importance	Importance	Важность события: Low, Normal, High.	Да	Да
IsReminderOn	Логическое	Если для напоминания пользователю о задаче установлено оповещение, то данному свойству присваивается значение true.	Да	Нет
LastModifiedDateTime	DateTimeOffset	Дата и время последнего изменения задачи. По умолчанию время указывается в формате UTC. Пользователь может указать настраиваемый часовой пояс в заголовке запроса.	Нет	Да
Owner	Строка	Имя человека, создавшего задачу.	Нет	Да
ParentFolderId	Строка	Уникальный идентификатор родительской папки задачи.	Нет	Нет
Recurrence	PatternedRecurrence	Расписание повторения для задачи.	Да	Нет
ReminderDateTime	DateTimeTimeZone	Дата и время появления оповещения с напоминанием о задаче.	Да	Нет
Sensitivity	Sensitivity	Характеризует уровень конфиденциальности события: Normal, Personal, Private, Confidential.	Да	Да
StartDateTime	DateTimeTimeZone	Дата начала выполнения задачи в указанном часовом поясе.	Да	Да
Status	TaskStatus	Характеризует состояние или ход выполнения задачи: NotStarted, InProgress, Completed, WaitingOnOthers, Deferred.	Да	Да
Subject	Строка	Краткое описание или название задачи.	Да	Да

Папка задач

Тип: Microsoft.OutlookServices.TaskFolder

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

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
ChangeKey	Строка	Версия папки задач.	Нет	Нет
Id	Строка	Уникальный идентификатор папки задач.	Нет	Нет
IsDefaultFolder	Логическое	True, если папка является папкой задач, используемой по умолчанию.	Нет	Да
Name	Строка	Имя папки задач.	Да	Да
ParentGroupKey	Edm.Guid	Уникальный идентификатор GUID для родительской группы папки задач.	Нет	Нет
Задачи	Коллекция (Task)	Задачи в этой папке задач. Свойство навигации.	Нет	Нет

TaskGroup

Тип: Microsoft.OutlookServices.TaskGroup

Группа папок, содержащих задачи. В Outlook существует группа задач по умолчанию My Tasks, которую невозможно переименовать или удалить. Тем не менее, пользователь может создавать дополнительные группы задач.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
ChangeKey	Строка	Версия группы задач.	Нет	Нет
GroupKey	Edm.Guid	Уникальный идентификатор GUID для группы задач.	Нет	Нет
Id	Строка	Уникальный идентификатор группы задач.	Нет	Нет
IsDefaultGroup	Логическое	True, если группа задач является группой задач по умолчанию.	Нет	Да
Name	Строка	Имя группы задач.	Да	Да
TaskFolders	Коллекция(TaskFolder)	Папки задач в этой группе задач. Свойство навигации.	Нет	Нет

User

Пользователь в системе. Конечная точка Me используется в качестве ярлыка для указания текущего пользователя по SMTP-адресу ( users/sadie@contoso.com).

Тип: Microsoft.OutlookServices.User

Коллекция Users возвращает массив пользователей в свойстве value ответа OData. Используйте $count, чтобы получить общее количество объектов в коллекции: .../me/users/$count

Примечание

Объект User включает в себя множество свойств и связей (свойства навигации), которые часто обновляются. В следующем разделе описываются только подмножества. Для получения информации, действительной на данный момент, см. определение User в соответствующем вашей версии файле метаданных.

Свойство	Type	Описание	Подлежит записи?	Фильтрующееся?
Alias	Строка	Псевдоним пользователя. Обычно это SMTP-адрес пользователя.	Да	Да
Calendar	Calendar	Основной календарь пользователя. Свойство навигации.	Нет	Нет
CalendarGroups	Коллекция(CalendarGroup)	Группы календарей пользователя. Свойство навигации.	Нет	Нет
Calendars	Коллекция (Calendar)	Календари пользователей. Свойство навигации.	Нет	Нет
CalendarView	Коллекция (Event)	Представление календаря для календаря. Свойство навигации.	Нет	Нет
ContactFolders	Коллекция (ContactFolder)	Папки контактов пользователя. Свойство навигации.	Нет	Нет
Contacts	Коллекция (Contact)	Контакты пользователя. Свойство навигации.	Нет	Нет
DisplayName	Строка	Отображаемое имя пользователя.	Да	Да
Events	Коллекция (Event)	События пользователя. Значение по умолчанию: показывать события в календаре по умолчанию. Свойство навигации.	Нет	Нет
Id	Строка	Уникальный идентификатор для пользователя.	Нет	Нет
InferenceClassification	InferenceClassification	Классификация релевантности для сообщений пользователя, основанная на явных обозначениях, переопределяющих заданную релевантность или важность. Свойство навигации.	Да	Да
MailboxGuid	guid	GUID, назначенный почтовому ящику пользователя.	Нет	Да
MailboxSettings	MailboxSettings	Параметры основного параметра вошедшего пользователя.	Да	Нет
MailFolders	Коллекция(MailFolder)	Папки в почтовом ящике. Свойство навигации.	Нет	Нет
MasterCategories	Коллекция(OutlookCategory)	Основной список категорий пользователей. Свойство навигации.	Да	Да
Messages	Коллекция (Message)	Сообщения в почтовом ящике или папке. Свойство навигации.	Нет	Нет
RootFolder	MailFolder	Корневая папка почтового ящика пользователя. Свойство навигации.	Нет	Нет

Сложные типы

• Attendee
• AttendeeAvailability
• AttendeeBase
• AutomaticRepliesMailTips (предварительная версия)
• AutomaticRepliesSetting
• DateTimeTimeZone
• EmailAddress
• Error (предварительная версия)
• FollowUpFlag (предварительная версия)
• GeoCoordinates
• InternetMessageHeader (предварительная версия)
• ItemBody
• LocaleInfo
• Location
• LocationConstraint
• LocationConstraintItem
• MailboxSettings
• MailTips (предварительная версия)
• MeetingTimeSuggestion
• MeetingTimeSuggestionsResult
• MentionsPreview (предварительная версия)
• MessageRuleActions (предварительная версия)
• MessageRulePredicates (предварительная версия)
• PatternedRecurrence
• Phone (предварительная версия)
• PhysicalAddress
• Recipient
• RecurrencePattern
• RecurrenceRange
• ResponseStatus
• SizeRange (предварительная версия)
• TimeConstraint
• TimeSlot
• TimeZoneInformation (предварительная версия)
• Website (предварительная версия)
• WorkingHours (предварительная версия)

Attendee

Участник события.

Тип: Microsoft.OutlookServices.AttendeeBase

Свойство	Type	Описание
Status	ResponseStatus	Ответ (нет, принят, отклонен и т. д.) и время.

AttendeeAvailability

Тип и занятость участника.

Тип: Microsoft.OutlookServices.AttendeeAvailability

Свойство	Type	Описание
Attendee	AttendeeBase	Тип участника — будь то человек или ресурс.
Availability	FreeBusyStatus	Состояние доступности участника.

AttendeeBase

Тип участника.

Тип: Microsoft.OutlookServices.Recipient

Свойство	Type	Описание
Type	AttendeeType	Тип участника. Возможные значения: Required, Optional, Resource. ПРИМЕЧАНИЕ. Если участник является человеком, то FindMeetingTimes всегда предполагает, что человек имеет тип Required.

AutomaticRepliesMailTips (предварительная версия)

Подсказки по почте об автоматических ответах, настроенных для почтового ящика.

Тип: Microsoft.OutlookServices.AutomaticRepliesMailTips

Свойство	Type	Описание
Message	Строка	Автоматическое ответное сообщение.
MessageLanguage	LocaleInfo	Язык, на котором написано автоматическое ответное сообщение.
ScheduledStartTime	DateTimeTimeZone	Дата и время, начиная с которых будет выполняться отправка автоматических ответов.
ScheduledEndTime	DateTimeTimeZone	Дата и время завершения отправки автоматических ответов.

AutomaticRepliesSetting

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

Тип: Microsoft.OutlookServices.AutomaticRepliesSetting

Свойство	Type	Описание
ExternalAudience	ExternalAudienceScope	Внешняя аудитория по отношению к организации пользователя, выполнившего вход, которая получит сообщение ExternalReplyMessage, если для параметра Status задано значение AlwaysEnabled или Scheduled. Значения None = 0, ContactsOnly = 1 или All = 2.
ExternalReplyMessage	Строка	Автоматический ответ, который нужно отправить указанной внешней аудитории, если для параметра Status задано значение AlwaysEnabled или Scheduled.
InternalReplyMessage	Строка	Автоматический ответ, который нужно отправить сотрудникам организации пользователя, выполнившего вход, если для параметра Status задано значение AlwaysEnabled или Scheduled.
ScheduledEndDateTime	DateTimeTimeZone	Дата и время завершения отправки автоматических ответов, если для параметра Status установлено значение Scheduled. Часовой пояс можно установить с помощью заголовка HTTP Prefer: outlook.timezone в операции Get.
ScheduledStartDateTime	DateTimeTimeZone	Дата и время начала отправки автоматических ответов, если для параметра Status установлено значение Scheduled. Часовой пояс можно установить с помощью заголовка HTTP Prefer: outlook.timezone в операции Get.
Status	AutomaticRepliesStatus	Состояние конфигурации для автоматических ответов: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2.

DateTimeTimeZone

Описывает дату, время и часовой пояс для определенного момента.

Свойство	Type	Описание
DateTime	DateTime	Единая точка времени в комбинированном представлении даты и времени (<date>T<time>) согласно формату ISO 8601
TimeZone	Строка	Один из указанных ниже часовых поясов.

Свойство TimeZone можно задать для каждого из часовых поясов, которые поддерживаются в Windows, а также для часовых поясов, указанных ниже. См. TimeZone, чтобы узнать больше.

Etc/GMT+12

Etc/GMT+11

Pacific/Honolulu

America/Anchorage

America/Santa_Isabel

America/Los_Angeles

America/Phoenix

America/Chihuahua

America/Denver

America/Guatemala

America/Chicago

America/Mexico_City

America/Regina

America/Bogota

America/New_York

America/Indiana/Indianapolis

America/Caracas

America/Asuncion

America/Halifax

America/Cuiaba

America/La_Paz

America/Santiago

America/St_Johns

America/Sao_Paulo

America/Argentina/Buenos_Aires

America/Cayenne

America/Godthab

America/Montevideo

America/Bahia

Etc/GMT+2

Atlantic/Azores

Atlantic/Cape_Verde

Africa/Casablanca

Etc/GMT

Europe/London

Atlantic/Reykjavik

Europe/Berlin

Europe/Budapest

Europe/Paris

Europe/Warsaw

Africa/Lagos

Africa/Windhoek

Europe/Bucharest

Asia/Beirut

Africa/Cairo

Asia/Damascus

Africa/Johannesburg

Europe/Kiev

Europe/Istanbul

Asia/Jerusalem

Asia/Amman

Asia/Baghdad

Europe/Kaliningrad

Asia/Riyadh

Africa/Nairobi

Asia/Tehran

Asia/Dubai

Asia/Baku

Europe/Moscow

Indian/Mauritius

Asia/Tbilisi

Asia/Yerevan

Asia/Kabul

Asia/Karachi

Asia/Tashkent

Asia/Kolkata

Asia/Colombo

Asia/Kathmandu

Asia/Almaty

Asia/Dhaka

Asia/Yekaterinburg

Asia/Rangoon

Asia/Bangkok

Asia/Novosibirsk

Asia/Shanghai

Asia/Krasnoyarsk

Asia/Singapore

Australia/Perth

Asia/Taipei

Asia/Ulaanbaatar

Asia/Irkutsk

Asia/Tokyo

Asia/Seoul

Australia/Adelaide

Australia/Darwin

Australia/Brisbane

Australia/Sydney

Pacific/Port_Moresby

Australia/Hobart

Asia/Yakutsk

Pacific/Guadalcanal

Asia/Vladivostok

Pacific/Auckland

Etc/GMT-12

Pacific/Fiji

Asia/Magadan

Pacific/Tongatapu

Pacific/Apia

Pacific/Kiritimati

EmailAddress

Имя и электронный адрес контакта или получателя сообщения.

Тип: Microsoft.OutlookServices.EmailAddress

Свойство	Type	Описание
Name	Строка	Отображаемое имя человека или объекта.
Address	Строка	Электронный адрес человека или объекта.

Error (предварительная версия)

Ошибка, возникающая во время выполнения действия.

Тип: Microsoft.OutlookServices.Error

Свойство	Type	Описание
Message	Строка	Сообщение об ошибке.
Code	Строка	Код ошибки.

FollowUpFlag (предварительная версия)

Информация о дальнейших действиях в отношении экземпляра ресурса.

Тип: Microsoft.OutlookServices.FollowupFlag

Свойство	Type	Описание
CompletedDateTime	DateTimeTimeZone	Дата и время завершения дополнительных действий.
DueDateTime	DateTimeTimeZone	Дата и время, установленные для завершения выполнения дополнительных действий.
StartDateTime	DateTimeTimeZone	Дата и время, когда следует начать выполнение дополнительных действий.
FlagStatus	FollowupFlagStatus	Представляет, помечен ли родительский экземпляр ресурса для последующего наблюдения, или его последующее наблюдение завершено.

GeoCoordinates

Географические координаты и высота расположения.

Тип: Microsoft.OutlookServices.GeoCoordinates

Свойство	Type	Описание
Altitude	Двойное	Высота расположения.
Latitude	Двойное	Широта расположения.
Longitude	Двойное	Долгота расположения.
Accuracy	Двойное	Точность датчика, предоставляющего данные о широте и долготе.
AltitudeAccuracy	Двойное	Точность датчика, предоставляющего данные высоты.

InternetMessageHeader (предварительный просмотр)

Пара «ключ-значение», характеризующая заголовок интернет-сообщения, которое представлено в формате, указанном в RFC2822 и предоставляющем сведения о сетевом пути, который прошло сообщение в процессе доставки от отправителя к получателю.

Тип: Microsoft.OutlookServices.InternetMessageHeader

Свойство	Type	Описание
Name	Строка	Ключ в паре «ключ-значение» заголовка интернет-сообщения.
Value	Строка	Значение в паре «ключ-значение» заголовка интернет-сообщения.

ItemBody

Текст сообщения или события.

Тип: Microsoft.OutlookServices.ItemBody

Свойство	Type	Описание
ContentType	BodyType	Тип содержимого: Текст = 0, HTML = 1.
Content	Строка	Содержимое в текстовом формате или формате HTML.

LocaleInfo

Сведения о языковом стандарте, включающие в себя информацию о предпочтительном языке и стране/регионе пользователя, вошедшего в систему.

Тип: Microsoft.OutlookServices.LocaleInfo

Свойство	Type	Описание
DisplayName	Строка	Название, отображающее языковой стандарт на его естественном языке, например, «English (United States)».
Locale	Строка	Характеристика языкового стандарта, включающая в себя язык и страну/регион. Например, «en-us». В языковом компоненте используются коды из двух букв, определенные в стандарте ISO 639-1, а в компоненте страны — коды из двух букв, определенные в стандарте ISO 3166-1 alpha-2.

Location (предварительный просмотр)

Расположение события.

Тип: Microsoft.OutlookServices.Location

Свойство	Type	Описание
Address	PhysicalAddress	Физический адрес расположения.
Координаты	GeoCoordinates	Географические координаты и высота расположения.
DisplayName	Строка	Имя, связанное с расположением.
LocationEmailAddress	Строка	Необязательный адрес электронной почты, соответствующий расположению.
LocationUri	Строка	Необязательный URI, характеризующий расположение.
LocationType	LocationType	Тип расположения: Default, ConferenceRoom, HomeAddress, BusinessAddress,GeoCoordinates, StreetAddress, Hotel, Restaurant, LocalBusiness, PostalAddress.

LocationConstraint

Условия, заданные клиентом для места проведения собрания.

Тип: Microsoft.OutlookServices.LocationConstraint

Свойство	Type	Описание
IsRequired	Логическое	Клиент запрашивает службу включить в ответ место проведения собрания.
SuggestLocation	Логическое	Клиент запрашивает у службы один или несколько вариантов расположений для проведения собрания.
Locations	Коллекция(LocationConstraintItem)	Одно или несколько мест, которые клиент запрашивает для проведения собрания.

LocationConstraintItem

Условия, указанные клиентом для проверки доступности каждого места проведения собрания, а также другая информация о расположении.

Тип: Microsoft.OutlookServices.Location

Свойство	Type	Описание
ResolveAvailability	Логическое	Если установлено значение true и указанный ресурс занят, действие FindMeetingTimes ищет другой свободный ресурс. Если этому свойству присвоено значение false, а указанный ресурс занят, то FindMeetingTimes возвращает ресурс, получивший наивысшую оценку в кэше пользователя, не проверяя, свободен ли он. Значением по умолчанию является true.

MailTips (предварительная версия)

Информационные сообщения, показываемые пользователям при составлении ими сообщения. Пример: сообщение об отсутствии на рабочем месте, отправляемое получателем сообщения в качестве автоматического ответа.

Тип: Microsoft.OutlookServices.MailTips

Свойство	Type	Описание
EmailAddress	EmailAddress	Адрес электронной почты получателя для получения подсказок.
AutomaticReplies	AutomaticRepliesMailTips	Подсказки для автоматического ответа, если он настроен получателем.
MailboxFull	Логическое	Указывает на заполнение почтового ящика получателя.
CustomMailTip	Строка	Настраиваемая подсказка, которую можно настроить для почтового ящика получателя.
ExternalMemberCount	Int32	Количество внешних участников, если получатель является списком рассылки.
TotalMemberCount	Int32	Число участников, если получатель является списком рассылки.
DeliveryRestricted	Логическое	Указывает, ограничен ли почтовый ящик получателя, например, с приемом сообщений только от предопределенного списка отправителей, отклонением сообщений от предопределенного списка отправителей или приемом сообщений только от отправителей, прошедших проверку подлинности.
IsModerated	Логическое	Указывает, требуется ли утверждение отправки сообщений получателю. Например, для случаев, когда получатель представляет собой большой список рассылки, а модератор настроен для утверждения сообщений, отправленных в этот список рассылки, или когда отправка сообщений получателю требует утверждения менеджером получателя.
RecipientScope	RecipientScopeType	Область, к которой относится получатель, например, внутренний, внешний или партнер. Администратор может назначить своим «партнером» другую организацию. Область полезна, если администратор желает, чтобы определенные подсказки были доступны для определенных областей. Она также полезна для отправителей: они информируются о том, что их сообщение может покинуть пределы организации, что позволяет им пересмотреть формулировку, тон и содержимое сообщения.
RecipientSuggestions	Набор (Recipient)	Предложения получателей, которые основываются на предыдущем контексте, когда они фигурируют в таком же сообщении.
MaxMessageSize	Int32	Максимальный размер сообщения, установленный для организации или почтового ящика получателя.
Error	Error	Ошибки, возникающие во время действия GetMailTips.

MailboxSettings

Параметры основного почтового ящика пользователя.

Тип: Microsoft.OutlookServices.MailboxSettings

Свойство	Type	Описание
AutomaticRepliesSetting	AutomaticRepliesSetting	Параметры для настройки автоматической отправки ответов на входящие сообщения.
TimeZone	Строка	Часовой пояс почтового ящика пользователя, применяемый по умолчанию.
Language	LocaleInfo	Сведения о языковом стандарте пользователя, в том числе о предпочитаемом языке и стране/регионе.
WorkingHours	WorkingHours	Дни недели и часы работы пользователя в определенном часовом поясе.

MeetingTimeSuggestion

Предложение собрания, включающее в себя такую информацию, как время проведения, вероятность участия, доступность отдельных участников и доступность мест проведения.

Тип: Microsoft.OutlookServices.MeetingTimeSuggestion

Свойство	Type	Описание
MeetingTimeSlot	TimeSlot	Период времени, предложенный для собрания.
Confidence	Двойное	Процент вероятности того, что все участники будут присутствовать на собрании.
OrganizerAvailability	FreeBusyStatus	Доступность организатора собрания для этого варианта собрания: Free, Tentative, Busy, Oof, WorkingElsewhere, Unknown.
AttendeeAvailability	Коллекция (AttendeeAvailability)	Массив, показывающий состояние доступности каждого из участников для этого варианта собрания.
Locations	Коллекция (Location)	Массив, в котором указано имя и географические данные каждого места проведения собрания для данного варианта.
SuggestionReason	Строка	Описывает причины, по которым предлагается указанное время проведения собрания.

Вероятность собрания

Свойство Confidence объекта MeetingTimeSuggestion принимает значения, изменяющиеся в диапазоне от 0 % до 100 %, и характеризует вероятность того, что все участники будут присутствовать на собрании, определяющуюся сведениями о доступности каждого участника:

• Если тот или иной участник доступен в указанный период времени, для него задается вероятность посещения 100 %, если его состояние неизвестно — 49 %, а если он занят— 0 %.
• Достоверность времени возможного проведения собрания вычисляется, как средняя вероятность присутствия всех указанных участников собрания.
• Вы можете использовать необязательный параметр MinimumAttendeePercentage для действия FindMeetingTimes чтобы указать необходимость возвращения только таких временных интервалов собрания, которые соответствуют минимальному уровню достоверности посещения. Например, можно указать для параметра MinimumAttendeePercentage значение 80 %, если требуется получить только варианты, для которых вероятность того, что все участники посетят собрание, будет равна 80 %. Если вы не задали значение MinimumAttendeePercentage, действие FindMeetingTimes предполагает, что значение равно 50 %.
• Если существует несколько возможных вариантов времени встречи, действие FindMeetingTimes сначала упорядочивает варианты по рассчитанному для них значению вероятности (от высокого к низкому). Если есть варианты с одинаковой вероятностью, действие в следующую очередь упорядочивает варианты в хронологическом порядке.

Например, если период времени для проведения собрания включает трех участников со следующими состояниями доступности/занятости:

Attendee	Информация о доступности	Процентная вероятность посещения
Дарья	Свободна	100 %
Иван	Unknown (Неизвестно)	49 %
Лилия	Busy (Занят)	0 %

В этом случае достоверность предлагаемого периода времени для проведения собрания, представляющая собой среднюю вероятность посещения, составляет (100 % + 49 % + 0 %)/3 = 49,66 %.

Если указать для параметра MinimumAttendeePercentage в методе FindMeetingTimes значение 80 %, операция не будет предлагать этот период времени в ответе, так как 49,66 % < 80 %.

MeetingTimeSuggestionsResult

Коллекция предложений проведения собрания (если они есть) или причина их отсутствия.

Тип: Microsoft.OutlookServices.MeetingTimeSuggestionsResult

Свойство	Type	Описание
MeetingTimeSuggestions	Коллекция (MeetingTimeSuggestion)	Массив предложений о проведении собрания.
EmptySuggestionsReason	Строка	Причина отсутствия предложений в результатах. Возможные значения: AttendeesUnavailable, LocationsUnavailable, OrganizerUnavailable, AttendeesUnavailableOrUnknown и Unknown.

Причины, по которым не удается получить предложения о проведении собрания

Свойство EmptySuggestionsReason определяет одну из следующих причин того, что действие FindMeetingTimes не возвращает никаких вариантов собраний. Если FindMeetingTimes возвращает какие-либо предложения по проведению собрания, то данное свойство представляет собой пустую строку.

Value	Причины
AttendeesUnavailable	Имеются сведения о доступности всех участников, но не достигнут порог достоверности собрания (значение по умолчанию — 50 %).
AttendeesUnavailableOrUnknown	Отсутствуют сведения о доступности некоторых или всех участников, из-за чего значение достоверности собрания становится ниже заданного порога (значение по умолчанию — 50 %). Доступность участника может стать неизвестной, если он находится за пределами организации или произошла ошибка при получении сведений о доступности.
LocationsUnavailable	Свойство IsRequired параметра LocationConstraint указано как обязательное, но для рассчитанных периодов времени нет доступных площадок.
OrganizerUnavailable	Параметру IsOrganizerOptional присвоено значение false, но организатор занят в течение запрашиваемого периода времени.
Unknown (Неизвестно)	Причина отсутствия предложений неизвестна.

MentionsPreview (предварительная версия)

Представляет информацию об упоминаниях в экземпляре ресурса.

Тип: Microsoft.OutlookServices.MentionsPreview

Свойство	Type	Описание
IsMentioned	Логическое	Значение true присваивается в случае, если вошедший в систему пользователь упоминается в экземпляре родительского ресурса. Только для чтения. Поддерживает фильтрацию.

MessageRuleActions (предварительная версия)

Характеризует набор действий, доступных для правила.

Тип: Microsoft.OutlookServices.MessageRuleActions

Свойство	Type	Описание
AssignCategories	Коллекция (String)	Список категорий, которые необходимо назначить сообщению.
CopyToFolder	Строка	Идентификатор папки, в которую необходимо скопировать сообщение.
Delete	Логическое	Указывает, нужно ли перемещать сообщение в папку «Удаленные».
ForwardAsAttachmentTo	Коллекция (Recipient)	Электронные адреса получателей, которым необходимо переслать сообщение в форме вложения.
ForwardTo	Коллекция (Recipient)	Электронные адреса получателей, которым необходимо переслать сообщение.
MarkAsRead	Логическое	Указывает, следует ли отмечать сообщение как прочитанное.
MarkImportance	Importance	Задает важность сообщения. Допустимые значения: Low, Normal, High.
MoveToFolder	Строка	Идентификатор папки, в которую будет перемещено сообщение.
PermanentDelete	Логическое	Указывает, нужно ли окончательно удалить сообщение без сохранения в папке «Удаленные».
RedirectTo	Recipient	Электронный адрес, на который должно быть перенаправлено сообщение.
StopProcessingRules	Логическое	Указывает, должны ли обрабатываться последующие правила.

MessageRulePredicates (предварительная версия)

Представляет набор условий и исключений, доступных для правила.

Тип: Microsoft.OutlookServices.MessageRulePredicates

Свойство	Type	Описание
BodyContains	Коллекция (String)	Характеризует строки, которые должны присутствовать в тексте входящего сообщения для применения определенного условия или исключения.
BodyOrSubjectContains	Коллекция (String)	Представляет строки, которые должны присутствовать в тексте или теме входящего сообщения, чтобы применялось условие или исключение.
Categories	Коллекция (String)	Характеризует категории, к которым должно относиться входящее сообщение для того, чтобы к нему применялось условие или исключение.
FromAddresses	Коллекция (Recipient)	Характеризует адреса электронной почты конкретных отправителей, при наличии которых к входящему сообщению применяется условие или исключение.
HasAttachments	Логическое	Указывает, должно ли входящее сообщение содержать вложения, чтобы применялось условие или исключение.
HeaderContains	Коллекция (String)	Указывает строки, которые должны присутствовать в заголовках входящего сообщения для применения к нему условия или исключения.
Importance	Importance	Уровень важности, который должен быть задан для входящего сообщения, чтобы к нему применялось условие или исключение: Low, Normal, High.
IsApprovalRequest	Логическое	Указывает, должно ли входящее сообщение быть запросом утверждения, чтобы к нему применялось условие или исключение.
IsAutomaticForward	Логическое	Указывает, должно ли входящее сообщение автоматически пересылаться, чтобы к нему применялось условие или исключение.
IsAutomaticReply	Логическое	Указывает, должно ли входящее сообщение быть автоматическим ответом, чтобы к нему применялось условие или исключение.
IsEncrypted	Логическое	Указывает, должно ли входящее сообщение быть зашифрованным, чтобы к нему применялось условие или исключение.
IsMeetingRequest	Логическое	Указывает, должно ли входящее сообщение быть приглашением на собрание, чтобы к нему применялось условие или исключение.
IsMeetingResponse	Логическое	Указывает, должно ли входящее сообщение быть ответом на приглашение на собрание, чтобы к нему применялось условие или исключение.
IsNonDeliveryReport	Логическое	Указывает, должно ли входящее сообщение быть отчетом об ошибке доставки, чтобы к нему применялось условие или исключение.
IsPermissionControlled	Логическое	Указывает, должно ли быть включено входящее сообщение контролироваться разрешениями (защита RMS), чтобы к нему применялось условие или исключение.
IsReadReceipt	Логическое	Указывает, должно ли входящее сообщение быть уведомлением о прочтении, чтобы к нему применялось условие или исключение.
IsSigned	Логическое	Указывает, должно ли входящее сообщение иметь подпись S/MIME, чтобы к нему применялось условие или исключение.
IsVoicemail	Логическое	Указывает, должно ли входящее сообщение быть сообщением голосовой почты, чтобы к нему применялось условие или исключение.
MessageActionFlag	MessageActionFlag	Харакетризует значение флага для действия, которое должно присутствовать во входящем сообщении, чтобы к нему применялось условие или исключение.
NotSentToMe	Логическое	Указывает, должно ли условие или исключение применяться только в том случае, если владелец почтового ящика не является получателем входящего сообщения.
ReceipentContains	Коллекция (String)	Характеризует строки, которые должны присутствовать в свойствах ToRecipients или CcRecipients входящего сообщения, чтобы к нему применялось условие или исключение.
SenderContains	Коллекция (String)	Характеризует строки, которые должны присутствовать в свойстве From входящего сообщения, чтобы к нему применялось условие или исключение.
Sensitivity	Sensitivity	Характеризует уровень конфиденциальности, который должен быть установлен для входящего сообщения, чтобы к нему применялось условие или исключение. Возможные значения: Normal, Personal, Private, Confidential.
SentCcMe	Логическое	Указывает, должен ли владелец почтового ящика быть указан в свойстве CcRecipients входящего сообщения, чтобы к нему применялось условие или исключение.
SentOnlyToMe	Логическое	Указывает, должен ли владелец почтового ящика быть единственным получателем входящего сообщения, чтобы применялось условие или исключение.
SentToAddresses	Коллекция (Recipient)	Характеризует электронные адреса, на которые должно быть отправлено входящее сообщение, чтобы к нему применялось условие или исключение.
SentToMe	Логическое	Указывает, должен ли владелец почтового ящика быть указан в свойстве ToRecipients входящего сообщения, чтобы к нему применялось условие или исключение.
SentToOrCcMe	Логическое	Указывает, должен ли владелец почтового ящика указываться в свойстве ToRecipients или CcRecipients входящего сообщения, чтобы к нему применялось условие или исключение.
SubjectContains	Коллекция (String)	Характеризует строки, которые должны присутствовать в теме входящего сообщения, чтобы к нему применялось условие или исключение.
WithinSizeRange	SizeRange	Представляет минимальное и максимальное значения (в килобайтах), между которыми должен находиться размер входящего сообщения, чтобы применялось условие или исключение.

PatternedRecurrence

Расписание и диапазон повторения.

Тип: Microsoft.OutlookServices.PatternedRecurrence

Свойство	Type	Описание
Pattern	RecurrencePattern	Частота события.
RecurrenceTimeZone	Строка	Часовой пояс времени начала и окончания. Для получения списка поддерживаемых часовых поясов см. сложный тип DateTimeTimeZone.
Range	RecurrenceRange	Продолжительность события.

Phone

Представляет номер телефона.

Тип: Microsoft.OutlookServices.Phone

Свойство	Type	Описание
Number	Строка	Номер телефона.
Type	Строка	Тип номера телефона. Возможные значения: Home, Business, Mobile, Other, Assistant, HomeFax, BusinessFax, OtherFax, Pager, Radio.

PhysicalAddress

Физический адрес контакта.

Тип: Microsoft.OutlookServices.PhysicalAddress

Свойство	Type	Описание
Street	Строка	Улица.
City	Строка	Город.
State	Строка	Штат.
CountryOrRegion	Строка	Страна или регион. Это строковое значение в произвольном формате, например «США».
PostalCode	Строка	Почтовый индекс.

Recipient

Содержит сведения о конечном пользователе, отрправляющем или получающем сообщение, либо информацию о событии.

Тип: Microsoft.OutlookServices.Recipient

Свойство	Type	Описание
EmailAddress	EmailAddress	Электронный адрес получателя.

RecurrencePattern

Частота события.

Тип: Microsoft.OutlookServices.RecurrencePattern

Свойство	Type	Описание
Type	RecurrencePatternType	Тип расписания повторения: Daily = 0, Weekly = 1, AbsoluteMonthly = 2, RelativeMonthly = 3, AbsoluteYearly = 4, RelativeYearly = 5. Правила шаблонов: - AbsoluteYearly. Необходимо задать параметры Month и DayOfMonth периодичности - RelativeYearly. Необходимо задать параметры Month, DaysOfWeek, а также индекс FirstDayOfWeek - AbsoluteMonthly. Необходимо задать параметр DayOfMonth - RelativeMonthly. Необходимо задать индекс FirstDayOfWeek и RecurrenceRange.NumberOfOccurrences - Weekly. Необходимо задать параметр DaysOfWeek и индекс FirstDayOfWeek - Daily. Никакой дополнительной информации о шаблоне не требуется.
Interval	Int32	Количество единиц заданного типа между повторениями.
DayOfMonth	Int32	День месяца, в который возникает элемент.
Month	Int32	Месяц, в котором появляется элемент. Это число от 1 до 12.
DaysOfWeek	Коллекция(DayOfWeek)	Коллекция дней недели: воскресенье = 0, понедельник = 1, вторник = 2, среда = 3, четверг = 4, пятница = 5, суббота = 6.
FirstDayOfWeek	DayOfWeek	Дни недели: воскресенье = 0, понедельник = 1, вторник = 2, среда = 3, четверг = 4, пятница = 5, суббота = 6.
Index	WeekIndex	Индекс недели: первая = 0, вторая = 1, третья = 2, четвертая = 3, последняя = 4.

RecurrenceRange

Продолжительность события.

Тип: Microsoft.OutlookServices.RecurrenceRange

Свойство	Type	Описание
Type	RecurrenceRangeType	Диапазон повторения: EndDate = 0, NoEnd = 1, Numbered = 2.
StartDate	datetimeoffset	Обязательное: дата начала последовательности.
EndDate	datetimeoffset	Требуется для привязанных к датам шаблонов: дата окончания последовательности. Должно быть после даты начала.
NumberOfOccurrences	Int32	Требуется для нумерованных шаблонов: количество повторений события.

ResponseStatus

Состояние ответа для приглашения на собрание.

Тип: Microsoft.OutlookServices.ResponseStatus

Свойство	Type	Описание
Ответ	ResponseType	Тип ответа: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Time	datetimeoffset	Дата и время возвращения ответа.

SizeRange (предварительная версия)

Указывает максимальный и минимальный размеры (в килобайтах) входящего сообщения, при которых к нему применяется условие или исключение.

Тип: Microsoft.OutlookServices.SizeRange

Свойство	Type	Описание
MaximumSize	Int32	Максимальный размер (в килобайтах) входящего сообщения, при котором к нему применяется условие или исключение.
MinimumSize	Int32	Минимальный размер (в килобайтах) входящего сообщения, при котором к нему применяется условие или исключение.

TimeConstraint

Ограничивает предложения по времени проведения собрания определенными временными рамками и днями недели в соответствии с указанным описанием действия и доступными периодами времени.

Тип: Microsoft.OutlookServices.TimeConstraint

Свойство	Type	Описание
ActivityDomain	ActivityDomain	Необязательно, характер действия: Work, Personal, Unrestricted или Unknown.
Временные интервалы	Коллекция (TimeSlot)	Массив периодов времени.

TimeSlot

Период времени.

Тип: Microsoft.OutlookServices.TimeSlot

Свойство	Type	Описание
Start	DateTimeTimeZone	Время начала периода.
End	DateTimeTimeZone	Время окончания периода.

TimeZoneInformation (предварительная версия)

Характеризует часовой пояс. Поддерживаемые форматы: Windows и часовой пояс организации по назначению Интернет-номеров (Internet Assigned Numbers Authority – IANA) (также известный, как часовой пояс Олсона).

Тип: Microsoft.OutlookServices.TimeZoneInformation

Свойство	Type	Описание
Alias	Строка	Идентификатор часового пояса.
DisplayName	Строка	Отображаемое имя часового пояса.

Website (предварительная версия)

Указывает на веб-сайт.

Тип: Microsoft.OutlookServices.Website

Свойство	Type	Описание
Address	Строка	URL-адрес веб-сайта.
DisplayName	Строка	Отображаемое имя веб-сайта.
Type	WebsiteType	Тип веб-сайта, обычно связанного с контактом. Возможные значения: Blog, Home, Other, Profile, Work.

WorkingHours (предварительная версия)

Характеризует дни недели и часы работы пользователя в определенном часовом поясе.

Тип: Microsoft.OutlookServices.WorkingHours

Свойство	Type	Описание
DaysOfWeek	Коллекция(DayOfWeek)	Коллекция дней недели, в которые работает пользователь: воскресенье = 0, понедельник = 1, вторник = 2, среда = 3, четверг = 4, пятница = 5, суббота = 6.
StartTime	Edm.TimeOfDay	Время дня, в которое пользователь начинает работать.
EndTime	Edm.TimeOfDay	Время дня, в которое пользователь заканчивает работать.
TimeZone	Строка	Часовой пояс, к которому относится рабочее время. Для получения списка допустимых часовых поясов см. DateTimeTimeZone.

Перечисления

• ActivityDomain
• AutomaticRepliesStatus
• CategoryColor (предварительная версия)
• DayOfWeek
• ExternalAudienceScope
• FollowupFlagStatus (предварительная версия)
• FreeBusyStatus
• InferenceClassificationType
• LocationType (предварительная версия)
• MailTipsType (предварительная версия)
• MessageActionFlag (предварительная версия)
• PhoneType (предварительная версия)
• RecipientScopeType (предварительная версия)
• ReferenceAttachmentPermissions
• ReferenceAttachmentProviders
• TaskStatus
• TimeZoneStandard
• WebsiteType

DayOfWeek

Множество дней недели.

Поддерживаемые значения:

• Sunday (Воскресенье)
• Monday (Понедельник)
• Tuesday (Вторник)
• Wednesday (Среда)
• Thursday (Четверг)
• Friday (Пятница)
• Saturday (Суббота)

FreeBusyStatus

Характеризует состояние доступности участника собрания.

Поддерживаемые значения:

• Busy (Занят)
• Free (Свободен)
• Oof (Нет на месте)
• Tentative (Под вопросом)
• Unknown (Неизвестно)
• WorkingElsewhere (Работаю в другом месте)

ActivityDomain

Характер деятельности.

Поддерживаемые значения:

• Work (Работа)
• Personal (Личный)
• Unrestricted (Без ограничений)
• Unknown (Неизвестно)

AutomaticRepliesStatus

Состояние конфигурации для автоматической отправки ответа, когда почтовый ящик пользователя получает сообщение.

Поддерживаемые значения:

• AlwaysEnabled (Всегда включена)
• Disabled (Отключена)
• Scheduled (По расписанию)

CategoryColor (предварительный просмотр)

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

Поддерживаемое значение	Цвет, сопоставленный в клиенте Outlook для настольных ПК
Preset0	Красный
Preset1	Оранжевый
Preset2	Коричневый
Preset3	Желтый
Preset4	Зеленый
Preset5	Сине-зеленый
Preset6	Оливковый
Preset7	Синий
Preset8	Сиреневый
Preset9	Клюквенный
Preset10	Стальной
Preset11	Темно-стальной
Preset12	Серый
Preset13	Темно-серый
Preset14	Черный
Preset15	Темно-красный
Preset16	Темно-оранжевый
Preset17	Темно-коричневый
Preset18	Темно-желтый
Preset19	Темно-зеленый
Preset20	Темно-бирюзовый
Preset21	Темно-оливковый
Preset22	Темно-синий
Preset23	Темно-фиолетовый
Preset24	Темно-клюквенный
None	Цвет не задан

ExternalAudienceScope

Множество внешней аудитории для отправки сообщения ExternalReplyMessage.

Поддерживаемые значения:

• All (Все)
• ContactsOnly (Только контакты)
• None

FollowupFlagStatus (предварительная версия)

Представляет состояние отметки дальнейших действий для экземпляра ресурса.

Поддерживаемые значения:

• Complete (Завершено)
• Flagged (Помечено)
• NotFlagged (Не помечено)

InferenceClassificationType

Представляет предполагаемую релевантность сообщения для пользователя.

Поддерживаемые значения:

• Focused (Отсортированное)
• Other (Другой)

LocationType (предварительная версия)

Возможные типы мест.

Поддерживаемые значения:

• Default (По умолчанию)
• ConferenceRoom (Конференц-зал)
• HomeAddress (Домашний адрес)
• BusinessAddress (Рабочий адрес)
• GeoCoordinates (Геокоординаты)
• StreetAddress (Уличный адрес)
• Hotel (Отель)
• Restaurant (Ресторан)
• LocalBusiness (Местный бизнес)
• PostalAddress (Почтовый адрес)

MailTipsType (предварительная версия)

Перечисление флагов, которое представляет запрошенные подсказки.

Поддерживаемые значения:

• AutomaticReplies
• CustomMailTip
• DeliveryRestriction
• ExternalMemberCount
• MailboxFullStatus
• MaxMessageSize
• ModerationStatus
• RecipientScope
• RecipientSuggestions
• TotalMemberCount

MessageActionFlag (предварительный просмотр)

Указывает действие, которое необходимо предпринять для сообщения.

Поддерживаемые значения:

• Any
• Call
• DoNotForward
• FollowUp
• FYI
• Forward
• NoResponseNecessary
• Read
• Reply
• ReplyToAll
• Review

PhoneType (предварительная версия)

Тип телефонных номеров, обычно связанных с контактом.

Поддерживаемые значения:

• Assistant (Помощник)
• Business (Рабочий)
• BusinessFax (Рабочий факс)
• Home (Главная страница)
• HomeFax (Домашний факс)
• Mobile (Мобильный)
• Other (Другой)
• OtherFax (Другой факс)
• Pager (Пейджер)
• Radio (Радио)

RecipientScopeType (предварительный просмотр)

Перечисление флагов, представляющих типы областей получателей. Области получателей используются администраторами для указания определенных подсказок, которые будут доступны только определенной области.

Поддерживаемые значения:

• None
• Internal (Внутренние)
• External (Внешние)
• ExternalPartner (Внешние, партнеры)
• ExternalNonPartner (Внешние, не партнеры)

ReferenceAttachmentPermissions

Разрешения доступа к файлу или папке вложенной ссылки.

Поддерживаемые значения:

• Other (Другой)
• View (Просмотр)
• Edit (Изменение)
• AnonymousView (Анонимный просмотр)
• AnonymousEdit
• OrganizationView
• OrganizationEdit

ReferenceAttachmentProviders

Возможные поставщики хранилищ файлов для вложенных ссылок.

Поддерживаемые значения:

• Dropbox
• OneDriveBusiness
• OneDriveConsumer
• Other (Другой)

Sensitivity

Указывает уровень конфиденциальности.

Поддерживаемые значения:

• Normal (Обычный)
• Personal (Личный)
• Private (Частный)
• Confidential (Конфиденциальный)

TaskStatus

Определяет состояние или ход выполнения задачи.

Поддерживаемые значения:

• Completed
• Deferred
• InProgress
• NotStarted
• WaitingOnOthers

TimeZoneStandard (предварительный просмотр)

Формат для отображения часовых поясов.

Поддерживаемые значения:

• Windows
• Iana

WebsiteType (предварительный просмотр)

Тип веб-сайта, обычно связанный с контактом.

Поддерживаемые значения:

• Blog (Блог)
• Home (Главная страница)
• Other (Другой)
• Profile (Профиль)
• Work (Работа)

Параметры запросов OData

Вы можете использовать стандартные параметры запроса OData v4.0 для фильтрации запросов данных, сортировки и отображения на странице результатов при работе с API почты, календаря и контактов. При указании параметров запроса убедитесь, что символы, которые зарезервированы для специальных значений в URI, закодированы надлежащим образом.

• $search для поиска по определенным условиям

• $filter для фильтрации по определенным условиям

• $select для запроса определенных свойств

• $orderby для сортировки результатов

• $top и $skip на страницу результатов

• $expand для развертывания вложений сообщения и вложений события

• $count для подсчета количества объектов в коллекции. Этот параметр указывается в URL-адресе: .../me/calendars/$count

При выполнение запросов с помощью API Почты, Календаря и Контактов всегда используется неглубокая область видимости. Возвращаются только элементы в текущей папке. Глубокие поисковые запросы не поддерживаются.

Поисковые запросы

Чтобы ограничить результаты запроса сообщениями, соответствующими поисковому выражению, можно использовать параметр $search. Строки поиска указываются с помощью расширенного синтаксиса запросов (AQS). Результаты сортируются по дате и времени отправки сообщения.

Примечание

После подачи запроса $search можно получить до 250 результатов. $search можно использовать только с сообщениями. Поиск контактов и событий календаря не поддерживается.

Использование $filter или $orderby в поисковом запросе не допускается. В противном случае, выдается сообщение об ошибке, подобное тому, которое указано ниже.

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }

Свойство	Описание
Attachment	Поиск указанного вложения по названию.
Bcc	Поиск в поле скрытой копии.
Body или Content	Поиск поля Body. Поддерживается только c поисковыми запросами по умолчанию.
Category	Поиск в поле Категория.
Cc	Поиск в поле Копия.
From	Поиск поля From.
Has	Поиск поля HasAttachments.
Participants	Поиск полей To, Cc и Bcc.
Received	Поиск поля Received для конкретной даты, указанной в виде ММ/ДД/ГГГГ.
Sender	Поиск поля Sender.
Subject	Поиск поля Subject.
To	Поиск в поле Кому.

Поиск в общих полях выполняется с помощью параметра запроса $search без указания свойства. При поиске по умолчанию ищутся свойства Body, Sender и Subject. Следующий поиск возвращает все сообщения в папке «Входящие», которые содержат слово «pizza» в любом из трех свойств по умолчанию.

Давайте посмотрим на некоторые примеры. Для простоты URL-адреса в примерах не были закодированы в URL; однако если вы попробуете использовать эти примеры, обязательно используйте кодировку URL перед отправкой их на сервер.

Для получения всех сообщений в папке «Входящие», содержащих слово «Pizza» в свойстве From, Subject или Body, можно использовать этот запрос.

GET https://outlook.office.com/api/beta/me/messages?$search="pizza"

Чтобы получить все сообщения в папке «Входящие», содержащие слово «Pizza» в свойстве Subject, можно использовать этот запрос.

GET https://outlook.office.com/api/beta/me/messages?$search="subject:pizza"

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

GET https://outlook.office.com/api/beta/me/messages?$search="from:help@contoso.com"

В приведенных выше примерах кодировка URL-адреса не применялась. Здесь приводятся те же примеры с закодированым URL-адресом, готовые к отправке на ваш сервер:

GET https://outlook.office.com/api/beta/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/beta/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/beta/me/messages?$search=%22from:help@contoso.com%22

Запросы фильтра

Параметр запроса $filter можно использовать для указания условий поиска с помощью приведенных ниже операторов фильтра.

Не все свойства поддерживают фильтрацию. Для этой цели могут использоваться только те свойства ресурса, для которых в графе «Фильтруемые?» установлена отметка «Да» «Подлежит фильтрации?» их соответствующей таблицы указано «Да». Если свойство не подлежит фильтрации, в ответе будет возвращено сообщение об ошибке, например, как показано ниже. Оно возвращается, если попытаться отфильтровать по свойству ChangeKey.

    {
      "error":
      {
        "code":"ErrorInvalidProperty",
        "message":"The property 'ChangeKey' does not support filtering."
      }
    }

При использовании неподдерживаемого метода фильтрации появляется сообщение об ошибке, подобное тому, которое возвращается в случае использования метода фильтрации startswith для свойства Subject:

    {
      "error":
      {
        "code":"ErrorInvalidUrlQueryFilter",
        "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
      }
    }

Оператор	Type	Пример
and	Логическое «И» (используется для объединения нескольких условий)	TotalCount gt 0 and ChildFolderCount eq 0
or	Логическое «Или» (используется для объединения нескольких условий)	TotalCount gt 0 or ChildFolderCount eq 0
eq	Равно	IsRead eq false
ne	Не равно	Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt	Больше	ReceivedDateTime gt 2014-09-01T00:00:00Z
ge	Больше или равно	LastModifiedDateTime ge 2014-09-01T00:00:00Z
lt	Меньше	ReceivedDateTime lt 2014-09-01T00:00:00Z
le	Меньше или равно	LastModifiedDateTime le 2014-09-01T00:00:00Z

Для разграничения любых строковых значений в условии фильтрации используются одинарные кавычки ('). Используйте %27 для URL-кодирования одинарных кавычек. Сама строка не чувствительна к регистру.

Давайте посмотрим на некоторые примеры. Для простоты URL-адреса в примерах не были закодированы в URL; однако если вы попробуете использовать эти примеры, обязательно используйте кодировку URL перед отправкой их на сервер.

Чтобы получить все события из календаря пользователя по умолчанию, которые начинаются с или после определенной даты, можно фильтровать по свойству Start.

GET https://outlook.office.com/api/beta/me/events?$filter=Start/DateTime ge '2016-04-01T08:00'

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

GET https://outlook.office.com/api/beta/me/events?$filter=Subject eq 'Mega Charity Bash'

Чтобы получить все непрочитанные сообщения в папке «Входящие», можно фильтровать по свойству IsRead.

GET https://outlook.office.com/api/beta/me/messages?$filter=IsRead eq false

Чтобы получить все сообщения с вложениями, имеющиеся в папке «Входящие», можно выполнить фильтрацию по свойству HasAttachments.

GET https://outlook.office.com/api/beta/me/messages?$filter=HasAttachments eq true

Чтобы получить все сообщения в папке «Входящие», полученные с 1 сентября 2014 года, можно фильтровать по свойству ReceivedDateTime.

GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime ge 2014-09-01

Чтобы получить все имеющиеся в папке «Входящие» сообщения, отправленные с адреса «hr@contoso.com», можно выполнить фильтрацию по свойству Sender.

GET https://outlook.office.com/api/beta/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

В приведенных выше примерах кодировка URL-адреса не применялась. Здесь приводятся те же примеры с закодированым URL-адресом, готовые к отправке на ваш сервер:

GET https://outlook.office.com/api/beta/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/beta/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/beta/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/beta/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/beta/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27

Выберите определенные свойства, которые необходимо возвратить

Чтобы указать только те свойства, которые необходимы вашему приложению, можно использовать параметр запроса $select.

Примечание

При получении элементов почты, календаря и контактов, всегда используйте параметр $select, чтобы исключить ненужные свойства из полезных данных ответа с целью поддержания надлежащей производительности приложения. Без применения параметра $select возвращаются все свойства элементов.

В следующем примере выполняется получение свойств Subject, Sender и ReceivedDateTime для всех сообщений в папке «Входящие».

GET https://outlook.office.com/api/beta/me/messages?$select=Subject,Sender,ReceivedDateTime

Сортировка результатов

Результаты можно сортировать с помощью параметра запроса $orderby. Задайте имя свойства в качестве значения этого параметра и, если требуется, укажите, следует ли выполнить сортировку по возрастанию (по умолчанию) или по убыванию. Помните о том, что использование параметра запроса $orderby с $search не допускается.

В следующем примере без кодирования URL-адреса производится получение всех сообщений, имеющихся в папке «Входящие» и отсортированных по свойству ReceivedDateTime в порядке убывания.

GET https://outlook.office.com/api/beta/me/messages?$orderby=ReceivedDateTime desc

Тот же пример с кодировкой URL:

GET https://outlook.office.com/api/beta/me/messages?$orderby=ReceivedDateTime%20desc

Страница результатов

По умолчанию запрос GET в отношении свойства Messages или ChildFolders, коллекции, или CalendarView, возвращает десять записей (максимум 50). Это можно изменить с помощью параметра запроса $top, что позволит установить максимальное количество. В следующем примере показана процедура получения первых пяти сообщений, содержащихся в папке «Входящие».

GET https://outlook.office.com/api/beta/me/messages?$top=5

Если в папке «Входящие» находится более пяти сообщений, ответ включает свойство odata.nextLink. Наличие этого свойства указывает на то, что на сервере доступны дополнительные элементы. Значение этого свойства представляет собой URI, который можно использовать для получения следующих пяти элементов.

GET https://outlook.office.com/api/beta/me/messages?$top=5&$skip=5

Разбиение по страницам производится с помощью параметра $top, позволяющего указать размер страницы, и параметра $skip, характеризующего кратность размеру страницы. Увеличивая значение параметра $skip на величину, равную размеру страницы, можно произвести запрос следующей страницы в наборе результатов.

Подсчет объектов в коллекции

Количество объектов в коллекции можно получить с помощью параметра $count. Запрос количества также можно фильтровать.

В этом примере отображается количество сообщений в папке «Входящие».

GET https://outlook.office.com/api/beta/me/messages/$count

А в этом примере без кодировки URL возвращается количество непрочитанных сообщений в папке «Входящие».

GET https://outlook.office.com/api/beta/me/messages/$count?$filter=IsRead eq false

Тот же пример с кодированием URL-адреса.

GET https://outlook.office.com/api/beta/me/messages/$count?$filter=IsRead%20eq%20false

Подведение итогов

Вы можете комбинировать параметры для создания сложных запросов. В примере ниже создается более точный запрос сообщений в папке «Входящие» следующими способами.

• Возвращаются только те элементы, свойству Importance которых присвоено значение High.

• Возврат только свойств Subject, Sender и ReceivedDateTime.

• Возвращаются только первые пять сообщений.

Примечание

Кодирование URL-адреса в данном случае не используется. Чтобы сделать пример удобочитаемым, были добавлены разрывы строк.

https://outlook.office.com/api/beta/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,ReceivedDateTime
    &$top=5

При указании $filter порядок сортировки результатов определяется сервером. При одновременном использовании $filter и $orderby свойства в $filter следует указать в $orderby перед всеми другими свойствами и привести их в том порядке, в котором они представлены в параметре $filter.

В следующем примере показан запрос, отфильтрованный по свойствам Subject и Importance, а затем отсортированный по свойствам Subject, Importance и Sender.

https://outlook.office.com/api/beta/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

Здесь приводятся те же примеры с кодированием URL-адреса и без разрывов строк.

https://outlook.office.com/api/beta/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,ReceivedDateTime&$top=5

https://outlook.office.com/api/beta/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender

См. также

• Outlook REST API для центра разработки Outlook
• Обзор разработки на платформе Office 365
• Проверка подлинности приложений и авторизация ресурсов в Office 365
• Вручную зарегистрируйте ваше приложение в Azure AD для предоставления ему доступа к API Office 365
• Справочник по REST API почты Outlook
• Справочник по API REST «Календарь» Outlook
• Справочник по REST API контактов Outlook
• Справочник по REST API задач Outlook