We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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


This function returns the first 200 lines of an email in the BoxTrapper queue.


cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:


In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.


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


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


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

 cPanel Tag System (deprecated)


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::showmessage( $FORM('account','logdate','queuefile') )">
 Command Line
cpapi1 --user=username BoxTrapper showmessage user@example.com '' example.msg


  • 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.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:


 Output (plaintext)
Return-Path: <sender@example.com>
X-SpamCatcher-Score: 1 [X]
Received: from [] (HELO example.com)
    by mail.example.com
    with ESMTP-TLS id 11111111 for user@example.com; Wed, 10 Aug 2014 12:34:56 -0600
Message-ID: <11111111.1111111@example.com>
Date: Wed, 10 Aug 2014 12:34:56 -0600
From: User Name <sender@example.com>
User-Agent: Example
X-Accept-Language: en-us, en
MIME-Version: 1.0
To: User Name <user@example.com>
Subject: Example Email
Content-Type: text/plain; charset=us-ascii; format=flowed
Content-Transfer-Encoding: 7bit
Email text.


ParameterTypeDescriptionPossible valuesExample


The account's email address.

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


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

Any placeholder value.''


The message's filename.

A valid filename.example.msg


This function returns the first 200 lines of the email message, inclusive of the email's headers.