Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - DAV::disable_shared_global_addressbook - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - DAV::disable_shared_global_addressbook
Skip to end of metadata
Go to start of metadata

Description


This function disables the shared global address book for the current cPanel account's webmail accounts.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/DAV/disable_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.
 
// Stop sharing the global address book.
$DAV = $cpanel->uapi(
    'DAV', 'disable_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.
  
# Stop sharing the global address book.
my $disable_shared_global_addressbook = $cpliveapi->uapi(
    'DAV', 'disable_shared_global_addressbook',
	{
		'name'	=> 'user',
	}
 );


Note:

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


 Command Line
uapi --user=username DAV disable_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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "data":{  
      "shared":"0"
   },
   "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 username 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 shared.

  • 1 — Shared.
  • 0 — Not shared.
1