UAPI Functions - Email::get_webmail_settings - Knowledgebase

Description

This function retrieves an email account's Webmail settings.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/get_webmail_settings?account=user

 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',
        )
);

 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',
    }
);

cPanel Template Toolkit

[% execute('Email', 'get_webmail_settings', { 'account' => 'user', } ) %]

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.

 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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
account	string	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

Parameter

Type

Description

Possible values

Example

account

string

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

Return	Type	Description	Possible values	Example
domain	string	The 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

Knowledgebase

Categories

Categories