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

Description

This function rejects outgoing mail for a suspended email account. This function does not disable a user's login credentials or access permissions to their email account.

Notes:

Examples


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

Note:

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

 

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


Note:

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

 

 Command Line
uapi --user=username Email suspend_outgoing email=user%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)
{
      "data" : 1,
      "status" : 1,
      "messages" : 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's username.

A valid email account username.

username@example.com

Returns

This function only returns metadata.

  • No labels