cPanel API 2 Functions - Email::checkmaindiscard - Knowledgebase

Description

This function checks whether the system deletes a domain's unroutable mail.

Note:

To modify this setting, use the Email::setdefaultaddress function.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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=

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

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

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Email checkmaindiscard domain=example.com

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "checkmaindiscard",
    "data": [
      {
        "status": 0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The domain.	A valid domain on the account.	example.com

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.	1 — The system deletes the domain's unroutable mail. 0 — The system forwards, pipes, or bounces the domain's unroutable mail.	0
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories