Child pages
  • cPanel API 1 Functions - BoxTrapper::showlog

Versions Compared

Key

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

Description

Excerpt

This function returns the account's BoxTrapper log.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


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

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

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="BoxTrapper::showlog( $FORM('date','account') )">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username BoxTrapper showlog 1410277881 user@example.com

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
languagetext
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.