Child pages
  • cPanel API 1 Functions - Mime::add_handler

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$add_handler = $cpanel->api1('Mime', 'add_handler', array('.txt','text/plain') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $add_handler = $cpliveapi->api1('Mime', 'add_handler', ['.txt','text/plain'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Mime::add_handler( $FORM('ext','handler') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Mime add_handler .txt text/plain

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (none)

This function does not return output.

Parameters

ParameterTypeDescriptionPossible ValuesExample
exts
string

Required

The file extension for which to add a MIME handler.

Any valid file extension.
.txt
handler
string

Required

The handler to add.

A valid MIME handler type.text/plain

Returns

This function does not return output.