Use the addon module to master the theme branding on your account directly in the panel.

We will guide you step by step through the whole installation process.

Files in your WHMCS directory should look like on the following screen.

Log in to your WHMCS admin area. Move to the 'System Settings' and find 'Addon Modules'.
Afterwards, find the 'OX WHMCS Module' and press the 'Activate' button.

To do so, click on the 'Configure' button, tick the desired admin roles and press 'Save Changes'.

Access the addon under 'Addons' → 'OX WHMCS Module'.

Log in to your WHMCS account, proceed to 'System Settings' → 'Products/Services' → 'Servers'.
There, press 'Add New Server'.

Choose 'OX WHMCS Module' from the 'Module' dropdown menu and type in your username and password.
Select 'Secure' if you use SSL for connection. Next, test your connection and press 'Save Changes' if that has been successful.

Important:

• You will need to know which of the OX Cloud data centers you are using for mailbox provisioning. Depending on data center you should use one of the following addresses:
  • eu.appsuite.cloud - For EU
  • us.appsuite.cloud - For US
  • asia.appsuite.cloud - For Asia
• Formats such as 'HTTPS' or 'HTTP' are not allowed in the "Hostname" field
• You will need a Username and Password which you receive from the provisioning mail.
  If you do not have one then please contact the OX Cloud team.

• You used the correct server name and Hostname that fits the underlying data center
• You used the correct username and password
• You white-listed your WHMCS server IP address during the provisioning process.
  

Note: If you use multiple servers, all their IP addresses have to be white-listed.

Now you need to create a new group for your server. For that purpose press 'Create New Group'.

Start by creating a new, dedicated group by pressing the 'Create a New Group' button.

Click on 'Create a New Product'.

Note: You may select "Shared Hosting" or "Other" type of the product.

By marking the 'Require Domain' option, customers will have the options to:

• register a new domain
• transfer an existing domain from another registrar
• use an existing domain and update their server name

• Email Accounts Limit - the maximum allowed number of email accounts per context is 500

• Email Aliases Limit - the maximum allowed number of email aliases per email account is 50

• Email Forwarders Limit - note that only one redirection is allowed per one forwarding alias

• Product Components - choose the product that you want to provision to clients:
  • Mail Essential (OX Mail, OX Calender, OX Tasks, OX Portal, OX Address Book)
  • Mail Essential + Productivity Add-on (additionally includes 'OX Drive', 'OX Text', 'OX Spreadsheet', 'OX Presentation' and Email Undelete)
  • Mail Essential + Security Add-on (additionally includes email and file encryption, 'Safe Unsubscribe', 'Time-of-click anti-phishing')
  • Mail Essential + Productivity Add-on + Security Add-on

• Maximum Quota Per Email Account [MB] - set the maximum quota for a single email account [MB]

• Maximum Quota Per Context [MB] - a context can be described as a container for users usually getting operated by a single end-user company having its users and their mail accounts located under this specific context.
  The maximum quota value cannot be lower than 10 000 MB (10 GB)

• Use Only WHMCS Own Domain - only users with an active domain on WHMCS will be able to manage this product

• Allow To Change Password - when executing the "Create" and "Change Package" functions, the user will be allowed to change the password in the created context.
  This action is performed on the 'context/user' level.

Please remember to create the configurable options for each email account type ("Essential", "Productivity", "Security"):

Press 'Create Configurable Options' to generate a default set of configurable options, these can be:

• acc_limit|Email Accounts Limit (allows user to increase Email Account Limit without product upgrade)
• alias_limit|Email Aliases Limit (allows user to increase Limit of Aliases without product upgrade)
• forwarding_alias_limit|Forwarding Aliases Limit (allows user to increase Limit of Forwarding Aliases with product upgrade)
• allow_to_change_password|Allow To Change Password (allows user to change password within the Webmail UI - recommended)
  

More about the management of configurable options can be found here.

Do this by clicking the "Custom Fields" tab and check for:

• context_id|Context ID as your first Field Name
• context_name|Context Name as your second Field Name

This is what your customers should see in your client area.

The first section is dedicated to created contexts. There you will find a list of all provisioned contexts and verified domains, status, context ID and name.
This information may be required if you connect to the OX Support Team:

• Client Fullname
• Domain
• Context ID
• Context Name
• Current Status

Take a look at the available settings.

Important: The changes made in the addon are not constant!
Once you set the configuration here, the logo and new theme settings will be applied to the newly created contexts, they will not be visible for the already existing accounts.

Read through the next chapters which illustrate all the possibilities of our add-on module.

After running the 'Create ' action on the product, the context and context admin are automatically created, you can check the context details in the 'Service Information' table.
The username and password of the service are the context admin credentials, you can log into the panel with these credentials.

The screen below presents a summary view of the ordered product in the admin area. Among the available actions you will find:

• Module Commands: 'Create', 'Suspend'/'Unsuspend', 'Terminate' the product and 'Change Package' action
• Change configurable options values - available options depend on the configuration in 'Module Settings'
• Service Information
• Context ID
• Context Name

Analyze them carefully to enjoy extensive and straightforward management capabilities.

This is what its management page looks like in the client area. Move to the below sections to learn more details.

You may edit the existing accounts with a wide range of options and create new ones within defined limits.

Note: The provided 'Quota' field must be lower than the setup limit. If the limit has been reached, the client will not be able to create an account.

Note: Email aliases are created within the same email domain.

Press the 'Create Forwarder' button, specify the forwarded email and define the destination emails.

Once you add an email catch-all, you may delete it using the action buttons.

Important: In the case custom endpoints are used with your own domain, you will get a different set of MX records during onboarding.

'yourWHMCS/modules/addons/OXWHMCSModule/lang/english.php'

and in the module provisioning part:

'yourWHMCS/modules/servers/OXWHMCSModule/lang/english.php'

If you want to add a new language translation, please add, for example: "deutsch.php" files in the above language directories.