Personal tools
Namespaces

Variants
Actions

OX WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Email Forwarders)
(→‎Installation and Configuration)
 
(91 intermediate revisions by one user not shown)
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The OX WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The OX WHMCS Module."></meta>
  
−
 
+
=About OX WHMCS Module=
−
=About [https://www.modulesgarden.com/products/whmcs/ox_whmcs_module OX WHMCS Module]=
+
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''OX WHMCS Module''' ...............
+
|style="padding: 10px 0px 10px 0px;"|'''OX WHMCS Module''' has been developed to allow quick and easy management of the OX account directly from the WHMCS client area. <br/> Establish the connection between your WHMCS and Open-Xchange to get access to email accounts, aliases, forwarders and many more. <br/>
 +
Use the addon module to master the theme branding on your account directly in the panel.
 
|}  
 
|}  
−
*'''Admin Area Features:'''
+
 
 +
*'''Important: Before using our WHMCS module'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Account
+
|style="padding: 10px 0px 0px 30px;"|✔ To be able to use the OX WHMCS Module, you '''MUST have an OX Cloud account!'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Account
+
|style="padding: 0px 0px 0px 30px;"|✔ The OX WHMCS Module lets you provision and manage OX Cloud email accounts.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ '''BEFORE you can do this,''' you need to be registered on OX Cloud, so that we can give you access to the OX Cloud servers.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Without this your OX WHMCS Module will not be able to connect to OX Cloud and will '''not work!'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ To register on OX Cloud please click '''[https://www.open-xchange.com/about-ox/contact-us/mail-productivity/ HERE]'''
 +
|}
 +
 
 +
*'''Admin Area Features:'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Context
 
|}
 
|}
 
{|
 
{|
Line 18: Line 33:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password
+
|style="padding: 0px 0px 0px 30px;"|✔ View Service Information:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Go To Zimbra Webmail
+
|style="padding: 0px 0px 0px 45px;"|✔ Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Define Products Configuration:
+
|style="padding: 0px 0px 0px 45px;"|✔ Owner
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Set Zimbra Account Settings
+
|style="padding: 0px 0px 0px 45px;"|✔ Module Access
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Use Class Of Service As:
+
|style="padding: 0px 0px 0px 45px;"|✔ Maximum Context Quota
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Fixed Choice
+
|style="padding: 0px 0px 0px 45px;"|✔ Context Username And Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Allowed Single Choice By Clients
+
|style="padding: 0px 0px 0px 45px;"|✔ Number And Limits Of:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Allowed Multiple Choices Of Quota Per Account
+
|style="padding: 0px 0px 0px 60px;"|✔ Email Accounts
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Custom Settings
+
|style="padding: 0px 0px 0px 60px;"|✔ Email Aliases
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Essential Features
+
|style="padding: 0px 0px 0px 60px;"|✔ Email Forwarders
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select General Features
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Product:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Mail Service Features
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Limit Of Email Accounts Per Context
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Contact/Calendar/Search/S/MIME Features
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Limit Of Email Aliases Per Context
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Access To Client Area Pages
+
|style="padding: 0px 0px 0px 45px;"|✔ Set Limit Of Email Forwarders Per Context
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Generate Default Configurable Options
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Module Access
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Enable Metric Billing
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Maximum Quota Per Email Account [MB]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Log In To Zimbra Administrator Panel On Click
+
|style="padding: 0px 0px 0px 45px;"|✔ Define Maximum Quota Per Context [MB]
 
|}
 
|}
−
 
−
*'''Client Area Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Manage Email Accounts:
+
|style="padding: 0px 0px 0px 45px;"|✔ Toggle Using WHMCS Own Domain Only
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Create/Edit/Delete
+
|style="padding: 0px 0px 10px 45px;"|✔ Allow Users To Change Password
 
|}
 
|}
 +
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Creation/Last Login Date
+
|style="padding: 10px 0px 0px 30px;"|✔ View Service Information:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Mailbox Quota
+
|style="padding: 0px 0px 0px 45px;"|✔ Status
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View/Change Mailbox Status
+
|style="padding: 0px 0px 0px 45px;"|✔ Owner
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Change Account Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Module Access
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Log In To Mailbox
+
|style="padding: 0px 0px 0px 45px;"|✔ Maximum Context Quota
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage Email Aliases
+
|style="padding: 0px 0px 0px 45px;"|✔ Context Username And Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage Distribution Lists
+
|style="padding: 0px 0px 0px 45px;"|✔ Number And Limits Of:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Manage Domain Aliases
+
|style="padding: 0px 0px 0px 60px;"|✔ Email Accounts
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Upgrade / Downgrade Account
+
|style="padding: 0px 0px 0px 60px;"|✔ Email Aliases
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Go To Zimbra Webmail
+
|style="padding: 0px 0px 0px 60px;"|✔ Email Forwarders
 
