pem.global_relay.getArchiveRecipientsCandidates

This method is supported by POA starting from version 2.8 hotfix02

This method returns the list of the archive recipient candidates.

The method has the following input parameters:

Name

Type

Short Description

subscription_id

int

Subscription ID.

The method returns the array of structures:

Name

Type

Short Description

recipient_owner_id

int

ID of the recipient candidate owner. It shows to which POA Hosting Module a recipient candidate corresponds.

external_recipient_id

int

ID of recipient candidate.

recipient_type

string

Type of recipient candidate. There are the following options:

  • mbx - Mailbox.
  • dlist - Distribution List.
  • pfolder - Public Folder.
  • contact - Contact.

Note: The dlist, pfolder, and contact recipient candidate types should not be used. They are reserved for future use.

display_name

string

Display Name of a recipient candidate.

email

string

E-mail address of a recipient candidate.

status

int

Status of a recipient candidate. There are the following options:

  • 0 - Unknown.
  • 1 - Creating.
  • 2 - Updating.
  • 3 - Deleting.
  • 4 - Ready.
  • 5 - Enabling.
  • 6 - Disabling.
  • 7 - Disabled.
  • 8 - Detached.

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