Description

This function sets a default email archiving configuration.

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 




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"



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

 



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




cpapi2 --user=username Email set_archiving_default_configuration outgoing=7 incoming=14 mailman=21



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



Parameters

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.

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.

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