# cPanel API 2 Functions - Email::set_archiving_default_configuration

Warning:

The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function sets a default email archiving configuration.

Warning:

We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

div
Important:
br
When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

br
div
Note:
br
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.

br
## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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"
```

div
Note:
br
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

br
LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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',
    )
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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',
    }
);
```

div
Note:
br
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

br
cPanel Tag System (deprecated)

div
Warnings:
br
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


br
Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Email set_archiving_default_configuration outgoing=7 incoming=14 mailman=21
```

div
Notes:
br
- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** run the `--user=username` command.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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"
  }
}
```

div
Note:
br
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

br
## Parameters

br
Warning:
br
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.

br
table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
incoming
td
em
integer
td
p
The retention period for incoming messages.
p
This parameter defaults to to 
code
-1
, which 
strong
disables
 archiving.
td
ul
li
A positive integer that represents a number of days. For example, to retain archived mail for one year, set a value of  
code
365
 .
li
code
0
 — Archive messages indefinitely.
td
code
14
tr
td
code
outgoing
td
em
integer
td
p
The retention period for outgoing messages.
p
 This parameter defaults to to  
code
-1
 , which 
strong
disables
  archiving.
br
td
ul
li
A positive integer that represents a number of days. For example, to retain archived mail for one year, set a value of 
code
365
.
li
code
0
 — Archive messages indefinitely.
td
code
7
tr
td
code
mailman
td
em
integer
td
p
The retention period for mailing list messages.
p
 This parameter defaults to to  
code
-1
 , which 
strong
disables
  archiving.
br
td
ul
li
A positive integer that represents a number of days. For example, to retain archived mail for one year, set a value of 
code
365
.
li
code
0
 — Archive messages indefinitely.
td
code
21
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
direction
td
em
string
td
The archiving type.
td
ul
li
code
outgoing
li
code
mailman
li
code
incoming
td
code
outgoing
tr
td
code
statusmsg
td
em
string
td
A confirmation message.
td
ul
li
code
Enabled the default archive configuration for \u201cuser\u201d.
— The function enabled archiving and set a retention period.
li
code
Skipped the default archive configuration for \u201cuser\u201d.
 — The function did not modify the configuration.
li
code
Disabled the default archive configuration for \u201cuser\u201d.
 — The function disabled archiving.
p
div
Note:
br
p
In these examples, 
code
user
 represents the account's cPanel username. 
br
td
code
                 Enabled the default archive configuration for \u201cuser\u201d.               
tr
td
code
retention_period
td
em
string
td
The retention period.
td
ul
li
A positive integer that represents a number of days.
li
code
0
 — Archive messages indefinitely.
li
code
-1
 — Archiving is disabled.
td
code
365
tr
td
code
status
td
em
Boolean
td
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1
tr
td
code
enabled
td
em
Boolean
td
Whether archiving is enabled for this type.
td
ul
li
code
1
 — Enabled.
li
code
0
 — Disabled.
td
code
1
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
div
Note:
br
p
This function 
strong
only
 returns a 
code
reason
 value if it failed. 
br
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1