How to Set Up Calendars and Contacts

Valid for versions 110 through 118

Version:

110

120

Last modified: July 18, 2024


Overview

Warning:

Because WebPros International, LLC doesn’t develop or ship these applications, cPanel Technical Support can’t help you set this up.

This document describes how to set up calendars and contacts on Apple® desktop and mobile-device operating systems and in Roundcube using CalDAV and CardDAV.

On Android™ devices, we recommend using Exchange ActiveSync to set up calendars, contacts, and email. For more information, read our How to Sync Calendars, Contacts, and Email on Android Devices documentation.

In this document, user represents the webmail user, and example.com represents the user’s domain name.

Configuration information

Important:

You can find your cPanel calendar (CalDAV) and contacts (CardDAV) setup information in Webmail’s Configure Calendar and Contacts Client interface. For example:

  • User Name[email protected]
  • Password — Enter the same password that you use for your webmail login.
  • Server URLhttps://example.com:2080
  • Alternate Server URLhttps://example.com:2080/principals/__uids__/132E0D5F-77F2-4A15-B888-B0741C57F938/
    Note:
    • Replace 132E0D5F-77F2-4A15-B888-B0741C57F938 with the corresponding UID from the Alternate Server URL in the interface.
    • Some applications may not support Autodiscover. If the Server URL does not work, use the Alternate Server URL to bypass Autodiscover.

You can also reference calendars and contacts via their direct URLs in the Direct CalDAV and CardDAV URLs for Calendars and Contacts section of the interface. For example:

  • Calendarhttps://example.com:2080/calendars/__uids__/132E0D5F-77F2-4A15-B888-B0741C57F938/calendar
  • Address Bookhttps://example.com:2080/addressbooks/__uids__/132E0D5F-77F2-4A15-B888-B0741C57F938/addressbook
    Note:

    Replace 132E0D5F-77F2-4A15-B888-B0741C57F938 with the UID from the corresponding entry in the interface.

You can also have the system email you scripts that automatically configure the cPanel calendars and contacts on your local system. For more information, read the Set up email on your device section of our The Webmail Interface documentation.

Set up calendar and contact applications

Important:

Specific attributes of this tutorial may vary with future Apple product versions.

Perform the following steps for your operating system to set up cPanel calendars (CalDAV) and contacts (CardDAV):

iOS®

Note:

If your server uses a self-signed SSL certificate, the following caveats apply:

  • When you set up calendars and contacts, you will get a message that your local system cannot verify the server’s identity. Tap Continue to complete the setup process.
  • The iOS Reminders application will not function with the calendars you set up.

Access the configuration screen

Perform the following steps to access the calendars (CalDAV) and contacts (CardDAV) account configuration screen on your iOS device:

  1. Tap Settings.
  2. Tap Mail.
  3. Tap Accounts.
  4. Tap Add Account.
  5. Tap Other.
  6. Tap the option for the type of account to add:
    • To add a calendar account, tap Add CalDAV Account under CALENDARS.
    • To add a contacts account, tap Add CardDAV Account under CONTACTS.

Enter your account information

To complete the setup of your account, perform the following steps:

  1. Enter your information in the appropriate text boxes. For example:
    • Serverexample.com:2080
      Important:
      You must add :2080 at the end of the server name for the setup to work correctly.
    • User Name[email protected]
    • Password — Enter the same password that you use for your webmail login.
    • DescriptionMy Calendar Account
  2. Tap Next.
  3. Set the Calendars toggle to enable the calendar.
  4. The Existing Local Calendars interface will appear. Tap Keep on My iPhone to keep your existing local calendars, or tap Delete to remove them.
  5. Tap Save.

macOS®

Perform the following steps to access the calendars (CalDAV) or contacts (CardDAV) account configuration menu on your Apple computer:

Access the account configuration menu

To access the account configuration menu, perform the following steps:

  1. Click Launchpad, and then click System Preferences.
  2. Click Internet Accounts.
  3. Click Add Other Account….
  4. Click CalDAV Account to add a calendar account, or CardDAV Account to add a contacts account.

Enter your account information

To complete the setup of your CalDAV or CardDAV account, use one of the following methods:

Automatic
Important:
  • You cannot set up calendars and contacts with the Automatic account type if your domain uses a self-signed certificate.
  • To use the Automatic account type, your hosting provider must enable the Thunderbird and Outlook autodiscover and autoconfig support (enables service subdomain and SRV record creation) setting in the Domains section of WHM’s Tweak Settings interface (WHM » Home » Server Configuration » Tweak Settings).

To automatically complete the setup of your account, perform the following steps:

  1. Select Automatic in the Account Type menu.
  2. Enter your email address in the Email Address text box.
  3. Enter your password in the Password text box.
  4. Click Sign In to save your changes.
Manual

