Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the available email archiving types.

Unable to render {include} The included page could not be found.

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_types

Unable to render {include} The included page could not be found.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get a list of archiving types.
$archive_types = $cpanel->api2(
    'Email', 'get_archiving_types'
);

Unable to render {include} The included page could not be found.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get a list of archiving types.
my $archive_types = $cpliveapi->api2(
    'Email', 'get_archiving_types',
);

Unable to render {include} The included page could not be found.

 cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Command Line
cpapi2 --user=username Email get_archiving_types


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_archiving_types",
    "data": [
      {
        "outgoing": "Outgoing",
        "incoming": "Incoming",
        "mailman": "Mailing Lists"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Unable to render {include} The included page could not be found.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
outgoingstringA message archiving type.

Outgoing is the only possible value.

Outgoing  
incomingstringA message archiving type.

Incoming is the only possible value.

Incoming  
mailmanstringA message archiving type.

Mailing Lists is the only possible value.

Mailing Lists  
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