How to use Zimbra Soap?

Rafael · Post by **Rafael** » Tue Sep 06, 2016 3:45 pm

Hi,

I new with zimbra and I try understand more about him before start make the integration.

I try use the SOAP UI to test the zimbra soap, but I see there is a lot of information, and I see in the documentation of the ZImbra about soap, and I don't understand well.
Below I will put the schema of the soap ui. But first, I need to know how it works.
- How use the Params?
- Which Params are required?
- do I need fill all the attributes? (In the schema below).
- Can you explain to me how works each part of the eschema, or only the things I need to know?

Here is the schema of the SOAP UI:

By the informations that I ask above, I think I will be able to fill the schema below and understand better how zimbra webservice works.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:zimbra" xmlns:urn1="urn:zimbraMail">
<soapenv:Header>
<urn:context hops="?">


<urn:authToken>?</urn:authToken>

<urn:session proxy="?" id="?" seq="?">?</urn:session>

<urn:sessionId proxy="?" id="?" seq="?">?</urn:sessionId>

<urn:nosession>?</urn:nosession>

<urn:account by="?" link="?">?</urn:account>

<urn:change token="?" type="?"/>

<urn:targetServer>?</urn:targetServer>

<urn:userAgent name="?" version="?"/>

<urn:authTokenControl voidOnExpired="?"/>

<urn:format type="?"/>

<urn:notify seq="?"/>

<urn:nonotify>?</urn:nonotify>

<urn:noqualify>?</urn:noqualify>

<urn:via>?</urn:via>

<urn:soapId>?</urn:soapId>

<urn:csrfToken>?</urn:csrfToken>
</urn:context>
</soapenv:Header>
<soapenv:Body>
<urn1:CreateAppointmentRequest max="1000">

<urn1:m aid="?" origid="?" rt="?" idnt="?" su="?" irt="?" l="?" f="?">

<urn1:content>?</urn1:content>

<urn1:header name="?">?</urn1:header>

<urn1:mp ct="?" content="?" ci="?">

<urn1:mp/>

<urn1:attach aid="?">

<urn1:mp optional="?" mid="?" part="?"/>
<urn1:m optional="?" id="?"/>
<urn1:cn optional="?" id="?"/>
<urn1:doc optional="?" path="?" id="?" ver="?"/>

</urn1:attach>
</urn1:mp>

<urn1:attach aid="?">

<urn1:mp optional="?" mid="?" part="?"/>
<urn1:m optional="?" id="?"/>
<urn1:cn optional="?" id="?"/>
<urn1:doc optional="?" path="?" id="?" ver="?"/>

</urn1:attach>

<urn1:inv method="?" compNum="?" rsvp="?" priority="?" name="?" loc="?" percentComplete="?" completed="?" noBlob="?" fba="?" fb="?" transp="?" isOrg="?" x_uid="?" uid="?" seq="?" d="?" calItemId="?" apptId="?" ciFolder="?" status="?" class="?" url="?" ex="?" ridZ="?" allDay="?" draft="?" neverSent="?" changes="?" id="?" ct="?" ci="?">

<urn1:category>?</urn1:category>

<urn1:comment>?</urn1:comment>

<urn1:contact>?</urn1:contact>

<urn1:geo lat="?" lon="?"/>

<urn1:at a="?" url="?" d="?" sentBy="?" dir="?" lang="?" cutype="?" role="?" ptst="?" rsvp="?" member="?" delTo="?" delFrom="?">

<urn1:xparam name="?" value="?"/>
</urn1:at>

<urn1:alarm action="?">

<urn1:trigger>

<urn1:abs d="?"/>

<urn1:rel neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:trigger>

<urn1:repeat neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>

<urn1:desc>?</urn1:desc>

<urn1:attach uri="?" ct="?">?</urn1:attach>

<urn1:summary>?</urn1:summary>

<urn1:at a="?" url="?" d="?" sentBy="?" dir="?" lang="?" cutype="?" role="?" ptst="?" rsvp="?" member="?" delTo="?" delFrom="?">

<urn1:xparam name="?" value="?"/>
</urn1:at>

<urn1:xprop name="?" value="?">

