Service: zimbraMail
Namespace: "urn:zimbraMail"
GetComments SOAP Command

Get comments

Authorization token required true
Admin Authorization token required false

GetCommentsRequest

    <GetCommentsRequest> ## GetCommentsRequest
        <comment parentId="{item-id-of-parent}" /> ## ParentId
    </GetCommentsRequest>

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

XPath Required / Optional Description
/comment Required (only 1) Select parent for comments
/comment@parentId Required (only 1) Type:String
Item ID of parent

GetCommentsResponse

    <GetCommentsResponse> ## GetCommentsResponse
        (<user [id="{id}"] [email="{email}"] [name="{name}"] /> ## IdEmailName)*
        (<comment [parentId="{item-id-of-parent}"] [id="{item-id}"] [uuid="{uuid}"] [email="{creator-email-address}"]
                      [f="{flags}"] [t="{tags}"] [tn="{tag-names}"] [color="{color} (Byte)"] [rgb="{rgb-color}"]
                      [d="{timestamp} (Long)"]> ## CommentInfo
            List of any of: {
                <meta [section="{section}"]> ## MailCustomMetadata
                    (<a n="{key}">{value}</a> ## KeyValuePair)*
                </meta>
            }
          </comment>)*
    </GetCommentsResponse>

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

XPath Required / Optional Description
/user Optional (0 or more) Users
/user@id Optional (0 or 1) Type:String
ID
/user@email Optional (0 or 1) Type:String
Email
/user@name Optional (0 or 1) Type:String
Name
/comment Optional (0 or more) Comment information
/comment@parentId Optional (0 or 1) Type:String
Item ID of parent
/comment@id Optional (0 or 1) Type:String
Item ID
/comment@uuid Optional (0 or 1) Type:String
Item's UUID - a globally unique identifier
/comment@email Optional (0 or 1) Type:String
Creator email address
/comment@f Optional (0 or 1) Type:String
Flags
/comment@t Optional (0 or 1) Type:String
Tags - Comma separated list of integers. DEPRECATED - use "tn" instead
/comment@tn Optional (0 or 1) Type:String
Comma-separated list of tag names
/comment@color Optional (0 or 1) Type:Byte
color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7
/comment@rgb Optional (0 or 1) Type:String
RGB color in format #rrggbb where r,g and b are hex digits
/comment@d Optional (0 or 1) Type:Long
Timestamp
/comment/meta Required (only 1)
/comment/meta@section Optional (0 or 1) Type:String
Section.
Normally present. If absent this indicates that CustomMetadata info is present but there are no sections to report on.
/comment/meta/a Optional (0 or more) Type:{value}
Key value pairs
Description for element text content:Value
/comment/meta/a@n Required (only 1) Type:String
Key