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

Versions Compared

Key

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

Description

Excerpt

This function returns the first 200 lines of an email in the 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.
$print_queued_message = $cpanel->api1('BoxTrapper', 'showmessage', array('user@example.com', '', 'example.msg') ); // 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 $print_queued_message = $cpliveapi->api1('BoxTrapper', 'showmessage', ['user@example.com', '', 'example.msg'] ); # 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::showmessage( $FORM('account','logdate','queuefile') )">



Expand
titleCommand Line


Code Block
languagebash
cpapi1 --user=username BoxTrapper showmessage user@example.com '' example.msg

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
languagetext
linenumberstrue
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.