cPanel API 2 Functions - Email::clearpopcache - Knowledgebase

Description

This function rebuilds an email account's cache file.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=clearpopcache&username=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Rebuild the cache file for user@example.com.
$rebuild_email_cache = $cpanel->api2(
    'Email', 'clearpopcache', 
    array(
        'username'        => 'user',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Rebuild the cache file for user@example.com.
my $rebuild_email_cache = $cpliveapi->api2(
    'Email', 'clearpopcache',
    {
        'username'        => 'user',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Email clearpopcache username=user

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "clearpopcache",
    "data": [
      {
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
username	string	Required The email account's username.	An email account username. For example, user to rebuild the cache file foruser@example.com.	user

Parameter

Type

Description

Possible values

Example

username

string

Required

The email account's username.

An email account username.

For example, user to rebuild the cache file foruser@example.com.

user

Returns

Return	Type	Description	Possible values	Example
status	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories