Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function sets a default email archiving configuration.

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_default_configuration&outgoing="7"&incoming="14"&mailman="21"

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.
 
// Configure the account's defaults for email archiving.
$default_archiving_config = $cpanel->api2(
    'Email', 'set_archiving_default_configuration', 
    array(
        'outgoing'     => '7',
        'incoming'     => '14',
        'mailman'      => '21',
    ) 
);

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.
 
# Configure the account's defaults for email archiving.
my $default_archiving_config = $cpliveapi->api2(
    'Email', 'set_archiving_default_configuration',
    { 
        'outgoing'     => '7',
        'incoming'     => '14',
        'mailman'      => '21',
    }
);

Note:

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

 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 set_archiving_default_configuration outgoing=7 incoming=14 mailman=21


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set_archiving_default_configuration",
    "data": [
      {
        "direction": "outgoing",
        "statusmsg": "Updated the default archive configuration for \u201cuser\u201d.",
        "retention_period": 7,
        "status": 1,
        "enabled": 1
      },
      {
        "direction": "mailman",
        "statusmsg": "Updated the default archive configuration for \u201cuser\u201d.",
        "retention_period": 21,
        "status": 1,
        "enabled": 1
      },
      {
        "direction": "incoming",
        "statusmsg": "Updated the default archive configuration for \u201cuser\u201d.",
        "retention_period": 14,
        "status": 1,
        "enabled": 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

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, and will disable archiving types for which you do not specify a value. 

ParameterTypeDescriptionPossible valuesExample
incominginteger

The retention period for incoming messages.

This parameter defaults to to -1, which disables archiving.

  • A positive integer that represents a number of days. For example, to retain archived mail for one year, set a value of 365.
  • 0 — Archive messages indefinitely.
14
outgoinginteger

The retention period for outgoing messages.

This parameter defaults to to -1 , which disables archiving.
 

  • A positive integer that represents a number of days. For example, to retain archived mail for one year, set a value of 365.
  • 0 — Archive messages indefinitely.
7
mailmaninteger

The retention period for mailing list messages.

This parameter defaults to to -1 , which disables archiving.
 

  • A positive integer that represents a number of days. For example, to retain archived mail for one year, set a value of 365.
  • 0 — Archive messages indefinitely.
21

Returns

ReturnTypeDescriptionPossible valuesExample
directionstringThe archiving type.
  • outgoing
  • mailman
  • incoming
outgoing
statusmsgstringA confirmation message.
  • Enabled the default archive configuration for \u201cuser\u201d.— The function enabled archiving and set a retention period.
  • Skipped the default archive configuration for \u201cuser\u201d. — The function did not modify the configuration.
  • Disabled the default archive configuration for \u201cuser\u201d. — The function disabled archiving.

Note:

In these examples, user represents the account's cPanel username. 

Enabled the default archive configuration for \u201cuser\u201d.
retention_periodstringThe retention period.
  • A positive integer that represents a number of days.
  • 0 — Archive messages indefinitely.
  • -1 — Archiving is disabled.
365
statusBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
1
enabledBooleanWhether archiving is enabled for this type.
  • 1 — Enabled.
  • 0 — Disabled.
1  
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1