To manually complete the setup of your account, perform the following steps:

  1. Select Manual in the Account Type menu.
  2. Enter your email address in the User Name text box.
  3. Enter your password in the Password text box.
  4. In the Server Address text box, enter the server name, and add :2080 at the end.
    Important:

    You must add :2080 at the end of the server name for the setup to work correctly.

  5. Click Sign In to save your changes.
Advanced

To complete setup of your account using the Advanced option, perform the following steps:

  1. Select Advanced in the Account Type menu.
  2. Enter your email address in the User Name text box.
  3. Enter your password in the Password text box.
  4. Enter the server name in the Server Address text box.
  5. Enter the server path in the Server Path text box.
    Note:
    • You can locate the CardDAV and CalDAV Server Path information in Webmail’s Configure Calendar and Contacts Client interface. Use the URL provided in the Secure SSL/TLS URLs table’s Address Book or Calendar rows, respectively.
    • The Server Path text box only requires the information after the server’s port address. For example, to add a CalDAV Server Path, use the /calendars/__uids__/132E0D5F-77F2-4A15-B888-B0741C57F938/calendar format, and replace 132E0D5F-77F2-4A15-B888-B0741C57F938 with the corresponding UID (Unique Identifier) from the URL in Webmail’s Configure Calendar and Contacts Client interface.
  6. Enter 2080 in the Port text box.
  7. Click Sign In to save your changes.

Other operating systems

Important:
  • We have only tested these steps on Apple®-distributed products. These clients natively support CalDAV and CardDAV. If you use other calendar or contacts applications that support these protocols, you may be able to access your calendars and contacts from those applications. Your application must support the CalDAV and CardDAV protocols.
  • On Android devices, we recommend using Exchange ActiveSync to set up calendars, contacts, and email. For more information, read our How to Sync Calendars, Contacts, and Email on Android Devices documentation.

Access your application’s configuration interface

Perform the necessary steps to access the calendars (CalDAV) or contacts (CardDAV) account configuration interface for your application. These steps vary between applications. For more information, read your application’s documentation.

Enter your account’s information

Enter the following information for your webmail account. For example:

  • Username — The webmail username — [email protected]
  • Password — The webmail user’s password.
  • Server — The full URL for the webmail user’s calendar or contacts.
    • Autodiscover — example.com
    • Non-Autodiscover — https://example.com:2080/calendars/__uids__/132E0D5F-77F2-4A15-B888-B0741C57F938/calendar
      Note:
      • Replace 132E0D5F-77F2-4A15-B888-B0741C57F938 with the corresponding UID from the URL in Webmail’s Configure Calendar and Contacts Client interface.
      • Some applications may not support Autodiscover. If the Server URL does not work, use the Alternate Server URL to bypass Autodiscover.

Roundcube

Roundcube’s database stores the internal calendar’s data. You can also add a CalDAV calendar from a remote cPanel server to Roundcube.

Log in to Webmail

To add a remote cPanel calendar to Roundcube, first log in to Webmail with one of the following methods:

  • Navigate to https://example.com:2096 in your browser. For more information, read our How to Log in to Your Server or Account documentation.
  • Navigate to cPanel’s Email Accounts interface (cPanel » Home » Email » Email Accounts). Then, locate the email account in the table and click or tap Check Email. The Webmail interface will open in a new browser tab.

After you log in, the Webmail interface will appear.

Access Roundcube

The Roundcube webmail client is cPanel & WHM’s default webmail client. Roundcube includes a mobile-responsive theme.

If Roundcube is not your current webmail client, click or tap Roundcube’s logo or text description in the Open your inbox section of the Webmail interface.

In the Roundcube interface, click Calendar on the left menu, or in the mobile interface, tap the menu () icon to open the main menu, then tap Calendar. The Calendar interface will appear.

Add the cPanel calendar to Roundcube

  1. In the Roundcube Calendar interface, navigate to Calendars at the top of the interface, or in the mobile interface, tap the folder ( ) icon.
  2. Click or tap the menu ( ) icon. A menu will appear.
  3. Select Add Calendar from the menu. The Create new calendar interface will appear.
  4. In the Properties section, enter a calendar name in the Name text box.
  5. Paste the calendar URL from the remote cPanel server into the CalDAV URL text box. You can find the calendar URL in the Direct CalDAV and CardDAV URLs for Calendars and Contacts section of Webmail’s Configure Calendar and Contacts Client interface on the remote server.
  6. Adjust the calendar color and whether to show reminders in the Settings section.
  7. Under Authentication, enter the username and password for the remote cPanel email account.
  8. Click or tap Save. The Roundcube Calendar interface will automatically upload the calendar.
    Note:
    You will see calendar events for the current week.

To add an event to the calendar, double-click or double-tap anywhere on the calendar. A New event interface will appear.

Additional Documentation