|}
 
|}
−
 
−
*'''Configurable Options:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Email Accounts Limit
+
|style="padding: 0px 0px 0px 30px;"|✔ Access And Management Of:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Email Account Size
+
|style="padding: 0px 0px 0px 45px;"|✔ Email Accounts
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Email Aliases Limit
+
|style="padding: 0px 0px 0px 45px;"|✔ Email Aliases
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Distribution List Limit
+
|style="padding: 0px 0px 0px 45px;"|✔ Email Forwarders
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Domain Aliases Limit
+
|style="padding: 0px 0px 0px 45px;"|✔ Email Catch-All
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Class Of Service
+
|style="padding: 0px 0px 10px 45px;"|✔ View MX Records For Mail Domains
 
|}
 
|}
  
−
*'''General Info:'''
+
*'''Configurable Options:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options Support
+
|style="padding: 10px 0px 0px 30px;"|✔ Email Accounts Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Actual Server Resource Usage Billing [https://www.modulesgarden.com/products/whmcs/advanced-billing/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Email Aliases Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Most Suitable Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Email Forwarders Limit
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 30px;"|✔ Email Quota
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports Zimbra 8.5.0 and Later
+
|style="padding: 0px 0px 10px 30px;"|✔ Allow To Change Password
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.2 Up To PHP 7.4
+
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Metric Billing - Integration: Email Accounts, Email Aliases, Distibution Lists, Domain Aliases, Storage
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Server Sync Tool
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
Line 156: Line 171:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.2 And Later
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V8.4 And Later
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/zimbra#open-source-version Open Source Version]
+
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/ox-whmcs-module OX WHMCS Module.]'''<br />
+
|style="padding: 10px 0px 30px 15px;"|'''The below tutorial will show you how to install and configure OX WHMCS Module successfully.'''<br />
 
We will guide you step by step through the whole installation process.
 
We will guide you step by step through the whole installation process.
 
|}
 
|}
Line 175: Line 187:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory. <br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Upload and extract the files into the main WHMCS directory.'''<br />
−
The content of the package to upload should look like this.
+
Files in your WHMCS directory should look like on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OX_2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_2.png]]
 
|}
 
|}
 +
==Activation of Addon==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install OX WHMCS Module for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''3. Now you have to activate the module in your WHMCS system.'''<br />
−
The file is located in '' 'modules/servers/oxWHMCSModule/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
Log in to your WHMCS admin area. Move to the '' 'System Settings' '' and find '' 'Addon Modules'. ''<br/>
 +
Afterwards, find the '' 'OX WHMCS Module' '' and press the '' 'Activate' '' button.
 
|}
 
|}
 
{|
 
{|
Line 189: Line 203:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In the next step you need to permit access to this module.'''<br />
−
Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → '' 'My Products'. ''
+
To do so, click on the '' 'Configure' '' button, tick the desired admin roles and press '' 'Save Changes'. ''<br />
 
|}
 
|}
 
