cPanel API 2 Functions - Cron::set_email - Knowledgebase

Description

This function sets the default notification email for the cron daemon.

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=Cron&cpanel_jsonapi_func=set_email&email=user%40example.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Set cron notification email to "user@example.com"
$set_email = $cpanel->api2(
    'Cron', 'set_email',
 array(
        'email'        => 'user@example.com',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Set cron notification email to "user@example.com"
my $set_email = $cpliveapi->api2(
    'Cron', 'set_email',
    {
        'email'        => 'user@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 Cron set_email email=user%40example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set_email",
    "data": [
      {
        "email": "user@example.com",
        "statusmsg": "crontab installed",
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Cron"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The notification email address.	A valid email address.	user@example.com

Parameter

Type

Description

Possible values

Example

string

Required

The notification email address.

A valid email address.

user@example.com

Returns

Return	Type	Description	Possible values	Example
email	string	The new notification email address.	A valid email address	user@example.com
statusmsg	string	The cron daemon's status.	crontab installed crontab not installed	crontab installed
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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