Zimbra Email For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About Zimbra Email For WHMCS

Zimbra Email For WHMCS is a module which allows your customers to manage email accounts of your domain directly in WHMCS.

Your clients will be able to conveniently manage mailboxes, aliases and quickly access their webmails.
Our product is simple in use and offers everything you need to conveniently manage Zimbra accounts.

  • Admin Area Features:
✔ Create Account
✔ Terminate Account
✔ Change Package
✔ Change Password
✔ Log In To Webmail
✔ Use COS / Custom Settings
✔ Generate Default Configurable Options
  • Client Area Functionality:
✔ Manage Accounts
✔ Manage Aliases
✔ Manage Distribution Lists
✔ Change Package
✔ Change Password
✔ Log In To Webmail
  • Configurable Options:
✔ Accounts Limits
✔ Account Size
✔ Aliases Limit
✔ Distribution List Limit
✔ COS
  • General Info:
✔ Configurable Options Support
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports Zimbra 8.5.0 and Later
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

This tutorial will show you how to successfully install and configure Zimbra Email For WHMCS.

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

Installation

1. Log in to your client area and download the module.
ZE1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

ZE2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

Xzdfs.png
4. When you install Zimbra Email For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/zimbraEmail/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

ZE3.png
5. In order to configure your license key you have to edit a 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 your client area → 'My Products'.

ZE4.png

Server Configuration

6. Now let's configure a new product. Log in to your WHMCS, press 'Setup' 'Products/Services' 'Servers'.

Afterwards press 'Add New Server'.

ZE4 1.png
7. Next, enter your server name and Zimbra server hostname. Type in your username and password used to log in to Zimbra server.

Choose 'ZimbraEmail' from a dropdown menu and press 'Save Changes'.
Keep in mind that value of client area button 'Login to Webmail' is taken from the 'Hostname' field. If the field is empty, it is taken from an 'IP Address' field.
Here you can also provide other server details like nameservers or maximum number of accounts.

ZE5.png
8. After you configure your server correctly, you will see a following screen.

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

ZE6.png
9. Enter name, click on your previously created server, press 'Add' then 'Save Changes'.
ZE7.png

Product Configuration

10. In order to create and configure product, click on 'Setup' 'Products/Services' 'Products/Services'.

If you do not have a product group, click on 'Create a New Group'. If you do, simply move to step 11.

ZE7 1.png
11. Enter product group name and press 'Create Group'.
ZE8.png
12. 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 13.

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

ZE9.png
13. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
ZE10.png
14. Now, go to 'Module Settings' section, choose both 'ZimbraEmail' and your previously created server group from dropdown menus.
ZE11.png
15. Afterwards, define settings of the module and press 'Save Changes'.

Note 1: If you choose 'Use Custom Settings' from 'COS Name' dropdown menu, you can define your own set of user permissions using sections below.
Note 2: If you choose 'Allow clients to choose COS', additional configurable options will be generated and clients will be allowed to set COS while ordering your product.

ZE12.png
16. Additionally, you can replace modules static limit with dynamic one in 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.

ZE13.png
This is how a properly created and configured product should look like from the administrator site.
ZE14.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. Edit configurable options values - available options depend on configuration in 'Module Settings'
  2. Module Commands:
    • Create
    • Suspend/Unsuspend
    • Terminate
    • Change Package
  3. Log In To Webmail
ZE14 1.png

Client Area

Zimbra Email allows your customers to manage their zimbra email accounts from your WHMCS client area.

This is how it looks like in the client area.

ZE15.png

Accounts

Accounts page enables you to manage existing accounts, edit and create new ones within defined limits.
ZE16.png
Press add to create a new account.

As you can see on the screen below, you can define details of account owner.

ZE17.png
You can order various operations on a single account through dropdown menu.

Alternatively, you can mark multiple accounts and issue any command using buttons above.

ZE18.png

Aliases

Aliases enable you to use additional address for the same e-mail account.
ZE19.png
Any alias can be quickly removed through pressing an adequate icon.
ZE20.png

Distribution Lists

Distribution lists enable you to create and manage them without the necessity to log into Zimbra panel.
ZE21.png
Create them in the same way you would do that in Zimbra panel.
ZE22.png
ZE23.png
ZE24.png
ZE25.png
As soon as you configure the list, press 'Save' to create it.
ZE26.png
If you made a mistake while creating a list, you can quickly edit it or remove it completely.
ZE27.png

Management of Billing

When you combine Zimbra Email For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.
ZE28.png
Module allows you to charge your customers basing on the server resources used by them.
ZE28 1.png
With Advanced Billing module, you can also display the current server resource usage and their cost and let your customers see it.
ZE29.png

Tips

1. Zimbra Email For WHMCS requires SOAP installed on your server.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If you got 'A problem with module occurred. Please contact the administration' error, please validate the correctness of your module license key first and you may also try to reissue key in your ModulesGarden control panel.

3. The error 'Could not connect to host' is connected with SOAP. To fix it, make sure that port default 7071 is open.
Otherwise you can change the communication port by specifying it in 'Access Hash' in the Zimbra server configuration.

ZE30.png
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
Zimbra Email For WHMCS