pem.exchange.addDistributionList

This method is supported by Operations starting from version 2.8 hotfix02

This method creates a Distribution List.

The method has the following input parameters:

Name

Type

Short Description

subscription_id

int

ID of the Subscription, where the Distribution List will be created.

alias

string

The Alias of the Distribution List.

display_name

string

The Display Name of the Distribution List.

primary_email_address

string

The Primary E-mail Address of the Distribution List.

[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.

This parameter is optional. If the parameter is not specified, the 1 value is used.

accept_mail_from

int

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

  • 1 – From everyone.
  • 2 – From the Distribution List's members only.
  • 3 – From members of the organization only.

[additional_emails]

array of string

Additional E-mail Addresses of the Distribution List. This parameter is optional.

The method has the following output parameters:

Name

Type

Short Description

distribution_list_id

int

ID of the Distribution List created.

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