Namespace: "urn:zimbraAdmin"
CreateAddressList SOAP Command

crteate address list request

Authorization token required true
Admin Authorization token required true

CreateAddressListRequest

    <CreateAddressListRequest [type="{type} (all|account|resource|group)"]> ## CreateAddressListRequest
        <name>{name} (String)</name>
        <desc>{desc} (String)</desc>
        <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>
        <domain [by="{domain-selector-by} (id|name|virtualHostname|krb5Realm|foreignName)"]>{key}</domain> ## DomainSelector
    </CreateAddressListRequest>

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

XPath Required / Optional Description
@type Optional (0 or 1) Type:all|account|resource|group
gal search type
/name Required (only 1) Type:{name} (String)
name of the address list
/desc Optional (0 or 1) Type:{desc} (String)
description of the address list
/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.
/domain Optional (0 or 1) Type:{key}
Domain selector
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}

CreateAddressListResponse

    <CreateAddressListResponse> ## CreateAddressListResponse
        <id>{id} (String)</id>
    </CreateAddressListResponse>

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

XPath Required / Optional Description
/id Required (only 1) Type:{id} (String)
zimbra id of the created address list