mailFolder: deltamailFolder: delta

Espacio de nombres: microsoft.graphNamespace: microsoft.graph

Obtenga un conjunto de carpetas de correo que se hayan agregado, eliminado o quitado del buzón del usuario.Get a set of mail folders that have been added, deleted, or removed from the user's mailbox.

Las llamadas de una función delta para las carpetas de correo de un buzón funcionan de forma similar a una solicitud GET, salvo que, al aplicar correctamente tokens de estado en al menos una de estas llamadas, puede realizar una consulta para obtener los cambios incrementales en las carpetas de correo. Esto permite mantener y sincronizar un almacén local de carpetas de correo de un usuario, sin tener que capturar cada vez todas las carpetas de correo de ese buzón desde el servidor.A delta function call for mail folders in a mailbox 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 mail folders. This allows you to maintain and synchronize a local store of a user's mail folders without having to fetch all the mail folders of that mailbox from the server every time.

PermisosPermissions

Se requiere uno de los siguientes permisos para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Tipo de permisoPermission type Permisos (de menos a más privilegiados)Permissions (from least to most privileged)
Delegado (cuenta profesional o educativa)Delegated (work or school account) Mail.ReadBasic, Mail.Read, Mail.ReadWriteMail.ReadBasic, Mail.Read, Mail.ReadWrite
Delegado (cuenta personal de Microsoft)Delegated (personal Microsoft account) Mail.ReadBasic, Mail.Read, Mail.ReadWriteMail.ReadBasic, Mail.Read, Mail.ReadWrite
AplicaciónApplication Mail.ReadBasic.All, Mail.Read, Mail.ReadWriteMail.ReadBasic.All, Mail.Read, Mail.ReadWrite

Solicitud HTTPHTTP request

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

Parámetros de consultaQuery parameters

El seguimiento de cambios en las carpetas de correo conlleva al menos una llamada de una 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 los parámetros de consulta deseados una vez por adelantado. En solicitudes posteriores, basta con copiar y aplicar la dirección URL nextLink o deltaLink de la respuesta anterior, dado que la dirección URL ya incluye los parámetros codificados deseados.Tracking changes in mail folders 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.

Parámetro de consultaQuery parameter TipoType DescripciónDescription
$deltatoken$deltatoken cadenastring Un token de estado que se devuelve en la dirección URL de deltaLink de la llamada de función delta anterior para la misma colección de carpetas de correo. Indica el progreso de la ronda de seguimiento de cambios. Guarde y aplique toda la dirección URL deltaLink, incluido este token, en la primera solicitud de la siguiente ronda de seguimiento de cambios de la colección.A state token returned in the deltaLink URL of the previous delta function call for the same mail folder 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 Un token de estado que se devuelve en la dirección URL de nextLink de la llamada de función delta. Indica que debe realizarse el seguimiento de más cambios en la misma colección de carpetas de correo.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 mail folder collection.

Parámetros de consulta de ODataOData query parameters

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.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.

Encabezados de solicitudRequest headers

NombreName TipoType DescripciónDescription
AuthorizationAuthorization cadenastring {token} de portador. Obligatorio.Bearer {token}. Required.
Content-TypeContent-Type cadenastring application/json. Obligatorio.application/json. Required.
PreferPrefer stringstring odata.maxpagesize={x}. Opcional.odata.maxpagesize={x}. Optional.

RespuestaResponse

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y el objeto de colección mailFolder en el cuerpo de la respuesta.If successful, this method returns a 200 OK response code and mailFolder collection object in the response body.

EjemploExample

SolicitudRequest

En el ejemplo siguiente se muestra cómo realizar una llamada de función delta única y limitar el número máximo de carpetas de correo en el cuerpo de la respuesta a 2.The following example shows how to make a single delta function call, and limit the maximum number of mail folders in the response body to 2.

Para realizar un seguimiento de los cambios de las carpetas de correo de un buzón, debería realizar al menos una llamada de función delta, con unos tokens de estado adecuados, para obtener el conjunto de cambios incrementales desde la última consulta delta.To track changes in the mail folders of a mailbox, you would make one or more delta function calls, with appropriate state tokens, to get the set of incremental changes since the last delta query.

Encontrará un ejemplo similar en el que se muestra cómo usar los tokens de estado para realizar un seguimiento de los cambios en los mensajes de una carpeta de correo: Obtener los cambios incrementales en los mensajes de una carpeta. Las diferencias principales entre realizar un seguimiento de las carpetas de correo y realizar un seguimiento de los mensajes en una carpeta están en las direcciones URL de consulta delta. Además, las respuestas de consulta devuelven colecciones mailFolder en lugar de colecciones message.You can find a similar example that shows how to use the state tokens to track changes in the messages of a mail folder: Get incremental changes to messages in a folder. The main differences between tracking mail folders and tracking messages in a folder are in the delta query request URLs, and the query responses returning mailFolder rather than message collections.

GET https://graph.microsoft.com/v1.0/me/mailFolders/delta

Prefer: odata.maxpagesize=2
RespuestaResponse

Si la solicitud es correcta, la respuesta debería incluir un símbolo de estado, que puede ser un skipTokenIf the request is successful, the response would include a state token, which is either a skipToken
(en un encabezado de respuesta de _@odata.nextLink_) o un deltaToken (en un encabezado de respuesta de _@odata.deltaLink_). Respectivamente, indican si debe continuar con la ronda, o bien si ha terminado de obtener todos los cambios de la ronda.(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.

La respuesta siguiente muestra un skipToken en un encabezado de respuesta de _@odata.nextLink_.The response below shows a skipToken in an _@odata.nextLink_ response header.

Nota: Es posible que el objeto de respuesta que aparezca aquí esté truncado para abreviar. Todas las propiedades se devolverán de una llamada real.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: 254

{
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/me/mailfolders/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "displayName": "displayName-value",
      "parentFolderId": "parentFolderId-value",
      "childFolderCount": 99,
      "unreadItemCount": 99,
      "totalItemCount": 99
    }
  ]
}

Recursos adicionalesSee also