Compartir a través de


List mailFolders

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.

Obtiene la colección de carpetas de correo directamente en la carpeta raíz del usuario que inició sesión. La colección devuelta contiene todas las carpetas de búsqueda de correo directamente en la raíz.

De forma predeterminada, esta operación no devuelve carpetas ocultas. Use un parámetro includeHiddenFolders de consulta para incluirlos en la respuesta. Esta operación no devuelve todas las carpetas de correo de un buzón, solo las carpetas secundarias de la carpeta raíz. Para devolver todas las carpetas de correo de un buzón, cada carpeta secundaria debe recorrerse por separado.

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 todas las carpetas de correo de la carpeta raíz en el buzón de correo del usuario especificado, excepto las que están ocultas:

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

Para incluir las carpetas de correo ocultas en la respuesta:

GET /me/mailFolders/?includeHiddenFolders=true
GET /users/{id | userPrincipalName}/mailFolders/?includeHiddenFolders=true

Parámetros de consulta opcionales

Para devolver una lista de todas las mailFolders, incluidas las que están ocultas (su propiedad isHidden es verdadera), en la dirección URL de la solicitud, especifique el parámetro de consulta includeHiddenFolders como true, tal y como se muestra en la sección de la solicitud HTTP.

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

Encabezados de solicitud

Encabezado Valor
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 código de respuesta 200 OK y una colección de objetos mailFolder en el cuerpo de la respuesta.

Ejemplos

Ejemplo 1: lista de las carpetas de correo del buzón del usuario que ha iniciado sesión

En este ejemplo se incluye un objeto mailSearchFolder en la respuesta. La carpeta de búsqueda de correo es una carpeta secundaria en la Bandeja de entrada con el nombre para mostrar "Resúmenes semanales".

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/me/mailFolders

Respuesta

El siguiente es un ejemplo de la respuesta, que incluye una mailSearchFolder que es una carpeta secundaria en la Bandeja de entrada.

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#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AQMkADYAAAIBXQAAAA==",
            "displayName": "Archive",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "archive",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBFQAAAA==",
            "displayName": "Conversation History",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "conversationhistory",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCgAAAA==",
            "displayName": "Deleted Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "deleteditems",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDwAAAA==",
            "displayName": "Drafts",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "drafts",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDAAAAA==",
            "displayName": "Inbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 70,
            "totalItemCount": 71,
            "wellKnownName": "inbox",
            "isHidden": false
        },
        {
            "@odata.type": "#microsoft.graph.mailSearchFolder",
            "id": "AAMkADYRAAAZg1yTAAA=",
            "displayName": "Weekly digests",
            "parentFolderId": "AQMkADYAAAIBDAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 4,
            "totalItemCount": 5,
            "wellKnownName": null,
            "isHidden": false,
            "isSupported": true,
            "filterQuery": "contains(subject, 'weekly digest')"
        },
        {
            "id": "AQMkADYAAAIBGQAAAA==",
            "displayName": "Junk Email",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "junkemail",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCwAAAA==",
            "displayName": "Outbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "outbox",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCQAAAA==",
            "displayName": "Sent Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "sentitems",
            "isHidden": false
        }
    ]
}

Sugerencia

Si una colección supera el tamaño de página predeterminado (10 elementos), se devuelve la propiedad @odata.nextLink en la respuesta para indicar que hay más elementos disponibles y proporcionar la dirección URL de solicitud para la siguiente página de elementos.

Puede controlar el tamaño de la página mediante los parámetros de cadena de consulta opcionales

Ejemplo 2: carpetas oculta incluidas de correo del buzón del usuario que ha iniciado sesión

En este ejemplo se usa el includeHiddenFolders parámetro de consulta para obtener una lista de carpetas de correo, incluidas las carpetas de correo ocultas. La respuesta incluye la carpeta "Clutter" que tiene el valor isHidden establecido en true.

Solicitud

GET https://graph.microsoft.com/beta/me/mailFolders/?includeHiddenFolders=true

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: El objeto de respuesta que se muestra aquí se abrevia para mejorar la legibilidad y no incluye todas las carpetas predeterminadas en un buzón de usuario.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Clutter",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": null,
            "isHidden": true
        },
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Conversation History",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "conversationhistory",
            "isHidden": false
        }
    ]
}