Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Include Page | ||||
---|---|---|---|---|
|
Description
Excerpt |
---|
This function removes mail messages from a cPanel account. |
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
|
Parameters
Parameter | Type | Description | Possible values | Example | |||||
---|---|---|---|---|---|---|---|---|---|
account | string | Required The email account's name. |
|
| |||||
mailbox_guid | string | Required The mailbox's globally unique identifier (GUID). | A valid mailbox GUID on the account.
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Function information
About WHM API 1
Find a function
Related functions
|