Carbonio SOAP API Reference 24.9.5_ZEXTRAS

Service: zimbraMail

Command: Browse
Namespace: urn:zimbraMail
Description: Browse
EXAMPLE:

     <mail:BrowseRequest xmlns:mail="urn:zimbraMail">
        <query>from:roland</query>
        <browseBy>attachments</browseBy>
     </mail:BrowseRequest>

     <mail:BrowseResponse xmlns:mail="urn:zimbraMail">
       <bd freq="3">application/pdf</bd>
       <bd freq="1">application/msword</bd>
       <bd freq="1">application/vnd.ms-powerpoint</bd>
       <bd freq="8">image/jpeg</bd>
       <bd freq="11">application/octet-stream</bd>
       <bd freq="23">text/plain</bd>
       <bd freq="1">image/gif</bd>
       <bd freq="12">message/rfc822</bd>
     </mail:BrowseResponse>

Properties:

Authorization token required	true
Admin Authorization token required	false

BrowseRequest

<BrowseRequest browseBy="{browse-by-domains|attachments|objects}" [regex="{regex-string}"]
[maxToReturn="{max-entries} (Integer)"] /> ## BrowseRequest

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

XPath	Required / Optional	Description
@browseBy	Required (only 1)	Type: String Browse by setting - domains\|attachments\|objects where objects means objects in message body content recognized by Zimlets via <contentObject> configuration.
@regex	Optional (0 or 1)	Type: String Regex string. Return only those results which match the specified regular expression
@maxToReturn	Optional (0 or 1)	Type: Integer Return only a maximum number of entries as requested. If more than {max-entries} results exist, the server will return the first {max-entries}, sorted by frequency

BrowseResponse

    <BrowseResponse> ## BrowseResponse
        (<bd [h="{h-flags}"] freq="{count} (int)">{data}</bd> ## BrowseData)*
    </BrowseResponse>

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

XPath Required / Optional Description

/bd

Optional (0 or more)

Type: {data}
Browse data
Description for element text content:Browse data.

for attachments	content type (e.g. application/msword)
for objects	object type (url, etc)
for domains	domains (e.g. stanford.edu) {h-flags} will also be set)

for attachments: content type (application/msword) for objects: object type (url, etc) for domains: domains (stanford.edu, etc)

/bd@h Optional (0 or 1) Type: String
Set for domains. Indicates whether or not the domain was from the "From", "To", or "Cc" header. Valid flags are always one of: "f", "t", "ft", "c", "fc", "tc", "ftc"

/bd@freq Required (only 1) Type: int
Frequency count