Page History

Include Page

	LIB:_WHMAPI1Menu
	LIB:_WHMAPI1Menu

Description

Excerpt
This function removes mail messages from a cPanel account.

Multiexcerpt include

SpaceWithExcerpt	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptName	APIDisabledReceiveMailRole
PageWithExcerpt	LIB:_ServerRoleDisabledAPI

Panel

bgColor	#F2F2F2
borderStyle	none

Examples

Panel

bgColor	#FFFFFF
borderStyle	none

Expand

title	JSON API

Code Block

language	xml

https://hostname.example.com:2087/cpsess##########/json-api/expunge_messages_for_mailbox_guid?api.version=1&account=example&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore%2052w

Expand

title	XML API

Code Block

language	xml

https://hostname.example.com:2087/cpsess##########/xml-api/expunge_messages_for_mailbox_guid?api.version=1&account=example&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore%2052w

Expand

title	Command Line

Code Block

language	bash

whmapi1 expunge_messages_for_mailbox_guid account=example mailbox_guid=2550860f0c58d158c92a000044f0d230 query="savedbefore 52w"

Include Page

	LIB:_WHMAPI1CLINote
	LIB:_WHMAPI1CLINote

Expand

title	Output (JSON)

Code Block

language	text
linenumbers	true

{  
   "metadata":{  
      "reason":"OK",
      "command":"expunge_messages_for_mailbox_guid",
      "version":1,
      "result":1
   },
   "data":{  

   }
}

Expand

title	Output (XML)

Code Block

language	text
linenumbers	true

<result>
    </data>
    <metadata>
        <reason>OK</reason>
        <version>1</version>
        <result>1</result>
        <command>expunge_messages_for_mailbox_guid</command>
    </metadata>
</result>

Include Page

	LIB:_WHMAPIShellNote
	LIB:_WHMAPIShellNote

Parameters

Parameter Type Description Possible values Example

account

string

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_guid

string

Required

The mailbox's globally unique identifier (GUID).

A valid mailbox GUID on the account.

Note

title	Note:

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

2550860f0c58d158c92a000044f0d230

query

string

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.

Panel

bgColor	#F2F2F2
borderStyle	none

Function information

Panel

bgColor	#FFFFFF
borderStyle	none

Section

Column

width	40%

API Version:

Column
WHM API 1

Section

Column

width	40%

Available in:

Column
WHM 64+

Section

Column

width	40%

Methods:

Column
GET, POST

Section

Column

width	40%

Required Parameters:

Column
`account`, `mailbox_guid`, `query`

Section

Column

width	40%

Return Formats:

Column

JSON, XML

Multiexcerpt include

MultiExcerptName	Short Macro
PageWithExcerpt	LIB:_XMLDeprecated

About WHM API 1

Include Page

	LIB:_WHMAPI1About
	LIB:_WHMAPI1About

Find a function

Livesearch

additional	page excerpt
placeholder	Search...
labels	whmapi1

Related functions

Content by Label

showLabels	false
max	5
showSpace	false
sort	modified
excerpt	true
excerptType	simple
operator	AND
cql	label = "email" and label = "whmapi1"
labels	whmapi1,server

Child pages

Versions Compared

Old Version 9

New Version Current

Key

Description

Examples

Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions