v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Mailboxes
Mailbox Management

Return if cPanel account's mailboxes use UTF-8

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

get/Mailboxes/has_utf8_mailbox_names

Query parameters

userstring username
Example:user

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.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "has_utf8_mailbox_names",
  "module": "Mailboxes",
  "result": {
    "data": {
      "enabled": 1
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}