Espacio de nombres: microsoft.graph
Obtenga todos los objetos mailboxFolder del buzón especificado, incluidas las carpetas de búsqueda.
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) |
MailboxFolder.Read |
MailboxFolder.ReadWrite |
| Delegado (cuenta personal de Microsoft) |
No admitida. |
No admitida. |
| Aplicación |
MailboxFolder.Read.All |
MailboxFolder.ReadWrite.All |
Solicitud HTTP
GET /admin/exchange/mailboxes/{mailboxId}/folders
Parámetros de consulta opcionales
Este método admite los $selectparámetros de consulta , $filter, $top, $skip$orderby, $county $expand OData para ayudar a personalizar la respuesta. Para obtener información general, vea Parámetros de consulta OData.
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 una colección de objetos mailboxFolder en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: Enumerar carpetas
En el ejemplo siguiente se muestra cómo obtener la colección mailboxFolder directamente en la carpeta raíz del buzón del usuario.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://mms.heiai.top/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Admin.Exchange.Mailboxes["{mailbox-id}"].Folders.GetAsync();
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
//other-imports
)
// To initialize your graphClient, see https://mms.heiai.top/en-us/graph/sdks/create-client?from=snippets&tabs=go
folders, err := graphClient.Admin().Exchange().Mailboxes().ByMailboxId("mailbox-id").Folders().Get(context.Background(), nil)
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailboxFolderCollectionResponse result = graphClient.admin().exchange().mailboxes().byMailboxId("{mailbox-id}").folders().get();
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
<?php
use Microsoft\Graph\GraphServiceClient;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$result = $graphServiceClient->admin()->exchange()->mailboxes()->byMailboxId('mailbox-id')->folders()->get()->wait();
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://mms.heiai.top/en-us/graph/sdks/create-client?from=snippets&tabs=python
result = await graph_client.admin.exchange.mailboxes.by_mailbox_id('mailbox-id').folders.get()
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
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
Content-length: 232
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders",
"value": [
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"id": "EDSVrdi3lRAAACgfQBAAA=",
"displayName": "Archive",
"parentFolderId": "NJWt2LeVEAAAIBCAAAAA==",
"parentMailboxUrl": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
"childFolderCount": 0,
"totalItemCount": 2,
"type": "IPF.Note"
},
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"id": "NJWt2LeVEAAAIBDQAAAA==",
"displayName": "Calendar",
"parentFolderId": "NJWt2LeVEAAAIBCAAAAA==",
"parentMailboxUrl": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
"childFolderCount": 5,
"totalItemCount": 6,
"type": "IPF.Appointment"
}
],
"@odata.nextLink": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders?%24skip=10"
}
Ejemplo 2: Enumerar carpetas con parámetros de consulta
En el ejemplo siguiente se usan los $filterparámetros de consulta , $selecty $top . El $filter parámetro refina los resultados y devuelve solo carpetas de tipoIPF.Appointment. El $select parámetro se especifica para devolver solo las propiedades displayName y type , y el $top parámetro establece el tamaño de página del conjunto de resultados para devolver las cinco primeras carpetas del buzón.
Solicitud
En el ejemplo siguiente se muestra la solicitud.
GET https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders?$filter=type eq 'IPF.Appointment'&$select=displayName,type&$top=5
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://mms.heiai.top/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Admin.Exchange.Mailboxes["{mailbox-id}"].Folders.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.Filter = "type eq 'IPF.Appointment'";
requestConfiguration.QueryParameters.Select = new string []{ "displayName","type" };
requestConfiguration.QueryParameters.Top = 5;
});
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphadmin "github.com/microsoftgraph/msgraph-sdk-go/admin"
//other-imports
)
requestFilter := "type eq 'IPF.Appointment'"
requestTop := int32(5)
requestParameters := &graphadmin.ExchangeMailboxesItemFoldersRequestBuilderGetQueryParameters{
Filter: &requestFilter,
Select: [] string {"displayName","type"},
Top: &requestTop,
}
configuration := &graphadmin.ExchangeMailboxesItemFoldersRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://mms.heiai.top/en-us/graph/sdks/create-client?from=snippets&tabs=go
folders, err := graphClient.Admin().Exchange().Mailboxes().ByMailboxId("mailbox-id").Folders().Get(context.Background(), configuration)
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailboxFolderCollectionResponse result = graphClient.admin().exchange().mailboxes().byMailboxId("{mailbox-id}").folders().get(requestConfiguration -> {
requestConfiguration.queryParameters.filter = "type eq 'IPF.Appointment'";
requestConfiguration.queryParameters.select = new String []{"displayName", "type"};
requestConfiguration.queryParameters.top = 5;
});
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
const options = {
authProvider,
};
const client = Client.init(options);
let folders = await client.api('/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders')
.filter('type eq \'IPF.Appointment\'')
.select('displayName,type')
.top(5)
.get();
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Admin\Exchange\Mailboxes\Item\Folders\FoldersRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new FoldersRequestBuilderGetRequestConfiguration();
$queryParameters = FoldersRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "type eq 'IPF.Appointment'";
$queryParameters->select = ["displayName","type"];
$queryParameters->top = 5;
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->admin()->exchange()->mailboxes()->byMailboxId('mailbox-id')->folders()->get($requestConfiguration)->wait();
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.admin.exchange.mailboxes.item.folders.folders_request_builder import FoldersRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://mms.heiai.top/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = FoldersRequestBuilder.FoldersRequestBuilderGetQueryParameters(
filter = "type eq 'IPF.Appointment'",
select = ["displayName","type"],
top = 5,
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.admin.exchange.mailboxes.by_mailbox_id('mailbox-id').folders.get(request_configuration = request_configuration)
Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.
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
Content-length: 232
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders",
"value": [
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"id": "NJWt2LeVEAAAIBDQAAAA==",
"displayName": "Calendar",
"parentMailboxUrl": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
"type": "IPF.Appointment"
}
]
}