Enable or disable Webmail mailbox UTF-8 encoding

This function enables or disables UTF-8-encoded mailbox names on Roundcube webmail for a cPanel user's email accounts.

SecurityBasicAuth

Request

query Parameters

enabled

required

integer

Whether to enable or disable UTF-8 character-encoded mailbox names.

1 - Enable UTF-8 encoded mailbox names.
0 - Disable UTF-8 encoded mailbox names.

Enum: 0 1

Example: enabled=1

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/Mailboxes/set_utf8_mailbox_names

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Mailboxes \
  set_utf8_mailbox_names \
  enabled='1'

Response samples

application/json

{"apiversion": 3,
"func": "set_utf8_mailbox_names",
"module": "Mailboxes",
"result": {"data": {"success": 1
},
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}