{|
 
{|
Line 196: Line 210:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. The last step is to set up the  '' 'storage' '' folder as recursively writable.'''<br />
+
|style="padding: 0px 0px 30px 15px;"|'''5.The OX WHMCS Module has been successfully installed!'''<br />
−
This folder is available at '' '/yourWHMCS/modules/servers/oxWHMCSmodule/'. ''
+
Access the addon under '' 'Addons' '' → '' 'OX WHMCS Module'. ''
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:OX_5.png]]
+
 
|}
 
|}
  
 
==Server Configuration==
 
==Server Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''7. Now let's configure a new product. Log in to your WHMCS, proceed to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Servers'. '' '''<br/>
+
|style="padding: 10px 0px 15px 15px;"|'''6. In order to establish a successful connection, you will need to set up the server first.<br/>
−
Afterwards, press '' 'Add New Server'. ''
+
Log in to your WHMCS account, proceed to '' 'System Settings' '' → '' 'Products/Services' '' → '' 'Servers'. '' ''' <br/>  
 +
There, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
Line 212: Line 224:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Next, enter your server name and Open Xchange server hostname or IP address. <br />
+
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your newly created server name and the Open-Xchange server hostname ''(server URL)''.''' <br />
−
Choose '' 'oxWHMCAModule' '' from a dropdown menu and type in your username and password used to log in to OX server.'''<br />
+
Choose '' 'OX WHMCS Module' '' from the '' 'Module' '' dropdown menu and type in your username and password.<br />
−
Select '' 'Secure' '' if you use SSL for connection. Next, test your connection and press '' 'Save Changes' '' if successful.<br />
+
Select '' 'Secure' '' if you use SSL for connection. Next, test your connection and press '' 'Save Changes' '' if that has been successful.<br />
 +
 
 +
'''''Important:''''' <br/>
 +
* 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.<br/> If you do not have one then please contact the [https://www.open-xchange.com/about-ox/contact-us/mail-productivity OX Cloud team]. 
 
|}
 
|}
 
{|
 
{|
Line 220: Line 240:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see the following screen.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|If the connection cannot be established, please ensure that:
 +
*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. <br/>
 +
'''''Note:''' If you use multiple servers, all their IP addresses have to be white-listed.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''8. After you configure your server correctly, you will see the following screen.'''<br />
 
Now you need to create a new group for your server. For that purpose press '' 'Create New Group'. ''
 
Now you need to create a new group for your server. For that purpose press '' 'Create New Group'. ''
 
|}
 
|}
Line 227: Line 254:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Enter name, click on your previously created server, press '' 'Add' '' then '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''9. Enter your desired 'Group Name', click on your previously created server, press '' 'Add' '' then '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
Line 235: Line 262:
 
==Product Configuration==
 
==Product Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'System Settings' '' → '' 'Products/Services'. '''''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''10. In order to create and configure your desired ''Products and Services'', proceed to '' 'System Settings' '' → '' 'Products/Services'. '''''<br />
−
If you do not have a product group, click on '' 'Create a New Group'. '' If you do, simply skip this step.
+
Start by creating a new, dedicated group by pressing the '' 'Create a New Group' '' button.  
 
|}
 
|}
 
{|
 
{|
Line 242: Line 269:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Enter a product group name and press '' 'Create Group'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''11. Next, enter your new product group name and press the '' 'Save Changes' '' button.'''
 
|}
 
|}
 
{|
 
{|
Line 248: Line 275:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''13. When you have a product group, you can create your product and assign it to OX WHMCS group.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''12. You can create your product now and assign it to the previously created product group.'''<br />
−
To create a product click on '' 'Create a New Product'. ''
+
Click on '' 'Create a New Product'. ''
 
|}
 
|}
 
{|
 
{|
Line 255: Line 282:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
+
|style="padding: 0px 0px 15px 15px;"|'''13. Afterwards, choose your product type and product group from the dropdown menu, enter the product name and select the '' 'OX WHMCS Module' '' module.'''<br/> You may '' 'Continue' '' to the next step now.<br/>
 +
'''''Note:''' You may select "Shared Hosting" or "Other" type of the product.''
 
|}
 
|}
 
{|
 
{|
Line 261: Line 289:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''15. Now, go to the '' 'Module Settings' '' section, choose both '' 'oxWHMCSModule' '' and your previously created server group from dropdown menus. '''
+
|style="padding: 0px 0px 15px 15px;"|'''14. In the product details make sure to mark the '' 'Require Domain' '' option.<br/>
 +
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
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_13_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''15. Now, go to the '' 'Module Settings' '' section, and choose both '' 'OX WHMCS Module' '' and your previously created server group from the dropdown menus, then click save changes.'''
 
|}
 
|}
 
{|
 
{|
Line 267: Line 305:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Afterwards, define product settings of the module and press '' 'Save Changes'.'' '''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. After you saved the changes, in this section you can define the limit settings per product.'''
−
* Email Accounts Limit
+
 
−
* Email Aliases Limit
+
* '''Email Accounts Limit''' - the maximum allowed number of email accounts per context is 500
−
* Product Components
+
 
−
* Email Forwarders Limit
+
* '''Email Aliases Limit''' - the maximum allowed number of email aliases per email account is 50
−
* Maximum Quota Per Email Account [MB]
+
 
−
* Maximum Quota Per Context [MB]
+
* '''Email Forwarders Limit''' - note that  only one redirection is allowed per one forwarding alias
−
* Use Only WHMCS Own Domain  
+
 
−
* Allow To Change Password
+
* '''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.<br/>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.<br/> This action is performed on the '' 'context/user' '' level.
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:OX_15.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:OX_15.png]]
 
|}
 
|}
 +
===Freemium Model===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''18. Additionally, you can replace the module static limit with dynamic one in the form of configurable options.<br />
+
|style="padding: 10px 0px 15px 15px;"|1.  Create a free product first. In the module settings tab, choose the "OpenXchange" module. Please remember that the configurable options should not be generated for the free product.<br/> Please see the exemplary module configuration in the screenshot below:
−
Press '' 'Generate Default' '' near '' 'Configurable Options' '' to generate default set of them.<br />
+
|}
−
More about management of configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here].
+
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|2. Then, create the second product which will be the paid one. In the configuration of the paid product, in the module settings tab' fill in the new field called "Free Mailboxes".<br/> In this field, provide the number of the free fields you have set in the configuration of the free product ''(the product described in point 1).''<br/> In this example, the product is configured to allow the user to have only one free account, that is why it is typed "1" in the "Free Mailboxes" field.<br/> This field is very important and it should be filled only in the case of the "Freemium model" products. Please see the exemplary product configuration in the screenshot below:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|3. While still in the paid product configuration in the "Module Settings" tab, create the configurable options.<br/>
 +
Please remember to create the configurable options for each email account type ("Essential", "Productivity", "Security"):
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|4. When you have created all the configurable options, please go back to the free product ''(from point 1)'' configuration page, and go to the "Upgrades" tab.<br/> On the "Packages Upgrades" field, please choose the product you have created and configured in points 2 and 3.<br/> The user also should not be able to buy this product directly:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|5. After the user buys the free product, a new context will be created for them.<br/> In this scenario, the user will be able to create only one account (in exactly the same way he was able to do this before this modification).
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|6. If the user wants to buy more accounts ''("Essential", "Productivity" and "Security" types)'', they will need to upgrade the product to the paid one first:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_6.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|7. When the product is updated the user will be able to see the "Upgrade/Downgrade Options" button:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|8. When the user clicks this button, he will be able to buy more email accounts for each type:
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|9. When he will pay the invoice, the limits will be upgraded. Then he will be able to create a new account.<br/> To choose the type of account there is a drop-down field called "Email Type":
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14_10.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|10. For the "Freemium" model functionality, there is a column in the "Email Accounts" table, called "Email Type".
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OX_14_11.png]]
 +
|}
 +
 
 +
==Additional Configuration==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''17. Additionally, you can replace the module's static limits with dynamic ones in the form of configurable options.'''<br />
 +
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)''<br/>
 +
 
 +
More about the management of configurable options can be found [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_15_1.png]]
 
|}
 
