Description

This function cancels the suspension action put in place by the UAPI Email::suspend_outgoing function for outgoing mail for an email account.


To suspend an email account and reject all outgoing mail, use the UAPI Email::suspend_outgoing function.

Examples




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

 



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Unsuspend outgoing email for the user's email account.
$unsuspend_outgoing = $cpanel->uapi(
    'Email', 'unsuspend_outgoing',
    array(
        'email' => 'username@example.com',
        )
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Unsuspend outgoing email for the user's email account.
my $unsuspend_outgoing = $cpliveapi->uapi(
    'Email', 'unsuspend_outgoing',
    {
        'email' => 'username@example.com',
    }
);



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



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



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



Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

Required

The email account's username.

A valid email account username.

username@example.com

Returns

This function only returns metadata.