Return email account's client settings

This function retrieves an email account's client settings.

Important:

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

SecurityBasicAuth

Request

query Parameters

account

string <email>

The email address for which to send client settings.

Note:

This parameter defaults to the system default email account.

Example: account=username@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/get_client_settings

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "get_client_settings",
"module": "Email",
"result": {"data": {"account": "username@example.com",
"activesync_available": 1,
"activesync_host": "mail.example.com",
"activesync_port": 2091,
"activesync_username": "username@example.com",
"display": "username@example.com",
"domain": "domain.com",
"from_archiving": 0,
"has_plaintext_authentication": 1,
"inbox_host": "mail.example.com",
"inbox_insecure_port": 143,
"inbox_port": 993,
"inbox_service": "imap",
"inbox_username": "username@example.com",
"mail_domain": "mail.example.com",
"smtp_host": "mail.example.com",
"smtp_insecure_port": 25,
"smtp_port": 465,
"smtp_username": "username@example.com"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}