|}
 
{|
 
{|
Line 289: Line 415:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|This is what a properly created and configured product should look like from the administrator site.
+
|style="padding: 0px 0px 20px 15px;"|'''18. After saving the product configuration, please make sure that the module generated custom fields have been successfully created.'''<br/>
 +
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
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZOX_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_16_0.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''19. That's all, you have just successfully created and customized a new product, and now you can check the results.'''<br/> Do this by visiting the client area and looking into '' 'My Products and Services' '' and then clicking on one of your users to observe his/her product/service information.<br/>
 +
This is what your customers should see in your client area.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_16_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Here is the view of a properly created and configured product from the administrator site.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OX_17.png]]
 +
|}
 +
 
 +
==OX WHMCS Module Configuration==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|Before you start your actual work with OX WHMCS Module, move again to 'Addons' → 'OX WHMCS Module'.<br/> The addon allows easy and comfortable access to the Contexts list and the OX panel cloud settings.<br/>
 +
 
 +
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.<br/> This information may be required if you connect to the OX Support Team:
 +
:
 +
* Client Fullname
 +
* Domain
 +
* Context ID
 +
* Context Name
 +
* Current Status
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|The next section, which is '' 'Cloud Settings','' is dedicated to the configuration and branding of the Webmail UI.<br/>
 +
Take a look at the available settings.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_19.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|You may provide a link to a logo image, specify its width and height to adjust its perfect display in the OX panel.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|Under '' 'Theme' '' you will find 8 options related to the main, topbar, link and list items coloring.<br/> Choose the colors of your preference from the palette and enable the theme items customization.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_21.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_21_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|When you have a ready configuration, make sure to save the changes. Now, you can create a new context and check in the OX panel if your design has been applied accurately.<br/>
 +
'''''Important:''' The changes made in the addon are not constant!<br/> 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.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OX_21_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OX_21_3.png]]
 
|}
 
