UAPI Functions - Mime::list_mime - Knowledgebase

Description

This function lists all of Apache's MIME types.

Examples

cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// List MIME types in Apache
$mime_list_mime = $cpanel->uapi(
    'Mime', 'list_mime',
    array(
        'type'    => 'user',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List MIME types in Apache
my $mime_list_mime = $cpliveapi->uapi(
    'Mime', 'list_mime',
    {
        'type'    => 'user',
    }
);

cPanel Template Toolkit

[% data = execute( 'Mime', 'list_mime', { type => 'user'} ); %]

[% FOREACH q = data %]

<p>

[% q %]

</p>

[% END %]

Command Line

uapi --user=username Mime list_mime 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",
      "origin": "user",
      "type": "application/foo"
    }
  ],
  "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 The MIME types to list.	system user	user

Parameter

Type

Description

Possible values

Example

type

string

Required

The MIME types to list.

system
user

user

Returns

Return	Type	Description	Possible values	Example
extension	string	The file extension.	A valid file extension.	.foo
type	string	The MIME type.	A valid string.	application/foo
origin	string	The handler's owner.	system user	user

Knowledgebase

Categories

Categories