Child pages
  • UAPI Functions - Email::unsuspend_outgoing
Skip to end of metadata
Go to start of metadata

Description

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

Note:

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

Examples


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


Note:

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

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


Note:

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

 Command Line
uapi --user=username Email unsuspend_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. 

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

A valid email account username.

username@example.com

Returns

This function only returns metadata.