Create MailFolder
2/6/2021
2 minutes to read
In this article
Namespace: microsoft.graph
Use this API to create a new mail folder in the root folder of the user's mailbox.
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
Header
Value
Authorization
Bearer {token}. Required.
Content-Type
application/json
Request body
In the request body, provide a JSON object with the following parameters. displayName is the only writable property for a
MailFolder object.
Parameter
Type
Description
displayName
String
The display name of the new folder.
Response
If successful, this method returns 201 Created response code and a MailFolder object in the response body.
Example
Request
Here is an example of the request.
POST https://graph.microsoft.com/v1.0/me/mailFolders
Content-type: application/json
Content-length: 159
{
"displayName": "Clutter"
}
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var mailFolder = new MailFolder
{
DisplayName = "Clutter"
};
await graphClient.Me.MailFolders
.Request()
.AddAsync(mailFolder);
Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.
const options = {
authProvider,
};
const client = Client.init(options);
const mailFolder = {
displayName: "Clutter"
};
let res = await client.api('/me/mailFolders')
.post(mailFolder);
Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.
MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];
NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/mailFolders"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
MSGraphMailFolder *mailFolder = [[MSGraphMailFolder alloc] init];
[mailFolder setDisplayName:@"Clutter"];
NSError *error;
NSData *mailFolderData = [mailFolder getSerializedDataWithError:&error];
[urlRequest setHTTPBody:mailFolderData];
MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest
completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {
//Request Completed
}];
[meDataTask execute];
Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.
IGraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();
MailFolder mailFolder = new MailFolder();
mailFolder.displayName = "Clutter";
graphClient.me().mailFolders()
.buildRequest()
.post(mailFolder);
Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.
Response
Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.
HTTP/1.1 201 Created
Content-type: application/json
Content-length: 179
{
"displayName": "Clutter",
"parentFolderId": "AQMkADlmOGQwZmU3LWVjOWMtNDhiYgAtODcxNy1",
"childFolderCount": 99,
"unreadItemCount": 99,
"totalItemCount": 99,
"id": "hN2Y5OGRhNGYwODEALgAAA0DAKbvJvFhJgcT3lZpkhNQBAA1"
}
