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

Attempts to abort a running cross mailbox search task

Network edition only API TRUE
Authorization token required true
Admin Authorization token required true

AbortXMbxSearchRequest

    <AbortXMbxSearchRequest> ## AbortXMbxSearchRequest
        <searchtask searchID="{search-id} (int)" /> ## SearchID
        <account by="{acct-selector-by} (adminName|appAdminName|id|foreignPrincipal|name|krb5Principal)">{key}</account> ## AccountSelector
    </AbortXMbxSearchRequest>

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

XPath Required / Optional Description
/searchtask Required (only 1) Search task
/searchtask@searchID Required (only 1) Type:int
Search ID
/account Optional (0 or 1) Type:{key}
Select account
Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by}
/account@by Required (only 1) Type:adminName|appAdminName|id|foreignPrincipal|name|krb5Principal
Select the meaning of {acct-selector-key}

AbortXMbxSearchResponse

    <AbortXMbxSearchResponse> ## AbortXMbxSearchResponse
        <searchtask> ## SearchNode
            (<a n="{key}" /> ## Attr)*
        </searchtask>
    </AbortXMbxSearchResponse>

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

XPath Required / Optional Description
/searchtask Required (only 1) Search task information
/searchtask/a Optional (0 or more) Attributes
/searchtask/a@n Required (only 1) Type:String
Key