cPanel API 2 Functions - Email::checkmaindiscard
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Description
This function checks whether the system deletes a domain's unroutable mail.
To modify this setting, use the Email::setdefaultaddress
function.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
When you disable the Receive Mail role, the system disables this function.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=checkmaindiscard&domain="example.com"
For more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Check whether example.com deletes unroutable mail.
$check_unroutable_rules = $cpanel->api2(
'Email', 'checkmaindiscard',
array(
'domain' => 'example.com',
)
);
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.
# Check whether example.com deletes unroutable mail.
my $check_unroutable_rules = $cpliveapi->api2(
'Email', 'checkmaindiscard',
{
'domain' => 'example.com',
}
);
For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our Deprecated cPanel Tag Usage documentation.
Command Line
cpapi2 --user=username Email checkmaindiscard domain=example.com
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help
command.
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "checkmaindiscard",
"data": [
{
"status": 0
}
],
"event": {
"result": 1
},
"module": "Email"
}
}
Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
domain |
string | Required The domain. |
A valid domain on the account. |
example.com |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
status |
Boolean | Whether the system deletes the domain's unroutable email. |
|
0 |
reason |
string | A reason for failure. Note:
This function only returns a |
A string that describes the error. |
This is an error message. |
result |
Boolean | Whether the function succeeded. |
|
1 |