Personal tools
Namespaces

Variants
Actions

OX WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Installation and Configuration)
(→‎Installation and Configuration)
Line 164: Line 164:
 
=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 Zimbra Email For WHMCS.]'''<br />
+
|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 />
−
We will guide you step by step through the whole installation process.<br/>
+
We will guide you step by step through the whole installation process.
−
 
+
−
'' '''Note:''' If you still use any of the module's previous versions '''prior to v2.X''', [https://www.docs.modulesgarden.com/Zimbra_Email_1.X_For_WHMCS follow these instructions].''
+
 
|}
 
|}
 
==Installation==
 
==Installation==
Line 174: Line 172:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_1.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
+
−
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
+
−
The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.<br/>
+
−
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_74.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/zimbra#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory. <br/>
 
The content of the package to upload should look like this.
 
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_2_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_2.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Zimbra Email For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|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 />
−
The file is located in '' 'modules/servers/zimbraEmail/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
The file is located in '' 'modules/servers/oxWHMCSModule/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_3.png]]
 
|}
 
|}
 
{|
 
{|
Line 213: Line 193:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_4.png]]
 
|}
 
|}
 
{|
 
{|
 
|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 15px 15px;"|'''6. The last step is to set up the  '' 'storage' '' folder as recursively writable.'''<br />
−
This folder is available at '' '/yourWHMCS/modules/servers/zimbraEmail/'. ''
+
This folder is available at '' '/yourWHMCS/modules/servers/oxWHMCSmodule/'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZE2_4_1.png]]
+
|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, press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. '' '''<br/>
+
|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/>
 
Afterwards, press '' 'Add New Server'. ''
 
Afterwards, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_4_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. Next, enter your server name and Zimbra server hostname or IP address. <br />
+
|style="padding: 0px 0px 15px 15px;"|'''8. Next, enter your server name and Open Xchange server hostname or IP address. <br />
−
Choose '' 'ZimbraEmail' '' from a dropdown menu and type in your username and password used to log in to Zimbra server.'''<br />
+
Choose '' 'oxWHMCAModule' '' from a dropdown menu and type in your username and password used to log in to OX server.'''<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 successful.<br />
−
 
−
Keep in mind that value of client area button '' 'Go To Webmail' '' is taken from the '' 'Hostname' '' field. If the field is empty, it is taken from the '' 'IP Address' '' field.<br />
 
−
Here you can also provide other server details like nameservers or maximum number of accounts.<br/>
 
−
Optionally, you may also set custom ports using the '' 'Override with Custom Port' '' field. Otherwise the default '''7071''' will be used.
 
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_7.png]]
 
|}
 
|}
 
{|
 
{|
Line 248: Line 224:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_8.png]]
 
|}
 
|}
 
{|
 
{|
Line 254: Line 230:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZE2_7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OX_9.png]]
 
|}
 
|}
  
 
==Product Configuration==
 
==Product Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. '''''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'System Settings' '' → '' 'Products/Services'. '''''<br />
−
If you do not have a product group, click on '' 'Create a New Group'. '' If you do, simply move to step 12.
+
If you do not have a product group, click on '' 'Create a New Group'. '' If you do, simply skip this step.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_7_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_10.png]]
 
|}
 
|}
 
{|
 
{|
Line 269: Line 245:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_11.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''13. When you have a product group, you can create your product and assign it to Zimbra Email. If you already have a product, go to step 14.'''<br />
+
|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 />
 
To create a product click on '' 'Create a New Product'. ''
 
To create a product click on '' 'Create a New Product'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_12.png]]
 
|}
 
|}
 
{|
 
{|
Line 282: Line 258:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_10.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_13.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''15. Now, go to the '' 'Module Settings' '' section, choose both '' 'ZimbraEmail' '' and your previously created server group from dropdown menus. '''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_11.png]]
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. Afterwards, define settings of the module and press '' 'Save Changes'.'' '''<br />
+
|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. '''
−
'''''Note 1:''' If you choose 'Use Custom Settings' from the 'Class Of Service Name' dropdown menu, you can define your own set of user permissions using sections below.''<br/>
+
−
'''''Note 2:''' If you choose 'Allow clients to choose Class Of Service', additional configurable options can also be generated after saving product changes.<br/> Clients will be allowed to set Class Of Service while ordering your product.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. If you select '' 'Allow Clients to choose Class Of Service Quota Per Account' '' in Class Of Service Name, the new 'Class Of Service For Mailbox Accounts' settings will appear.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. Afterwards, define product settings of the module and press '' 'Save Changes'.'' '''<br />
−
Define the number of the accounts limit for each available size. Your clients will be allowed to order a product with limits defined in configurable options and create mailboxes within the defined quota size.
+
* Email Accounts Limit
−
<br/>
+
* Email Aliases Limit
−
'' '''Note:''' The new 'Configurable Options' based on the above settings will be also available to generate, but they will appear only '''after''' saving product changes first!''
+
* Product Components
 +
* Email Forwarders Limit
 +
* Maximum Quota Per Email Account [MB]
 +
* Maximum Quota Per Context [MB]
 +
* Use Only WHMCS Own Domain
 +
* Allow To Change Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_12_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_15.png]]
 
|}
 
|}
 
{|
 
{|
Line 313: Line 286:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_13.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OX_16.png]]
 
|}
 
|}
 
{|
 
{|
Line 319: Line 292:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:ZE2_14.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:ZOX_17.png]]
 
|}
 
|}
  

Revision as of 12:54, 13 September 2022


Contents

About OX WHMCS Module

OX WHMCS Module ...............
  • Admin Area Features:
✔ Create Account
✔ Terminate Account
✔ Change Package
✔ Change Password
✔ Go To Zimbra Webmail
✔ Define Products Configuration:
✔ Set Zimbra Account Settings
✔ Use Class Of Service As:
✔ Fixed Choice
✔ Allowed Single Choice By Clients
✔ Allowed Multiple Choices Of Quota Per Account
✔ Custom Settings
✔ Select Essential Features
✔ Select General Features
✔ Select Mail Service Features
✔ Select Contact/Calendar/Search/S/MIME Features
✔ Select Access To Client Area Pages
✔ Generate Default Configurable Options
✔ Enable Metric Billing
✔ Log In To Zimbra Administrator Panel On Click
  • Client Area Features:
✔ Manage Email Accounts:
✔ Create/Edit/Delete
✔ View Creation/Last Login Date
✔ View Mailbox Quota
✔ View/Change Mailbox Status
✔ Change Account Password
✔ Log In To Mailbox
✔ Manage Email Aliases
✔ Manage Distribution Lists
✔ Manage Domain Aliases
✔ Upgrade / Downgrade Account
✔ Go To Zimbra Webmail
  • Configurable Options:
✔ Email Accounts Limit
✔ Email Account Size
✔ Email Aliases Limit
✔ Distribution List Limit
✔ Domain Aliases Limit
✔ Class Of Service
  • General Info:
✔ Configurable Options Support
✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing (read more)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products (read more)
✔ Multi-Language Support
✔ Supports Zimbra 8.5.0 and Later
✔ Supports PHP 7.2 Up To PHP 7.4
✔ Supports WHMCS Metric Billing - Integration: Email Accounts, Email Aliases, Distibution Lists, Domain Aliases, Storage
✔ Supports WHMCS Server Sync Tool
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.2 And Later
✔ Easy Module Upgrade To Open Source Version

Installation and Configuration

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

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

Installation

1. Log in to our client area and download the module.
OX 1.png
2. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

OX 2.png
4. When you install OX WHMCS Module for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/servers/oxWHMCSModule/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

OX 3.png
5. In order to configure your license key you have to edit the previously renamed 'license.php' file.

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

OX 4.png
6. The last step is to set up the 'storage' folder as recursively writable.

This folder is available at '/yourWHMCS/modules/servers/oxWHMCSmodule/'.

File:OX 5.png

Server Configuration

7. Now let's configure a new product. Log in to your WHMCS, proceed to 'System Settings' → 'Products/Services' → 'Servers'.

Afterwards, press 'Add New Server'.

OX 6.png
8. Next, enter your server name and Open Xchange server hostname or IP address.

