Service: zimbraAccount

Command: GetDistributionListMembers
Namespace: urn:zimbraAccount
Description: Get the list of members of a distribution list.
Properties:
Authorization token required true
Admin Authorization token required false

GetDistributionListMembersRequest

    <GetDistributionListMembersRequest [limit="(Integer)"] [offset="(Integer)"]> ## GetDistributionListMembersRequest
        <dl>{dl} (String)</dl>
    </GetDistributionListMembersRequest>

elements and attributes you can define within a <GetDistributionListMembersRequest> element:

XPath Required / Optional Description
@limit Optional (0 or 1) Type: Integer
The number of members to return (0 is default and means all)
@offset Optional (0 or 1) Type: Integer
The starting offset (0, 25, etc)
/dl Required (only 1) Type: {dl} (String)
The name of the distribution list

GetDistributionListMembersResponse

    <GetDistributionListMembersResponse [more="{more-flag} (0|1)"] [total="{total} (Integer)"]> ## GetDistributionListMembersResponse
        (<dlm>{dlMembers} (String)</dlm>)*
        <groupMembers>
            (<groupMember [seniorityIndex="{seniorityIndex} (int)"]> ## HABGroupMember
                (<attr name="{name}">{value}</attr> ## NamedValue)+
                <name>{name} (String)</name>
              </groupMember>)*
        </groupMembers>
    </GetDistributionListMembersResponse>

elements and attributes you can define within a <GetDistributionListMembersResponse> element:

XPath Required / Optional Description
@more Optional (0 or 1) Type: 0|1
1 (true) if more members left to return
@total Optional (0 or 1) Type: Integer
total number of distribution lists (not affected by limit/offset)
/dlm Optional (0 or more) Type: {dlMembers} (String)
Distribution list members
/groupMembers Required (only 1)
/groupMembers/groupMember Optional (0 or more)
/groupMembers/groupMember@seniorityIndex Optional (0 or 1) Type: int
seniorityIndex of the HAB group member
/groupMembers/groupMember/attr Required (1 or more) Type: {value}
Member attributes. Currently only these attributes are returned:
zimbraId the unique UUID of the hab member
displayName display name for the member

Description for element text content:Value
/groupMembers/groupMember/attr@name Required (only 1) Type: String
Name
/groupMembers/groupMember/name Required (only 1) Type: {name} (String)
HAB Member name - an email address (user@domain)