Crear mailSearchFolder

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.

Cree un nuevo mailSearchFolder en el buzón del usuario especificado.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos 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 la 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.

Encabezados de solicitud

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 El tipo de carpeta que se va a crear. Establecer 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 de buzones 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 buzones que se deben minar.
filterQuery Cadena Consulta OData para filtrar los mensajes.

Respuesta

Si se realiza correctamente, este método devuelve un 201 Created código de respuesta y un objeto mailSearchFolder en el cuerpo de la respuesta.

Ejemplo

Solicitud

A continuación se muestra 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 se encuentra en la misma carpeta en la que se aplica la consulta de filtro especificada.

POST https://graph.microsoft.com/beta/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')"
}

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/beta/$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,
    "wellKnownName": null,
    "isSupported": true,
    "includeNestedFolders": true,
    "sourceFolderIds": [
        "AQMkADYAAAIBDAAAAA=="
    ],
    "filterQuery": "contains(subject, 'weekly digest')"
}