v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Email Forwarding

Delete email account's email forwarder

This function deletes an email forwarder.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/delete_forwarder

Query parameters

addressstring email required
Example:user@example.com

The forwarder's email address.

forwarderstring required
Example:fwdtome@example.com

The forwarder's destination.

  • A valid email address.
  • A script location.
  • A system account.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "delete_forwarder",
  "module": "Email",
  "result": {
    "status": 1
  }
}