Description

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


Examples




https://hostname.example.com:2083/cpsess##########/execute/Mailboxes/set_utf8_mailbox_names?enabled=1



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Enable or disable UTF-8 character-encoded mailbox names for user.
$utf8_set = $cpanel->uapi(
    'Mailboxes', 'set_utf8_mailbox_names',
    array(
        'enabled'     => '1',
         )
);



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Enable or disable UTF-8 character-encoded mailbox names for user.
my $utf8-set = $cpliveapi->uapi(
    'Mailboxes', 'set_utf8_mailbox_names',
    {
        'enabled'     => '1',
    }
);



<!-- Check whether user uses UTF-8 character-encoded mailbox names. -->
[% execute('Mailboxes', 'set_utf8_mailbox_names', { 'enabled' => '1', }) %]



uapi --user=username Mailboxes set_utf8_mailbox_names enabled=1



{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "success": 1
  },
  "metadata": {
    "transformed": 1
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
enabledBoolean

Required

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.
1

Returns

ReturnTypeDescriptionPossible valuesExample
successBooleanWhether the system changed mailbox name setting's status.
  • 1 — Success.
  • 0 — Failure.
1