Return cPanel account's mail forwarder total

This function returns the number of forwarders for every email address on a cPanel account.

Important:

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

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Email/count_forwarders

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  count_forwarders

Response samples

application/json

{"apiversion": 3,
"func": "count_forwarders",
"module": "Email",
"result": {"data": 1,
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}