Child pages
  • cPanel API 1 Functions - BoxTrapper::showlog
Skip to end of metadata
Go to start of metadata

 

Description

This function returns the account's BoxTrapper log.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples 


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$boxtrapper_log = $cpanel->api1('BoxTrapper', 'showlog', array('1410277881', 'user@example.com') ); // Call the function.


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.
my $boxtrapper_log = $cpliveapi->api1('BoxTrapper', 'showlog', ['1410277881', 'user@example.com'] ); # Call the function.


Note:

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

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="BoxTrapper::showlog( $FORM('date','account') )">
 Command Line
cpapi1 --user=username BoxTrapper showlog 1410277881 user@example.com


Notes:

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

 Output (plaintext)
Processing email with trusted transport method [esmtpa] test@example.com/Subject Searching for stale data files (1296000 seconds old)

   

Parameters

ParameterTypeDescriptionPossible valuesExample
datestring

The date to view.

This parameter defaults to the current time.

Any valid time, in Unix time format.
1410277881
accountstring

Required

The account's email address.

A valid email address on the server.user@example.com

Returns

This function returns the contents of the log file for the specified time.