Page tree
Skip to end of metadata
Go to start of metadata

 

Description

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Fileman/empty_trash?&older_than=31

 

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$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
 )
);

Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
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
		}
 );

Note:

For more information, read our Guide to the LiveAPI System.

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

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Fileman empty_trash older_than=31

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":{  

   }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

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.