cPanel API 1 Functions - BoxTrapper::showqueue

Description

This function generates a list of messages in the BoxTrapper queue.

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.
$list_boxtrapper_queue = $cpanel->api1('BoxTrapper', 'showqueue', array('1410277881', 'user@example.com', 'showmsg.html', '', '0') ); // Call the function.


 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $list_boxtrapper_queue = $cpliveapi->api1('BoxTrapper', 'showqueue', ['1410277881', 'user@example.com', 'showmsg.html', '', '0'] ); # Call the function.

 cPanel Tag System (deprecated)

<cpanel Module="BoxTrapper::showqueue( $FORM('logdate','account','showfile','bxaction','skipcontrols') )">

 Output (HTML)
<input type="hidden" name="account" value="test@example.com">
<input type="hidden" name="bxaction" value="multimsgaction">
<tr class="tdshade1">
<td width="5%"><input type="checkbox" name="msgid0" value="qM3nKcgdNWKJQoJmzYxHtUfCHJYMMLki.msg"></td>
<td class="truncate" truncate="25" width="15%"><a href="showmsg.html?account=test@example.com&q=qM3nKcgdNWKJQoJmzYxHtUfCHJYMMLki.msg&bxaction=">test@cpanel.net</a></td>
<td class="truncate" truncate="75"><a href="showmsg.html?account=test@example.com&q=qM3nKcgdNWKJQoJmzYxHtUfCHJYMMLki.msg&bxaction=">Subject</a></td>
<td width="15%"><a href="showmsg.html?account=test@example.com&q=qM3nKcgdNWKJQoJmzYxHtUfCHJYMMLki.msg&bxaction=">02/19 20:40:05</a></td>
</tr>
<tr class="tdshade2">
<td width="5%"><input type="checkbox" name="msgid1" value="TnOFsIHUb3EX19Wcqlc1DwAEqwSxaIUL.msg"></td>
<td class="truncate" truncate="25" width="15%"><a href="showmsg.html?account=test@example.com&q=TnOFsIHUb3EX19Wcqlc1DwAEqwSxaIUL.msg&bxaction=">test@cpanel.net</a></td>
<td class="truncate" truncate="75"><a href="showmsg.html?account=test@example.com&q=TnOFsIHUb3EX19Wcqlc1DwAEqwSxaIUL.msg&bxaction=">Subject</a></td>
<td width="15%"><a href="showmsg.html?account=test@example.com&q=TnOFsIHUb3EX19Wcqlc1DwAEqwSxaIUL.msg&bxaction=">02/19 20:40:14</a></td>
</tr>

 

Parameters

 Parameter 

Type

Description

Possible values

Example

 logdate

 string

 The date to view.

 This parameter defaults to the current time.

 Any valid time, in Unix time.

 1410277881

 account

 string

 Required

 The account's email address.

 A valid email address on the server.

 user@example.com 

 showfile

 string

 Required

 The file to process requests to view emails.

 showmsg.html

 Warning:

 If you specify another file, the HTML output may contain broken links. 

 showmsg.html

 bxaction

 string

 Required

 The system does not use this parameter, and will ignore the value.

 A placeholder value.

 ''

 skipcontrols

 boolean 

 Required

 Whether the function skips multi-message functions when it prints.

  • 0 — Print multi-message functions.
  • 1 — Skip multi-message functions.

 0

 

Returns

This function returns HTML to generate a table that lists the account's queued messages.

  • The table sorts messages by date.
  • The table contains a checkbox, the message's sender, the message subject, and the date for each message
  • 35 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....