mailboxItem: delta

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

Получение набора объектов mailboxItem , которые были добавлены, удалены или обновлены в указанной папке mailboxFolder.

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

Этот API доступен в следующих национальных облачных развертываниях.

Глобальное обслуживание	Правительство США L4	Правительство США L5 (DOD)	Китай, обслуживаемый 21Vianet
✅	❌	❌	❌

Разрешения

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

Тип разрешения	Разрешения с наименьшим объемом привилегий	Разрешения с более высоким уровнем привилегий
Делегированные (рабочая или учебная учетная запись)	MailboxItem.Read	MailboxItem.ReadWrite
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	MailboxItem.Read.All	MailboxItem.ReadWrite.All

HTTP-запрос

GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/items/delta

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

Для отслеживания изменений в элементах выполняется один или несколько вызовов разностной функции. Если вы используете параметры запроса, отличные от $deltaToken и $skipToken, их необходимо указать в начальном запросе delta. Microsoft Graph автоматически кодирует указанные параметры в маркере, входящем в состав URL-адреса nextLink или deltaLink, включенного в отклик. Параметры запроса нужно указать только один раз в первом запросе. В последующих запросах просто скопируйте и примените nextLink URL-адрес или deltaLink из предыдущего ответа, поскольку этот URL-адрес уже содержит закодированные нужные параметры.

Параметр	Описание
$deltaToken	Маркер состояния, возвращаемый в deltaLink URL-адресе предыдущего вызова разностной функции для той же коллекции элементов, что указывает на завершение этого раунда отслеживания изменений. Сохраните URL-адрес deltaLink с этим токеном и примените его в первом запросе следующего цикла отслеживания изменений для этой коллекции.
$skipToken	Маркер состояния, возвращаемый в nextLink URL-адресе предыдущего вызова разностной функции, указывающий, что доступны дальнейшие изменения, которые можно отслеживать в той же коллекции элементов.

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

• Вы можете использовать параметр запроса, $select чтобы указать только те свойства, которые необходимы для наилучшей производительности. Свойство id возвращается всегда.
• Этот разностный запрос поддерживает $select параметры запроса and $top для элементов.
• Существует ограниченная поддержка для $filter и $orderby:
  • Поддерживаются только $filter$filter=receivedDateTime+ge+{value} выражения и $filter=receivedDateTime+gt+{value}.
  • Для параметра $orderby поддерживается только выражение $orderby=receivedDateTime+desc. Если вы не добавили выражение $orderby , порядок возврата не гарантируется.
• Параметр $search запроса не поддерживается.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения об аутентификации и авторизации.
Prefer	odata.maxpagesize={x}. Необязательный параметр. Управляет размером страницы.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успеха эта функция возвращает код отклика 200 OK и коллекцию объектов mailboxItem в тексте ответа.

Примеры

Запрос

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

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

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

HTTP

GET https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/AAMkAGUwNjQ4ZyTAAA=/items/delta
Prefer: odata.maxpagesize=2

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Admin.Exchange.Mailboxes["{mailbox-id}"].Folders["{mailboxFolder-id}"].Items.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.Headers.Add("Prefer", "odata.maxpagesize=2");
});

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

Go

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphadmin "github.com/microsoftgraph/msgraph-sdk-go/admin"
	  //other-imports
)

headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "odata.maxpagesize=2")

configuration := &graphadmin.ExchangeMailboxesItemFoldersItemItemsDeltaRequestBuilderGetRequestConfiguration{
	Headers: headers,
}

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delta, err := graphClient.Admin().Exchange().Mailboxes().ByMailboxId("mailbox-id").Folders().ByMailboxFolderId("mailboxFolder-id").Items().Delta().GetAsDeltaGetResponse(context.Background(), configuration)

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

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.admin().exchange().mailboxes().byMailboxId("{mailbox-id}").folders().byMailboxFolderId("{mailboxFolder-id}").items().delta().get(requestConfiguration -> {
	requestConfiguration.headers.add("Prefer", "odata.maxpagesize=2");
});

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/AAMkAGUwNjQ4ZyTAAA=/items/delta')
	.header('Prefer','odata.maxpagesize=2')
	.get();

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Admin\Exchange\Mailboxes\Item\Folders\Item\Items\Delta\DeltaRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$headers = [
		'Prefer' => 'odata.maxpagesize=2',
	];
$requestConfiguration->headers = $headers;


$result = $graphServiceClient->admin()->exchange()->mailboxes()->byMailboxId('mailbox-id')->folders()->byMailboxFolderId('mailboxFolder-id')->items()->delta()->get($requestConfiguration)->wait();

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

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.admin.exchange.mailboxes.item.folders.item.items.delta.delta_request_builder import DeltaRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

request_configuration = RequestConfiguration()
request_configuration.headers.add("Prefer", "odata.maxpagesize=2")


result = await graph_client.admin.exchange.mailboxes.by_mailbox_id('mailbox-id').folders.by_mailbox_folder_id('mailboxFolder-id').items.delta.get(request_configuration = request_configuration)

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

Отклик

Если запрос выполнен успешно, отклик содержит маркер состояния, который является либо $skipToken (в заголовке ответа @odata.nextLink ), либо ( $deltaToken в заголовке ответа @odata.deltaLink ). Соответственно, они указывают, следует ли вам продолжить раунд или вы завершили получение всех изменений для этого раунда.

В следующем примере показан заголовок ответа $skipToken@odata.nextLink .

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

HTTP/1.1 200 OK
Content-Type: application/json
Content-length: 337

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(mailboxItem)",
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/AAMkAGUwNjQ4ZyTAAA=/items/delta?$skiptoken={_skipToken_}",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxItem",
            "@odata.etag": "W/\"CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAFR+6ZT\"",
            "createdDateTime": "2021-10-19T06:30:30Z",
            "lastModifiedDateTime": "2021-10-19T07:17:06Z",
            "changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAFR+6ZT",
            "categories": [],
            "type": "IPM.Note",
            "size": 75329,
            "id": "AAMkAGUwNjQ4ZyTAACQ2fKdhq8oSKEDSVrdi3lRAAFSX03WAAA="
        }
    ]
}

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

• Отслеживание изменений данных Microsoft Graph с помощью запроса изменений
• Получение добавочных изменений папок в почтовом ящике