We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function unsuspends incoming email for an email account.

Important:

In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/unsuspend_incoming?email=user%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 incoming email for the user's email account.
$unsuspend_incoming = $cpanel->uapi(
    'Email', 'unsuspend_incoming',
    array(
        'email'    => 'user%40example.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 incoming email for the user's email account.
my $unsuspend_incoming = $cpliveapi->uapi(
    'Email', 'unsuspend_incoming',
    {
        'email'    => 'user%40example.com',
    }
);


Note:

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

 Command Line
uapi --user=username Email unsuspend_incoming 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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
	"warnings": null,
	"status": 1,
	"metadata": {},
	"data": 1,
	"errors": null,
	"messages": null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
emailstring

The email user's account name.

A valid email account username.

user@example.com

Returns

ParameterTypeDescriptionPossible valuesExample
dataBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1