|}
  
 
=Management=
 
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Let's customize your OX WHMCS Module and see what features it has in offer.'''
+
|style="padding: 10px 0px 30px 15px;"|'''OX WHMCS Module allows your customers to manage their Open-Xchange contexts directly in your WHMCS client area.
 +
Read through the next chapters which illustrate all the possibilities of our add-on module.
 
|}
 
|}
 
==Admin Area==
 
==Admin Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|OX WHMCS Module product management site:
+
|style="padding: 10px 0px 15px 15px;"|'''From now on, all your clients who ordered a previously created product will be able to manage their OX accounts via your WHMCS system.'''<br/>
−
* Change configurable options values - available options depend on configuration in '' 'Module Settings' ''
+
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.<br/> The username and password of the service are the context admin credentials, you can log into the panel with these credentials.<br/>
−
 
+
−
* Module Commands:
+
−
** Create
+
−
** Suspend/Unsuspend
+
−
**Terminate
+
−
**Change Package
+
  
 +
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
 
* Service Information
−
 
 
* Context ID
 
* Context ID
−
 
 
* Context Name
 
* Context Name
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OX_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_22.png]]
 
|}
 
|}
  
 
==Client Area==
 
==Client Area==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|In the section below, you will find descriptions of the basic tools used to manage your OX account.<br/>
 +
Analyze them carefully to enjoy extensive and straightforward management capabilities.
 +
|}
 
===Ordering Process===
 
===Ordering Process===
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|Order page view of a product with the configurable options generated:
+
|style="padding: 10px 0px 20px 15px;"|The order page view of a product with the configurable options generated:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OX_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Order page view of a product with static limits setup:
+
|style="padding: 0px 0px 20px 15px;"|The order page view of a product with static limits setup:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OX_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_24.png]]
 
|}
 
|}
  
−
===Management===
+
===Mailbox Management===
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|OX WHMCS Module allows your customers to manage their OX email accounts from your WHMCS client area.<br />
 
|style="padding: 10px 0px 15px 15px;"|OX WHMCS Module allows your customers to manage their OX email accounts from your WHMCS client area.<br />
Line 341: Line 531:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OX_21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_25.png]]
 
|}
 
|}
 
====Email Accounts====
 
====Email Accounts====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Email Accounts section enables full management of accounts associated with your domain.<br/>
+
|style="padding: 10px 0px 15px 15px;"|The '' 'Email Accounts' '' section enables full management of accounts associated with your domain.<br/>
−
You may edit existing accounts with a wide range of options and create new ones within defined limits.
+
You may edit the existing accounts with a wide range of options and create new ones within defined limits.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Press '' 'Add Mailbox' '' to create a new account.<br />
+
|style="padding: 0px 0px 15px 15px;"|Press '' 'Create Account' '' to create a new one.<br/> Fill out the fields to provide any details on the account owner.<br/>
−
Fill out the fields to provide any details on the account owner. Only fields marked with an asterisk are obligatory.<br>
+
'''''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:''' The 'Quota' field is available to select only if Class of service 'Quota Per Account' is used for the product. If the limit has been reached, the client will not be able to create an account.''<br/>
+
−
'''''Important:''' Remember that password is also verified by Zimbra. It is advised to set up default limits in Zimbra panel, within which the password settings can be modified in the module. ''  
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE_23.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_27.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you wish, you can provide more details of a new account in the '' 'Additional Information' '' tab, although it is not required for the account creation.
+
|style="padding: 0px 0px 20px 15px;"|As you can see, the just-created account is now visible on the list of all email accounts. <br/> Use marked buttons to either delete a single account or change its settings.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_17_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_28.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|You can order various operations on a single account using buttons marked on the screen .<br />
+
|style="padding: 0px 0px 15px 15px;"|Apart from changing all the basic data of the selected account, including the password, you may change its status here.<br/> Just toggle the adequate switcher to enable or disable ''(suspend)'' the email account.
−
You are allowed to change the account's status and password, log in directly to a mailbox, edit its details or delete it.<br/>
+
−
Alternatively, you can select multiple accounts and issue command on them as well using buttons above the list of accounts. <br />
+
−
 
+
−
'' '''Note:''' The 'Last Login' column shows only the date of the last '''manual''' login. When using the "Log In To Mailbox" feature, its date is not registered by the API here.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZE2_18.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_29.png]]
 
|}
 
|}
  
 
====Email Aliases====
 
====Email Aliases====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Email Aliases enable you to create and use additional address for the same e-mail account.<br/>
+
|style="padding: 10px 0px 15px 15px;"|'' 'Email Aliases' '' enable you to create and use additional addresses for the same e-mail account.<br/>
−
'''''Note:''' Email aliases are created within the same email domain.''<br/>
+
'''''Note:''' Email aliases are created within the same email domain.''
−
''Read more about '''[[#Domain_Aliases|Domain Aliases]]''' below.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_19_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_31.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Any aliases can be quickly removed through pressing an adequate icon or using mass actions.
+
|style="padding: 0px 0px 20px 15px;"|Any alias can be quickly removed by pressing the trashcan icon next to the address of the Email Alias
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZE2_20.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_32.png]]
 