<urn1:xparam name="?" value="?"/>
</urn1:xprop>
</urn1:alarm>

<urn1:xprop name="?" value="?">

<urn1:xparam name="?" value="?"/>
</urn1:xprop>

<urn1:fr>?</urn1:fr>

<urn1:desc>?</urn1:desc>

<urn1:descHtml>?</urn1:descHtml>

<urn1:or a="?" url="?" d="?" sentBy="?" dir="?" lang="?">

<urn1:xparam name="?" value="?"/>
</urn1:or>

<urn1:recur>

<urn1:add>

<urn1:add/>
<urn1:exclude>

<urn1:add/>
<urn1:exclude/>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:exclude>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:add>
<urn1:exclude>

<urn1:add>

<urn1:add/>
<urn1:exclude/>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:add>
<urn1:exclude/>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:exclude>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:recur>

<urn1:exceptId d="?" tz="?" rangeType="?"/>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>

<urn1:content uid="?" summary="?">?</urn1:content>

<urn1:comp method="?" compNum="?" rsvp="?" priority="?" name="?" loc="?" percentComplete="?" completed="?" noBlob="?" fba="?" fb="?" transp="?" isOrg="?" x_uid="?" uid="?" seq="?" d="?" calItemId="?" apptId="?" ciFolder="?" status="?" class="?" url="?" ex="?" ridZ="?" allDay="?" draft="?" neverSent="?" changes="?">

<urn1:category>?</urn1:category>

<urn1:comment>?</urn1:comment>

<urn1:contact>?</urn1:contact>

<urn1:geo lat="?" lon="?"/>

<urn1:at a="?" url="?" d="?" sentBy="?" dir="?" lang="?" cutype="?" role="?" ptst="?" rsvp="?" member="?" delTo="?" delFrom="?">

<urn1:xparam name="?" value="?"/>
</urn1:at>

<urn1:alarm action="?">

<urn1:trigger>

<urn1:abs d="?"/>

<urn1:rel neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:trigger>

<urn1:repeat neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>

<urn1:desc>?</urn1:desc>

<urn1:attach uri="?" ct="?">?</urn1:attach>

<urn1:summary>?</urn1:summary>

<urn1:at a="?" url="?" d="?" sentBy="?" dir="?" lang="?" cutype="?" role="?" ptst="?" rsvp="?" member="?" delTo="?" delFrom="?">

<urn1:xparam name="?" value="?"/>
</urn1:at>

<urn1:xprop name="?" value="?">

<urn1:xparam name="?" value="?"/>
</urn1:xprop>
</urn1:alarm>

<urn1:xprop name="?" value="?">

<urn1:xparam name="?" value="?"/>
</urn1:xprop>

<urn1:fr>?</urn1:fr>

<urn1:desc>?</urn1:desc>

<urn1:descHtml>?</urn1:descHtml>

<urn1:or a="?" url="?" d="?" sentBy="?" dir="?" lang="?">

<urn1:xparam name="?" value="?"/>
</urn1:or>

<urn1:recur>

<urn1:add>

<urn1:add/>
<urn1:exclude>

<urn1:add/>
<urn1:exclude/>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:exclude>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:add>
<urn1:exclude>

<urn1:add>

<urn1:add/>
<urn1:exclude/>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:add>
<urn1:exclude/>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:exclude>
<urn1:except rangeType="?" recurId="?" tz="?" ridZ="?">

<urn1:add/>

<urn1:exclude/>
</urn1:except>
<urn1:cancel rangeType="?" recurId="?" tz="?" ridZ="?"/>
<urn1:dates tz="?">

<urn1:dtval>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:dtval>
</urn1:dates>
<urn1:rule freq="?">

<urn1:until d="?"/>

<urn1:count num="?"/>

<urn1:interval ival="?"/>

<urn1:bysecond seclist="?"/>

<urn1:byminute minlist="?"/>

<urn1:byhour hrlist="?"/>

<urn1:byday unusedCodeGenHelper="?">

<urn1:wkday day="?" ordwk="?"/>
</urn1:byday>

<urn1:bymonthday modaylist="?"/>

<urn1:byyearday yrdaylist="?"/>

<urn1:byweekno wklist="?"/>

