Справка по API REST Почты Outlook (версия 1.0)

Статья
06/30/2018

Примечание

Не рекомендуется использовать версию 1.0 API REST Outlook. Начиная с 1 ноября 2018 г. приложения не смогут использовать обычную проверку подлинности с конечной точкой v1.0 REST. К 1 ноября 2019 г. конечная точка v1.0 REST будет полностью выведена из эксплуатации, а вскоре после этого будет удалена документация версии 1.0. Чтобы использовать API REST Outlook в версии 1.0 Microsoft Graph, запустите миграцию вашего приложения. Дополнительные сведения см. в нашем объявлении.

API Почты Outlook позволяет читать, создавать и отправлять сообщения и вложения, просматривать и отвечать на сообщения о событиях, а также управлять папками, защищенными Azure Active Directory в Office 365. Он также обеспечивает такую же функциональность в учетных записях Майкрософт непосредственно в этих доменах: Hotmail.com, Live.com, MSN.com, Outlook.com и Passport.com.

Примечание

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

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

Все операции API Почты

Операции с сообщениями

Сообщения хранятся в папках почтовых ящиков, поэтому конечные точки сообщения часто включают в себя папку, содержащую сообщение. Папка указывается либо по идентификатору, либо по одному из следующих стандартных имен папок: Inbox, Drafts, SentItems или DeletedItems.

Получение сообщений
Синхронизация сообщений
Создание и отправка сообщений
Ответить или ответить всем на сообщения
Переадресация новых сообщений или черновиков сообщений
Обновление сообщений
Удаление сообщений
Перемещение или копирование сообщений
Управление сортировкой почты
Управление @-Упоминаниями (предварительная версия)
Управление правилами (предварительная версия)
Отписаться (предварительная версия)
Получение вариантов языков (предварительная версия)
Получение вариантов выбора часового пояса (предварительная версия)
Получение параметров почтового ящика
Получение параметров автоответчика
Обновление параметров автоответчика
Получить подсказки (предварительная версия)
Получение вложений
Создание вложений
Удаление вложений

Операции с папками

Папки почтового ящика могут содержать сообщения и другие папки. Вы можете получать, создавать, изменять, удалять папки и управлять ими. Чтобы указать соответствующую папку, вместо идентификатора вы можете использовать следующие стандартные имена папок: Inbox, SentItems, Drafts или DeletedItems.

Получение папок
Синхронизация папок
Создание папок
Обновление папок
Удалить папки
Переместить или скопировать папки

См. также

Использовать REST API Почты

Проверка подлинности

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

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

Версия API

REST API Почты поддерживается во всех версиях REST API Outlook. Функциональность может отличаться в зависимости от конкретной версии.

Целевой пользователь

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

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

Получение сообщений

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

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

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

Prefer: outlook.allow-unsafe-html

В настоящее время операция GET возвращает тексты сообщений только в формате HTML.

Получить коллекцию сообщений
Получить сообщение

Получить коллекцию сообщений

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.read
wl.imap

Примечание

Поведение операций в этом разделе зависит от версии. Узнайте больше, выбрав нужную версию в разделе Справка по Office 365 REST API в содержании в левой части.

Получить коллекцию сообщений из папки "Входящие".

GET https://outlook.office.com/api/v1.0/me/messages

Вы также можете указать папку в почтовом ящике пользователя и получить коллекцию сообщений из этой папки.