|}
 
|}
  
 
====Email Forwarders====
 
====Email Forwarders====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In this section you can set up email forwarders and choose from several destination options to adjust mail forwarding perfectly to your needs.
+
|style="padding: 10px 0px 15px 15px;"|In this section you can set up email forwarders and choose from several destination options to adjust mail forwarding perfectly to your needs.  <br/>
 +
Press the '' 'Create Forwarder' '' button, specify the forwarded email and define the destination emails.
 
|}
 
|}
−
 
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OX_xx.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_33.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Press the 'Create Forwarder' button, specify the forwarded email and define the destination emails.
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_33_1.png]]
−
You may add more than one forwarder name and destination emails, use a comma to separate them.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OX_xx.png]]
+
|style="padding: 0px 0px 15px 15px;"| A full list of existing email forwarders is now available for preview.<br/> You may add more forwarders, yet, once the limit is reached, you will have to delete some to be allowed to add new ones.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OX_34.png]]
 
|}
 
|}
  
 
====Email Catch-All====
 
====Email Catch-All====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Catch All Email' is a feature that allows you to forward emails that are sent to the non-existent email address of your domain name.
+
|style="padding: 10px 0px 15px 15px;"|Email Catch-All is a feature that allows you to forward emails that are sent to the non-existent email address of your domain name.<br/>
−
 
+
Once you add an email catch-all, you may delete it using the action buttons.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_27_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_35.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OX_35_1.png]]
 
|}
 
|}
  
 
====MX Records====
 
====MX Records====
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This page enables you to manage your MX records for each of your domains.
+
|style="padding: 10px 0px 15px 15px;"|The below MX records can be used for mail domains that are accessed under the ''appsuite.cloud'' domain either in the EU, US or in Asia. <br/>
−
First, you need to choose the desired domain.
+
'''''Important:''' In the case custom endpoints are used with your own domain, you will get a different set of MX records during onboarding.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OX_xx.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_36.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 15px;"|1.???????????
+
|style="padding: 10px 0px 30px 15px;"|1. The module supports the multilanguage functionality, which means that you can change the language of the addon at:<br/>
−
|}
+
  
−
<!--
+
'' 'yourWHMCS/modules/addons/OXWHMCSModule/lang/english.php' ''<br/>
−
=Update Instructions=
+
−
{|
+
−
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
  
−
'''Important:''' If you migrate the module '''from version 1.X to version 2.X''', the following steps are needed to be performed additionally:<br/>
+
and in the module provisioning part:<br/>
−
# Open any of your Zimbra product configuration and go to the '' 'Modules Settings' '' tab
+
−
# Then connect to your WHMCS server through the terminal and go to the following directory using '''cd''' command in console: <br/><pre>yourWHMCS/modules/servers/zimbraEmail/commands</pre>
+
−
# Now run the migration script using the command below: <br/><pre>php commands.php migration:v1_v2</pre>
+
−
<br/>
+
  
−
Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!<br/>
+
'' 'yourWHMCS/modules/servers/OXWHMCSModule/lang/english.php' ''<br/>
−
To take advantage of it, simply use the '''License Upgrade''' button located on the product's page and a discounted invoice will be generated automatically.<br/>
+
 
 +
If you want to add a new language translation, please add, for example: "deutsch.php" files in the above language directories.
 
|}
 
|}
−
-->
+
 
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 
|}
 
|}

Latest revision as of 16:03, 8 January 2024

Contents

[edit] About OX WHMCS Module

OX WHMCS Module has been developed to allow quick and easy management of the OX account directly from the WHMCS client area.
Establish the connection between your WHMCS and Open-Xchange to get access to email accounts, aliases, forwarders and many more.

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

  • Important: Before using our WHMCS module
✔ To be able to use the OX WHMCS Module, you MUST have an OX Cloud account!
✔ The OX WHMCS Module lets you provision and manage OX Cloud email accounts.
✔ BEFORE you can do this, you need to be registered on OX Cloud, so that we can give you access to the OX Cloud servers.
✔ Without this your OX WHMCS Module will not be able to connect to OX Cloud and will not work!
✔ To register on OX Cloud please click HERE
  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Context
