pem.exchange.listPublicFolderRoles

This method is supported by Operations starting from version 5.0

This method returns a list of Hosted Exchange Entities (Mailboxes or Distribution Lists), which have the Roles for the specified Public Folder.

The method has the following input parameters:

Name

Type

Short Description

public_folder_id

int

Public Folder ID

The method returns array of the following structures:

Name

Type

Short Description

entity_id

struct

Hosted Exchange Entity (Mailbox or Distribution List)

  • [mailbox_id]

int

Mailbox ID

  • [distribution_list_id]

int

Distribution List ID

entity_name

string

Name of Hosted Exchange Entity (Mailbox or Distribution List)

entity_display_name

string

Display Name of Hosted Exchange Entity (Mailbox or Distribution List)

role

string

Role of 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 is returned. If Hosted Exchange Entity is a Distribution List, the distribution_list_id parameter is returned.

This method can also be called under Reseller permissions.

CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.