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.

SecurityBasicAuth

Request

query Parameters

address required	string <email> The forwarder's email address. Example: address=user@example.com
forwarder required	string The forwarder's destination. A valid email address. A script location. A system account. Example: forwarder=fwdtome@example.com

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/delete_forwarder

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  delete_forwarder \
  address='user@example.com' \
  forwarder='fwdtome@example.com'

Response samples

application/json

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