cPanel API 2 Functions - Email::set_archiving_configuration
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Description
This function configures email archiving for a domain.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
When you disable the Receive Mail role, the system disables this function.
This feature uses the GMT time zone to name directories, select messages to store in each directory, and timestamp messages. You cannot change this behavior.
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=set_archiving_configuration&domains="example.com%2Cseconddomain.com"&incoming="14"&mailman="21"For more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Configure example.com and seconddomain.com's archiving.
$archiving_config = $cpanel->api2(
'Email', 'set_archiving_configuration',
array(
'domains' => 'example.com,seconddomain.com',
'incoming' => '14',
'mailman' => '21',
)
);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.
# Configure example.com and seconddomain.com's archiving.
my $archiving_config = $cpliveapi->api2(
'Email', 'set_archiving_configuration',
{
'domains' => 'example.com,seconddomain.com',
'incoming' => '14',
'mailman' => '21',
}
);For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- 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 set_archiving_configuration domains=example.com.seconddomain.com incoming=14 mailman=21- You must URI-encode values.
-
usernamerepresents your account-level username. -
You
must
run the
--user=usernamecommand. -
For more information and additional output options, read our
Guide to cPanel API 2
documentation or run the
cpapi2 --helpcommand. -
If you run CloudLinux™, you
must
use the full path of the
cpapi2command:/usr/local/cpanel/bin/cpapi2
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "set_archiving_configuration",
"data": [{
"direction": "mailman",
"domain": "example.com",
"statusmsg": "Updated archive configuration for “example.com“.",
"retention_period": 93,
"status": 1,
"enabled": 1
}],
"event": {
"result": 1
},
"module": "Email"
}
}Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.