Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function returns the first 200 lines of an email 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.
$print_queued_message = $cpanel->api1('BoxTrapper', 'showmessage', array('user@example.com', '', 'example.msg') ); // Call the function.

Note:

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.

Note:

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

 

 cPanel Tag System (deprecated)

Warning:

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

Notes:

  • 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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (plaintext)
Return-Path: <sender@example.com>
X-SpamCatcher-Score: 1 [X]
Received: from [127.0.0.1] (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.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

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

Required

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

Any placeholder value.''
queuefilestring

Required

The message's filename.

A valid filename.example.msg

Returns

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