Child pages
  • cPanel API 2 Functions - Email::get_archiving_configuration
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves the cPanel account's archiving configurations.


Warning:

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

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


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


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


Note:

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

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • 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 documentation.

 Command Line
cpapi2 --user=username Email get_archiving_configuration domain=example.com regex=addon


Notes:

  • 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 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "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"
  }
}


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

ParameterTypeDescriptionPossible valuesExample
domainstring

The domain to query.

If you do not use this parameter, the function lists all of the account's domain's archiving configurations.

A valid domain on the cPanel account.

example.com
regexstring

A Perl Compatible Regular Expression (PCRE) that filters the results.

If you do not use this parameter, the function returns all of the account's domains.

A valid PCRE.

addon

Returns

ReturnTypeDescriptionPossible valuesExample
diskusedintegerThe disk space that the domain's archived messages use.

A positive integer that represents the used disk space, in Megabytes (MB).

135
archive_mailman_retain_daysintegerThe mailing list message retention period.
  • A positive integer that represents the number of days to archive messages.
  • 0 or null — Archiving is disabled.
14
domainstringThe domain or subdomain.

A valid domain or subdomain on the cPanel account.

example.com
archive_incomingBooleanWhether archiving is enabled for incoming messages.
  • 1 — Enabled.
  • 0 — Disabled.
1
archive_outgoing_retain_daysBooleanThe outgoing message retention period.
  • A positive integer that represents the number of days to archive messages.
  • 0 or null — Archiving is disabled.
7
archive_incoming_retain_daysBooleanThe incoming message retention period.
  • A positive integer that represents the number of days to archive messages.
  • 0 or null — Archiving is disabled.
21
archive_mailmanBooleanWhether archiving is enabled for mailing list messages.
  • 1 — Enabled.
  • 0 — Disabled.
1
has_archiveBooleanWhether archiving is enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1
archive_outgoingBooleanWhether archiving is enabled for outgoing messages.
  • 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