Send email client settings to an email address

This function sends an email account's client settings to an email address.

Important:

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

SecurityBasicAuth

Request

query Parameters

required	string or string The email account username or address for which to send client settings. Example: account=username
to required	string <email> The email address to send client settings. Example: to=user@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/dispatch_client_settings

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  dispatch_client_settings \
  to='user@example.com' \
  account='username'

Response samples

application/json

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