Child pages
  • cPanel API 2 Functions - Email::get_archiving_configuration

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function retrieves the cPanel account's archiving configurations.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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',
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username Email get_archiving_configuration domain=example.com regex=addon

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "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"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

Parameters

Warning
titleWarning:

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
titleNote:

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