cPanel/DAV
cPanel module

DAV

6 functions, invoked through the cpanel_uapi tool.

CalDAV/CardDAV global address book and Horde webmail toggles → CCS, CPDAVD

scope cpanel:uapiemail
Call any function with cpanel_uapi(service_id, module="DAV", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

disable_shared_global_addressbook GET mutating#

Disable global address book

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

namestringOptional
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.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

sharedinteger
Whether the global address book is shared. 1 — Shared. 0 — Not shared.
One of: 0 1

enable_shared_global_addressbook GET mutating#

Enable global address book

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

namestringOptional
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.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

sharedinteger
Whether the global address book is shared. 1 — Shared. 0 — Not shared.
One of: 0 1

get_calendar_contacts_config GET#

Return CalDAV and CardDAV connection information

This function returns the connection information to set up the CalDAV and CardDAV clients.

usermixedOptional
A cPanel account or valid email account user. If you do not include this parameter, the function defaults to the current authenticated user.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

activesyncobject
Configuration details for ActiveSync.
enabledinteger
Whether the server has ActiveSync enabled. 1 — Enabled. 0 — Not enabled.
One of: 1 0
portinteger
The port number the system uses for secure ActiveSync connections.
serverstring
The fully qualified domain name to connect to.
userstring
The cPanel user or email account user to whom the returned connection information pertains. If you do not specify the user parameter, this function returns the authenticated cPanel user.
no_sslobject
A list of non-SSL connection configurations.
calendarsarray<object>
An array of objects containing the user's calendars.
descriptionstring
The description of the calendar.
namestring
The name of the calendar.
pathstring
The relative URL path to the calendar.
urlstring
The absolute URL to the calendar.
contactsarray<object>
An array of objects containing the user's address books.
descriptionstring
The description of the address book.
namestring
The name of the address book.
pathstring
The relative URL to the address book.
urlstring
The absolute URL to the address book.
free_busystring
The absolute URL path and HTTP port to the user's CalDAV free-busy-query connection. Note: This information is useful for clients that support Autodiscovery.
full_serverstring
The absolute URL path and HTTP port to the user's CalDAV and CardDAV connection information. Note: This information is useful for clients that do not support Autodiscovery.
portinteger
The port number that the system uses for non-SSL connections.
serverstring
The short server connection string that includes a domain name and a port that uses the HTTP protocol.
sslobject
A list of SSL connection configurations.
calendarsarray<object>
An array of objects containing the user's calendars.
descriptionstring
The description of the calendar.
namestring
The name of the calendar.
pathstring
The relative URL path to the calendar.
urlstring
The absolute URL to the calendar.
contactsarray<object>
An array of objects containing the user's address books.
descriptionstring
The description of the address book.
namestring
The name of the address book.
pathstring
The relative URL to the address book.
urlstring
The absolute URL to the address book.
free_busystring
The absolute URL path and HTTPS port to the user's CalDAV free-busy-query connection. Note: This information is useful for clients that support Autodiscovery.
full_serverstring
The absolute URL path and HTTPS port to the user's CalDAV and CardDAV connection information. Note: This information is useful for clients that do not support Autodiscovery.
is_self_signedinteger
Whether the server uses a self-signed certificate. 1 — Self-signed. 0 — Not self-signed.
One of: 1 0
portinteger
The port number that the system uses for SSL connections.
serverstring
The short server connection string that includes a domain name and a port that uses the HTTPS protocol. Note: This value is useful for clients that support Autodiscovery.
userstring
The cPanel user or email account user to whom the returned connection information pertains. If you do not specify the user parameter, this function returns the authenticated cPanel user.

has_shared_global_addressbook GET#

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.

namestringOptional
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.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

sharedinteger
Whether the global address book is enabled. 1 — Enabled. 0 — Not enabled.
One of: 0 1

is_dav_service_enabled GET#

Return whether DAV is enabled

This function checks whether the DAV service is enabled.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

enabledinteger
Whether the DAV service is enabled. 1 — Enabled. 0 — Disabled.
One of: 0 1

is_horde_enabled GET#

Return whether Horde is enabled

This function checks whether Horde is enabled. Since Horde is no longer installed with the product, the return value will only ever be 0.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

enabledinteger
Whether Horde is enabled. Always false because horde is no longer installed with the product. * 0 — Disabled.
One of: 0