retractRequest

Retracts calendar items.

Request

<retractRequest>
   <items type="types:ItemRefList"/>
   <comment type="string"/>
   <retractingAllInstances type="boolean"/>
   <retractCausedByResend type="boolean"/>
   <retractType type="types:RetractType"/>
   <recurrenceAllInstances type="unsignedInt"/>
</retractRequest>

Response

<retractResponse>
   <status type="types:Status"/>
</retractResponse>

Elements

items

Specifies the calendar items to retract.

comment

Specifies that the comment is included in the notice.

retractCausedByResend

Specifies that a notice is not sent because it is suppressed and replaced with the new calendar item (True).

retractingAllInstances

Specifies that a single notice is placed in the recipient’s in box (True), rather than a notice for each instance.

retractType

Specifies where to retract the item:

  • myMailbox-Retract only the items in the sender’s mailbox.
  • recipientMailboxes-Retract only the items in the recipient's mailbox.
  • allMailboxes-Retract the items in both the sender’s and recipient’s mailboxes.
code

Returns the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

recurrenceAllInstances

Specifies that you want the purge to be applied to all recurring items if you pass the recurrenceKey.

Remarks

If a recipient has opened or accepted a calendar item, a notice or mail item is placed in the recipient’s In box when the item is retracted.

Example

<retractRequest> 
   <items> 
      <item>4510FFC8.domain1.po1.100.16E3837.1.103D.1@4:7.
                  domain1.po1.100.0.1.0.1@16</item>
   </items> 
   <comment>comment</comment> 
   <retractingAllInstances>true</retractingAllInstances> 
   <retractCausedByResend>true</retractCausedByResend> 
   <retractType>allMailboxes</retractType> 
</retractRequest>

<retractResponse> 
   <status> 
      <code>0</code> 
   </status> 
</retractResponse>