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

Description

This function sets Exim's queue to not send outgoing mail from an email account.

Notes:

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/hold_outgoing?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.
 
// Holds outgoing mail for the user's email account.
$hold_outgoing = $cpanel->uapi(
    'Email', 'hold_outgoing',
    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.
 
# Holds outgoing mail for to the user's email account.
my $hold_outgoing = $cpliveapi->uapi(
    'Email', 'hold_outgoing',
    {
        'email' => 'username@example.com',
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Hold outgoing mail for the user's email account. -->
[% execute('Email', 'hold_outgoing', { 'email' => 'username@example.com' } ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username Email hold_outgoing email=username%40example.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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "status" : 1,
  "errors" : null,
  "messages" : null,
  "data" : 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 account's username.

A valid email account username.

username@example.com

Returns

This function only returns metadata.