Service: zimbraAccount
Namespace: "urn:zimbraAccount"
SubscribeDistributionList SOAP Command

Subscribe to or unsubscribe from a distribution list

Authorization token required true
Admin Authorization token required false

SubscribeDistributionListRequest

    <SubscribeDistributionListRequest op="(subscribe|unsubscribe)"> ## SubscribeDistributionListRequest
        <dl by="{dl-selector-by} (id|name)">{key}</dl> ## DistributionListSelector
    </SubscribeDistributionListRequest>

The following table describes elements and attributes you can define within a <SubscribeDistributionListRequest> element:

XPath Required / Optional Description
@op Required (only 1) Type:subscribe|unsubscribe
The operation to perform.
  • subscribe : Subscribe the requested account to the distribution list
  • unsubscribe: Unsubscribe the requested account from the distribution list
/dl Required (only 1) Type:{key}
Selector for the distribution list
Description for element text content:The key used to identify the account. Meaning determined by {dl-selector-by}
/dl@by Required (only 1) Type:id|name
Select the meaning of {dl-selector-key}

SubscribeDistributionListResponse

    <SubscribeDistributionListResponse status="(subscribed|unsubscribed|awaiting_approval)" /> ## SubscribeDistributionListResponse

The following table describes elements and attributes you can define within a <SubscribeDistributionListResponse> element:

XPath Required / Optional Description
@status Required (only 1) Type:subscribed|unsubscribed|awaiting_approval
Status of subscription attempt