Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - BoxTrapper::list_queued_messages - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - BoxTrapper::list_queued_messages
Skip to end of metadata
Go to start of metadata

Description

This function returns a list of messages in the account's BoxTrapper queue.

Important:

When you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/list_queued_messages?email=user@example.com&date=1556812881


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Retrieve a list of messages in the BoxTrapper queue from user@example.com.
$list_queued_messages = $cpanel->uapi(
    'BoxTrapper', 'list_queued_messages',
    array(
		'email'  => 'user@example.com'
		'date'   => '1556812881',
    )
);


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.
 
# Retrieve a list of messages in the BoxTrapper queue from user@example.com.
my $list_queued_messages = $cpliveapi->uapi(
    'BoxTrapper', 'list_queued_messages',
    {
		'email'	 => 'user@example.com'
		'date'   => '1556812881',
    }
);


Note:

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

 Command Line
uapi --user=username BoxTrapper list_queued_messages email=user@example.com date=1556812881


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "metadata":{  
      "transformed":1
   },
   "status":1,
   "data":[  
        {
           "queuefile" : "rhzaBZzNQCaZ02EFqYblT-1557172966.msg",
           "subject" : "Go Groundhogs!!!",
           "from" : "groundhog@groovy.tld",
           "time" : "1557172966"
        },
   ],
   "warnings":null,
   "errors":null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account for which to retrieve queued messages.

Important:

If you call this function in Webmail, the system ignores this parameter and defaults to the currently authenticated email address.

A valid email address on the cPanel account.user@example.com
dateinteger

The date for which to return queued messages.

This parameter defaults to the current time.

A valid time, in Unix time format.
1556812881

Returns

ReturnTypeDescriptionPossible valuesExample

array of hashesAn array of hashes that displays information about each queued message.

This array of hashes contains the queuefile, from, subject, and time returns.


queuefile

string

The message's unique ID.

The function returns this value in the unnamed array of hashes.

A valid filename.example.msg

from

string

The sender's email address.

The function returns this value in the unnamed array of hashes.

A valid email address.user@example.com

subject

string

The message's subject.

The function returns this value in the unnamed array of hashes.

A valid string.Email Message Subject

time

integer

The message's creation time.

The function returns this value in the unnamed array of hashes.

A valid time, in Unix time format.

1556812881