GET https://outlook.office.com/api/v1.0/me/MailFolders/{folder_id}/messages

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор папки или стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`, если вы получаете сообщения из определенной папки.

Примечание

По умолчанию каждое сообщение в ответе включает все его свойства. Для лучшей производительности используйте $select, чтобы указать только те свойства, которые вам нужны. Свойство Id всегда возвращается. Параметры фильтрации, сортировки и поискового вызова см. в разделе Параметры запроса OData.

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

Пример запроса

GET https://outlook.office.com/api/v1.0/me/folders/sentitems/messages/?$select=Sender,Subject

Пример отклика

Код состояния: 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders('sentitems')/Messages(Sender,Subject)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqS\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIzAAAA=",
            "Subject": "Meeting Notes",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=",
            "Subject": "Contract Signing",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        },
        {
            "@odata.type": "#Microsoft.OutlookServices.EventMessage",
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
            "@odata.etag": "W/\"CwAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqJ\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy9AAA=",
            "Subject": "Rob:Alex 1:1",
            "Sender": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "/O=EXCHANGELABS/OU=EXCHANGE ADMINISTRATIVE GROUP (FYDIBOHF23SPDLT)/CN=RECIPIENTS/CN=1A5F1737122542AEA595DF9590A1C6FD-ALEXD"
                }
            }
        }
    ]
}

Тип ответа

Запрошенная коллекция сообщений.

Получить сообщение

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.read
wl.imap

Получите сообщение по идентификатору.

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения.

Пример запроса

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=

Пример отклика

Код состояния: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:41:57Z",
  "DateTimeLastModified": "2014-10-20T00:41:57Z",
  "Subject": "Re: Meeting Notes",
  "BodyPreview": "________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP",
  "Body": {
    "ContentType": "Text",
    "Content": "\n________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP\n"
  },
  "Importance": "Normal",
  "HasAttachments": true,
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Katie Jordan"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Katie Jordan"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Alex D"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAEmjRj3pwjRLrbymGMYyEto=",
  "DateTimeReceived": "2014-10-20T00:41:57Z",
  "DateTimeSent": "2014-10-20T00:41:53Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": false
}

Тип ответа

Запрошенное сообщение.

Примечание

По умолчанию отклик включает все свойства указанного сообщения. Для лучшей производительности используйте $select, чтобы указать только те свойства, которые вам нужны. Свойство Id всегда возвращается. Параметры фильтрации, сортировки и поискового вызова см. в разделе Параметры запроса OData.

В следующем примере показано, как использовать $select, чтобы задать возврат только свойств Sender и Subject сообщения в ответе.

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGEI5MTAAA=?$select=Sender,Subject

Синхронизация сообщений

Эта функция в настоящий момент доступна только в версии 2.0 и в бета-версии. Чтобы узнать больше, в оглавлении слева перейдите в раздел Справка по REST API для Office 365 и выберите нужную вам версию.

Создать и отправить сообщения

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

Отправить новое сообщение на лету
Создать черновик сообщения
Отправить черновик сообщения

Отправить новое сообщение на лету

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.send
wl.imap

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

POST https://outlook.office.com/api/v1.0/me/sendmail

Обязательный параметр	Тип	Описание
Параметры текста сообщения
Message	Message	Сообщение для отправки.
SaveToSentItems	boolean (логический)	Указывает, сохранять ли сообщение в папке «Отправленные». По умолчанию true.

Укажите параметр Message с требуемым свойством ToRecipients и любыми доступными для записи свойствами сообщения в теле запроса. Параметр SaveToSentItems требуется, только если false.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/sendmail

{
  "Message": {
    "Subject": "Meet for lunch?",
    "Body": {
      "ContentType": "Text",
      "Content": "The new cafeteria is open."
    },
    "ToRecipients": [
      {
        "EmailAddress": {
          "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
      }
    ],
    "Attachments": [
      {
        "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
        "Name": "menu.txt",
        "ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk="
      }
    ]
  },
  "SaveToSentItems": "false"
}

Пример отклика

Status code: 202

Создать черновик сообщения

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Создание черновика нового сообщения. Черновики могут быть созданы в любой папке и по желанию обновлены перед отправкой. Чтобы сохранить в папке «Черновики», используйте ярлык /me/messages.

POST https://outlook.office.com/api/v1.0/me/messages
POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/messages

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор папки назначения либо стандартное имя папки `Inbox` или `Drafts`.

Укажите любые записываемые свойства сообщения в тексте запроса.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/folders/inbox/messages

Content-Type: application/json

{
  "Subject": "Did you see last night's game?",
  "Importance": "Low",
  "Body": {
    "ContentType": "HTML",
    "Content": "They were <b>awesome</b>!"
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
      }
    }
  ]
}

Пример отклика

Код состояния: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEPAAAmP1Ln1wcHRariNdTMGAO9AAASz7k0AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5",
  "Categories": [],
  "DateTimeCreated": "2014-10-18T20:06:51Z",
  "DateTimeLastModified": "2014-10-18T20:06:51Z",
  "Subject": "Did you see last night's game?",
  "BodyPreview": "They were awesome!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nThey were <b>awesome</b>!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Low",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEPAAA=",
  "From": null,
  "Sender": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAQADXiGXoAtX9IubRTpv2hisc=",
  "DateTimeReceived": "2014-10-18T20:06:51Z",
  "DateTimeSent": "2014-10-18T20:06:51Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

Тип ответа

Черновик сообщения.

Отправить черновик сообщения

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.send
wl.imap

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/send

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор черновика сообщения для отправки.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz7k0AAA=/send

Пример отклика

Status code: 202

Ответить или ответить всем на сообщения

Примечание

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

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

Ответ отправителю на лету
Ответить всем на лету
Создать черновик ответного сообщения
Создайте черновик сообщения «ответить всем»

Ответ отправителю на лету

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.send
wl.imap

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

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/reply

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения для ответа.
Параметры текста сообщения
Комментарий	string	Добавляемый комментарий. Может быть пустой строкой.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/reply
Content-Type: application/json

{
  "Comment": "Sounds great! See you tomorrow."
}

Пример отклика

Status code: 202

Ответить всем на лету

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.send
wl.imap

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

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/replyall

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения для ответа.
Параметры текста сообщения
Комментарий	string	Добавляемый комментарий. Может быть пустой строкой.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0MSz8DmAAA=/replyall
Content-Type: application/json

{
  "Comment": "Thanks for the heads up."
}

Пример отклика

Status code: 202

Создать черновик ответного сообщения

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreply

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения для ответа.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkADA1MTAAAAqldOAAA=/createreply

Пример отклика

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKoAAA=')",
  "@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO\"",
  "Id": "AAMkADA1MTAAAH5JKoAAA=",
  "CreatedDateTime": "2016-03-15T08:33:43Z",
  "LastModifiedDateTime": "2016-03-15T08:33:43Z",
  "ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO",
  "Categories": [ ],
  "ReceivedDateTime": "2016-03-15T08:33:43Z",
  "SentDateTime": "2016-03-15T08:33:43Z",
  "HasAttachments": false,
  "InternetMessageId": "<DM2PR00MB00571796B16132601E1F286CF7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
  "Subject": "RE: Let's start a group",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<body>Fanny, would you name the group if the project is approved, please?\r\n<b>From:</b> Fanny Downs<br>\r\n<b>Sent:</b> Friday, March 4, 2016 12:23:35 AM<br>\r\n<b>To:</b> Admin<br>\r\n<b>Subject:</b> Re: Let's start a group</font>\r\n<p>That's a great idea!<br>\r\n</body>\r\n</html>"
  },
  "BodyPreview": "Fanny, would you name the group if the project is approved, please?\r\n________________________________\r\nFrom: Fanny Downs\r\nSent: Friday, March 4, 2016 12:23:35 AM\r\nTo: Admin\r\nSubject: Re: Let's start a group\r\n\r\n\r\nThat's a gre",
  "Importance": "Normal",
  "ParentFolderId": "AQMkADA1MTAAAAIBDwAAAA==",
  "Sender": {
    "EmailAddress": {
      "Name": "Admin",
      "Address": "admin@contoso.onmicrosoft.com"
    }
  },
  "From": null,
  "ToRecipients": [
    {
      "EmailAddress": {
        "Name": "Fanny Downs",
        "Address": "fannyd@contoso.onmicrosoft.com"
      }
    }
  ],
  "CcRecipients": [ ],
  "BccRecipients": [ ],
  "ReplyTo": [ ],
  "ConversationId": "AAQkADA1MTVGjIwpLvWmGtIo-aFE=",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsRead": true,
  "IsDraft": true,
  "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKoAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
  "MentionedMe": null,
  "AppliedHashtagsPreview": null,
  "LikesPreview": null,
  "MentionsPreview": null,
  "Mentioned": [ ],
  "InferenceClassification": "Focused",
  "UnsubscribeData": [ ],
  "UnsubscribeEnabled": false,
  "Flag": { "FlagStatus": "NotFlagged" }
}

Тип ответа

Черновик ответного сообщения с ToRecipient, IsDraft и другими соответствующими предварительно созданными свойствами.

Создайте черновик сообщения «ответить всем»

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createreplyall

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения для ответа.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/createreplyall

Пример отклика

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k5AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF\"",
  "Id": "AAMkAGE0Mz7k5AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF",
  "Categories": [],
  "CreatedDateTime": "2014-10-18T21:21:06Z",
  "LastModifiedDateTime": "2014-10-18T21:21:06Z",
  "Subject": "RE: Check out the new Office 365 APIs",
  "BodyPreview": "If the project gets approved, please decide on the name.\r\n_________________________________\r\nFrom: Alex D\r\nSent: Saturday, October 18, 2014 9:18:18 PM\r\nTo: Katie Jordan; Garth Fort\r\nSubj",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n...</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MAAEPAAA=",
  "From": null,
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0M3HbTkEU=",
  "ReceivedDateTime": "2014-10-18T21:21:06Z",
  "SentDateTime": "2014-10-18T21:21:06Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

Тип ответа

Черновик сообщения «ответить всем» с предварительно заполненными соответствующим образом свойствами ToRecipient, IsDraft и т. д.

Переадресация новых сообщений или черновиков сообщений

Примечание

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

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

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

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.send
wl.imap

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

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/forward

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения для пересылки.
Параметры текста сообщения
Комментарий	string	Добавляемый комментарий. Может быть пустой строкой.
ToRecipients	Коллекция (Получатель)	Список получателей.

Укажите параметры Comment и ToRecipients в тексте запроса.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/forward
Content-Type: application/json

{
  "Comment": "FYI",
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
      }
    }
  ]
}

Пример отклика

Status code: 202

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

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/createforward

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения для пересылки.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8DmAAA=/createforward

Пример отклика

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k6AAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG\"",
  "Id": "AAMkAGE0Mz7k6AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG",
  "Categories": [],
  "CreatedDateTime": "2016-03-15T08:42:10Z",
  "LastModifiedDateTime": "2016-03-15T08:42:10Z",
  "Subject": "FW: Let's start a group",
  "BodyPreview": "Dana, just want to make sure you get this.\r\n________________________________\r\nFrom: Admin\r\nSent: Tuesday, March 15, 2016 6:47:54 AM\r\nTo: Fanny Downs; Randi Welch\r\nSubject: RE: Let's st",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n...</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MAAEPAAA=",
  "From": null,
  "Sender": {
    "EmailAddress": {
      "Address": "'alexd@contoso.onmicrosoft.com'",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0M3HbTkEU=",
  "ReceivedDateTime": "2016-03-15T08:42:10Z",
  "SentDateTime": "2016-03-15T08:42:10Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": true,
  "IsRead": true
}

Тип ответа

Черновик переадресуемого сообщения с установленным флагом IsDraft и предварительно заполненными соответствующими свойствами.

Обновление сообщений

Измените записываемые свойства в сообщении и сохраните изменения.

Обновить сообщение

Обновить сообщение

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Изменить записываемые свойства в черновике или существующем сообщении. Будут изменены только указанные вами свойства.

PATCH https://outlook.office.com/api/v1.0/me/messages/{message_id}

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения, которое нужно обновить.

Укажите любые записываемые свойства сообщения в тексте запроса.

Пример запроса

PATCH https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAAmP1Ln1wcHRariNdTMGAO9AAASz8S-AAA=

Content-Type: application/json

{
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "IsRead": true
}

Пример отклика

Код состояния: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAAmP1Ln1wcHRariNdTMGAO9AAASz8S-AAA=",
  "ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP",
  "Categories": [
    "Orange category",
    "Green category"
  ],
  "DateTimeCreated": "2014-10-17T17:12:15Z",
  "DateTimeLastModified": "2014-10-19T03:24:35Z",
  "Subject": "Meeting notes from today",
  "BodyPreview": "See attached",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<style type=\"text/css\" style=\"display:none\"><!-- p { margin-top: 0px; margin-bottom: 0px; }--></style>\r\n</head>\r\n<body dir=\"ltr\">\r\n<div id=\"divtagdefaultwrapper\" style=\"color: rgb(0, 0, 0); font-family: Calibri,Arial,Helvetica,sans-serif; font-size: 12pt; background-color: rgb(255, 255, 255);\">\r\n<p>See attached</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": true,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAQANKneItHNYxNlwnKip-qvhs=",
  "DateTimeReceived": "2014-10-17T17:12:15Z",
  "DateTimeSent": "2014-10-17T17:12:12Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

Тип ответа

Обновленное сообщение.

Удаление сообщений

Удалить сообщение

Примечание

Будьте осторожны при удалении сообщений. Удаленное содержимое не может быть восстановлено. Подробнее см. Удаление элементов.

Удалить сообщение

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

DELETE https://outlook.office.com/api/v1.0/me/messages/{message_id}

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения, которое нужно удалить.

Пример запроса

DELETE https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8TBAAA=

Пример отклика

Status code: 204

Перемещение или копирование сообщений

Вы можете перемещать или копировать сообщение в папку.

Переместить сообщение
Скопировать сообщение

Переместить сообщение

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

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

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/move

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	ИД сообщения, которое нужно переместить.
Параметры текста сообщения
DestinationId	string	Идентификатор целевой папки либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=/move

Content-Type: application/json

{
  "DestinationId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA="
}

Пример отклика

Код состояния: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTshBhAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:13:21Z",
  "DateTimeLastModified": "2014-10-20T00:13:23Z",
  "Subject": "Contract Signing",
  "BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
  "Body": {
    "ContentType": "Text",
    "Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAKjRc0YJSUBJpofjWgitxag=",
  "DateTimeReceived": "2014-10-20T00:13:21Z",
  "DateTimeSent": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

Тип ответа

Сообщение, которое было перемещено.

Скопировать сообщение

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Копирование сообщения в папку.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/copy

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	ИД сообщения, которое нужно скопировать.
Параметры текста сообщения
DestinationId	string	Идентификатор целевой папки либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADTIy-AAA=/copy

Content-Type: application/json

{
  "DestinationId": "inbox"
}

Пример отклика

Код состояния: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIS\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEJAACd9nJ-tVysQos2hTfspaWRAAADT8DtAAA=",
  "ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
  "Categories": [],
  "DateTimeCreated": "2014-10-20T00:13:21Z",
  "DateTimeLastModified": "2014-10-20T00:13:23Z",
  "Subject": "Contract Signing",
  "BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
  "Body": {
    "ContentType": "Text",
    "Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "From": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "Sender": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Alex D"
    }
  },
  "ToRecipients": [
    {
      "EmailAddress": {
        "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Katie Jordan"
      }
    },
    {
      "EmailAddress": {
        "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Garth Fort"
      }
    }
  ],
  "CcRecipients": [],
  "BccRecipients": [],
  "ReplyTo": [],
  "ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAKjRc0YJSUBJpofjWgitxag=",
  "DateTimeReceived": "2014-10-20T00:13:21Z",
  "DateTimeSent": "2014-10-20T00:13:21Z",
  "IsDeliveryReceiptRequested": false,
  "IsReadReceiptRequested": false,
  "IsDraft": false,
  "IsRead": true
}

Тип ответа

Новая копия сообщения.

Управление сортировкой почты

Эта функция в настоящий момент доступна в версии 2.0 и бета-версии. Чтобы узнать больше, в оглавлении слева перейдите в раздел Справка по REST API для Office 365 и выберите одну из этих версий.

Управление @-Упоминаниями (предварительная версия)

Эта функция в настоящий момент доступна в бета-версии. Чтобы узнать больше, в оглавлении слева перейдите в раздел Справка по REST API для Office 365 и выберите бета.

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

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

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

Эта функция в настоящий момент доступна только в бета-версии. Чтобы узнать больше, в оглавлении слева перейдите в раздел Справка по REST API для Office 365 и выберите бета.

Получить варианты выбора часового пояса (предварительная версия)

Получение параметров почтового ящика

Получение параметров автоответчика

Обновление параметров автоответчика

Получить Подсказки (предварительная версия)

Получение вложений

Можно получить коллекцию вложений или получить вложение. Вложения могут быть файлами (например,

Получить коллекцию вложений
Получить вложение

Получить коллекцию вложений

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.read
wl.imap

Получите вложения из определенного сообщения.

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения.

Примечание

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

Тип ответа

Коллекция вложений, которые могут быть объектами типа FileAttachment или ItemAttachment.

Пример запросов и ответов

В следующем примере показано, как с помощью $select задать возврат только свойства Name каждого вложенного файла в ответе. См. пример ответа в Получить вложение для полного списка свойств, которые будут возвращены для вложения, если вы не используете $select.

Пример запроса

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=/attachments?$select=Name

Пример отклика

Код состояния: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA%3D')/Attachments",
  "value": [
    {
      "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAABEgAQANQEWV4bM8FIlPwxj4kShdM=",
      "Name": "minutes.docx",
      "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "Size": 11585,
      "IsInline": false,
      "DateTimeLastModified": "2014-10-20T00:41:52Z",
      "ContentId": null,
      "ContentLocation": null,
      "IsContactPhoto": false,
      "ContentBytes": "UEsDBBQABgAIAAAAIQDCAAA4KQAAAAA="
    }
  ]
}

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

GET https://outlook.office.com/api/v1.0/me/messages('AAMkADFiNTPAAA=')/attachments

Content-Type: application/json

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkADFiNTPAAA%3D')/Attachments",
  "value": [
    {
      "@odata.type": "#Microsoft.OutlookServices.ItemAttachment",
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-20075df800e5@1717622f-1d94-4d0c-9d74-f907ad6677b4')/Messages('AAMkADFiNTPAAA=')/Attachments('AAMkADFiNTAUhhYuYi0=')",
      "Id": "AAMkADFiNTAUhhYuYi0=",
      "Name": "How to retrieve item attachment using Outlook REST API",
      "ContentType": message/rfc822,
      "Size": 71094,
      "IsInline": false,
      "DateTimeLastModified": "2015-09-24T05:57:59Z",
    }
  ]
}

Получить вложение

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.read
wl.imap

Получите вложение из определенного сообщения.

GET https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments/{attachment_id}

Примечание

Параметры фильтрации, сортировки и поискового вызова см. в разделе Параметры запроса OData.

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения.
attachment_id	string	Идентификатор вложения.

Примечание

По умолчанию ответ включает все свойства вложения. Для лучшей производительности используйте $select, чтобы указать только те свойства, которые вам нужны. Для примера см. раздел Получить коллекцию вложений. Свойство Id всегда возвращается. Параметры фильтрации, сортировки и поискового вызова см. в разделе Параметры запроса OData.

Тип ответа

Запрошенное вложение файла или вложение элемента.

Пример запроса

GET https://outlook.office.com/api/v1.0/me/messages/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAABEgAQANQEWV4bM8FIlPwxj4kShdM=

Пример отклика

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Messages('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEMAACd9nJ-tVysQos2hTfspaWRAAADTHVSAAA%3D')/Attachments/$entity",
  "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2j4kShdM=",
  "Name": "minutes.docx",
  "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "Size": 11585,
  "IsInline": false,
  "DateTimeLastModified": "2014-10-20T00:41:52Z",
  "ContentId": null,
  "ContentLocation": null,
  "IsContactPhoto": false,
  "ContentBytes": "UEsDBBQABgAIAAAAIQDCAAA4KQAAAAA=",
}

Создание вложений

Вы можете создать вложенный файл или создать вложенный элемент для сообщения.

Создать вложение файла
Создать вложение элемента
Создать вложение ссылки

Создать вложение файла

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Добавьте вложение файла в сообщение.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения.
Параметры текста сообщения
@odata.type	string	`#Microsoft.OutlookServices.FileAttachment`
Name	string	Имя вложения.
ContentBytes	binary	Файл для вложения.

