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

Versions Compared

Key

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

Description

Excerpt

This function searches the account's BoxTrapper queue.

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.
$search_boxtrapper_queue = $cpanel->api1('BoxTrapper', 'showqueuesearch', array('sender', 'John', 'user@example.com', 'queuesearch.html', '', '0') ); // 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 $search_boxtrapper_queue = $cpliveapi->api1('BoxTrapper', 'showqueuesearch', ['sender', 'John', 'user@example.com', 'queuesearch.html', '', '0'] ); # 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::showqueuesearch( $FORM('field','string','account','showfile','bxaction','skipcontrols') )">



Expand
titleCommand Line


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

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (HTML)


Code Block
languagexml
linenumberstrue
<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

Warning
titleWarning:

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.