cPanel API 2 Functions - Email::clearpopcache

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.


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.


Important:

When you disable the Receive Mail role, the system disables this function.


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="user"
Note:

For more information, read our Calls from the WHM API documentation.


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',
    )
);
Note:

For more information, read our Guide to the LiveAPI System.


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',
    }
);
Note:

For more information, read our Guide to the LiveAPI System.


Warnings:
  • cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username Email clearpopcache username=user
Note:

For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.


Output (JSON)

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

Use cPanel's API Shell interface (cPanel >> 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 for user@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 reason value 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