pem.exchange.getMailboxTemplates

This method is supported by Operations starting from version 2.9

This method returns the list of available Mailbox Templates for a specified Service User. These Mailbox Templates can be used in the following ways:

Creating a Mailbox on the basis of a certain Mailbox Template.
Changing the Mailbox Template for the existing Mailbox.

The method has the following input parameters:

Name	Type	Short Description

`user_id`	int	Service User ID. Notes: 1. If the Service User has been bound to a Subscription containing services in the subscription-local mode (for example pem.addUser has been called and subscription_id has been specified), the subscription-local Hosted Exchange service from the Subscription will be used to retrieve the list of available Mailbox Templates. 2. If the Service User has not been bound to any Subscription (for example pem.addUser has been called and owner_account_id has been specified), the account-wide Hosted Exchange service from an account Subscription containing services in the account-wide mode will be used to retrieve the list of available Mailbox Templates. In case when the account does not have the account-wide Hosted Exchange service, the method returns an error.

Name

Type

Short Description

user_id

int

Service User ID.

Notes:
1. If the Service User has been bound to a Subscription containing services in the subscription-local mode (for example pem.addUser has been called and subscription_id has been specified), the subscription-local Hosted Exchange service from the Subscription will be used to retrieve the list of available Mailbox Templates.
2. If the Service User has not been bound to any Subscription (for example pem.addUser has been called and owner_account_id has been specified), the account-wide Hosted Exchange service from an account Subscription containing services in the account-wide mode will be used to retrieve the list of available Mailbox Templates. In case when the account does not have the account-wide Hosted Exchange service, the method returns an error.

The method has the following output parameters:

Name	Type	Short Description
`mailbox_templates`	array of string	The names of the Mailbox Templates.

Notes:

1. This method can also be called under Reseller permissions.

2. Service User ID is not displayed in Operations control panel. You may use the pem.getUserByLogin or pem.getUsers methods to obtain the ID of the required Service User. Also, you may use the Operations Public API methods, which contain Service User ID(s) in the list of the output parameters.