message: delta

Namespace: microsoft.graph

Abrufen einer Reihe von Nachrichten, die in einem angegebenen Ordner hinzugefügt, gelöscht oder aktualisiert wurden.

Ein Delta-Funktionsaufruf für Nachrichten 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 Nachrichten in diesem Ordner abfragen können. Die Verwendung von Deltas ermöglicht es Ihnen, einen lokalen Speicher für die Nachrichten eines Benutzers inkrementell zu verwalten und zu synchronisieren.

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

So rufen Sie alle Änderungen an Nachrichten im angegebenen mailFolder ab:

GET /me/mailFolders/{id}/messages/delta
GET /users/{id}/mailFolders/{id}/messages/delta

Gehen Sie folgendermaßen vor, um nur erstellte, aktualisierte oder gelöschte Nachrichten im angegebenen mailFolder abzurufen:

GET /me/mailFolders/{id}/messages/delta?changeType=created
GET /users/{id}/mailFolders/{id}/messages/delta?changeType=created
GET /me/mailFolders/{id}/messages/delta?changeType=updated
GET /users/{id}/mailFolders/{id}/messages/delta?changeType=updated
GET /me/mailFolders/{id}/messages/delta?changeType=deleted
GET /users/{id}/mailFolders/{id}/messages/delta?changeType=deleted

Abfrageparameter

Das Nachverfolgen von Änderungen in Nachrichten führt zu einer Runde von mindestens einem Delta-Funktionsaufruf. Wenn Sie eine OData-Systemabfrageoption oder die Option für benutzerdefinierte Abfragen verwenden, changeTypemüssen Sie dies in der ursprünglichen Deltaanforderung angeben. Microsoft Graph codiert automatisch alle angegebenen Parameter in den Tokenteil der in der Antwort enthaltenen @odata.nextLink- oder @odata.deltaLink-URL. Sie müssen alle gewünschten Abfrageparameter nur einmal im Vorfeld angeben. In nachfolgenden Anforderungen einfach die @odata.nextLink@odata.deltaLink 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 wie bei jeder GET-Anforderung den Abfrageparameter $select verwenden, um zwecks Leistungsoptimierung nur die benötigten Eigenschaften anzugeben. Die Eigenschaft id wird immer zurückgegeben.
• Die Delta-Abfrage unterstützt $select, $top und $expand für Nachrichten.
• Es gibt eingeschränkte Unterstützung für $filter und $orderby:
  • Es werden nur die $filter-Ausdrücke $filter=receivedDateTime+ge+{value} oder $filter=receivedDateTime+gt+{value} unterstützt.
  • Es wird nur der $orderby-Ausdruck $orderby=receivedDateTime+desc unterstützt. Wenn Sie keinen $orderby Ausdruck einfügen, ist der Rückgabeauftrag nicht garantiert.
• Es gibt keine Unterstützung für $search.

Anforderungsheader

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und das message-Sammlungsobjekt im Antworttext zurückgegeben.

Beispiel

Anforderung

Das folgende Beispiel zeigt, wie Sie einen einzelnen delta-Funktionsaufruf ausführen und die maximale Anzahl von Nachrichten im Textkörper der Antwort auf 2 beschränken.

Zum Nachverfolgen von Änderungen an den Nachrichten in einem Ordner führen Sie einen oder mehrere Delta-Funktionsaufrufe aus, um die Menge der inkrementellen Änderungen seit der letzten Deltaabfrage abzurufen. Ein Beispiel, das eine Runde von Delta-Abfrageaufrufen zeigt, finden Sie unter Abrufen inkrementeller Änderungen an Nachrichten in einem Ordner.

GET https://graph.microsoft.com/beta/me/mailFolders/{id}/messages/delta

Prefer: odata.maxpagesize=2

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/mailFolders/{id}/messages/delta')
	.version('beta')
	.get();

Antwort

Wenn die Anforderung erfolgreich ist, würde die Antwort ein Zustandstoken enthalten, 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.

Die folgende Antwort zeigt einen skipToken in einem @odata.nextLink-Antwortheader .

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

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

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/mailFolders/{id}/messages/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "receivedDateTime": "datetime-value",
      "sentDateTime": "datetime-value",
      "hasAttachments": true,
      "internetMessageId": "internetMessageId-value",
      "subject": "subject-value",
      "body": {
        "contentType": "contentType-value",
        "content": "content-value"
      }
    }
  ]
}

Verwandte Inhalte

• Microsoft Graph-Delta-Abfrage
• Inkrementelle Änderungen an Nachrichten in einem Ordner abrufen