Return if cPanel account's mailboxes use UTF-8

This function determines whether a cPanel user currently uses UTF-8 character-encoded mailbox names.

Authorizations:
query Parameters
user
string <username>

The user for whom to determine whether they currently use UTF-8 character-encoded mailbox names.

Note:

This parameter defaults to the currently-logged in user.

Example: user=user

Responses

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

Request samples

uapi --user=username Mailboxes has_utf8_mailbox_names

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "has_utf8_mailbox_names",
  • "module": "Mailboxes",
  • "result": {
    • "data": {
      • "enabled": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}