✔ Change Package
✔ View Service Information:
✔ Status
✔ Owner
✔ Module Access
✔ Maximum Context Quota
✔ Context Username And Password
✔ Number And Limits Of:
✔ Email Accounts
✔ Email Aliases
✔ Email Forwarders
✔ Configure Product:
✔ Set Limit Of Email Accounts Per Context
✔ Set Limit Of Email Aliases Per Context
✔ Set Limit Of Email Forwarders Per Context
✔ Select Module Access
✔ Define Maximum Quota Per Email Account [MB]
✔ Define Maximum Quota Per Context [MB]
✔ Toggle Using WHMCS Own Domain Only
✔ Allow Users To Change Password
  • Client Area Features:
✔ View Service Information:
✔ Status
✔ Owner
✔ Module Access
✔ Maximum Context Quota
✔ Context Username And Password
✔ Number And Limits Of:
✔ Email Accounts
✔ Email Aliases
✔ Email Forwarders
✔ Access And Management Of:
✔ Email Accounts
✔ Email Aliases
✔ Email Forwarders
✔ Email Catch-All
✔ View MX Records For Mail Domains
  • Configurable Options:
✔ Email Accounts Limit
✔ Email Aliases Limit
✔ Email Forwarders Limit
✔ Email Quota
✔ Allow To Change Password
  • General Info:
✔ Configurable Options Support
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.4 And Later

[edit] Installation and Configuration

The below tutorial will show you how to install and configure OX WHMCS Module successfully.

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

[edit] Installation

1. Log in to our client area and download the module.
OX 1.png
2. Upload and extract the files into the main WHMCS directory.

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

OX 2.png

[edit] Activation of Addon

3. Now you have to activate the module in your WHMCS system.

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.

OX 3.png
4. In the next step you need to permit access to this module.

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

OX 4.png
5.The OX WHMCS Module has been successfully installed!

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

[edit] Server Configuration

6. In order to establish a successful connection, you will need to set up the server first.

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

OX 6.png
7. Next, enter your newly created server name and the Open-Xchange server hostname (server URL).

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.
OX 7.png
If the connection cannot be established, please ensure that:
  • 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.

8. After you configure your server correctly, you will see the following screen.

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

OX 8.png
9. Enter your desired 'Group Name', click on your previously created server, press 'Add' then 'Save Changes'.
OX 9.png

[edit] Product Configuration

10. In order to create and configure your desired Products and Services, proceed to 'System Settings' → 'Products/Services'.

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

OX 10.png
11. Next, enter your new product group name and press the 'Save Changes' button.
OX 11.png
12. You can create your product now and assign it to the previously created product group.

Click on 'Create a New Product'.

OX 12.png
13. Afterwards, choose your product type and product group from the dropdown menu, enter the product name and select the 'OX WHMCS Module' module.
You may 'Continue' to the next step now.

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

OX 13.png
14. In the product details make sure to mark the 'Require Domain' option.

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
OX 13 1.png
15. Now, go to the 'Module Settings' section, and choose both 'OX WHMCS Module' and your previously created server group from the dropdown menus, then click save changes.
OX 14.png
16. After you saved the changes, in this section you can define the limit settings per product.
  • 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.
OX 15.png

[edit] Freemium Model

1. Create a free product first. In the module settings tab, choose the "OpenXchange" module. Please remember that the configurable options should not be generated for the free product.
Please see the exemplary module configuration in the screenshot below:
OX 14 1.png
2. Then, create the second product which will be the paid one. In the configuration of the paid product, in the module settings tab' fill in the new field called "Free Mailboxes".
In this field, provide the number of the free fields you have set in the configuration of the free product (the product described in point 1).
In this example, the product is configured to allow the user to have only one free account, that is why it is typed "1" in the "Free Mailboxes" field.
This field is very important and it should be filled only in the case of the "Freemium model" products. Please see the exemplary product configuration in the screenshot below:
OX 14 2.png
3. While still in the paid product configuration in the "Module Settings" tab, create the configurable options.

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

