Return current user's account name

This function returns the provided value. This function works with other functions to display form data within a user interface.

Note:

If you call this function from a Webmail session URL, the system will only access data for that email account.

Important:

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

SecurityBasicAuth

Request

query Parameters

account	string The function will return this value in the data return. If you do not include this parameter, the function returns `All Mail On The Account` or a blank value. A valid string. An empty value. Note: The function does not validate this parameter's value. Example: account=user
display	string Include this parameter to cause the function to return `All Mail On The Account` if the account parameter is blank or does not exist. If you do not include this parameter and the account value is blank or does not exist, the function returns a blank data value. Example: display=any_value

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

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "account_name",
"module": "Email",
"result": {"data": "user@example.com",
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}