UAPI Functions - DAV::has_shared_global_addressbook

Description

This function checks whether the shared global address book is enabled on the current cPanel account's webmail accounts.

Examples


 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/DAV/has_shared_global_addressbook?name=user

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Check the global address book's status.
$DAV $cpanel->uapi(
    'DAV''has_shared_global_addressbook',
    array(
        'name'  => 'user',
    )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
   
# Check the global address book's status.
my $enable_shared_global_addressbook $cpliveapi->uapi(
    'DAV''has_shared_global_addressbook',
    {
        'name'  => 'user',
    }
 );

 cPanel Template Toolkit

<!-- Verify the global address book's status. -->
[% data = execute( 'DAV', 'has_shared_global_addressbook'{ 'name' => 'user' } ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

 Command Line

uapi --user=username DAV has_shared_global_addressbook name=user

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

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

 

Note:

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

 

Parameters

 Parameter 

 Type 

Description

Possible values

 Example 

name

string

A cPanel account user name or a Webmail user's email address.

 If you do not specify a user, this parameter defaults to the currently-authenticated user. 

 A valid username. 

user

 

Returns

 Return 

Type

Description

Possible values

 Example 

shared

 Boolean 

 Whether the global address book is enabled .

  • 1 — Enabled.
  • 0 — Not enabled.

1

 

  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....