mailboxFolder: delta

Namespace: microsoft.graph

Rufen Sie eine Gruppe von MailboxFolder-Objekten ab, die dem Postfach des Benutzers hinzugefügt, gelöscht oder daraus entfernt wurden.

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

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

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ❌ ❌ ❌

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.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) MailboxFolder.Read MailboxFolder.ReadWrite
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application MailboxFolder.Read.All MailboxFolder.ReadWrite.All

HTTP-Anforderung

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

Abfrageparameter

Das Nachverfolgen von Änderungen in Ordnern führt zu einer Runde von einem oder mehreren Delta-Funktionsaufrufen. 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.

Parameter Beschreibung
$deltaToken Ein Zustandstoken, das in der deltaLink URL des vorherigen Delta-Funktionsaufrufs für dieselbe Ordnersammlung zurückgegeben wurde und den Abschluss dieser Runde der Änderungsnachverfolgung angibt. Speichern Sie die gesamte deltaLink-URL einschließlich dieses Tokens, und wenden Sie sie in der ersten Anforderung der nächsten Änderungsnachverfolgungsrunde für diese Sammlung an.
$skipToken Ein Zustandstoken, das in der nextLink URL des vorherigen Delta-Funktionsaufrufs zurückgegeben wird und angibt, dass weitere Änderungen in derselben Ordnersammlung nachverfolgt werden können.

OData-Abfrageparameter

Sie können den $select Abfrageparameter verwenden, um nur die Eigenschaften anzugeben, die Sie für eine optimale Leistung benötigen. Die ID wird immer zurückgegeben.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Prefer odata.maxpageSize={x}. Optional. Steuert die Seitengröße.

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 mailboxFolder-Objekten im Antworttext zurück.

Beispiele

Anforderung

Das folgende Beispiel zeigt, wie Sie einen einzelnen Delta-Funktionsaufruf ausführen und die maximale Anzahl von Ordnern im Antworttext auf zwei beschränken.

Zum Nachverfolgen von Änderungen in den Ordnern eines Postfachs führen Sie einen oder mehrere Delta-Funktionsaufrufe mit entsprechenden Zustandstoken aus, um den Satz der inkrementellen Änderungen seit der letzten Deltaabfrage abzurufen.

Ein ähnliches Beispiel, das zeigt, wie die Zustandstoken zum Nachverfolgen von Änderungen in den Elementen eines Ordners verwendet werden, finden Sie unter Abrufen inkrementeller Änderungen an Nachrichten in einem Ordner. Die Hauptunterschiede zwischen Verfolgungsordnern und Verfolgungselementen in einem Ordner liegen in den Delta-Abfrageanforderungs-URLs und den Abfrageantworten, die Ordner anstelle vonElementsammlungen zurückgeben.

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

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 $deltaToken in einem @odata.deltaLink-Antwortheader .

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

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 254

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(mailboxFolder)",
    "@odata.deltaLink": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/delta?$deltatoken={_deltaToken_}",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "displayName": "Inbound",
            "wellKnownName": null,
            "id": "AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMzNjMwNWM0ZGE2YQAuAAAAAADbrwBIJbBSTKolRbhHUzSHAQCQ2fKdhq8oSKEDSVrdi3lRAAACgfP9AAA="
        },
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "displayName": "Outbound",
            "wellKnownName": null,
            "id": "AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMzNjMwNWM0ZGE2YQAuAAAAAADbrwBIJbBSTKolRbhHUzSHAQCQ2fKdhq8oSKEDSVrdi3lRAAACgfP_AAA="
        }
    ]
}

Verwandte Inhalte

  • Last updated on