Service: zimbraAdmin

Command: GetAdminExtensionZimlets
Namespace: urn:zimbraAdmin
Description: Returns the admin extension addon Zimlets.
Properties:
Authorization token required true
Admin Authorization token required true

GetAdminExtensionZimletsRequest

    <GetAdminExtensionZimletsRequest /> ## GetAdminExtensionZimletsRequest

GetAdminExtensionZimletsResponse

    <GetAdminExtensionZimletsResponse> ## GetAdminExtensionZimletsResponse
        <zimlets>
            (<zimlet> ## AdminZimletInfo
                <zimletContext baseUrl="{zimlet-base-url}" [priority="{zimlet-priority} (Integer)"]
                                   presence="{zimlet-presence}" /> ## AdminZimletContext
                <zimlet [name="{zimlet-name}"] [version="{version-string}"] [description="{zimlet-description}"]
                            [extension="{is-extension}"] [target="{zimlet-target}"] [label="{zimlet-label}"]> ## AdminZimletDesc
                    List of any of: {
                        <serverExtension [hasKeyword="{keyword}"] [extensionClass="{extension-class}"] [regex="{regex}"] /> ## ZimletServerExtension
                        <include>{value}</include> ## AdminZimletInclude
                        <includeCSS>{value}</includeCSS> ## AdminZimletIncludeCSS
                        <target>{value}</target> ## AdminZimletTarget
                    }
                 </zimlet>
                <zimletConfig [name="{zimlet-name}"] [version="{version-string}"] [description="{zimlet-description}"]
                                  [extension="{is-extension}"] [target="{zimlet-target}"] [label="{zimlet-label}"]> ## AdminZimletConfigInfo
                    <global> ## AdminZimletGlobalConfigInfo
                        (<property [name="..."]>{value}</property> ## AdminZimletProperty)*
                     </global>
                    <host [name="{zimlet-host-name}"]> ## AdminZimletHostConfigInfo
                        (<property [name="..."]>{value}</property> ## See /zimlets/zimlet/zimletConfig/global/property [ ## AdminZimletProperty])*
                     </host>
                 </zimletConfig>
              </zimlet>)*
        </zimlets>
    </GetAdminExtensionZimletsResponse>

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

XPath Required / Optional Description
/zimlets Required (only 1)
/zimlets/zimlet Optional (0 or more)
/zimlets/zimlet/zimletContext Optional (0 or 1) Zimlet context
/zimlets/zimlet/zimletContext@baseUrl Required (only 1) Type: String
Zimlet Base URL
/zimlets/zimlet/zimletContext@priority Optional (0 or 1) Type: Integer
Zimlet Priority
/zimlets/zimlet/zimletContext@presence Required (only 1) Type: String
Zimlet presence
Valid values: mandatory | enabled | disabled
/zimlets/zimlet/zimlet Optional (0 or 1) Zimlet description
/zimlets/zimlet/zimlet@name Optional (0 or 1) Type: String
Zimlet name
/zimlets/zimlet/zimlet@version Optional (0 or 1) Type: String
Version string
/zimlets/zimlet/zimlet@description Optional (0 or 1) Type: String
Zimlet description
/zimlets/zimlet/zimlet@extension Optional (0 or 1) Type: String
Valid values true|false
/zimlets/zimlet/zimlet@target Optional (0 or 1) Type: String
Zimlet target
/zimlets/zimlet/zimlet@label Optional (0 or 1) Type: String
Zimlet label
/zimlets/zimlet/zimlet/serverExtension Required (only 1)
/zimlets/zimlet/zimlet/serverExtension@hasKeyword Optional (0 or 1) Type: String
Keyword
/zimlets/zimlet/zimlet/serverExtension@extensionClass Optional (0 or 1) Type: String
Extension class
/zimlets/zimlet/zimlet/serverExtension@regex Optional (0 or 1) Type: String
Regex
/zimlets/zimlet/zimlet/include Required (only 1) Type: {value}
Description for element text content:Included script
/zimlets/zimlet/zimlet/includeCSS Required (only 1) Type: {value}
Description for element text content:Included Cascading Style Sheet (CSS)
/zimlets/zimlet/zimlet/target Required (only 1) Type: {value}
Description for element text content:Zimlet target
/zimlets/zimlet/zimletConfig Optional (0 or 1) Other elements
/zimlets/zimlet/zimletConfig@name Optional (0 or 1) Type: String
Zimlet name
/zimlets/zimlet/zimletConfig@version Optional (0 or 1) Type: String
Version string
/zimlets/zimlet/zimletConfig@description Optional (0 or 1) Type: String
Zimlet description
/zimlets/zimlet/zimletConfig@extension Optional (0 or 1) Type: String
Valid values true|false
/zimlets/zimlet/zimletConfig@target Optional (0 or 1) Type: String
Zimlet target
/zimlets/zimlet/zimletConfig@label Optional (0 or 1) Type: String
Zimlet label
/zimlets/zimlet/zimletConfig/global Optional (0 or 1) Zimlet global configuration information
/zimlets/zimlet/zimletConfig/global/property Optional (0 or more) Type: {value}
Global zimlet configuration property
Description for element text content:Property value
/zimlets/zimlet/zimletConfig/global/property@name Optional (0 or 1) Type: String
Property name
/zimlets/zimlet/zimletConfig/host Optional (0 or 1) Zimlet host configuration information
/zimlets/zimlet/zimletConfig/host@name Optional (0 or 1) Type: String
Designates the zimbra host name for the properties.
Must be a valid Zimbra host name
/zimlets/zimlet/zimletConfig/host/property Optional (0 or more) Type: {value}
Host specifice zimlet configuration properties
Description for element text content:Property value
See /zimlets/zimlet/zimletConfig/global/property for more details.