Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Create a new mailboxFolder or child mailboxFolder in a user's mailbox.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
MailboxFolder.ReadWrite |
Not available. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
MailboxFolder.ReadWrite.All |
Not available. |
HTTP request
POST /admin/exchange/mailboxes/{mailboxId}/folders
POST /admin/exchange/mailboxes/{mailboxId}/folders/inbox/childFolders
Request body
In the request body, supply a JSON representation of the mailboxFolder object.
You can specify the following properties when you create a mailboxFolder.
| Property |
Type |
Description |
| displayName |
String |
The display name of the folder. Required. |
| type |
String |
Describes the folder class type. Required. |
Response
If successful, this method returns a 201 Created response code and a mailboxFolder object in the response body.
Examples
Request
The following example shows how to create a new mailbox folder.
POST https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0648f21@aab09c93/folders
{
"displayName": "Announcements",
"type": "IPF.Note",
"singleValueExtendedProperties": [
{
"id": "String 0x3001",
"value": "Announcements"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new MailboxFolder
{
DisplayName = "Announcements",
Type = "IPF.Note",
SingleValueExtendedProperties = new List<SingleValueLegacyExtendedProperty>
{
new SingleValueLegacyExtendedProperty
{
Id = "String 0x3001",
Value = "Announcements",
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Admin.Exchange.Mailboxes["{mailbox-id}"].Folders.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewMailboxFolder()
displayName := "Announcements"
requestBody.SetDisplayName(&displayName)
type := "IPF.Note"
requestBody.SetType(&type)
singleValueLegacyExtendedProperty := graphmodels.NewSingleValueLegacyExtendedProperty()
id := "String 0x3001"
singleValueLegacyExtendedProperty.SetId(&id)
value := "Announcements"
singleValueLegacyExtendedProperty.SetValue(&value)
singleValueExtendedProperties := []graphmodels.SingleValueLegacyExtendedPropertyable {
singleValueLegacyExtendedProperty,
}
requestBody.SetSingleValueExtendedProperties(singleValueExtendedProperties)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
folders, err := graphClient.Admin().Exchange().Mailboxes().ByMailboxId("mailbox-id").Folders().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
MailboxFolder mailboxFolder = new MailboxFolder();
mailboxFolder.setDisplayName("Announcements");
mailboxFolder.setType("IPF.Note");
LinkedList<SingleValueLegacyExtendedProperty> singleValueExtendedProperties = new LinkedList<SingleValueLegacyExtendedProperty>();
SingleValueLegacyExtendedProperty singleValueLegacyExtendedProperty = new SingleValueLegacyExtendedProperty();
singleValueLegacyExtendedProperty.setId("String 0x3001");
singleValueLegacyExtendedProperty.setValue("Announcements");
singleValueExtendedProperties.add(singleValueLegacyExtendedProperty);
mailboxFolder.setSingleValueExtendedProperties(singleValueExtendedProperties);
MailboxFolder result = graphClient.admin().exchange().mailboxes().byMailboxId("{mailbox-id}").folders().post(mailboxFolder);
const options = {
authProvider,
};
const client = Client.init(options);
const mailboxFolder = {
displayName: 'Announcements',
type: 'IPF.Note',
singleValueExtendedProperties: [
{
id: 'String 0x3001',
value: 'Announcements'
}
]
};
await client.api('/admin/exchange/mailboxes/MBX:e0648f21@aab09c93/folders')
.version('beta')
.post(mailboxFolder);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\MailboxFolder;
use Microsoft\Graph\Beta\Generated\Models\SingleValueLegacyExtendedProperty;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MailboxFolder();
$requestBody->setDisplayName('Announcements');
$requestBody->setType('IPF.Note');
$singleValueExtendedPropertiesSingleValueLegacyExtendedProperty1 = new SingleValueLegacyExtendedProperty();
$singleValueExtendedPropertiesSingleValueLegacyExtendedProperty1->setId('String 0x3001');
$singleValueExtendedPropertiesSingleValueLegacyExtendedProperty1->setValue('Announcements');
$singleValueExtendedPropertiesArray []= $singleValueExtendedPropertiesSingleValueLegacyExtendedProperty1;
$requestBody->setSingleValueExtendedProperties($singleValueExtendedPropertiesArray);
$result = $graphServiceClient->admin()->exchange()->mailboxes()->byMailboxId('mailbox-id')->folders()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.mailbox_folder import MailboxFolder
from msgraph_beta.generated.models.single_value_legacy_extended_property import SingleValueLegacyExtendedProperty
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MailboxFolder(
display_name = "Announcements",
type = "IPF.Note",
single_value_extended_properties = [
SingleValueLegacyExtendedProperty(
id = "String 0x3001",
value = "Announcements",
),
],
)
result = await graph_client.admin.exchange.mailboxes.by_mailbox_id('mailbox-id').folders.post(request_body)
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
Content-length: 179
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/exchange/mailboxes('MBX%3A73c326ef%402829ab8a')/folders/$entity",
"id": "AQMkAGUw==",
"displayName": "Announcements",
"parentFolderId": "AQMkAGUc==",
"parentMailboxUrl": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0648f21@aab09c93",
"childFolderCount": 0,
"totalItemCount": 0,
"wellKnownName": null,
"type": "IPF.Note"
}