Choose 'oxWHMCAModule' from a dropdown menu and type in your username and password used to log in to OX server.
 Select 'Secure' if you use SSL for connection. Next, test your connection and press 'Save Changes' if successful.

OX 7.png
9. 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
10. Enter name, click on your previously created server, press 'Add' then 'Save Changes'.
OX 9.png

Product Configuration

11. In order to create and configure product, click on 'System Settings' → 'Products/Services'.

If you do not have a product group, click on 'Create a New Group'. If you do, simply skip this step.

OX 10.png
12. Enter a product group name and press 'Create Group'.
OX 11.png
13. When you have a product group, you can create your product and assign it to OX WHMCS group.

To create a product click on 'Create a New Product'.

OX 12.png
14. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
OX 13.png
15. Now, go to the 'Module Settings' section, choose both 'oxWHMCSModule' and your previously created server group from dropdown menus.
OX 14.png
16. Afterwards, define product settings of the module and press 'Save Changes'.
  • Email Accounts Limit
  • Email Aliases Limit
  • Product Components
  • Email Forwarders Limit
  • Maximum Quota Per Email Account [MB]
  • Maximum Quota Per Context [MB]
  • Use Only WHMCS Own Domain
  • Allow To Change Password
OX 15.png
18. Additionally, you can replace the module static limit with dynamic one in the form of configurable options.

Press 'Generate Default' near 'Configurable Options' to generate default set of them.
More about management of configurable options can be found here.

OX 16.png
This is what a properly created and configured product should look like from the administrator site.
File:ZOX 17.png

Management

Let's customize your Zimbra Email For WHMCS and see what features it has in offer.

Admin Area

Zimbra Email product management site:
  1. Go To Webmail
  2. Edit configurable options values - available options depend on configuration in 'Module Settings'
  3. Module Commands:
    • Create
    • Suspend/Unsuspend
    • Terminate
    • Change Package
ZE2 14 1.png

Client Area

Ordering Process

Order page view of a product with the 'Allow clients to choose Class Of Service' option selected:
ZE2 15 1.png
Order page view of a product with the 'Allow Clients to choose Class Of Service Quota Per Account' option selected:
ZE2 15 2.png

Management

Zimbra Email allows your customers to manage their Zimbra 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.

ZE2 15.png

Email Accounts

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

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

ZE2 16.png
Press 'Add Mailbox' to create a new account.

Fill out the fields to provide any details on the account owner. Only fields marked with an asterisk are obligatory.
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.
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.

ZE2 17 1.png
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.
ZE2 17 2.png
You can order various operations on a single account using buttons marked on the screen .

You are allowed to change the account's status and password, log in directly to a mailbox, edit its details or delete it.
Alternatively, you can select multiple accounts and issue command on them as well using buttons above the list of accounts.

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.

ZE2 18.png

Email Aliases

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

Note: Email aliases are created within the same email domain.
Read more about Domain Aliases below.

ZE2 19.png
ZE2 19 1.png
Any aliases can be quickly removed through pressing an adequate icon or using mass actions.
ZE2 20.png

Distribution Lists

Distribution lists enable you to create and manage them without the necessity to log in to Zimbra panel.
ZE2 21.png
Create them in the same way you would do that in Zimbra panel. Start with entering an email address, then move to assigning members to the list.

Proceed with setting detailed options.

ZE2 22.png
Remember that in order to enable the distribution list on its creation, you must select option 'Can Receive Mail' in the 'Properties' section.
ZE2 23.png
Assign email aliases if you have any.
ZE2 24.png
You may also add/remove owners of the list.
ZE2 25.png
As soon as you set the last preferences, press 'Confirm' to finally create the distribution list.
ZE2 26.png
If you made a mistake while creating a list, you can quickly edit it or remove it completely.
ZE2 27.png

Domain Aliases

Domain Aliases option allows you to create more than one domain name that will refer to the same account.

Add a new domain alias, like on the below screen, and no matter which address used, emails will be delivered to the same mailbox.

ZE2 27 1.png
ZE2 27 2.png
When a domain alias is no longer needed, simply delete it by pressing an icon.
ZE2 27 3.png


Tips

1.???????????

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=60307"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community