UAPI Functions - Mime::add_handler

Description

This function creates an Apache MIME type handler for a file extension.

Examples 


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mime/add_handler?extension=.foo&handler=text-foo

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Add handler "text-foo" to ".foo"
$mime_add_handler $cpanel->uapi(
    'Mime''add_handler',
    array(
        'extension'    => '.foo',
        'handler'      => 'text-foo',
 )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Add handler "text-foo" to ".foo"
my $mime_add_handler $cpliveapi->uapi(
    'Mime''add_handler',
    {
        'extension'    => '.foo',
        'handler'      => 'text-foo',
    }
);

 cPanel Template Toolkit

<!--  Add handler "text-foo" to ".foo" -->
[% data = execute( 'Mime', 'add_handler', {'extension'=> '.foo', 'handler' => 'text-foo' } ); %]

 Command Line

uapi --user=username Mime add_handler extension=.foo handler=text-foo

 

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}

 

Note:

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

 

Parameters

 Parameter 

Type

Description

Possible values

 Example 

extension

string

Required

The file extension.

A valid file extension.

.foo

handler

 string 

Required

 The Apache MIME handler. 

 A valid Apache MIME handler. 

txt-foo

 

Returns

This function only returns metadata.

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....