Укажите в тексте запроса параметры Name и ContentBytes, а также любые записываемые свойства вложения файла.

Тип ответа

Новое вложение файла.

Создать вложение элемента

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Добавьте вложенный элемент в сообщение.

POST https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения.
Параметры текста сообщения
@odata.type	string	`#Microsoft.OutlookServices.ItemAttachment`
Name	string	Имя вложения.
Item	Сущность Сообщение или Мероприятие.	Элемент для вложения.

Укажите в тексте запроса параметры Name и Item, а также любые записываемые свойства вложенного элемента.

Тип ответа

Новое вложение элемента.

Создать вложение ссылки

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Добавьте вложенную ссылку в сообщение.

Удаление вложений

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Удалить указанное вложение сообщения. Вложение может быть вложенным файлом или вложенным элементом.

DELETE https://outlook.office.com/api/v1.0/me/messages/{message_id}/attachments/{attachment_id}

Обязательный параметр	Тип	Описание
Параметры URL-адреса
message_id	string	Идентификатор сообщения.
attachment_id	string	Идентификатор вложения.

Пример запроса

DELETE https://outlook.office.com/api/v1.0/me/messages/AAMkAGE0Mz8S-AAA=/attachments/AAMkAGE0Mg67gL7o=

Пример отклика

