Description

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

Examples




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

 



$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
 )
);



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



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



uapi --user=username Fileman empty_trash older_than=31



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":{  

   }
}



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.