Personal tools
Namespaces

Variants
Actions

OX WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Management)
(→‎About OX WHMCS Module)
Line 5: Line 5:
 
=About [https://www.modulesgarden.com/products/whmcs/ox_whmcs_module 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''' has been developed to allow quick and easy management of the OX account directly from the WHMCS client area. <br/> Establish the connection to get access to email accounts, aliases forwarders and many more. <br/>
+
|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 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 in the Open-Xchange panel.
+
Use the addon module to master the theme branding on your account directly in in the panel.
 
|}  
 
|}  
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Account
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Context
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Account
+
 
|}
 
|}
 
{|
 
{|
Line 19: Line 16:
 
|}
 
|}
 
{|
 
{|
−
|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 30px;"|✔ Owner
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Set Zimbra Account Settings
+
|style="padding: 0px 0px 0px 30px;"|✔ 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 7.2 Up To PHP 7.4
 
|}
 
|}
 
{|
 
{|
Line 157: Line 154:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.2 And Later
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V8.2 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]
+
 
|}
 
|}
  

Revision as of 11:46, 20 September 2022


Contents

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 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 in the panel.

  • 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 7.2 Up To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.2 And Later

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 yet, click on 'Create a New Group' button.

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

click on 'Create a New Product'.

OX 12.png
14. Afterwards, choose your product type and product group from dropdown menu, enter the product name and select 'oxWHMCSModule' module.
You may 'Continue' to the next step now.
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. 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 - select the combination of modules and addons the client will have access to
  • Maximum Quota Per Email Account [MB] - set the maximum quota for single email account [MB]
  • Maximum Quota Per Context [MB] - the maximum quota value cannot be lower than 10 000 MB (10 GB)
  • Use Only WHMCS Own Domain - only users with with an active domain on WHMCS will be able to manage this product
  • Allow To Change Password - the option to change the password in the client area will be unlocked for all users
OX 15.png
18. Additionally, you can replace the module static limit with dynamic one in the form of configurable options.

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

OX 16.png
19. That's all, you have just correctly created and customized a new product, now you can check the results.

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

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

Management

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

Read through the next chapters which illustrate all the possibilities of our addon module.

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.

The screen below presents a summary view of the ordered product in 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 configuration in 'Module Settings'
  • Service Information
  • Context ID
  • Context Name
OX 18.png

Client Area

In the below section, you will find basic tools used to manage your OX account shown and described.
Analyze them carefully to enjoy full and easy management.

Ordering Process

Order page view of a product with the configurable options generated:
OX 19.png
Order page view of a product with static limits setup:
OX 20.png

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

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

OX 23.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.
File:OX 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.

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

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

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.
File:OX xx.png
Press the 'Create Forwarder' button, specify the forwarded email and define the destination emails.

You may add more than one forwarder name and destination emails, use a comma to separate them.

File:OX xx.png

Email Catch-All

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.
File:OX xxx.png

MX Records

This page enables you to manage your MX records for each of your domains.

First, you need to choose the desired domain.

File:OX xx.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=60366"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community