Child pages
  • UAPI Functions - Fileman::empty_trash

Versions Compared

Key

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

Description

Excerpt
This function purges content from the .trash folder in the user's home directory.

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

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
https://hostname.example.com:2083/cpsess##########/execute/Fileman/empty_trash?&older_than=31

 

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Empty content older than 31 days from the user's .trash file
$what_an_incredible_smell_youve_discovered = $cpanel->uapi(
    'Fileman', 'empty_trash',
		array(
		'older_than'	=> 31
 )
);

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.
 
# Empty content older than 31 days from the user's .trash file
my $what_an_incredible_smell_youve_discovered = $cpliveapi->uapi(
 	'Fileman', 'empty_trash',
		{
		'older_than'	=> 31
		}
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
[% execute('Fileman', 'empty_trash' {older_than => 31}  ) %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username Fileman empty_trash older_than=31

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


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

   },
   "data":{  

   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParametersTypeDescriptionPossible valuesExample
older_thaninteger

The minimum age of content that the function will purge.

This value defaults to 0, which purges everything from the user's .trash folder.

An integer that is zero or greater, measured in days.31

Returns

This function only returns metadata.