cPanel API 2 Functions - Email::set_archiving_configuration - Knowledgebase

Description

This function configures email archiving for a domain.

Warning:

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

Note:

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=

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

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

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.

 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"
   }
}

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 will not return errors if you pass invalid parameters.

Parameter	Type	Description	Possible values	Example
domains	string	Required One or more domains.	A comma-separated list of valid domains on the cPanel account. Note: In WHM API calls, replace commas with %2C.	example.com
incoming	integer	The length of time to archive incoming messages.	A positive integer that represents a number of days.For example, to archive messages for one year, set a value of 365. 0 — Archive messages indefinitely.	365
outgoing	integer	The length of time to archive outgoing messages.	A positive integer that represents a number of days. For example, to archive messages for one year, set a value of 365. 0 — Archive messages indefinitely.	365
mailman	integer	The length of time to archive mailing listmessages.	A positive integer that represents a number of days. For example, to archive messages for one year, set a value of 365. 0 — Archive messages indefinitely.	365

Returns

Return	Type	Description	Possible values	Example
direction	string	The archive type.	incoming outgoing mailman	mailman
domain	string	The domain or domains.	The domainsinput parameter's value.	example.com
statusmsg	string	A message of success or a reason for failure.	A success message. An error message.	Updated archive configuration for “example.com”.
retention_period	integer	The length of time to archive mailing list messages.	A positive integer that represents a number of days. 0 — Archive messages indefinitely.	93
status	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1
enabled	boolean	Whether archiving is enabled.	1 — Enabled. 0 — Disabled.	1
reason	string	A reason for failure. Note: This function only returns areasonvalue 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