OX 14 3.png
4. When you have created all the configurable options, please go back to the free product (from point 1) configuration page, and go to the "Upgrades" tab.
On the "Packages Upgrades" field, please choose the product you have created and configured in points 2 and 3.
The user also should not be able to buy this product directly:
OX 14 4.png
5. After the user buys the free product, a new context will be created for them.
In this scenario, the user will be able to create only one account (in exactly the same way he was able to do this before this modification).
OX 14 5.png
6. If the user wants to buy more accounts ("Essential", "Productivity" and "Security" types), they will need to upgrade the product to the paid one first:
OX 14 6.png
OX 14 7.png
7. When the product is updated the user will be able to see the "Upgrade/Downgrade Options" button:
OX 14 8.png
8. When the user clicks this button, he will be able to buy more email accounts for each type:
OX 14 9.png
9. When he will pay the invoice, the limits will be upgraded. Then he will be able to create a new account.
To choose the type of account there is a drop-down field called "Email Type":
OX 14 10.png
10. For the "Freemium" model functionality, there is a column in the "Email Accounts" table, called "Email Type".
OX 14 11.png

[edit] Additional Configuration

17. Additionally, you can replace the module's static limits with dynamic ones in the form of configurable options.

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.

OX 15 1.png
OX 16.png
18. After saving the product configuration, please make sure that the module generated custom fields have been successfully created.

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
OX 16 0.png
19. That's all, you have just successfully created and customized a new product, and now you can check the results.
Do this by visiting the client area and looking into 'My Products and Services' and then clicking on one of your users to observe his/her product/service information.

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

OX 16 1.png
Here is the view of a properly created and configured product from the administrator site.
OX 17.png

[edit] OX WHMCS Module Configuration

Before you start your actual work with OX WHMCS Module, move again to 'Addons' → 'OX WHMCS Module'.
The addon allows easy and comfortable access to the Contexts list and the OX panel cloud settings.

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
OX 18.png
The next section, which is 'Cloud Settings', is dedicated to the configuration and branding of the Webmail UI.

Take a look at the available settings.

OX 19.png
You may provide a link to a logo image, specify its width and height to adjust its perfect display in the OX panel.
OX 20.png
Under 'Theme' you will find 8 options related to the main, topbar, link and list items coloring.
Choose the colors of your preference from the palette and enable the theme items customization.
OX 21.png
OX 21 1.png
When you have a ready configuration, make sure to save the changes. Now, you can create a new context and check in the OX panel if your design has been applied accurately.

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.

OX 21 2.png
OX 21 3.png

[edit] Management

OX WHMCS Module allows your customers to manage their Open-Xchange contexts directly in your WHMCS client area.

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

[edit] Admin Area

From now on, all your clients who ordered a previously created product will be able to manage their OX accounts via your WHMCS system.

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
OX 22.png

[edit] Client Area

In the section below, you will find descriptions of the basic tools used to manage your OX account.

Analyze them carefully to enjoy extensive and straightforward management capabilities.

[edit] Ordering Process

The order page view of a product with the configurable options generated:
OX 23.png
The order page view of a product with static limits setup:
OX 24.png

[edit] Mailbox Management

OX WHMCS Module allows your customers to manage their OX email accounts from your WHMCS client area.

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

OX 25.png

[edit] Email Accounts

The 'Email Accounts' section enables full management of accounts associated with your domain.

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

OX 26.png
Press 'Create Account' to create a new one.
Fill out the fields to provide any details on the account owner.

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.

OX 27.png
As you can see, the just-created account is now visible on the list of all email accounts.
Use marked buttons to either delete a single account or change its settings.
OX 28.png
Apart from changing all the basic data of the selected account, including the password, you may change its status here.
Just toggle the adequate switcher to enable or disable (suspend) the email account.
OX 29.png

[edit] Email Aliases

'Email Aliases' enable you to create and use additional addresses for the same e-mail account.

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

OX 30.png
OX 31.png
Any alias can be quickly removed by pressing the trashcan icon next to the address of the Email Alias
OX 32.png

[edit] Email Forwarders

In this section you can set up email forwarders and choose from several destination options to adjust mail forwarding perfectly to your needs.

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

OX 33.png
OX 33 1.png
A full list of existing email forwarders is now available for preview.
You may add more forwarders, yet, once the limit is reached, you will have to delete some to be allowed to add new ones.
OX 34.png

[edit] Email Catch-All

Email Catch-All is a feature that allows you to forward emails that are sent to the non-existent email address of your domain name.

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

OX 35.png
OX 35 1.png

[edit] MX Records

The below MX records can be used for mail domains that are accessed under the appsuite.cloud domain either in the EU, US or in Asia.

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

OX 36.png

[edit] Tips

1. The module supports the multilanguage functionality, which means that you can change the language of the addon at:

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

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=OX_WHMCS_Module&oldid=64611"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community