mailboxItem: delta

Espacio de nombres: microsoft.graph

Obtenga un conjunto de objetos mailboxItem que se agregaron, eliminaron o actualizaron en un mailboxFolder especificado.

Una llamada de función diferencial para elementos de una carpeta es similar a una solicitud GET, excepto que mediante la aplicación adecuada de tokens de estado en una o varias de estas llamadas, puede consultar cambios incrementales en los elementos de esa carpeta. Este enfoque le permite mantener y sincronizar un almacén local de elementos del buzón de un usuario sin tener que capturar todo el conjunto de elementos del servidor cada vez.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Solicitud HTTP

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

Parámetros de consulta

El seguimiento de los cambios en los elementos implica una ronda de una o más llamadas a la función delta . Si usa cualquier parámetro de consulta (distinto de $deltaToken y $skipToken), debe especificarlo en la solicitud delta inicial. Microsoft Graph codifica automáticamente cualquier parámetro especificado en la parte del token de la URL nextLink o deltaLink proporcionada en la respuesta. Solo debe especificar una vez por adelantado los parámetros de consulta deseados. En solicitudes posteriores, simplemente copie y aplique la nextLinkdeltaLink dirección URL o de la respuesta anterior, ya que esa dirección URL ya incluye los parámetros deseados codificados.

Parámetros de consulta de OData

• Puede usar el parámetro de $select consulta para especificar solo las propiedades que necesita para obtener el mejor rendimiento. Siempre se devuelve la propiedad id.
• Esta consulta diferencial admite los $select parámetros de consulta y $top para los elementos.
• Existe soporte limitado para $filter y $orderby:
  • Las únicas expresiones admitidas $filter son $filter=receivedDateTime+ge+{value} y $filter=receivedDateTime+gt+{value}.
  • La única expresión $orderby admitida es $orderby=receivedDateTime+desc. Si no incluyes una $orderby expresión, la orden de devolución no está garantizada.
• El $search parámetro query no se admite.

Encabezados de solicitud

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se realiza correctamente, esta función devuelve un 200 OK código de respuesta y una colección de objetos mailboxItem en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra cómo realizar una sola llamada de función delta y limitar el número máximo de elementos del cuerpo de la respuesta a dos.

Para realizar un seguimiento de los cambios en los elementos de una carpeta, debe realizar una o varias llamadas de función delta para obtener el conjunto de cambios incrementales desde la última consulta delta.

Para obtener un ejemplo que muestra una ronda de llamadas de consulta delta, consulte Obtener cambios incrementales en los elementos de una carpeta.

GET https://graph.microsoft.com/v1.0/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 $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)

// 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')
	.header('Prefer','odata.maxpagesize=2')
	.get();

<?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();

# 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)

Respuesta

Si la solicitud es correcta, la respuesta incluye un token de estado que es a $skipToken (en un encabezado de respuesta @odata.nextLink ) o un $deltaToken (en un encabezado de respuesta @odata.deltaLink ). Respectivamente, indican si debe continuar con la ronda o si completó la obtención de todos los cambios para esa ronda.

En el siguiente ejemplo se muestra un $skipToken en un encabezado de respuesta @odata.nextLink .

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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="
        }
    ]
}

Contenido relacionado

• Usar la consulta delta para realizar el seguimiento de los cambios en datos de Microsoft Graph
• Obtener cambios incrementales en las carpetas de un buzón