Child pages
  • UAPI Functions - Mime::add_handler

Versions Compared

Key

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

Description

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

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
 )
);

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.
 
# Add handler "text-foo" to ".foo"
my $mime_add_handler = $cpliveapi->uapi(
    'Mime', 'add_handler',
    {
        'extension'    => '.foo',
        'handler'      => 'text-foo',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


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

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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.