# cPanel API 2 Functions - Email::get_archiving_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 retrieves the cPanel account's archiving configurations.

Warning:

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

## 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=get_archiving_configuration&domain="example.com"&regex="addon"
```

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.

// Get archiving configs for example.com that contain "addon"
$list_archiving_configuration = $cpanel->api2(
    'Email', 'get_archiving_configuration',
    array(
        'domain'       => 'example.com',
        'regex'        => 'addon',
    )
);
```

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.

# Get archiving configs for example.com that contain "addon"
my $list_archiving_configuration = $cpliveapi->api2(
    'Email', 'get_archiving_configuration',
    {
        'domain'       => 'example.com',
        'regex'        => 'addon',
    }
);
```

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 get_archiving_configuration domain=example.com regex=addon
```

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": "get_archiving_configuration",
    "data": [
      {
        "diskused": 135,
        "archive_mailman_retain_days": "14",
        "domain": "addon.example.com",
        "archive_incoming": 1,
        "archive_outgoing_retain_days": "7",
        "archive_incoming_retain_days": "21",
        "archive_mailman": 1,
        "has_archive": 1,
        "archive_outgoing": 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

Warning:

Make certain that you use the correct parameters when you call this function. The function does **not** return errors if you pass invalid parameters.

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domain
td
em
string
td
p
The domain to query.
p
If you do not use this parameter, the function lists all of the account's domain's archiving configurations.
td
p
A valid domain on the cPanel account.
td
code
example.com
br
tr
td
code
regex
td
em
string
td
p
A 
a
Perl Compatible Regular Expression (PCRE)
 that filters the results.
p
If you do not use this parameter, the function returns all of the account's domains.
td
p
A valid PCRE.
td
code
addon
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
diskused
td
em
integer
td
The disk space that the domain's archived messages use.
td
p
A positive integer that represents the used disk space, in megabytes (MB).
td
code
135
tr
td
code
archive_mailman_retain_days
td
em
integer
td
The mailing list message retention period.
td
ul
li
A positive integer that represents the number of days to archive messages.
li
code
0
 or 
code
null
 — Archiving is disabled.
td
code
                 14               
tr
td
code
domain
td
em
string
td
The domain or subdomain.
td
p
A valid domain or subdomain on the cPanel account.
td
code
example.com
tr
td
code
archive_incoming
td
em
Boolean
td
Whether archiving is enabled for incoming messages.
td
ul
li
code
1
 — Enabled.
li
code
0
 — Disabled.
td
code
1
tr
td
code
archive_outgoing_retain_days
td
em
Boolean
td
The outgoing message retention period.
td
ul
li
A positive integer that represents the number of days to archive messages.
li
code
0
 or 
code
null
 — Archiving is disabled.
td
code
7
tr
td
code
archive_incoming_retain_days
td
em
Boolean
td
The incoming message retention period.
td
ul
li
A positive integer that represents the number of days to archive messages.
li
code
0
 or 
code
null
 — Archiving is disabled.
td
code
21
tr
td
code
archive_mailman
td
em
Boolean
td
Whether archiving is enabled for mailing list messages.
td
ul
li
code
1
 — Enabled.
li
code
0
 — Disabled.
td
code
1
tr
td
code
has_archive
td
em
Boolean
td
Whether archiving is enabled.
td
ul
li
code
1
 — Enabled.
li
code
0
 — Disabled.
td
code
1
tr
td
code
archive_outgoing
td
em
Boolean
td
Whether archiving is enabled for outgoing messages.
td
ul
li
code
1
 — Enabled.
li
code
0
 — Disabled.
td
code
1
tr
td
code
reason
td
em
string
td
div
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