Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The following operations allow you to work with folders. Click an operation name to see details on how to use it.

...

OperationDescription

createFolder

Create a new folder

deleteFolder

Delete a folder

getChildFolder

Get child folder

getFolder

Get the folder collection 

moveFolder

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
languagexml
titlecreateFolder
<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.

Anchor
Request
Request
Sample request

Following is a sample REST/JSON request that can be handled by the createFolder operation.

Code Block
languagexml
titleSample request for createFolder
{
   "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
languagexml
titledeleteFolder
<outlookmail.deleteFolder>
    <folderId>{$ctx:folderId}</folderId>
</outlookmail.deleteFolder>
Properties

folderId: Required -The folder ID, or the Inbox, Drafts, SentItems, orDeletedItems well-known folder name.

Anchor
Request
Request
Sample request

Following is a sample REST/JSON request that can be handled by the deleteFolder operation.

Code Block
languagexml
titleSample request for deleteFolder
{
   "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
languagexml
titlegetChildFolder
<outlookmail.deleteFolder>
    <folderId>{$ctx:folderId}</folderId>
</outlookmail.deleteFolder>
Properties

folderId: Required -The folder ID, or the Inbox, Drafts, SentItems, orDeletedItems well-known folder name.

Anchor
Request
Request
Sample request

Following is a sample REST/JSON request that can be handled by the getChildFolder operation.

Code Block
languagexml
titleSample request for getChildFolder
{
   "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
getFolder
getFolder
Get Folder

 The getFolder operation gets the folder collection under the root folder of the signed-in user. 

Code Block
languagexml
titlegetFolder
<outlookmail.getFolder/>

Anchor
Request
Request
Sample request

Following is a sample REST/JSON request that can be handled by the getFolder operation.

Code Block
languagexml
titleSample Request for getFolder
{
   "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
languagexml
titlemoveFolder
<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.

Anchor
Request
Request
Sample request

Following is a sample REST/JSON request that can be handled by the moveFolder operation.

Code Block
languagexml
titleSample request for moveFolder
{
   "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"
}

...