Operation: CreateMailFolder

The CreateMailFolder operation creates a new email folder.

Input

The adapter expects the following XML structure as input:

Example

XML

<?xml version="1.0" encoding="UTF-8"?>
<MailFolder>
		<DisplayName>My folder name</DisplayName>
		<!-- ##The <Hidden/> tag is optional## -->
		<Hidden>true/false</Hidden>
</MailFolder>

The following elements can be included in the input:

Element Description

MailFolder Enclosing element for the CreateMailFolder operation

DisplayName

Name of the email folder to be created.

Possible value:

Any string

Hidden

(optional)

Specifies whether the email folder is visible or not.

Possible values:

true: The email folder is hidden.
false: The email folder is visible.

Output

The adapter creates an email folder based on the data given in the input.

Example

XML

<?xml version="1.0" encoding="UTF-8"?>
<CreateMailFolder>
   <Object>
      <Value name="@odata.context" type="String">https://graph.microsoft.com/v1.0/$metadata#users('test.user%40softproject.de')/mailFolders/$entity</Value>
      <Value name="id" type="String">AAMkAGI0NDU3YTMxLTVkOTktNGQ2Zi04OGViLTgzNWM1YWFlNjAwNwAuAAAAAABqZX6HQaolT792ILCaL-z8AQCRrcaFxKxcR7F2mRmZk4TVAAC6q4pRAAA=</Value>
      <Value name="displayName" type="String">TEST FOLDER</Value>
      <Value name="parentFolderId" type="String">AAMkAGI0NDU3YTMxLTVkOTktNGQ2Zi04OGViLTgzNWM1YWFlNjAwNwAuAAAAAABqZX6HQaolT792ILCaL-z8AQCRrcaFxKxcR7F2mRmZk4TVAAAAAAEIAAA=</Value>
      <Value name="childFolderCount" type="Number">0</Value>
      <Value name="unreadItemCount" type="Number">0</Value>
      <Value name="totalItemCount" type="Number">0</Value>
      <Value name="sizeInBytes" type="Number">0</Value>
      <Value name="isHidden" type="Boolean">false</Value>
   </Object>
</CreateMailFolder>

Note:

Included in the output is metadata provided by MS Graph. More information about this metadata can be found in the official MS Graph documentation:
https://learn.microsoft.com/en-us/graph/

The following elements and attributes can be included in the output:

Element Description

CreateMailFolder Enclosing element for the output of the CreateMailFolder operation

Object

Enclosing element for the Value elements with details about the created email folder:

User account in Microsoft Outlook
ID of the email folder
Name of the email folder
ID of the parent email folder
Number of subfolders
Number of unread items
Total number of items in the folder
Size of the email folder in bytes
Visibility of the folder

Value

The Value element can have different values in the name attribute.

Possible values:

@odata.context: Request URL to get a response from MS Graph
id: ID of the email folder
displayName: Name of the email folder
parentFolderId: ID of the parent email folder
childFolderCount: Number of subfolders
unreadItemCount: Number of unread items
totalItemCount: Total number of items in the folder
sizeInBytes: Size of the email folder in bytes
isHidden: Visibility of the folder

The type attribute specifies the type of the given data:

String: Any string
Number: Any integer
Boolean: Boolean value with the options true or false