cPanel API 2 Functions - Cron::set_email

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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

Note:

For more information, read our Calls from the WHM API documentation.

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

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.

# Set cron notification email to "user@example.com"
my $set_email = $cpliveapi->api2(
    'Cron', 'set_email',
    {
        'email'        => 'user@example.com',
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

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

email

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. 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`