Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
GetAllDistributionLists SOAP Command

Get all distribution lists that match the selection criteria
Access: domain admin sufficient

Authorization token required true
Admin Authorization token required true

GetAllDistributionListsRequest

    <GetAllDistributionListsRequest> ## GetAllDistributionListsRequest
        <domain [by="{domain-selector-by} (id|name|virtualHostname|krb5Realm|foreignName)"]>{key}</domain> ## DomainSelector
    </GetAllDistributionListsRequest>

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

XPath Required / Optional Description
/domain Optional (0 or 1) Type:{key}
Domain
Description for element text content:The key used to identify the domain. Meaning determined by {domain-selector-by}
/domain@by Optional (0 or 1) Type:id|name|virtualHostname|krb5Realm|foreignName
Select the meaning of {domain-selector-key}

GetAllDistributionListsResponse

    <GetAllDistributionListsResponse> ## GetAllDistributionListsResponse
        (<dl [dynamic="{dl-is-dynamic} (0|1)"] name="{name}" id="{id}"> ## DistributionListInfo
            (<dlm>{members} (String)</dlm>)*
            <owners>
                (<owner [type="{grantee-type} (usr|grp|egp|all|dom|edom|gst|key|pub|email)"] id="{grantee-id}"
                            name="{grantee-name}" /> ## GranteeInfo)*
            </owners>
            (<a n="{key}" /> ## Attr)*
          </dl>)*
    </GetAllDistributionListsResponse>

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

XPath Required / Optional Description
/dl Optional (0 or more) Information on distribution lists
/dl@dynamic Optional (0 or 1) Type:0|1
Flags whether this is a dynamic distribution list or not
/dl@name Required (only 1) Type:String
Name
/dl@id Required (only 1) Type:String
ID
/dl/dlm Optional (0 or more) Type:{members} (String)
dl-members
/dl/owners Required (only 1)
/dl/owners/owner Optional (0 or more)
/dl/owners/owner@type Optional (0 or 1) Type:usr|grp|egp|all|dom|edom|gst|key|pub|email
Grantee type
/dl/owners/owner@id Required (only 1) Type:String
Grantee ID
/dl/owners/owner@name Required (only 1) Type:String
Grantee name
/dl/a Optional (0 or more) Attributes
/dl/a@n Required (only 1) Type:String
Key