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

 

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

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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

Note:

For more information, read our Guide to the LiveAPI System.

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

Note:

For more information, read our Guide to the LiveAPI System.

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

Note:

For more information, read our Guide to Template Toolkit documentation. 

 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.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
extensionstring

Required

The file extension.

A valid file extension..foo
handlerstring

Required

The Apache MIME handler.

A valid Apache MIME handler.txt-foo

 

Returns

This function only returns metadata.