mensaje: delta

Espacio de nombres: microsoft.graph

Obtener un conjunto de mensajes que se agregaron, eliminaron o actualizaron en una carpeta especificada.

Una llamada de función delta para mensajes en una carpeta es similar a una solicitud GET, excepto que mediante la aplicación adecuada de tokens de estado en una o más de estas llamadas, puede consultar cambios incrementales en los mensajes de esa carpeta. El uso de deltas le permite mantener y sincronizar de forma incremental un almacén local de los mensajes de un usuario.

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

Para obtener todos los cambios en los mensajes de la carpeta de correo especificada:

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

Para obtener específicamente solo los mensajes creados, actualizados o eliminados en la carpeta de correo especificada:

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

Parámetros de consulta

El seguimiento de los cambios en los mensajes implica una ronda de una o más llamadas a la función delta . Si usa cualquier opción de consulta del sistema OData o la opción de consulta personalizada, changeTypedebe especificarla en la solicitud diferencial inicial. Microsoft Graph codifica automáticamente cualquier parámetro especificado en la parte del token de la URL @odata.nextLink o @odata.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 @odata.nextLink@odata.deltaLink 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 utilizar un parámetro de consulta $select como en cualquier solicitud GET para especificar solo las propiedades que necesita para un mejor rendimiento. Siempre se devuelve la propiedad id.
• Compatibilidad con consultas de delta $select, $top, y $expand para los mensajes.
• La compatibilidad $filter con y $orderby:
  • Las únicas expresiones $filter admitidas 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.
• No hay compatibilidad con $search.

Encabezados de solicitud

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto de colección message en el cuerpo de la respuesta.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra cómo realizar una llamada de función delta única y limitar el número máximo de mensajes en el cuerpo de la respuesta a 2.

Para realizar un seguimiento de los cambios en los mensajes 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 diferencial, consulte Obtener cambios incrementales en los mensajes de una carpeta.

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

Respuesta

Si la solicitud es correcta, la respuesta incluiría un token de estado, que es un skipToken (en un encabezado de respuesta @odata.nextLink ) o un deltaToken (en un encabezado de respuesta @odata.deltaLink ). Respectivamente, indican si debes continuar con la ronda o terminaste de obtener todos los cambios para esa ronda.

La siguiente respuesta muestra un skipToken en un encabezado de respuesta @odata.nextLink .

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

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

Contenido relacionado

• Consulta delta de Microsoft Graph
• Obtener los cambios incrementales en los mensajes de una carpeta