Exchange Provider::ModifyFolder

  • Article

The ModifyFolder method modifies folder parameters such as quotas, in addition to setting permissions for a folder in a MAPI top-level hierarchy (TLH).

Arguments

Input argument Required Description

MdbDN

Yes

The Lightweight directory access protocol (LDAP) path of Exchange Public Folder store that is part of the MAPI tree.

Folderpath

Yes

The absolute folder path. If the folder is a top-level folder, this parameter should be specified as "/".

Name

Yes

The name of folder.

MaxItemSize

No

A number that represents the maximum size (in KB) of a message. Any negative number passed in with this parameter removes the size limitation.

ProhibitPostLimit

No

A number that represents the maximum size (in KB) that the folder is allowed to grow to. Any negative number will remove this quota from the folder.

Permissions

No

The permissions specification for the folder.

The Permissions parameter has two modes. The first mode allows you to set the folder Access Control List (ACL) according to input that you specify, while the second mode allows you to modify the ACL. In either case, the default configuration of the Everyone and Anonymous groups in the ACL are not supported. The reason is that these groups can span hosted organizations and open security holes.

The basic format of the <permissions> node is:

<Permissions mode="update"> 
        <Permission role="mapi role">ldap path </Permission> 
</Permissions>

The mode attribute must be set to either "update" or "set." When set to "update", this allows you to change the Access Control Entry (ACE). The Permissions parameter doesn't cause a merging with existing ACEs, but replaces them instead. The "set" mode replaces the entire ACL on the folder and configures it to the values specified in the <permissions> node.

The mapi role attribute can have any of the following values:

  • "owner"

  • "publishing editor"

  • "author"

  • "editor"

  • "publishing author"

  • "non editing author"

  • "contributor"

  • "none"

These values correspond to the Messaging Application Programming Interface (MAPI) roles that are exposed in the MAPI ACL editor. Please refer to this editor to view the specific rights that are granted with each role.

The ldap path in each <permission> node must refer to an entity that is mail/mailbox- enabled. This is required because without an Exchange legacy DN, MAPI will not properly manipulate the ACLs and users without causing a failure.

Remarks

Rollback Calls

The ModifyFolder method calls the ModifyFolder method on transaction rollback to reestablish the original configuration.

Sample Code

Example XML Request

No example XML request.

Example XML Response

No example XML response.

Applies To

Exchange Provider API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

See also

Tasks

Exchange Provider::CreateFolder
Exchange Provider::DeleteFolder