Page tree
Skip to end of metadata
Go to start of metadata

 

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

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 the global address book's status.
$DAV = $cpanel->uapi(
    'DAV', 'has_shared_global_addressbook',
	array(
		'name'	=> '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 the global address book's status.
my $enable_shared_global_addressbook = $cpliveapi->uapi(
    'DAV', 'has_shared_global_addressbook',
	{
		'name'	=> 'user',
	}
 );

Note:

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

 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 %]

Note:

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

 Command Line
uapi --user=username DAV has_shared_global_addressbook name=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. 
  • We introduced this functionality in cPanel & WHM version 56.

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

   }
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

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

ReturnTypeDescriptionPossible valuesExample
sharedBoolean

Whether the global address book is enabled.

  • 1 — Enabled.
  • 0 — Not enabled.
1