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
  • UAPI Functions - Email::delete_held_messages
Skip to end of metadata
Go to start of metadata

Description

This function deletes all outbound email messages held in the mail queue for the specified email account.

Important:

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/delete_held_messages?email=username%40example.com


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.
 
// Delete the held outbound messages for the specified email address.
$emails = $cpanel->uapi(
    'Email', 'delete_held_messages'
    array(
        'email' => 'username@example.com',
        )
);


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.
 
# Delete the held outbound messages for the specified email address.
my $emails = $cpliveapi->uapi(
    'Email', 'delete_held_messages'
    {
        'email' => 'username@example.com',
    }
);


Note:

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

 Command Line
uapi --user=username Email delete_held_messages email=username@example.com


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)
{
  "data": 0,
  "errors": null,
  "messages": null,
  "status": 1
}


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 address to query.

A valid email address that the cPanel account owns.

username@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
dataintegerThe number of held outbound email messages deleted from the mail queue.

A positive integer.

Note:

This function returns a 0 value when no messages exist in the queue.

0