Return whether global address book is enabled

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

SecurityBasicAuth

Request

query Parameters

name	string 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. Example: name=user

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/DAV/has_shared_global_addressbook

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  DAV \
  has_shared_global_addressbook

Response samples

application/json

{"apiversion": 3,
"func": "has_shared_global_addressbook",
"module": "DAV",
"result": {"data": {"shared": 1
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}