Child pages
  • UAPI Functions - Mime::list_handlers

Versions Compared

Key

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

Description

Excerpt
This function lists all of Apache's MIME handlers.

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/list_handlers?type=user

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List all of Apache user handlers
$mime_list_handlers = $cpanel->uapi(
    'Mime', 'list_handlers',
    array(
        'type'    => 'user',
    )
);

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.
 
# List all of Apache user handlers
my $mime_list_handlers = $cpliveapi->uapi(
    'Mime', 'list_handlers',
    {
        'type'    => 'user',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
<!--  List all of Apache user handlers -->
[% data = execute( 'Mime', 'list_handlers', { type => 'user'} ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagetext
uapi --user=username Mime list_handlers type=user

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": [
    {
      "extension": "foo",
      "handler": "text-foo",
      "origin": "user"
    }
  ],
  "metadata": {
    "transformed": 1
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
typestring

Required

Whether to retrieve system or user handlers.

  • system
  • user
user

Returns

ReturnTypeDescriptionPossible valuesExample
originstringThe handler's owner.
  • system
  • user
user

handler

stringThe handler's name.A valid string.
text-foo
extensionstringThe handler's extension.A valid file extension..foo