pem.exchange.getDistributionList

This method is supported by Operations starting from version 5.5

This method returns properties of a Distribution List.

The method has the following input parameters:

Name

Type

Short Description

distribution_list_id

int

Distribution List ID

The method has the following output parameters:

Name

Type

Short Description

distribution_list_id

int

Distribution List ID

display_name

string

The Display Name of the Distribution List

email_address

string

The Primary E-mail Address of the Distribution List

alias

string

The Alias of the Distribution List

accept_mail_from

int

This parameter defines the type of accepted recipients. There are the following options:

  • 0 – System only
  • 1 – Everyone
  • 2 – Members of the Distribution List
  • 3 – Members of the organization

show_in_address_book

boolean

It defines whether to show the Distribution List in the Address Book of the organization. There are the following options:

  • 0 – The Distribution List is not shown in the Address Book of the organization.
  • 1 – The Distribution List is shown in the Address Book of the organization.

members

array of structures

The list of the Distribution List's members.

The mailbox_id, distribution_list_id, public_folder_id, and mail_contact_id parameters are mutually exclusive.

  • [mailbox_id]

int

Mailbox ID

  • [distribution_list_id]

int

Distribution List ID

  • [public_folder_id]

int

Public Folder ID

  • [mail_contact_id]

int

Contact ID

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