Тип ресурса message

  • Статья

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

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

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

Максимальное число получателей, включенное в свойства toRecipients, ccRecipients и bccRecipients для одного сообщения электронной почты, отправляемого из почтового ящика Exchange Online, равно 500. Дополнительные сведения см. в разделе Ограничения на отправку.

Этот ресурс поддерживает:

  • добавление собственных данных как настраиваемых заголовков сообщений Интернета. Добавляйте настраиваемые заголовки только при создании сообщения и выбирайте для них имя, начинающееся с "x-". После отправки сообщения вы не сможете изменить заголовки. Чтобы получить заголовки сообщения, примените параметр запроса $select в операции получения сообщения;
  • добавление собственных данных как настраиваемых свойств в виде расширений;
  • подписку на уведомления об изменениях;
  • отслеживание дополнений, удалений и обновлений с помощью запроса изменений (функция delta).

Методы

Метод Тип возвращаемых данных Описание
Список сообщений Коллекция message Получение всех сообщений в почтовом ящике пользователя, выполнившего вход (в том числе сообщений в папках "Удаленные" и "Несрочные").
Создание сообщения message Создание черновика нового сообщения.
Получение сообщения message Считывание свойств и отношений объекта message.
Обновление message Обновление объекта message.
Удаление Нет Удаление объекта message.
copy Message Копирование сообщения в папку.
createForward Сообщение Создание черновика пересылаемого сообщения, чтобы добавить комментарий или обновить любые свойства сообщения одновременно в одном вызове createForward. После этого вы сможете обновить или отправить черновик.
createReply Сообщение Создание черновика ответного сообщения, чтобы добавить комментарий или обновить любые свойства сообщения одновременно в одном вызове createReply. После этого вы сможете обновить или отправить черновик.
createReplyAll Сообщение Создание черновика сообщения "Ответить всем", чтобы добавить комментарий или обновить любые свойства сообщения одновременно в одном вызове createReplyAll. После этого вы сможете обновить или отправить черновик.
delta Коллекция объектов message Получение набора сообщений, которые были добавлены, удалены или обновлены в указанной папке.
forward Нет Пересылка сообщения, добавление комментария или изменение любого обновляемого свойства одновременно в одном вызове forward. После этого сообщение сохраняется в папке "Отправленные".
markAsJunk message Пометьте сообщение как нежелательное. Этот API добавляет отправителя в список заблокированных отправителей и перемещает сообщение в папку Нежелательная Email, если moveToJunk имеет значение true.
markAsNotJunk message Пометьте сообщение как не нежелательное. Этот API удаляет отправителя из списка заблокированных отправителей и перемещает сообщение в папку "Входящие" , если параметр moveToInbox имеет значение true.
move Message Перемещение сообщения в папку. При этом в целевой папке создается новая копия сообщения.
reply Нет Ответ отправителю сообщения, добавление комментария или изменение любых обновляемых свойств одновременно в одном вызове reply. После этого сообщение сохраняется в папке "Отправленные".
replyAll Нет Ответ всем получателям сообщения путем указания комментария и изменения любых обновляемых свойств ответа с помощью метода replyAll. После этого сообщение сохраняется в папке "Отправленные".
send Нет Отправка ранее созданного черновика сообщения. После этого сообщение сохраняется в папке "Отправленные".
unsubscribe Нет Отправка сообщения, используя данные и адрес, указанные в это первой команде mailto заголовка List-Unsubscribe.
Вложения
Список вложений Коллекция Attachment Получение всех вложений сообщения.
Добавление вложения Attachment Добавление нового вложения к сообщению путем публикации в коллекции вложений.
Открытые расширения
Создание открытого расширения openTypeExtension Создание открытого расширения и добавление настраиваемых свойств в новый или существующий ресурс.
Получение открытого расширения Коллекция объектов openTypeExtension Получение открытого расширения, определяемого именем расширения.
Расширения схемы
Добавление значений расширений для схемы Создание определения расширения схемы и его дальнейшее использование для добавления в ресурс введенных пользовательских данных.
Расширенные свойства
Создание однозначного расширенного свойства message Создание одного или нескольких расширенных свойств с одним значением в новом или существующем сообщении.
Получение сообщения с однозначным расширенным свойством message Получение сообщений, которые содержат однозначное расширенное свойство, с помощью $expand или $filter.
Создание многозначного расширенного свойства message Создание одного или нескольких многозначных расширенных свойств в новом или существующем сообщении.
Получение сообщения с многозначным расширенным свойством message Получение сообщения, которое содержит многозначное расширенное свойство, с помощью $expand.

