...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Overview
The following operations allow you to work with folders. Click an operation name to see details on how to use it.
For a sample proxy service that illustrates how to work with messages, see Sample configuration.
| Operation | Description |
|---|---|
| Create a new folder | |
| Delete a folder | |
| Get child folder | |
| Get the folder collection | |
| Move a folder and its contents |
Operation details
This section provides further details on the operations related to discussions.
...
The createFolder operation creates a child folder by the name.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<outlookmail.createFolder>
<folderId>{$ctx:folderId}</folderId>
<displayName>{$ctx:displayName}</displayName>
</outlookmail.createFolder> |
Properties
folderId: Required -The folder ID, or the Inbox, Drafts, SentItems, orDeletedItems well-known folder name.
displayName: Required -The display name of the folder.
Sample requestAnchor Request Request
Following is a sample REST/JSON request that can be handled by the createFolder operation.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"apiUrl":"https://outlook.office.com/api",
"apiVersion":"v2.0",
"accessToken":"accesstoken",
"refreshToken":"refreshtoken",
"clientSecret":"K+M5n5OidY4hJ......",
"clientId":"dec93ce7-dd0f.....",
"resource":"https://outlook.office.com/",
"redirectUri":"http://www.wso2.com",
"registryPath":"Connector/OutlookMailRegPath",
"intervalTime":"",
"folderId":"Inbox",
"displayName":"Inbox_Child"
} |
...
The deleteFolder operation deletes a folder and all of its contents.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<outlookmail.deleteFolder>
<folderId>{$ctx:folderId}</folderId>
</outlookmail.deleteFolder> |
Properties
folderId: Required -The folder ID, or the Inbox, Drafts, SentItems, orDeletedItems well-known folder name.
Sample requestAnchor Request Request
Following is a sample REST/JSON request that can be handled by the deleteFolder operation.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"apiUrl":"https://outlook.office.com/api",
"apiVersion":"v2.0",
"accessToken":"accesstoken",
"refreshToken":"refreshtoken",
"clientSecret":"K+M5n5OidY4hJ......",
"clientId":"dec93ce7-dd0f.....",
"resource":"https://outlook.office.com/",
"redirectUri":"http://www.wso2.com",
"registryPath":"Connector/OutlookMailRegPath",
"intervalTime":"",
"folderId":"Inbox"
} |
...
The getChildFolder operation gets the folder collection under the specified folder.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<outlookmail.deleteFolder>
<folderId>{$ctx:folderId}</folderId>
</outlookmail.deleteFolder> |
Properties
folderId: Required -The folder ID, or the Inbox, Drafts, SentItems, orDeletedItems well-known folder name.
Sample requestAnchor Request Request
Following is a sample REST/JSON request that can be handled by the getChildFolder operation.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"apiUrl":"https://outlook.office.com/api",
"apiVersion":"v2.0",
"accessToken":"accesstoken",
"refreshToken":"refreshtoken",
"clientSecret":"K+M5n5OidY4hJ......",
"clientId":"dec93ce7-dd0f.....",
"resource":"https://outlook.office.com/",
"redirectUri":"http://www.wso2.com",
"registryPath":"Connector/OutlookMailRegPath",
"intervalTime":"",
"folderId":"Inbox"
} |
| Anchor | ||||
|---|---|---|---|---|
|
The getFolder operation gets the folder collection under the root folder of the signed-in user.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<outlookmail.getFolder/> |
| Anchor | ||||
|---|---|---|---|---|
|
Following is a sample REST/JSON request that can be handled by the getFolder operation.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"apiUrl":"https://outlook.office.com/api",
"apiVersion":"v2.0",
"accessToken":"accesstoken",
"refreshToken":"refreshtoken",
"clientSecret":"K+M5n5OidY4hJ......",
"clientId":"dec93ce7-dd0f.....",
"resource":"https://outlook.office.com/",
"redirectUri":"http://www.wso2.com",
"registryPath":"Connector/OutlookMailRegPath",
"intervalTime":""
} |
...
The moveFolder operation moves a folder and its contents to another folder.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<outlookmail.moveFolder>
<folderId>{$ctx:folderId}</folderId>
<destinationId>{$ctx:destinationId}</destinationId>
</outlookmail.moveFolder> |
Properties
folderId: Required -The folder ID, or the Inbox, Drafts, SentItems, orDeletedItems well-known folder name.
destinationId: Required -The destination folder ID, or the Inbox, Drafts,SentItems, or DeletedItems well-known folder name.
Sample requestAnchor Request Request
Following is a sample REST/JSON request that can be handled by the moveFolder operation.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"apiUrl":"https://outlook.office.com/api",
"apiVersion":"v2.0",
"accessToken":"accesstoken",
"refreshToken":"refreshtoken",
"clientSecret":"K+M5n5OidY4hJ......",
"clientId":"dec93ce7-dd0f.....",
"resource":"https://outlook.office.com/",
"redirectUri":"http://www.wso2.com",
"registryPath":"Connector/OutlookMailRegPath",
"intervalTime":"",
"folderId":"TESTFOLDER",
"destinationId":"DeletedItems"
} |
...