Status code: 204

Получение папок

Вы можете получить коллекцию папок или получить папку в почтовом ящике пользователя.

Получить коллекцию папок
Получить папку

Получить коллекцию папок

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.read
wl.imap

Получите коллекцию папок в корневой папке вошедшего пользователя (.../me/folders) или в указанной папке. Вы можете использовать ярлык .../me/folders для получения коллекции папок верхнего уровня и перехода к другой папке.

GET https://outlook.office.com/api/v1.0/me/folders
GET https://outlook.office.com/api/v1.0/me/folders/{folder_id}/childfolders

Примечание

Параметры фильтрации, сортировки и поискового вызова см. в разделе Параметры запроса OData.

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор папки или стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`, если вы получаете папки из определенной папки.

Пример запроса

GET https://outlook.office.com/api/v1.0/me/folders

Пример отклика

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEfAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Conversation Action Settings",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEKAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Deleted Items",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEPAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Drafts",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEMAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Inbox",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEQAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Journal",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEeAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Junk Email",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAERAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Notes",
      "ChildFolderCount": 0
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAELAAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
      "DisplayName": "Outbox",
      "ChildFolderCount": 0
    }
  ]
}

Тип ответа

Запрошенная коллекция папок.

Получить папку

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.read
wl.imap

Получить папку по идентификатору.

GET https://outlook.office.com/api/v1.0/me/folders/{folder_id}

Примечание

Параметры фильтрации, сортировки и поискового вызова см. в разделе Параметры запроса OData.

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор целевой папки, либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.

Пример запроса

GET https://outlook.office.com/api/v1.0/me/folders/inbox

Пример отклика

Код состояния: 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEJAAA=",
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEIAAA=",
  "DisplayName": "Inbox",
  "ChildFolderCount": 0,
  "UnreadItemCount": 2,
  "TotalItemCount": 2
}

Тип ответа

Запрошенная папка.

Синхронизировать иерархию папок

Создание папок

Добавьте новую папку в коллекцию папок.

Создать папку

Создать папку

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Создайте дочернюю папку по имени, указанному в ** DisplayName** . DisplayName является единственным записываемым свойством для папки.

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/childfolders

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор целевой папки, либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.
Параметры текста сообщения
Отображаемое имя	string	Отображаемое имя папки.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/folders/inbox/childfolders

Content-Type: application/json

{
  "DisplayName": "Company"
}

Пример отклика

Код состояния: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders('inbox')/ChildFolders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Company",
  "ChildFolderCount": 0,
  "UnreadItemCount": 2,
  "TotalItemCount": 27
}

Тип ответа

Новая папка.

Замечания

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

Обновление папок

Изменить имя папки.

Обновить папку

Обновить папку

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Измените имя папки на указанное в DisplayName. Имя является единственным записываемым свойством для папки.

PATCH https://outlook.office.com/api/v1.0/me/folders/{folder_id}

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор целевой папки, либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.
Параметры текста сообщения
Отображаемое имя	string	Новое отображаемое имя папки.

Пример запроса

PATCH https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=

Content-Type: application/json

{
  "DisplayName": "Business"
}

Пример отклика

Код состояния: 200

}
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

Тип ответа

Обновленная папка.

Удалить папки

Удалите папку и все ее содержимое.

Примечание

Будьте осторожны при удалении папок. Удаленное содержимое не может быть восстановлено. Подробнее см. Удаление элементов.

Удаление папки

Удаление папки

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Удалить папку, указанную в folder_id.

DELETE https://outlook.office.com/api/v1.0/me/folders/{folder_id}

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор целевой папки, либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.

Пример запроса

DELETE https://outlook.office.com/api/v1.0/me/MailFolders/AAMkAGE0Mz-l_AAA=

Пример отклика

Status code: 204

Переместить или скопировать папки

Вы можете перемещать или копировать папку в другую папку.

Переместить папку
Скопировать папку

Переместить папку

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Переместите папку и ее содержимое в другую папку, используя метод Move.

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/move

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор целевой папки, либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.
Параметры текста сообщения
DestinationId	string	Идентификатор целевой папки либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=/move

Content-Type: application/json

{
  "DestinationId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAOyxQ9AAA="
}

Пример отклика

Код состояния: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAOyxQ9AAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

Тип ответа

Папка, которая была перемещена.

Скопировать папку

Минимальная требуемая область

Одно из следующих:

https://outlook.office.com/mail.readwrite
wl.imap

Скопируйте папку и ее содержимое в другую папку, используя метод Copy.

POST https://outlook.office.com/api/v1.0/me/folders/{folder_id}/copy

Обязательный параметр	Тип	Описание
Параметры URL-адреса
folder_id	string	Идентификатор целевой папки, либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.
Параметры текста сообщения
DestinationId	string	Идентификатор целевой папки либо стандартное имя папки `Inbox`, `Drafts`, `SentItems` или `DeletedItems`.

Пример запроса

POST https://outlook.office.com/api/v1.0/me/folders/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-l_AAA=/copy

Content-Type: application/json

{
  "DestinationId": "inbox"
}

Пример отклика

Код состояния: 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Folders/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAASz-mAAAA=",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEMAAA=",
  "DisplayName": "Business",
  "ChildFolderCount": 0,
  "UnreadItemCount": 4,
  "TotalItemCount": 38
}

Тип ответа

Новая копия папки.

Дальнейшие действия

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

Начало работы с REST API Почты, Календаря и Контактов.
Хотите увидеть примеры? Вот они.

Или узнайте больше об использовании платформы Office 365 здесь:

Поделиться через

Справка по API REST Почты Outlook (версия 1.0)

Все операции API Почты

Операции с сообщениями

Операции с папками

См. также

Использовать REST API Почты

Проверка подлинности

Версия API

Целевой пользователь

Получение сообщений

Получить коллекцию сообщений

Минимальная требуемая область

Пример запроса

Пример отклика

Тип ответа

Получить сообщение

Минимальная требуемая область

Пример запроса

Пример отклика

Тип ответа

Синхронизация сообщений

Создать и отправить сообщения

Отправить новое сообщение на лету

Минимальная требуемая область

Пример запроса

Пример отклика

Создать черновик сообщения

Минимальная требуемая область

Пример запроса

Пример отклика

Тип ответа

Отправить черновик сообщения

Минимальная требуемая область

Пример запроса

Пример отклика

Ответить или ответить всем на сообщения

Ответ отправителю на лету

Минимальная требуемая область

Пример запроса

Пример отклика

Ответить всем на лету

Минимальная требуемая область

Пример запроса

Пример отклика

Создать черновик ответного сообщения

Минимальная требуемая область

Пример запроса

Пример отклика

Тип ответа

Создайте черновик сообщения «ответить всем»

Минимальная требуемая область

Пример запроса

Пример отклика

Тип ответа

Переадресация новых сообщений или черновиков сообщений

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

Минимальная требуемая область

Пример запроса

Пример отклика

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

Минимальная требуемая область

Пример запроса

Пример отклика

Тип ответа

Обновление сообщений

Обновить сообщение

Минимальная требуемая область

Пример запроса

Пример отклика

Тип ответа

Удаление сообщений

Удалить сообщение

Минимальная требуемая область

Пример запроса

Пример отклика

Перемещение или копирование сообщений

Переместить сообщение

Минимальная требуемая область

Пример запроса