pem.exchange.grantPublicFolderRoles

This method is supported by Operations starting from version 5.0

This method grants the Roles to the Hosted Exchange Entities (Mailboxes or Distribution Lists) for the specified Public Folder.

The method has the following input parameters:

Name

Type

Short Description

public_folder_id

int

Public Folder ID

roles

array

This parameter defined the Hosted Exchange Entities (Mailboxes or Distribution Lists) and Roles, which are granted to the Hosted Exchange Entities (Mailboxes or Distribution Lists).

  • entity_id

struct

Hosted Exchange Entity (Mailbox or Distribution List)

  • [mailbox_id]

int

Mailbox ID

  • [distribution_list_id]

int

Distribution List ID

  • role

string

Role of the Hosted Exchange Entity (Mailbox or Distribution List). There are the following options:

  • none – The None Role,
  • reviewer – The Reviewer Role,
  • contributor – The Contributor Role,
  • non-editing-author – The Non-Editing Author Role,
  • author – The Author Role,
  • publishing-author – The Publishing Author Role,
  • editor – The Editor Role,
  • publishing-editor – The Publishing Editor Role,
  • owner – The Owner Role.

Note: The mailbox_id and distribution_list_id optional parameters are mutually exclusive. If Hosted Exchange Entity is a Mailbox, the mailbox_id parameter should be specified. If Hosted Exchange Entity is a Distribution List, the distribution_list_id parameter should be specified.

The method has no output parameters.

Note: This method can also be called under Reseller permissions.