Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titlecPanel or Webmail Session URL
Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/DAV/enable_shared_global_addressbook?name=user

Include Page
_CallUAPIFromBrowserLink
_CallUAPIFromBrowserLink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Share the global address book.
$DAV = $cpanel->uapi(
    'DAV', 'enable_shared_global_addressbook',
	array(
		'name'	=> 'user',
	)
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Share the global address book.
my $enable_shared_global_addressbook = $cpliveapi->uapi(
    'DAV', 'enable_shared_global_addressbook',
	{
		'name'	=> 'user',
	}
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Template Toolkit
Code Block
languagexml
linenumberstrue
<!-- Verify that the system enables the global address book. -->
[% data = execute( 'DAV', 'enable_shared_global_addressbook'{ 'name' => 'user' } ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Include Page
_TTLink
_TTLink

Expand
titleCommand Line
Code Block
languagetext
uapi --user=username DAV enable_shared_global_addressbook name=user

Include Page
_UAPICLINote
_UAPICLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "messages":null,
   "data":{  
      "shared":"1"
   },
   "errors":null,
   "status":1,
   "metadata":{  

   }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

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