mailboxItem: delta

Namespace: microsoft.graph

Abrufen einer Gruppe von mailboxItem-Objekten , die in einem angegebenen mailboxFolder hinzugefügt, gelöscht oder aktualisiert wurden.

Ein Delta-Funktionsaufruf für Elemente in einem Ordner ähnelt einer GET-Anforderung, mit dem Unterschied, dass Sie durch entsprechende Anwendung von Zustandstoken in einem oder mehreren dieser Aufrufe inkrementelle Änderungen in den Elementen in diesem Ordner abfragen können. Mit diesem Ansatz können Sie einen lokalen Speicher für Postfachelemente eines Benutzers verwalten und synchronisieren, ohne jedes Mal den gesamten Satz von Elementen vom Server abrufen zu müssen.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

HTTP-Anforderung

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

Abfrageparameter

Das Nachverfolgen von Änderungen an Elementen führt zu einer Runde von mindestens einem Delta-Funktionsaufruf. Wenn Sie Abfrageparameter (außer $deltaToken und $skipToken) verwenden, müssen Sie sie in der ursprünglichen Delta-Anforderung angeben. Microsoft Graph codiert automatisch alle angegebenen Parameter in den Tokenteil der in der Antwort enthaltenen nextLink- oder deltaLink-URL. Sie müssen alle gewünschten Abfrageparameter nur einmal im Vorfeld angeben. In nachfolgenden Anforderungen einfach die nextLinkdeltaLink oder-URL aus der vorherigen Antwort kopieren und anwenden, da diese URL bereits die codierten, gewünschten Parameter enthält.

OData-Abfrageparameter

• Sie können den $select Abfrageparameter verwenden, um nur die Eigenschaften anzugeben, die Sie für eine optimale Leistung benötigen. Die Eigenschaft id wird immer zurückgegeben.
• Diese Deltaabfrage unterstützt die Abfrageparameter und $top für Elemente$select.
• Eingeschränkte Unterstützung besteht für $filter und $orderby:
  • Die einzigen unterstützten $filter Ausdrücke sind und .$filter=receivedDateTime+ge+{value}$filter=receivedDateTime+gt+{value}
  • Es wird nur der $orderby-Ausdruck $orderby=receivedDateTime+desc unterstützt. Wenn Sie keinen $orderby Ausdruck einfügen, ist der Rückgabeauftrag nicht garantiert.
• Der $search Abfrageparameter wird nicht unterstützt.

Anforderungsheader

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Bei erfolgreicher Ausführung gibt diese Funktion einen 200 OK Antwortcode und eine Auflistung von mailboxItem-Objekten im Antworttext zurück.

Beispiele

Anforderung

Im folgenden Beispiel wird gezeigt, wie Sie einen einzelnen Delta-Funktionsaufruf ausführen und die maximale Anzahl von Elementen im Antworttext auf zwei beschränken.

Zum Nachverfolgen von Änderungen an den Elementen in einem Ordner führen Sie einen oder mehrere Delta-Funktionsaufrufe aus, um den Satz der inkrementellen Änderungen seit der letzten Deltaabfrage abzurufen.

Ein Beispiel, das eine Runde von Delta-Abfrageaufrufen zeigt, finden Sie unter Abrufen inkrementeller Änderungen an Elementen in einem Ordner.

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

// 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");
});

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

// Dependencies
import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphadmin "github.com/microsoftgraph/msgraph-beta-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)

// 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");
});

const options = {
	authProvider,
};

const client = Client.init(options);

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

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\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();

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.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)

Antwort

Wenn die Anforderung erfolgreich ist, enthält die Antwort ein Zustandstoken, das entweder ein $skipToken (in einem @odata.nextLink-Antwortheader ) oder ein $deltaToken (in einem @odata.deltaLink-Antwortheader ) ist. Sie zeigen jeweils an, ob Sie mit der Runde fortfahren sollten oder ob Sie alle Änderungen für diese Runde erhalten haben.

Das folgende Beispiel zeigt einen $skipToken in einem @odata.nextLink-Antwortheader .

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(mailboxItem)",
    "@odata.nextLink": "https://graph.microsoft.com/beta/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="
        }
    ]
}

Verwandte Inhalte

• Verwenden einer Delta-Abfrage zum Nachverfolgen von Änderungen in Microsoft Graph-Daten
• Abrufen inkrementeller Änderungen an Ordnern in einem Postfach