Enumerar mensajes

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Obtenga los mensajes del buzón del usuario que ha iniciado sesión (incluidas las carpetas Elementos eliminados y Otros correos).

Dependiendo de los datos del buzón y del tamaño de la página, recibir mensajes desde un buzón puede conllevar varias solicitudes. El tamaño de página predeterminado es de 10 mensajes. Use $top para personalizar el tamaño de página, dentro del intervalo de 1 y 1000.

Para mejorar el tiempo de respuesta de la operación, use $select para especificar las propiedades exactas que necesita; consulte el siguienteejemplo 1. Ajuste los valores de $select y $top, especialmente cuando debe usar un tamaño de página más grande, ya que devolver una página con cientos de mensajes cada uno con una carga de respuesta completa puede desencadenar el tiempo de espera de la puerta de enlace (HTTP 504).

Para obtener la página siguiente de mensajes, basta con aplicar la dirección URL completa devuelta en @odata.nextLink a la siguiente solicitud get-messages. Esta dirección URL contiene todos los parámetros de consulta que haya especificado en la solicitud inicial.

No intente extraer el valor $skip de la dirección URL @odata.nextLink para manipular las respuestas. Esta API usa el valor $skip para mantener el recuento de todos los elementos que ha recorrido en el buzón del usuario para devolver una página de elementos de tipo de mensaje. Por tanto, es posible que incluso en la respuesta inicial, el valor de $skip sea mayor que el tamaño de la página. Para obtener más información, vea Paginación de los datos de Microsoft Graph en su aplicación.

Puede filtrar por los mensajes y obtener solo aquellos que incluyan una mención del usuario que ha iniciado sesión. Vea un ejemplo a continuación. De forma predeterminada, la GET /me/messages operación no devuelve la propiedad mentions . Use el parámetro de $expand consulta para buscar detalles de cada mención en un mensaje.

Hay dos posibles escenarios donde una aplicación puede obtener mensajes en la carpeta de correo de otro usuario:

  • Si la aplicación tiene permisos de aplicación, o bien,
  • Si la aplicación tiene los correspondientes permisos delegados de un usuario y otro usuario ha compartido una carpeta de correo con ese usuario, o bien, le ha concedido acceso delegado a ese usuario. Vea detalles y un ejemplo.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) Mail.ReadBasic Mail.ReadWrite, Mail.Read
Delegado (cuenta personal de Microsoft) Mail.ReadBasic Mail.ReadWrite, Mail.Read
Aplicación Mail.ReadBasic.All Mail.ReadWrite, Mail.Read

Solicitud HTTP

Para obtener todos los mensajes del buzón de un usuario:

GET /me/messages
GET /users/{id | userPrincipalName}/messages

Para obtener los mensajes de una carpeta específica del buzón del usuario:

GET /me/mailFolders/{id}/messages
GET /users/{id | userPrincipalName}/mailFolders/{id}/messages

Para obtener todos los mensajes en el buzón del usuario que incluyen una mención del usuario:

GET /me/messages?$filter=mentionsPreview/isMentioned eq true
GET /users/{id | userPrincipalName}/messages?$filter=mentionsPreview/isMentioned eq true

Parámetros de consulta opcionales

Este método admite los parámetros de consulta de OData a modo de ayuda para personalizar la respuesta.

Puede usar el parámetro de $filter consulta en la propiedad mentionsPreview para obtener los mensajes que mencionan al usuario que ha iniciado sesión.

Usar Filter y OrderBy en la misma consulta

Cuando este usando $filter y $orderby en la misma consulta para obtener mensajes, asegúrese de especificar las propiedades de las siguientes maneras:

  1. Las propiedades que aparecen $orderby en también deben aparecer $filteren.
  2. Las propiedades que aparecen $orderby en están en el mismo orden que $filteren.
  3. Las propiedades presentes en $orderby aparecen en antes de $filter las propiedades que no lo sean.

Si no lo hace, se produce el siguiente error:

  • Código de errorInefficientFilter
  • Mensaje de error: The restriction or sort order is too complex for this operation.

