Child pages
  • UAPI Functions - Mailboxes::has_utf8_mailbox_names
Skip to end of metadata
Go to start of metadata

Description

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mailboxes/has_utf8_mailbox_names?user=username


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Check whether user uses UTF-8 character-encoded mailbox names.
$utf8_check = $cpanel->uapi(
    'Mailboxes', 'has_utf8_mailbox_names',
    array(
        'user'     => 'user',
         )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Check whether user uses UTF-8 character-encoded mailbox names.
my $utf8-check = $cpliveapi->uapi(
    'Mailboxes', 'has_utf8_mailbox_names',
    {
        'user'     => 'user',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Template Toolkit
<!-- Check whether user uses UTF-8 character-encoded mailbox names. -->
[% execute('Mailboxes', 'has_utf8_mailbox_names', { 'user' => 'user', }) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Mailboxes has_utf8_mailbox_names user=user 


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "enabled": 1
  },
  "metadata": {
    "transformed": 1
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

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

This parameter defaults to the currently-logged in user.

A valid username.

user

Returns

ReturnTypeDescriptionPossible valuesExample
enabledBooleanWhether the user currently uses UTF-8 character-encoded mailbox names.
  • 1 — Uses UTF-8 character-encoded mailbox names.
  • 0 — Does not use UTF-8 character-encoded mailbox names.
1