UAPI Functions - Mime::list_handlers - Knowledgebase

Description

This function lists all of Apache's MIME handlers.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mime/list_handlers?type=user

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List all of Apache user handlers
$mime_list_handlers = $cpanel->uapi(
    'Mime', 'list_handlers',
    array(
        'type'    => 'user',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List all of Apache user handlers
my $mime_list_handlers = $cpliveapi->uapi(
    'Mime', 'list_handlers',
    {
        'type'    => 'user',
    }
);

cPanel Template Toolkit

<!--  List all of Apache user handlers -->
[% data = execute( 'Mime', 'list_handlers', { type => 'user'} ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Command Line

uapi --user=username Mime list_handlers type=user

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "extension": "foo",
      "handler": "text-foo",
      "origin": "user"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
type	string	Required Whether to retrieve system or user handlers.	system user	user

Parameter

Type

Description

Possible values

Example

type

string

Required

Whether to retrieve system or user handlers.

system
user

user

Returns

Return	Type	Description	Possible values	Example
origin	string	The handler's owner.	system user	user
handler	string	The handler's name.	A valid string.	text-foo
extension	string	The handler's extension.	A valid file extension.	.foo

Knowledgebase

Categories

Categories