Description

This function searches the account's BoxTrapper queue.

Examples 




$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$search_boxtrapper_queue = $cpanel->api1('BoxTrapper', 'showqueuesearch', array('sender', 'John', 'user@example.com', 'queuesearch.html', '', '0') ); // Call the function.



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

 


<cpanel Module="BoxTrapper::showqueuesearch( $FORM('field','string','account','showfile','bxaction','skipcontrols') )">




cpapi1 --user=username BoxTrapper showqueuesearch sender John user@example.com queuesearch.html '' 0



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




Parameters

ParameterTypeDescriptionPossible valuesExample
fieldstring

Required

The field to search.

  • sender
  • subject
  • body
sender
stringstring

Required

The string for which to search.

Any string.John
accountstring

Required

The account's email address.

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

Required

The file to process requests to search emails.

queuesearch.html

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


queuesearch.html
bxactionstring

Required

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

A placeholder value.''
skipcontrolsBoolean

Required

Whether the function suppresses additional options.

If you disable this option, the user receives additional options after the search (for example, the multimessageaction options).

  • 0 — Generate additional options.
  • 1 — Do not generate additional options.
0

Returns

This function returns HTML to generate a table that lists the search results.

  • The table sorts messages by date.
  • The table contains a checkbox, the message's sender, the message subject, and the date for each message.