Тип ресурса eventMessage
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Сообщение, представляющее приглашение на собрание, отмену или ответ. Может быть одним из следующих значений: принятие, предварительное принятие или отклонение.
Объект eventMessage является производным от объекта message. eventMessage — это базовый тип для eventMessageRequest и eventMessageResponse. Свойство meetingMessageType определяет тип сообщения о событии.
Когда организатор или приложение отправляет приглашение на собрание, приглашение на собрание поступает в почтовый ящик приглашенного в качестве экземпляра eventMessage с типом meetingMessageTypeобъекта meetingRequest. Кроме того, Outlook автоматически создает экземпляр события в календаре приглашенного с предварительным значением свойства showAs.
Чтобы получить свойства связанного события в почтовом ящике приглашенного, приложение может использовать свойство навигации по событиямeventMessage, как показано в этом примере сообщения о событии get. Приложение также может отвечать на событие от имени приглашенного программным способом, принимая, предварительно принимая или отклоивая событие.
Помимо приглашения на собрание, экземпляр eventMessage можно найти в почтовом ящике приглашенного в результате отмены собрания организатором мероприятия или в почтовом ящике организатора в результате ответа приглашенного на приглашение на собрание. Приложение может предпринимать с сообщениями о событиях те же действия, что и с обычными сообщения (с небольшими отличиями).
Представление JSON
В следующем представлении JSON показан тип ресурса.
{
"bccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"categories": ["string"],
"ccRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"changeKey": "string",
"conversationId": "string",
"conversationIndex": "String (binary)",
"createdDateTime": "DateTimeOffset",
"endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"flag": {"@odata.type": "microsoft.graph.followupFlag"},
"from": {"@odata.type": "microsoft.graph.recipient"},
"hasAttachments": true,
"id": "string (identifier)",
"importance": "String",
"inferenceClassification": "String",
"internetMessageHeaders": [{"@odata.type": "microsoft.graph.internetMessageHeader"}],
"internetMessageId": "String",
"isAllDay": "Boolean",
"isDelegated": true,
"isDeliveryReceiptRequested": true,
"isDraft": true,
"isOutOfDate": "Boolean",
"isRead": true,
"isReadReceiptRequested": true,
"lastModifiedDateTime": "DateTimeOffset",
"location": {"@odata.type": "microsoft.graph.location"},
"meetingMessageType": {"@odata.type": "microsoft.graph.meetingMessageType"},
"mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
"parentFolderId": "string",
"receivedDateTime": "DateTimeOffset",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
"sender": {"@odata.type": "microsoft.graph.recipient"},
"sentDateTime": "DateTimeOffset",
"startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
"type": "string",
"uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
"UnsubscribeData": "string",
"UnsubscribeEnabled": true,
"webLink": "string"
}
Свойства
| Свойство | Тип | Описание |
|---|---|---|
| bccRecipients | Коллекция recipient | Получатели скрытой копии сообщения. |
| body | itemBody | Текст сообщения. В формате HTML или текстовом формате. |
| bodyPreview | String | Первые 255 символов в тексте сообщения. В текстовом формате. |
| categories | Коллекция String | Категории, сопоставленные с сообщением. |
| ccRecipients | Коллекция recipient | Получатели копии сообщения. |
| changeKey | String | Версия сообщения. |
| conversationId | String | Идентификатор беседы, к которой принадлежит электронное сообщение. |
| conversationIndex | Edm.Binary | Указывает место сообщения в беседе. |
| createdDateTime | DateTimeOffset | Дата и время создания сообщения. |
| endDateTime | dateTimeTimeZone | Время окончания запрошенного собрания. |
| flag | followupFlag | Значение флага, которое указывает статус, дату начала, дату выполнения или дату завершения сообщения. |
| from | recipient | Владелец почтового ящика, из которого отправлено сообщение. В большинстве случаев это значение совпадает со свойством sender, кроме сценариев предоставления общего доступа или делегирования. Значение должно соответствовать фактически используемому почтовому ящику. Дополнительные сведения о задании свойств from и sender сообщения. |
| hasAttachments | Boolean | Указывает на наличие вложений в сообщении. |
| id | String | Уникальный идентификатор сообщения.
По умолчанию это значение изменяется при перемещении элемента из одного контейнера (например, папки или календаря) в другой. Чтобы изменить это поведение, используйте заголовок Prefer: IdType="ImmutableId". Дополнительные сведения см. в статье Получение неизменяемых идентификаторов для ресурсов Outlook. Только для чтения. |
| importance | String | Важность сообщения: low, normal, high. |
| inferenceClassification | String | Возможные значения: focused, other. |
| internetMessageHeaders | Коллекция internetMessageHeader | Коллекция заголовков сообщений, установленных по RFC 5322, которые содержат информацию о маршруте прохождения сообщения. Только для чтения. |
| internetMessageId | String | Идентификатор сообщения в формате, установленном документом RFC5322. |
| isAllDay | Boolean | Указывает, длится ли событие весь день. Для настройки этого свойства необходимо также настроить свойства startDateTime и endDateTime события. |
| isDelegated | Логический | Значение true, если этот запрос на собрание доступен делегату, в противном случае — значение false. Значение по умолчанию: false. |
| isDeliveryReceiptRequested | Boolean | Указывает, запрашивается ли уведомление о прочтении сообщения. |
| isDraft | Логическое | Указывает, является ли сообщение черновиком. Сообщение считается черновиком, если оно еще не отправлено. |
| isOutOfDate | Логический | Указывает, был ли этот запрос на собрание устаревшим по последнему запросу. |
| isRead | Boolean | Указывает, прочитано ли сообщение. |
| isReadReceiptRequested | Boolean | Указывает, запрашивается ли уведомление о прочтении сообщения. |
| lastModifiedDateTime | DateTimeOffset | Дата и время последнего изменения сообщения. |
| location | location | Расположение запрошенного собрания. |
| meetingMessageType | String | Тип сообщения о событии: none, meetingRequest, meetingCancelled, meetingAccepted, meetingTentativelyAccepted, meetingDeclined. |
| mentionsPreview | mentionsPreview | Сведения об упоминаниях в сообщении. При обработке запроса GET /messages сервер устанавливает это свойство и включает его в отклик по умолчанию. Сервер возвращает значение null, если в сообщении нет упоминаний. Необязательное свойство. |
| parentFolderId | String | Уникальный идентификатор родительского ресурса mailFolder для сообщения. |
| receivedDateTime | DateTimeOffset | Дата и время получения сообщения. |
| recurrence | patternedRecurrence | Шаблон повторения запрошенного собрания. |
| replyTo | Коллекция recipient | Электронные адреса, которые необходимо использовать при ответе. |
| sender | recipient | Учетная запись, используемая для создания сообщения. В большинстве случаев это значение совпадает со значением свойства from. Этому свойству можно присвоить другое значение при отправке сообщения из общего почтового ящика, для общего календаря или в качестве делегата. В любом случае значение должно соответствовать фактически используемому почтовому ящику. Дополнительные сведения см. в разделе Настройка свойств from и sender. |
| sentDateTime | DateTimeOffset | Дата и время отправки сообщения. |
| startDateTime | dateTimeTimeZone | Время начала запрошенного собрания. |
| subject | String | Тема сообщения. |
| toRecipients | Коллекция recipient | Получатели сообщения, указанные в поле "Кому". |
| type | String | Тип запрошенного собрания: singleInstance, occurence, exception, seriesMaster. |
| uniqueBody | itemBody | Часть текста сообщения, которая уникальна для текущего сообщения. |
| Отменить подпискуData | String | Допустимые объекты, анализируемые из заголовка List-Unsubscribe Это данные для почтовой команды в заголовке List-Unsubscribe, если свойству UnsubscribeEnabled присвоено значение true. |
| Отменить подпискуEnabled | Boolean | Указывает, допускает ли сообщение отмену подписки. Имеет значение True, если заголовок List-Unsubscribe соответствует документу RFC-2369. |
| webLink | String | URL-адрес для открытия сообщения в Outlook в Интернете. Чтобы изменить способ отображения сообщения, можно добавить аргумент ispopout в конце URL-адреса. Если ispopout отсутствует или для него задано значение 1, сообщение отображается во всплывающем окне. Если параметр ispopout имеет значение 0, браузер отображает сообщение в области Outlook в Интернете. Сообщение откроется в браузере, если вы вошли в почтовый ящик через Outlook в Интернете. Если вы еще не вошли в браузер, вам будет предложено войти в систему. Этот URL-адрес не может быть получен из iFrame. |
Связи
| Связь | Тип | Описание |
|---|---|---|
| attachments | Коллекция attachment | Коллекция вложений fileAttachment, itemAttachment и referenceAttachment для сообщения. Только для чтения. Допускается значение null. |
| event | event | Событие, связанное с сообщением о событии. Для участников или ресурсов помещений предполагается, что помощник по ведению календаря настроен для автоматического обновления события в календаре, если поступают сообщения с приглашением на собрание. Свойство навигации. Только для чтения. |
| extensions | Коллекция extension | Коллекция открытых расширений, определенных для eventMessage. Только для чтения. Допускается значение null. |
| mentions | Коллекция mention | Коллекция упоминаний в сообщении, упорядоченных по свойству createdDateTime от новых к старым. По умолчанию значение /messages не возвращает это свойство, GET если оно не применяется $expand . |
| multiValueExtendedProperties | Коллекция multiValueLegacyExtendedProperty | Коллекция расширенных свойств с несколькими значениями, определенных для eventMessage. Только для чтения. Допускается значение null. |
| singleValueExtendedProperties | Коллекция singleValueLegacyExtendedProperty | Коллекция расширенных свойств с одним значением, определенных для eventMessage. Только для чтения. Допускается значение null. |
Методы
| Метод | Возвращаемый тип | Описание |
|---|---|---|
| Получение | eventMessage | Считывание свойств и отношений объекта eventMessage. |
| Обновление | eventMessage | Обновление объекта eventMessage. |
| Удаление | Нет | Удаление объекта eventMessage. |
| Копирование сообщения | message | Копирование сообщения в папку. |
| Создание черновика для пересылки сообщения | message | Создание черновика пересылаемого сообщения. После этого вы сможете обновить или отправить черновик. |
| Создание черновика для ответа | message | Создание черновика ответного сообщения. После этого вы сможете обновить или отправить черновик. |
| Создание черновика для ответа на все | message | Создание черновика сообщения для ответа всем пользователям. После этого вы сможете обновить или отправить черновик. |
| Пересылка сообщения | Нет | Пересылка сообщения. После этого сообщение сохраняется в папке "Отправленные". |
| Переместить сообщение | message | Перемещение сообщения в папку. При этом в целевой папке создается новая копия сообщения. |
| Ответ на сообщение | Нет | Ответ отправителю сообщения. После этого сообщение сохраняется в папке "Отправленные". |
| Ответить всем на сообщение | Нет | Ответ всем получателям сообщения. После этого сообщение сохраняется в папке "Отправленные". |
| Отправка черновика сообщения | Нет | Отправка ранее созданного черновика сообщения. После этого сообщение сохраняется в папке "Отправленные". |
| Сообщение об отзыве | message | Отзыв сообщения в папке "Отправленные" в почтовом ящике указанного пользователя. |
| Отмена подписки | Нет | Отправка сообщения, используя данные и адрес, указанные в это первой команде mailto заголовка List-Unsubscribe. |
| Удалить без возможности восстановления | Нет | Окончательно удалите сообщение о событии и поместите его в папку Purges в папке "Элементы с возможностью восстановления" в почтовом ящике пользователя. |
| Вложения | ||
| Список вложений | Коллекция attachment | Получение всех файлов, вложенных в сообщение о событии. |
| Добавление вложения | attachment | Вложение в сообщение о событии нового файла путем публикации в коллекции вложений. |
| Открытые расширения | ||
| Создание открытого расширения | openTypeExtension | Создание открытого расширения и добавление настраиваемых свойств в новый или существующий экземпляр ресурса. |
| Получение открытого расширения | Коллекция объектов openTypeExtension | Получите открытое расширение, идентифицируемое по имени. |
| Расширенные свойства | ||
| Создание однозначного свойства | eventMessage | Создание одного или нескольких расширенных свойств с одним значением в новом или существующем экземпляре eventMessage. |
| Получение однозначного свойства | eventMessage | Получение экземпляров eventMessage, которые содержат расширенное свойство с одним значением, с помощью параметра $expand или $filter. |
| Создание свойства с несколькими значениями | eventMessage | Создание одного или нескольких расширенных свойств с несколькими значениями в новом или существующем экземпляре eventMessage. |
| Получение свойства с несколькими значениями | eventMessage | Получение eventMessage, которое содержит расширенное свойство с несколькими значениями, с помощью параметра $expand. |