cPanel API 2 Functions - Email::get_archiving_default_configuration - Knowledgebase

Description

This function retrieves the default archiving configurations.

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=get_archiving_default_configuration&domain=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Get the default archiving config for example.com.
$get_default_archive_config = $cpanel->api2(
    'Email', 'get_archiving_default_configuration', 
    array(
        'domain'       => 'example.com',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Get the default archiving config for example.com.
my $get_default_archive_config = $cpliveapi->api2(
    'Email', 'get_archiving_default_configuration',
    {
        'domain'       => 'example.com',
    }
);

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 get_archiving_default_configuration domain=example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_archiving_default_configuration",
    "data": [
      {
        "direction": "outgoing",
        "retention_period": "7",
        "enabled": 1
      },
      {
        "direction": "mailman",
        "retention_period": "14",
        "enabled": 1
      },
      {
        "direction": "incoming",
        "retention_period": "21",
        "enabled": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Warning:

Make certain that you use the correct parameters when you call this function. The function does not return errors if you pass invalid parameters.

Parameter	Type	Description	Possible values	Example
domain	string	The domain to query. If you do not use this parameter, the function lists the account's default configuration.	A valid domain on the cPanel account.	example.com

Parameter

Type

Description

Possible values

Example

domain

string

The domain to query.

If you do not use this parameter, the function lists the account's default configuration.

A valid domain on the cPanel account.

example.com

Returns

Return	Type	Description	Possible values	Example
direction	string	The message type.	outgoing mailman incoming	outgoing
retention_period	integer	The message retention period.	A positive integer that represents the number of days to archive messages. 0 or null — Archiving is disabled.	14
enabled	Boolean	Whether archiving is enabled.	1 — Enabled. 0 — Disabled.	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