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.

Examples




https://hostname.example.com:2083/cpsess##########/execute/Email/suspend_outgoing?email=username%40example.com



$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',
         )
);

 



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',
    }
);

 



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

 



uapi --user=username Email suspend_outgoing email=user%40example.com



{
      "data" : 1,
      "status" : 1,
      "messages" : null,
      "errors" : null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account's username.

A valid email account username.

username@example.com

Returns

This function only returns metadata.