Свойства

Свойство Тип Описание
bccRecipients Коллекция recipient Получатели скрытой копии сообщения.
body itemBody Текст сообщения. В формате HTML или текстовом формате. Сведения о надежном формате HTML в тексте сообщения.
bodyPreview String Первые 255 символов в тексте сообщения. В текстовом формате. Если сообщение содержит экземпляры упоминаний, это свойство будет также содержать объединение этих упоминаний.
ccRecipients Коллекция recipient Получатели копии сообщения.
changeKey String Версия сообщения.
conversationId String Идентификатор беседы, к которой принадлежит электронное сообщение.
conversationIndex Edm.Binary Указывает место сообщения в беседе.
createdDateTime DateTimeOffset Дата и время создания сообщения.

Сведения о времени и дате представлены в формате ISO 8601 (всегда используется формат UTC). Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z.
flag followupFlag Значение флага, которое указывает статус, дату начала, дату выполнения или дату завершения сообщения.
from recipient Владелец почтового ящика, из которого отправлено сообщение. В большинстве случаев это значение совпадает со свойством sender, кроме сценариев предоставления общего доступа или делегирования. Значение должно соответствовать фактически используемому почтовому ящику. Дополнительные сведения о задании свойств from и sender сообщения.
hasAttachments Boolean Указывает на наличие вложений в сообщении. Это свойство не включает встроенные вложения, поэтому, если сообщение содержит только встроенные вложения, это свойство имеет значение false. Чтобы проверить наличие встроенных вложений, выполните синтаксический анализ свойства body для поиска атрибута src , например <IMG src="cid:image001.jpg@01D26CD8.6C05F070">.
id String Уникальный идентификатор сообщения. По умолчанию это значение изменяется при перемещении элемента из одного контейнера (например, папки или календаря) в другой. Чтобы изменить это поведение, используйте заголовок Prefer: IdType="ImmutableId". Дополнительные сведения см. в статье Получение неизменяемых идентификаторов для ресурсов Outlook. Только для чтения.
importance importance Важность сообщения. Возможные значения: low, normal и high.
inferenceClassification inferenceClassificationType Классификация сообщения для пользователя на основании подразумеваемой релевантности или важности либо явного переопределения. Возможные значения: focused, other.
internetMessageHeaders Коллекция internetMessageHeader Коллекция заголовков сообщений, определенных документом RFC5322. Набор содержит заголовки сообщений, указывающие сетевой путь, пройденный сообщением от отправителя до получателя. Он также может содержать настраиваемые заголовки сообщений, содержащие данные приложения для сообщения.

Возвращается только при применении параметра запроса $select. Только для чтения.
internetMessageId String Идентификатор сообщения в формате, установленном документом RFC5322. Можно обновить, только если параметр isDraft имеет значение true.
isDeliveryReceiptRequested Boolean Указывает, запрашивается ли уведомление о прочтении сообщения.
isDraft Логическое Указывает, является ли сообщение черновиком. Сообщение считается черновиком, если оно еще не отправлено.
isRead Boolean Указывает, прочитано ли сообщение.
isReadReceiptRequested Boolean Указывает, запрашивается ли уведомление о прочтении сообщения.
lastModifiedDateTime DateTimeOffset Дата и время последнего изменения сообщения.

Сведения о времени и дате представлены в формате ISO 8601 (всегда используется формат UTC). Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z.
mentionsPreview mentionsPreview Сведения об упоминаниях в сообщении. При обработке запроса GET /messages сервер устанавливает это свойство и включает его в отклик по умолчанию. Сервер возвращает значение null, если в сообщении нет упоминаний. Необязательное свойство.
parentFolderId String Уникальный идентификатор родительского ресурса mailFolder для сообщения.
receivedDateTime DateTimeOffset Дата и время получения сообщения.

