Get mailFolder
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.
Recupere las propiedades y las relaciones de un objeto de carpeta de mensajes.
En la lista siguiente se muestran los dos escenarios existentes en los que una aplicación puede obtener 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. Para obtener más detalles, vea Obtener mensajes de Outlook en una carpeta compartida o delegada.
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
GET /me/mailFolders/{id}
GET /users/{id | userPrincipalName}/mailFolders/{id}
Parámetros de consulta opcionales
Este método admite los parámetros de consulta de OData a modo de ayuda para personalizar la respuesta.
Encabezados de solicitud
Nombre | Descripción |
---|---|
Authorization | {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
Cuerpo de la solicitud
No proporcione un cuerpo de solicitud para este método.
Respuesta
Si se ejecuta correctamente, este método devuelve un 200 OK
código de respuesta y un objeto mailFolder en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: obtener una carpeta de correo
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzM
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
{
"id": "AAMkAGVmMDEzM",
"displayName": "Inbox",
"parentFolderId": "AAMkAGVmMDEzI",
"childFolderCount": 2,
"unreadItemCount": 59,
"totalItemCount": 60,
"wellKnownName": "inbox",
"isHidden": false
}
Ejemplo 2: obtener una carpeta de búsqueda de correo
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/beta/me/mailFolders/AAMkAGVmMDEzN
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.type": "#microsoft.graph.mailSearchFolder",
"id": "AAMkAGVmMDEzN",
"displayName": "Get MyAnalytics",
"parentFolderId": "AAMkAGVmMDEzI",
"childFolderCount": 0,
"unreadItemCount": 6,
"totalItemCount": 6,
"wellKnownName": null,
"isHidden": false,
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": [
"AAMkAGVmMDEzM"
],
"filterQuery": "contains(subject, 'MyAnalytics')"
}