<urn1:bymonth molist="?"/>

<urn1:bysetpos poslist="?"/>

<urn1:wkst day="?"/>

<urn1:rule-x-name name="?" value="?"/>
</urn1:rule>
</urn1:recur>

<urn1:exceptId d="?" tz="?" rangeType="?"/>

<urn1:s d="?" tz="?" u="?"/>

<urn1:e d="?" tz="?" u="?"/>

<urn1:dur neg="?" w="?" d="?" h="?" m="?" s="?" related="?" count="?"/>
</urn1:comp>

<urn1:tz id="?" stdoff="?" dayoff="?" stdname="?" dayname="?">

<urn1:standard week="?" wkday="?" mon="?" mday="?" hour="?" min="?" sec="?"/>

<urn1:daylight week="?" wkday="?" mon="?" mday="?" hour="?" min="?" sec="?"/>
</urn1:tz>

<urn1:mp ct="?" content="?" ci="?">

<urn1:mp/>

<urn1:attach aid="?">

<urn1:mp optional="?" mid="?" part="?"/>
<urn1:m optional="?" id="?"/>
<urn1:cn optional="?" id="?"/>
<urn1:doc optional="?" path="?" id="?" ver="?"/>

</urn1:attach>
</urn1:mp>

<urn1:attach aid="?">

<urn1:mp optional="?" mid="?" part="?"/>
<urn1:m optional="?" id="?"/>
<urn1:cn optional="?" id="?"/>
<urn1:doc optional="?" path="?" id="?" ver="?"/>

</urn1:attach>
</urn1:inv>

<urn1:e a="?" t="?" p="?"/>

<urn1:tz id="?" stdoff="?" dayoff="?" stdname="?" dayname="?">

<urn1:standard week="?" wkday="?" mon="?" mday="?" hour="?" min="?" sec="?"/>

<urn1:daylight week="?" wkday="?" mon="?" mday="?" hour="?" min="?" sec="?"/>
</urn1:tz>

<urn1:fr>?</urn1:fr>

</urn1:m>
</urn1:CreateAppointmentRequest>
</soapenv:Body>
</soapenv:Envelope>

Thanks for your attention.

Best Regards
Rafael

jon_mann64 · Post by **jon_mann64** » Fri Oct 07, 2022 4:15 pm

This is a simple example of a soap envelope that will create an appointment.

Code: Select all

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:zimbra" xmlns:urn1="urn:zimbraMail">
   <soapenv:Header>
      <urn:context>
         <urn:authToken>0_2d31e95f4f3....</urn:authToken>
      </urn:context>
   </soapenv:Header>
   <soapenv:Body>
      <urn1:CreateAppointmentRequest echo="1">
         <urn1:m l="662086ff....">
            <urn1:inv name="invite name" allDay="1">
               <urn1:s d="20221004"/>
               <urn1:e d="20221011"/>
            </urn1:inv>
          </urn1:m>
      </urn1:CreateAppointmentRequest>
   </soapenv:Body>
</soapenv:Envelope>

To get the folder id (e.g. calendar id), I used the export feature in the zimbra UI (Preferences > Import/Export) then looked in the exported .ics file for the calendar ID, example: X-WR-CALID:662086ff....

liverpoolfcfan · Post by **liverpoolfcfan** » Mon Oct 10, 2022 10:05 am

There is extensive SOAP documentation in your Docs folder - /opt/zimbra/docs

Post by **barrydegraaff** » Tue Oct 11, 2022 3:54 pm

I would suggest you use zmmailbox from the command line with the debug flag and do what you want to achieve using zmmailbox. The debug flag will show you all the SOAP commands fired at the server.

https://wiki.zimbra.com/wiki/Zmmailbox

You can then copy/paste the SOAP you need into your application.

The SOAP API is documented here https://wiki.zimbra.com/wiki/SOAP_API_R ... with_ZCS_8 but it is a little hard to read, that's why I recommend the --debug flag approach first.

Zimbra Forums

How to use Zimbra Soap?

How to use Zimbra Soap?

Re: How to use Zimbra Soap?

Re: How to use Zimbra Soap?

Re: How to use Zimbra Soap?