Сведения о времени и дате представлены в формате ISO 8601 (всегда используется формат UTC). Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z.
replyTo Коллекция recipient Электронные адреса, которые необходимо использовать при ответе.
sender recipient Учетная запись, которая фактически используется для создания сообщения. В большинстве случаев это значение совпадает со значением свойства from. Этому свойству можно присвоить другое значение при отправке сообщения из общего почтового ящика, для общего календаря или в качестве делегата. В любом случае значение должно соответствовать фактически используемому почтовому ящику. Дополнительные сведения о задании свойств from и sender сообщения.
sentDateTime DateTimeOffset Дата и время отправки сообщения.

Сведения о времени и дате представлены в формате ISO 8601 (всегда используется формат UTC). Например, значение полуночи 1 января 2014 г. в формате UTC: 2014-01-01T00:00:00Z.
subject String Тема сообщения.
toRecipients Коллекция recipient Получатели сообщения, указанные в поле "Кому".
uniqueBody itemBody Часть текста сообщения, которая уникальна для текущего сообщения. uniqueBody не возвращается по умолчанию, но его можно получить для заданного ?$select=uniqueBody сообщения с помощью запроса. В формате HTML или текстовом формате.
unsubscribeData String Допустимые объекты, анализируемые из заголовка List-Unsubscribe Это данные для почтовой команды в заголовке List-Unsubscribe, если свойству UnsubscribeEnabled присвоено значение true.
unsubscribeEnabled Boolean Указывает, допускает ли сообщение отмену подписки. Имеет значение True, если заголовок List-Unsubscribe соответствует документу RFC-2369.
webLink String URL-адрес для открытия сообщения в Outlook в Интернете.

Чтобы изменить способ отображения сообщения, можно добавить аргумент ispopout в конце URL-адреса. Если аргумент ispopout отсутствует или для него задано значение 1, то сообщение откроется во всплывающем окне. Если параметр ispopout имеет значение 0, браузер отображает сообщение в области Outlook в Интернете проверки.

Сообщение откроется в браузере, если вы вошли в почтовый ящик через Outlook в Интернете. Если вы еще не вошли в браузер, вам будет предложено войти в систему.

Доступ к этому URL-адресу невозможно получить из объекта iFrame.

Связи

Связь Тип Описание
attachments Коллекция Attachment Вложения fileAttachment и itemAttachment для сообщения.
extensions Коллекция Extension Коллекция открытых расширений, определенных для сообщения. Допускается значение null.
mentions Коллекция mention Коллекция упоминаний в сообщении, упорядоченных по свойству createdDateTime от новых к старым. По умолчанию запрос GET /messages не возвращает это свойство, если к свойству не применен параметр $expand.
multiValueExtendedProperties Коллекция multiValueLegacyExtendedProperty Коллекция многозначных расширенных свойств, определенных для сообщения. Допускается значение null.
singleValueExtendedProperties Коллекция singleValueLegacyExtendedProperty Коллекция однозначных расширенных свойств, определенных для сообщения. Допускается значение null.

Представление 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": "String (timestamp)",
  "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",
  "isDeliveryReceiptRequested": true,
  "isDraft": true,
  "isRead": true,
  "isReadReceiptRequested": true,
  "lastModifiedDateTime": "String (timestamp)",
  "mentionsPreview": {"@odata.type": "microsoft.graph.mentionsPreview"},
  "parentFolderId": "string",
  "receivedDateTime": "String (timestamp)",
  "replyTo": [{"@odata.type": "microsoft.graph.recipient"}],
  "sender": {"@odata.type": "microsoft.graph.recipient"},
  "sentDateTime": "String (timestamp)",
  "subject": "string",
  "toRecipients": [{"@odata.type": "microsoft.graph.recipient"}],
  "uniqueBody": {"@odata.type": "microsoft.graph.itemBody"},
  "unsubscribeData": "string",
  "unsubscribeEnabled": true,
  "webLink": "string",

  "attachments": [{"@odata.type": "microsoft.graph.attachment"}],
  "extensions": [{"@odata.type": "microsoft.graph.extension"}],
  "mentions": [{"@odata.type": "microsoft.graph.mention"}],
  "multiValueExtendedProperties": [{"@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty"}],
  "singleValueExtendedProperties": [{"@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty"}]
}

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