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

Get XMPP Component
XMPP stands for Extensible Messaging and Presence Protocol

Authorization token required true
Admin Authorization token required true

GetXMPPComponentRequest

    <GetXMPPComponentRequest [attrs="{request-attrs}"]> ## GetXMPPComponentRequest
        <xmppcomponent by="{xmpp-comp-selector-by} (id|name|serviceHostname)">{value}</xmppcomponent> ## XMPPComponentSelector
    </GetXMPPComponentRequest>

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

XPath Required / Optional Description
@attrs Optional (0 or 1) Type:String
Comma separated list of attributes
/xmppcomponent Required (only 1) Type:{value}
XMPP Component selector
Description for element text content:The key used to identify the XMPP component. Meaning determined by {xmpp-comp-selector-by}
/xmppcomponent@by Required (only 1) Type:id|name|serviceHostname
Select the meaning of {xmpp-comp-selector-key}

GetXMPPComponentResponse

Note:
Attributes that are not allowed to be got by the authenticated admin will be returned as :

     <a n="{attr-name}" pd="1"/>
 
To allow an admin to get all attributes, grant the getXMPPComponent right

    <GetXMPPComponentResponse> ## GetXMPPComponentResponse
        <xmppcomponent name="{name}" id="{id}" [x-domainName="..."] [x-serverName="..."]> ## XMPPComponentInfo
            (<a n="{key}" /> ## Attr)*
        </xmppcomponent>
    </GetXMPPComponentResponse>

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

XPath Required / Optional Description
/xmppcomponent Required (only 1) XMPP Component Information
/xmppcomponent@name Required (only 1) Type:String
Name
/xmppcomponent@id Required (only 1) Type:String
ID
/xmppcomponent@x-domainName Optional (0 or 1) Type:String
x-domainName
/xmppcomponent@x-serverName Optional (0 or 1) Type:String
x-serverName
/xmppcomponent/a Optional (0 or more) Attributes
/xmppcomponent/a@n Required (only 1) Type:String
Key