Encabezados de solicitud

Nombre Tipo Descripción
Authorization string {token} de portador. Obligatorio.
Prefer: outlook.body-content-type string Formato de las propiedades body y uniqueBody que se devolverá. Los valores pueden ser "text" o "html". Si no se especifica el encabezado, las propiedades body y uniqueBody se devuelven en formato HTML. Opcional.

Cuerpo de la solicitud

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

Respuesta

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

Ejemplos

Ejemplo 1: mostrar todos los mensajes

Solicitud

En el primer ejemplo se obtienen los 10 mensajes principales predeterminados en el buzón del usuario que ha iniciado sesión. Usa $select para devolver un subconjunto de las propiedades de cada mensaje en la respuesta.

GET https://graph.microsoft.com/beta/me/messages?$select=sender,subject

Respuesta

En el ejemplo siguiente se muestra la respuesta. Para obtener la página siguiente de mensajes, aplique la dirección URL devuelta en @odata.nextLink en una solicitud GET siguiente.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('bb8775a4-4d8c-42cf-a1d4-4d58c2bb668f')/messages(sender,subject)",
  "value": [
    {
      "@odata.etag": "W/\"CQAAABYAAADHcgC8Hl9tRZ/hc1wEUs1TAAAwR4Hg\"",
      "id": "AAMkAGUAAAwTW09AAA=",
      "subject": "You have late tasks!",
      "sender": {
        "emailAddress": {
          "name": "Microsoft Planner",
          "address": "noreply@Planner.Office365.com"
        }
      }
    }
  ]
}

Ejemplo 2: Uso de $filter para obtener todos los mensajes que cumplen una condición específica

Solicitud

En el siguiente ejemplo se filtran todos los mensajes del buzón del usuario que ha iniciado sesión para aquellos que mencionan al usuario. También usa $select para devolver un subconjunto de las propiedades de cada mensaje de la respuesta.

En el ejemplo siguiente también se incorpora la codificación de direcciones URL para los caracteres de espacio en la cadena del parámetro de consulta.

GET https://graph.microsoft.com/beta/me/messages?$filter=MentionsPreview/IsMentioned%20eq%20true&$select=Subject,Sender,ReceivedDateTime,MentionsPreview

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#me/messages(subject,sender,receivedDateTime,mentionsPreview)",
  "value":[
    {
      "@odata.id":"https://graph.microsoft.com/beta/users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/messages('AQMkADJmMTUAAAgVZAAAA')",
      "@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAAATI\"",
      "id":"AQMkADJmMTUAAAgVZAAAA",
      "receivedDateTime":"2016-07-21T07:40:21Z",
      "subject":"Re: Start planning soon",
      "sender":{
        "emailAddress":{
          "name":"Adele Vance",
          "address":"AdeleV@contoso.com"
        }
      },
      "mentionsPreview":{
        "isMentioned":true
      }
    }
  ]
}

Ejemplo 3: Use prefer header para obtener el cuerpo del mensaje y uniqueBody es el formato de texto.

Solicitud

En el tercer ejemplo se muestra cómo usar un Prefer: outlook.body-content-type="text" encabezado para obtener el cuerpo y las propiedades uniqueBody de cada mensaje en formato de texto.

GET https://graph.microsoft.com/beta/me/messages?$select=subject,body,bodyPreview,uniqueBody
Prefer: outlook.body-content-type="text"

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/messages(subject,body,bodyPreview,uniqueBody)",
  "value":[
    {
      "@odata.type":"#microsoft.graph.eventMessageRequest",
      "@odata.etag":"W/\"CwAAABYAAABmWdbhEgBXTophjCWt81m9AAAoZYj5\"",
      "id":"AAMkAGIAAAoZCfIAAA=",
      "subject":"Orientation ",
      "bodyPreview":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.",
      "body":{
        "contentType":"text",
        "content":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.\r\n"
      },
      "uniqueBody":{
        "contentType":"text",
        "content":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.\r\n"
      }
    }
  ]
}