Child pages
  • UAPI Functions - Email::get_webmail_settings
Skip to end of metadata
Go to start of metadata

Description

This function retrieves an email account's Webmail settings.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/get_webmail_settings?account=user



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.
 
// List webmail settings for user@example.com.
$webmail = $cpanel->uapi(
    'Email', 'get_webmail_settings',
    array(
        'account'      => '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.
 
# List webmail settings for user@example.com.
my $webmail = $cpliveapi->uapi(
    'Email', 'get_webmail_settings',
    {
        'account'      => 'user',
    }
);


Note:

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

 

 cPanel Template Toolkit
<!-- List webmail settings for user@example.com. -->
[% execute('Email', 'get_webmail_settings', { 'account' => 'user', } ) %]


Note:

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

 

 Command Line
uapi --user=username Email get_webmail_settings account=user@example.com


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,
   "metadata":{  

   },
   "data":{  
      "domain":"mail.example.com",
      "user":"user",
      "has_maildir":1
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

The mail account's username.

If you do not specify a value, the function retrieves settings for the cPanel account's default mail account.

A mail account username on the cPanel account.

For example, user if the email address is user@example.com.

user@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
domainstringThe email account's domain.A valid domain on the cPanel account.example.com

user

string

The email account username.

A valid email account username on the cPanel account.

user

has_maildir

Boolean

Whether Webmail is enabled for the email account.

  • 1 — Enabled.
  • 0 — Disabled.
1