Espacio de nombres: microsoft.graph
Cree una nueva mailSearchFolder en el buzón del usuario especificado.
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.ReadWrite |
No disponible. |
| Delegado (cuenta personal de Microsoft) |
Mail.ReadWrite |
No disponible. |
| Aplicación |
Mail.ReadWrite |
No disponible. |
Solicitud HTTP
POST /me/mailFolders/{id}/childFolders
POST /users/{id | userPrincipalName}/mailFolders/{id}/childFolders
Especifique la carpeta primaria en la dirección URL de consulta como un identificador de carpeta o un nombre de carpeta conocido. Para obtener una lista de los nombres de carpeta conocidos compatibles, vea Tipo de recurso mailFolder.
| Encabezado |
Valor |
| Authorization |
Bearer {token}. Obligatorio. |
| Content-Type |
application/json. Obligatorio. |
Cuerpo de la solicitud
En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.
| Parámetro |
Tipo |
Descripción |
| @odata.type |
Cadena |
Tipo de carpeta que se va a crear. Establézcalo en "microsoft.graph.mailSearchFolder". |
| displayName |
String |
Nombre para mostrar de la nueva carpeta. |
| includeNestedFolders |
Booleano |
Indica cómo se debe recorrer la jerarquía de carpetas del buzón en la búsqueda.
true significa que se debe realizar una búsqueda profunda para incluir carpetas secundarias en la jerarquía de cada carpeta especificada explícitamente en sourceFolderIds.
false significa una búsqueda superficial de solo cada una de las carpetas especificadas explícitamente en sourceFolderIds. |
| sourceFolderIds |
Colección string |
Carpetas de buzón que se deben minado. |
| filterQuery |
Cadena |
Consulta de OData para filtrar los mensajes. |
Respuesta
Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto mailSearchFolder en el cuerpo de la respuesta.
Ejemplo
Solicitud
El siguiente es un ejemplo de la solicitud: crea una carpeta de búsqueda de mensajes que contienen la cadena "resumen semanal" en el asunto. La carpeta de búsqueda está en la misma carpeta en la que se aplica la consulta de filtro especificada.
POST https://graph.microsoft.com/v1.0/me/mailFolders/AQMkADYAAAIBDAAAAA==/childFolders
Content-type: application/json
{
"@odata.type": "microsoft.graph.mailSearchFolder",
"displayName": "Weekly digests",
"includeNestedFolders": true,
"sourceFolderIds": ["AQMkADYAAAIBDAAAAA=="],
"filterQuery": "contains(subject, 'weekly digest')"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new MailSearchFolder
{
OdataType = "microsoft.graph.mailSearchFolder",
DisplayName = "Weekly digests",
IncludeNestedFolders = true,
SourceFolderIds = new List<string>
{
"AQMkADYAAAIBDAAAAA==",
},
FilterQuery = "contains(subject, 'weekly digest')",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailFolders["{mailFolder-id}"].ChildFolders.PostAsync(requestBody);
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"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewMailFolder()
displayName := "Weekly digests"
requestBody.SetDisplayName(&displayName)
includeNestedFolders := true
requestBody.SetIncludeNestedFolders(&includeNestedFolders)
sourceFolderIds := []string {
"AQMkADYAAAIBDAAAAA==",
}
requestBody.SetSourceFolderIds(sourceFolderIds)
filterQuery := "contains(subject, 'weekly digest')"
requestBody.SetFilterQuery(&filterQuery)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
childFolders, err := graphClient.Me().MailFolders().ByMailFolderId("mailFolder-id").ChildFolders().Post(context.Background(), requestBody, 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);
MailSearchFolder mailFolder = new MailSearchFolder();
mailFolder.setOdataType("microsoft.graph.mailSearchFolder");
mailFolder.setDisplayName("Weekly digests");
mailFolder.setIncludeNestedFolders(true);
LinkedList<String> sourceFolderIds = new LinkedList<String>();
sourceFolderIds.add("AQMkADYAAAIBDAAAAA==");
mailFolder.setSourceFolderIds(sourceFolderIds);
mailFolder.setFilterQuery("contains(subject, 'weekly digest')");
MailFolder result = graphClient.me().mailFolders().byMailFolderId("{mailFolder-id}").childFolders().post(mailFolder);
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);
const mailFolder = {
'@odata.type': 'microsoft.graph.mailSearchFolder',
displayName: 'Weekly digests',
includeNestedFolders: true,
sourceFolderIds: ['AQMkADYAAAIBDAAAAA=='],
filterQuery: 'contains(subject, \'weekly digest\')'
};
await client.api('/me/mailFolders/AQMkADYAAAIBDAAAAA==/childFolders')
.post(mailFolder);
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\Models\MailSearchFolder;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MailSearchFolder();
$requestBody->setOdataType('microsoft.graph.mailSearchFolder');
$requestBody->setDisplayName('Weekly digests');
$requestBody->setIncludeNestedFolders(true);
$requestBody->setSourceFolderIds(['AQMkADYAAAIBDAAAAA==', ]);
$requestBody->setFilterQuery('contains(subject, \'weekly digest\')');
$result = $graphServiceClient->me()->mailFolders()->byMailFolderId('mailFolder-id')->childFolders()->post($requestBody)->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.
Import-Module Microsoft.Graph.Mail
$params = @{
"@odata.type" = "microsoft.graph.mailSearchFolder"
displayName = "Weekly digests"
includeNestedFolders = $true
sourceFolderIds = @(
"AQMkADYAAAIBDAAAAA=="
)
filterQuery = "contains(subject, 'weekly digest')"
}
# A UPN can also be used as -UserId.
New-MgUserMailFolderChildFolder -UserId $userId -MailFolderId $mailFolderId -BodyParameter $params
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.models.mail_search_folder import MailSearchFolder
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MailSearchFolder(
odata_type = "microsoft.graph.mailSearchFolder",
display_name = "Weekly digests",
include_nested_folders = True,
source_folder_ids = [
"AQMkADYAAAIBDAAAAA==",
],
filter_query = "contains(subject, 'weekly digest')",
)
result = await graph_client.me.mail_folders.by_mail_folder_id('mailFolder-id').child_folders.post(request_body)
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 201 Created
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders('AQMkADYAAAIBDAAAAA%3D%3D')/childFolders/$entity",
"@odata.type": "#microsoft.graph.mailSearchFolder",
"id": "AAMkADYfRAAAZg1yTAAA=",
"displayName": "Weekly digests",
"parentFolderId": "AQMkADYAAAIBDAAAAA==",
"childFolderCount": 0,
"unreadItemCount": 0,
"totalItemCount": 0,
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": [
"AQMkADYAAAIBDAAAAA=="
],
"filterQuery": "contains(subject, 'weekly digest')"
}