Service: zimbraAdmin

Command: PurgeMessages
Namespace: urn:zimbraAdmin
Description: Purges aged messages out of trash, spam, and entire mailbox
(if <mbox> element is omitted, purges all mailboxes on server)
Properties:
Authorization token required true
Admin Authorization token required true

PurgeMessagesRequest

    <PurgeMessagesRequest> ## PurgeMessagesRequest
        <mbox id="{account-id}" /> ## MailboxByAccountIdSelector
    </PurgeMessagesRequest>

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

XPath Required / Optional Description
/mbox Optional (0 or 1) Mailbox selector
/mbox@id Required (only 1) Type: String
Account ID

PurgeMessagesResponse

    <PurgeMessagesResponse> ## PurgeMessagesResponse
        (<mbox mbxid="{mailbox-id} (int)" [id="{account-id}"] [s="{size-in-bytes} (Long)"] /> ## MailboxWithMailboxId)*
    </PurgeMessagesResponse>

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

XPath Required / Optional Description
/mbox Optional (0 or more) Information about mailboxes where aged messages have been purged
/mbox@mbxid Required (only 1) Type: int
Mailbox ID
/mbox@id Optional (0 or 1) Type: String
Account ID
/mbox@s Optional (0 or 1) Type: Long
Size in bytes