OX WHMCS Module
From ModulesGarden Wiki
(Difference between revisions)
|
|
Line 398: |
Line 398: |
| ====Email Forwarders==== | | ====Email Forwarders==== |
| {| | | {| |
− | |style="padding: 10px 0px 15px 15px;"|Domain Aliases option allows you to create more than one domain name that will refer to the same account.<br /> | + | |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. |
− | Add a new domain alias, like on the below screen, and no matter which address used, emails will be delivered to the same mailbox.
| + | |
| |} | | |} |
| + | |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:ZE2_27_1.png]] | + | |style="padding: 0px 0px 20px 25px;"|[[File:OX_xx.png]] |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 25px;"|[[File:ZE2_27_2.png]] | + | |style="padding: 0px 0px 20px 15px;"|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. |
| |} | | |} |
| {| | | {| |
− | |style="padding: 0px 0px 20px 15px;"|When a domain alias is no longer needed, simply delete it by pressing an icon.
| + | |style="padding: 0px 0px 30px 25px;"|[[File:OX_xx.png]] |
− | |}
| + | |
− | {|
| + | |
− | |style="padding: 0px 0px 30px 25px;"|[[File:ZE2_27_3.png]] | + | |
| |} | | |} |
| | | |
Revision as of 13:47, 13 September 2022
OX WHMCS Module ...............
|
✔ Define Products Configuration:
|
✔ Set Zimbra Account Settings
|
✔ Use Class Of Service As:
|
✔ Allowed Single Choice By Clients
|
✔ Allowed Multiple Choices Of Quota Per Account
|
✔ 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
|
✔ Log In To Zimbra Administrator Panel On Click
|
✔ View Creation/Last Login Date
|
✔ View/Change Mailbox Status
|
✔ Change Account Password
|
✔ Manage Distribution Lists
|
✔ Upgrade / Downgrade Account
|
✔ Distribution List Limit
|
✔ 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)
|
✔ 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
|
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.
|
2. Extract the package and upload its content into the main WHMCS directory.
The content of the package to upload should look like this.
|
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'.
|
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'.
|
6. The last step is to set up the 'storage' folder as recursively writable.
This folder is available at '/yourWHMCS/modules/servers/oxWHMCSmodule/'.
|
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'.
|
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.
|
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'.
|
10. Enter name, click on your previously created server, press 'Add' then 'Save Changes'.
|
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.
|
12. Enter a product group name and press 'Create Group'.
|
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'.
|
14. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
|
15. Now, go to the 'Module Settings' section, choose both 'oxWHMCSModule' and your previously created server group from dropdown menus.
|
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
|
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.
|
This is what a properly created and configured product should look like from the administrator site.
|
Management
Let's customize your OX WHMCS Module and see what features it has in offer.
|
Admin Area
OX WHMCS Module product management site:
- Change configurable options values - available options depend on configuration in 'Module Settings'
- Module Commands:
- Create
- Suspend/Unsuspend
- Terminate
- Change Package
|
Client Area
Ordering Process
Order page view of a product with the configurable options generated:
|
Order page view of a product with static limits setup:
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
Any aliases can be quickly removed through pressing an adequate icon or using mass actions.
|
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.
You may add more than one forwarder name and destination emails, use a comma to separate them.
|
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.
|
MX Records
This page enables you to manage your MX records for each of your domains.
First, you need to choose the desired domain.
|
Tips
Common Problems
1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
|