Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function removes mail messages from a cPanel account.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/expunge_messages_for_mailbox_guid?api.version=1&account=example&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore%2052w
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/expunge_messages_for_mailbox_guid?api.version=1&account=example&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore%2052w
 Command Line
whmapi1 expunge_messages_for_mailbox_guid account=example mailbox_guid=2550860f0c58d158c92a000044f0d230 query="savedbefore 52w"

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{  
   "metadata":{  
      "reason":"OK",
      "command":"expunge_messages_for_mailbox_guid",
      "version":1,
      "result":1
   },
   "data":{  

   }
}
 Output (XML)
<result>
    </data>
    <metadata>
        <reason>OK</reason>
        <version>1</version>
        <result>1</result>
        <command>expunge_messages_for_mailbox_guid</command>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (Home >> Development >> API Shell) to directly test WHM API calls.

     

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The email account's name.

  • The cPanel user's account name.

  • A valid email account that exists on the server.

  • example
  • user@example.com

mailbox_guidstring

Required

The mailbox's globally unique identifier (GUID).

A valid mailbox GUID on the account.

Note:

To find the mailbox GUID, use the WHM API 1 - get_mailbox_status function.

2550860f0c58d158c92a000044f0d230
querystring

Required

The query to select which messages you wish to remove from the mailbox.

A valid Dovecot search query.

For more information, read Dovecot's Search Query documentation.

savedbefore 52w

Returns

This function only returns metadata.