Description

This function lists the available email archiving types.

Examples 




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



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

 



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',
);




cpapi2 --user=username Email get_archiving_types



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



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.

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