Service: zimbraAdmin

Command: GetAddressListInfo
Namespace: urn:zimbraAdmin
Description: get address list info request
Properties:
Authorization token required true
Admin Authorization token required true

GetAddressListInfoRequest

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

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

XPath Required / Optional Description
@id Optional (0 or 1) Type: String
zimbra id of the address list to get
@name Optional (0 or 1) Type: String
name of the address list to get
/domain Optional (0 or 1) Type: {key}
domain of the address list to get (needed with name)
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}

GetAddressListInfoResponse

    <GetAddressListInfoResponse id="{id}" name="{name}" type="{type} (all | account | resource | group)"> ## GetAddressListInfoResponse
        <desc>{desc} (String)</desc>
        <domain [by="{domain-selector-by} (id | name | virtualHostname | krb5Realm | foreignName)"]>{key}</domain> ## DomainSelector
        <searchFilter> ## EntrySearchFilterInfo
            Choose one of: {
                <conds [not="{not} (0|1)"] [or="{or} (0|1)"]> ## EntrySearchFilterMultiCond
                    List of any of: {
                        <conds> ... </conds> ## See /searchFilter/conds [ ## EntrySearchFilterMultiCond] # [inside itself]
                        <cond [not="{not} (0|1)"] attr="{single-cond-attr}" op="{single-cond-op}" value="..." /> ## EntrySearchFilterSingleCond
                    }
                 </conds>
                <cond ... /> ## See /searchFilter/conds/cond [ ## EntrySearchFilterSingleCond]
            }
         </searchFilter>
    </GetAddressListInfoResponse>

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

XPath Required / Optional Description
@id Required (only 1) Type: String
zimbra id of the address list
@name Required (only 1) Type: String
name of the address list
@type Required (only 1) Type: all | account | resource | group
gal search type
/desc Optional (0 or 1) Type: {desc} (String)
description of the address list
/domain Optional (0 or 1) Type: {key}
domain of the address list
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}
/searchFilter Optional (0 or 1) search filter for conditions
/searchFilter/conds Optional (0 or 1)
/searchFilter/conds@not Optional (0 or 1) Type: 0|1
Negation flag
If set to 1 (true) then negate the compound condition
/searchFilter/conds@or Optional (0 or 1) Type: 0|1
OR flag
1 (true) child conditions are OR'ed together
0 (false) [default] child conditions are AND'ed together
/searchFilter/conds/conds Optional (0 or 1) See /searchFilter/conds for more details.
/searchFilter/conds/cond Optional (0 or 1)
/searchFilter/conds/cond@not Optional (0 or 1) Type: 0|1
Negation flag
If set to 1 (true) then negate the compound condition
/searchFilter/conds/cond@attr Required (only 1) Type: String
Attribute name
/searchFilter/conds/cond@op Required (only 1) Type: String
Operator. Valid operators are:
eq attr equals value (integer or string)
has attr has value (substring search)
ge attr greater than or equal to integer value
le attr less than or equal to integer value
gt attr greater than (but not equal to) equal to integer value
lt attr less than (but not equal to) to integer value
startswith attr starts with value (string)
endswith attr ends with value (string)
/searchFilter/conds/cond@value Required (only 1) Type: String
value
/searchFilter/cond Optional (0 or 1) See /searchFilter/conds/cond for more details.