Skip to content

user-post-mailfolders.md

Latest commit

 

History

History
139 lines (112 loc) · 4.82 KB

user-post-mailfolders.md

File metadata and controls

139 lines (112 loc) · 4.82 KB
title Create MailFolder
description Use this API to create a new mail folder in the root folder of the user's mailbox.
ms.localizationpriority medium
author SuryaLashmiS
ms.subservice outlook
doc_type apiPageType
ms.date 04/04/2024

Create MailFolder

Namespace: microsoft.graph

Use this API to create a new mail folder in the root folder of the user's mailbox.

If you intend a new folder to be hidden, you must set the isHidden property to true on creation.

[!INCLUDE national-cloud-support]

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Mail.ReadWrite
Delegated (personal Microsoft account) Mail.ReadWrite
Application Mail.ReadWrite

HTTP request

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

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json

Request body

In the request body, provide a JSON object with the following parameters. displayName and isHidden are the only writable property for a mailFolder object.

Parameter Type Description
displayName String The display name of the new folder.
isHidden Boolean Indicates whether the new folder is hidden. The default value is false. Setting the property is optional. Once set, you cannot update this property. See more information in Hidden mail folders

Response

If successful, this method returns 201 Created response code and a mailFolder object in the response body.

Example

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/v1.0/me/mailFolders
Content-type: application/json

{
  "displayName": "Clutter",
  "isHidden": true
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

{
  "displayName": "Clutter",
  "parentFolderId": "AQMkADlmOGQwZmU3LWVjOWMtNDhiYgAtODcxNy1",
  "childFolderCount": 99,
  "unreadItemCount": 99,
  "totalItemCount": 99,
  "id": "hN2Y5OGRhNGYwODEALgAAA0DAKbvJvFhJgcT3lZpkhNQBAA1",
  "isHidden": true
}