We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Page tree
Skip to end of metadata
Go to start of metadata


This tutorial explains how to configure your WHM account so that users can receive push notifications for iOS® mail. We introduced this feature in cPanel & WHM version 64. When users enable push notifications, they receive notifications when new messages arrive.

You must export the Apple® Push Notification service (APNs) key, and then install the key on your WHM server to enable push notifications.


  • You cannot create APNs certificates in macOS Server® version 5.7.1 and later. The macOS® Mojave 10.14 operating system requires version 5.7.1 or later. For more information, read Apple's macOS Server 5.7.1 upgrade documentation. You can request that Apple includes this feature in macOS Server 5.7.1 on Apple's feedback forum.
  • You must open TCP outbound traffic for port 2195 if your firewall restricts this port. For more information, read our How to Configure Your Firewall for cPanel Services documentation.


  • Perform steps 1 – 3 on you MacOS device.
  • Perform steps 4 – 5 on your iOS device.

Receive push notifications for iOS mail


Create an APNs key.

To create the APNs key, perform the following steps:

  1. Open the Apple App Store application (app) via Finder (Applications >> App Store). Sign in when the system prompts you.


    You can also press the Command + Space Bar keys and search for App Store.

  2. Search for macOS Server.
  3. Click the macOS Server icon.
  4. Click $19.99, then click Buy App.
  5. Click Open.
  6. Select This Mac from the Choose A Mac menu and click Continue.
  7. Select the Apple Push Notifications (APN) checkbox from the Settings menu.
  8. Enter your credentials.




Export APNs key information.

To export the APNs key, perform the following steps:

  1. Open the Keychain Access app via Finder (Applications >> Utilities >> Keychain Access).


    You can also press the Command + Space Bar keys and search for Keychain Access .

  2. Select System from the Keychains menu and then select Keys from the Category menu.
  3. Press the control key and left-click (or right-click) the com.apple.servermgrd.apns.mail key () or certificate bundle () with your mouse.
  4. Select Export "com.apple.servermgrd.apns.mail"… 

  5. Click Save to save the APNs key to your desired location.


    • You may need to enter your user credentials.
    • We strongly recommend that you password protect this file because it contains sensitive information.




Install the APNs key.

To install the APNs key on WHM, perform the following steps:

  1. Navigate to WHM's Manage Service SSL Certificates interface (WHM >> Home >> Service Configuration >> Manage Service SSL Certificates).
  2. Select the iOS Mail Push Notifications tab.
  3. Click Upload PKCS #12 archive.
  4. Select your file.


    If you password protected your file, enter your password in the Input the password for the PKCS #12 archive: text box.

  5. Click Install.




Prepare device configuration.

To ensure that the device can receive push notifications, you must restart the Mail app. To do this, perform the following steps:

  1. Open the Mail app on your iOS device.

  2. Double-tap the Home button.

  3. Swipe up to close the Mail app. For more information about how to close an app, read Apple's® Force an app to close documentation.

  4. Re-open the Mail app.
  5. Swipe down to perform a manual fetch.


  • If the above steps do not successfully initiate push notifications, you may need to restart your device.
  • To enable push notifications for the default email account, you must enter the username @ the server hostname on the client device, not @ the account's domain name.
    • For example, enter username@server.hostname.tld, not username@example.com.
    • For more information, read our Email Accounts documentation.




Lock screen notifications.

You can enable your device to display notifications from select persons on a locked screen. To do this, perform the following steps:

  1. Open the Mail app.

  2. Tap Mailboxes () in the top left corner.

  3. Tap the information () symbol from the VIP menu.
  4. Tap Add VIP…
  5. Select the contacts from whom you wish to receive notifications on a locked screen to the VIP list.



Specific attributes of this tutorial may vary with future Apple product versions. We used the following versions to capture this document's screenshots:

Program or Operating SystemVersion
OS X El Captain10.11.6
App Store2.1


Keychain Access9.0

Additional documentation

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels