message: deltamessage: delta

Dient zum Abrufen eines Satzes von Nachrichten, die einem bestimmten Ordner hinzugefügt bzw. daraus gelöscht oder darin aktualisiert wurden.Get a set of messages that have been added, deleted, or updated in a specified folder.

Ein delta-Funktionsaufruf für Nachrichten in einem Ordner ähnelt einer GET-Anforderung, mit der Ausnahme, dass durch entsprechende Anwendung von Statustoken in einem oder mehreren dieser Aufrufe inkrementelle Änderungen an den Nachrichten im betreffenden Ordner abgefragt werden können. Dies ermöglicht es Ihnen, einen lokalen Speicher der Nachrichten eines Benutzers zu pflegen und zu synchronisieren, ohne dass Sie jedes Mal den gesamten Satz Nachrichten vom Server abrufen müssen.A delta function call for messages in a folder is similar to a GET request, except that by appropriately applying state tokens in one or more of these calls, you can query for incremental changes in the messages in that folder. This allows you to maintain and synchronize a local store of a user's messages without having to fetch the entire set of messages from the server every time.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Mail.Read, Mail.ReadWriteMail.Read, Mail.ReadWrite
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Mail.Read, Mail.ReadWriteMail.Read, Mail.ReadWrite
AnwendungApplication Mail.Read, Mail.ReadWriteMail.Read, Mail.ReadWrite

HTTP-AnforderungHTTP request

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

AbfrageparameterQuery parameters

Beim Nachverfolgen von Änderungen in Nachrichten wird eine Runde von einem oder mehreren delta-Funktionsaufrufen ausgeführt. 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 können Sie die nextLink- oder deltaLink-URL einfach aus der vorherigen Antwort kopieren und anwenden, da diese URL bereits die codierten gewünschten Parameter enthält.Tracking changes in messages incurs a round of one or more delta function calls. If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph automatically encodes any specified parameters into the token portion of the nextLink or deltaLink URL provided in the response. You only need to specify any desired query parameters once upfront. In subsequent requests, simply copy and apply the nextLink or deltaLink URL from the previous response, as that URL already includes the encoded, desired parameters.

AbfrageparameterQuery parameter TypType BeschreibungDescription
$deltatoken$deltatoken stringstring Ein Statustoken, das in der deltaLink-URL des vorhergehenden delta-Funktionsaufrufs für dieselbe Nachrichtensammlung zurückgegeben wird und den Abschluss dieser Runde der Änderungsnachverfolgung anzeigt. 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.A state token returned in the deltaLink URL of the previous delta function call for the same message collection, indicating the completion of that round of change tracking. Save and apply the entire deltaLink URL including this token in the first request of the next round of change tracking for that collection.
$skiptoken$skiptoken stringstring Ein Statustoken, das in der nextLink-URL des vorhergehenden delta-Funktionsaufrufs zurückgegeben wird und anzeigt, dass in derselben Nachrichtensammlung weitere Änderungen zum Nachverfolgen vorliegen.A state token returned in the nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same message collection.

OData-AbfrageparameterOData query parameters

  • 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.You can use a $select query parameter as in any GET request to specify only the properties your need for best performance. The id property is always returned.
  • Die Delta-Abfrage unterstützt $select, $top und $expand für Nachrichten.Delta query support $select, $top, and $expand for messages.
  • Es besteht eingeschränkte Unterstützung für $filter und $orderby:There is limited support for $filter and $orderby:
    • Es werden nur die $filter-Ausdrücke $filter=receivedDateTime+ge+{value} oder $filter=receivedDateTime+gt+{value} unterstützt.The only supported $filter expresssions are $filter=receivedDateTime+ge+{value} or $filter=receivedDateTime+gt+{value}.
    • Es wird nur der $orderby-Ausdruck $orderby=receivedDateTime+desc unterstützt. Wenn Sie keinen $orderby-Ausdruck einschließen, ist die Rückgabereihenfolge nicht gewährleistet.The only supported $orderby expression is $orderby=receivedDateTime+desc. If you do not include an $orderby expression, the return order is not guaranteed.
  • $search wird nicht unterstützt.There is no support for $search.

AnforderungsheaderRequest headers

NameName TypType BeschreibungDescription
AuthorizationAuthorization stringstring Bearer {token}. Erforderlich.Bearer {token}. Required.
Content-TypeContent-Type stringstring application/json. Erforderlich. application/json. Required.
PreferPrefer stringstring odata.maxpagesize={x}. Optional.odata.maxpagesize={x}. Optional.

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und das message-Sammlungsobjekt im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and message collection object in the response body.

BeispielExample

AnforderungRequest

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.The following example shows how to make a single delta function call, and limit the maximum number of messages in the response body to 2.

Zum Nachverfolgen von Änderungen in den Nachrichten eines Ordners führen Sie einen oder mehrere delta-Funktionsaufrufe aus, um den Satz der inkrementellen Änderungen seit der letzten Delta-Abfrage abzurufen. Ein Beispiel für eine Runde von Delta-Abfrageaufrufen finden Sie unter Inkrementelle Änderungen an Nachrichten in einem Ordner abrufen.To track changes in the messages in a folder, you would make one or more delta function calls to get the set of incremental changes since the last delta query. For an example that shows a round of delta query calls, see Get incremental changes to messages in a folder.

GET https://graph.microsoft.com/v1.0/me/mailFolders/{id}/messages/delta
Prefer: odata.maxpagesize=2
AntwortResponse

Wenn die Anforderung erfolgreich ist, enthält die Antwort ein Statustoken, entweder ein skipTokenIf the request is successful, the response would include a state token, which is either a skipToken
(in einem _@odata.nextLink_-Antwortheader) oder ein deltaToken (in einem _@odata.deltaLink_-Antwortheader). Diese geben an, ob Sie mit der Runde fortfahren sollten oder ob alle Änderungen für diese Runde abgerufen wurden.(in an _@odata.nextLink_ response header) or a deltaToken (in an _@odata.deltaLink_ response header). Respectively, they indicate whether you should continue with the round or you have completed getting all the changes for that round.

Die Antwort unten zeigt ein skipToken in einem _@odata.nextLink_-Antwortheader.The response below shows a skipToken in an _@odata.nextLink_ response header.

Hinweis: Das hier gezeigte Antwortobjekt ist möglicherweise aus Platzgründen abgeschnitten. Von einem tatsächlichen Aufruf werden alle Eigenschaften zurückgegeben.Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/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"
      }
    }
  ]
}

SDK-BeispielcodeSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var delta = await graphClient.Me.MailFolders["{id}"].Messages.Delta()
    .Request()
    .Header("Prefer","odata.maxpagesize=2")
    .GetAsync();

In der SDK-Dokumentation finden Sie Informationen zum Hinzufügen des SDK zu Ihrem Projekt und zum Erstellen einer authProvider -Instanz.Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Siehe auchSee also