Gregor: /* Admin Area */

2019-11-12T09:18:09Z

‎Admin Area

Gregor: /* Installation */

2019-11-08T10:03:28Z

‎Installation

Gregor: Created page with "
2019-11-07T06:45:32Z

Created page with "<meta name="keywords" content="zimbra email for whmcs, zimbra email configuration, zimbra email management, zimbra email installation, zimbra email common problems, about zimb..."

New page
<meta name="keywords" content="zimbra email for whmcs, zimbra email configuration, zimbra email management, zimbra email installation, zimbra email common problems, about zimbra email, zimbra email documentation, zimbra email faq, zimbra email help, zimbra email guide, modulesgarden zimbra email, zimbra email wiki, zimbra email tutorial, zimbra email tips, zimbra module wiki"></meta>
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Zimbra Email For WHMCS Module."></meta>
=About [https://www.modulesgarden.com/products/whmcs/zimbra-email Zimbra Email For WHMCS]=
{|
|style="padding: 10px 0px 10px 0px;"|'''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, email and domain aliases and quickly move to their webmails. 
Our product is simple in use and offers everything you need to conveniently manage Zimbra accounts.
|}

'''Admin Area:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Create Account
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Account
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Change Package
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Change Password
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Go To Zimbra Webmail
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Use Class Of Service As:
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Fixed Choice
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Allowed Single Choice By Clients
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Allowed Multiple Choices Of Quota Per Account
|}
{|
|style="padding: 0px 0px 0px 45px;"|✔ Custom Settings
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Generate Default Configurable Options
|}
'''Client Area:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Manage Email Accounts
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Manage Email Aliases
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Manage Distribution Lists
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Manage Domain Aliases
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Upgrade / Downgrade Account
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Change Account Password
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Go To Zimbra Webmail
|}
'''Configurable Options:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Email Accounts Limit
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Email Account Size
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Email Aliases Limit
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Distribution List Limit
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Domain Aliases Limit
|}
{|
|style="padding: 0px 0px 10px 30px;"|✔ Class Of Service
|}
'''General Info:'''
{|
|style="padding: 10px 0px 0px 30px;"|✔ Configurable Options Support
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing [https://www.modulesgarden.com/products/whmcs/advanced-billing/features (read more)]
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports Zimbra 8.5.0 and Later
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.3
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
|}
{|
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.6 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=
{|
|style="padding: 10px 0px 30px 15px;"|'''This tutorial will show you how to successfully install and configure [https://www.modulesgarden.com/products/whmcs/zimbra-email Zimbra Email For WHMCS.]''' 
We will guide you step by step through the whole installation process.
|}
==Installation==
{|
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE1.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.''' 
In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later. 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:PHP71_73.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.''' 
The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3. 
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.0 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_73.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.'' '' '''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. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.''' 
The content of the chosen PHP version files to upload should look like this.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_2.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''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'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE3.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''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 our client area → '' 'My Products'. ''
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE4.png]]
|}

==Server Configuration==
{|
|style="padding: 10px 0px 15px 15px;"|'''6. Now let's configure a new product. Log in to your WHMCS, press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. '' ''' 
Afterwards press '' 'Add New Server'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE4_1.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''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 '' 'Go 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. 
Alternatively, custom ports may be set in '' 'Access Hash' '' section.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE5.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''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'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE6.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''9. Enter name, click on your previously created server, press '' 'Add' '' then '' 'Save Changes'. '''''
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE7.png]]
|}

==Product Configuration==
{|
|style="padding: 10px 0px 15px 15px;"|'''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 12.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE7_1.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''11. Enter product group name and press '' 'Create Group'. '''''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE8.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''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 14.''' 
To create a product click on '' 'Create a New Product'. ''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE9.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''13. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE10.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|'''14. Now, go to '' 'Module Settings' '' section, choose both '' 'ZimbraEmail' '' and your previously created server group from dropdown menus. '''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE11.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''15. Afterwards, define settings of the module and press '' 'Save Changes'.'' ''' 
'''''Note 1:''' If you choose 'Use Custom Settings' from 'Class Of Service Name' dropdown menu, you can define your own set of user permissions using sections below.'' 
'''''Note 2:''' If you choose 'Allow clients to choose Class Of Service', additional configurable options will be generated. Clients will be allowed to set Class Of Service while ordering your product.''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE12.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''16. If you select '' 'Allow Clients to choose Class Of Service Quota Per Account' '' in Class Of Service Name, 'Mailbox Accounts' settings will appear.''' 
Define the number of accounts limits for each available size. Your clients will be allowed to order product with limits defined in configurable options and create mailboxes within the defined quota size.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE12_1.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|'''17. 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 [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here].
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE13.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|This is how a properly created and configured product should look like from the administrator site.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE14.png]]
|}

=Management=
{|
|style="padding: 10px 0px 30px 15px;"|'''Let's customize your Zimbra Email For WHMCS and see what features it has in offer.'''
|}
==Admin Area==
{|
|style="padding: 10px 0px 20px 15px;"|Zimbra Email product management site:
#Edit configurable options values - available options depend on configuration in '' 'Module Settings' ''
#Module Commands:
#Create
#Suspend/Unsuspend
#Terminate
#Change Package
#Log In To Webmail
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE14_1.png]]
|}

==Client Area==
===Ordering Process===
{|
|style="padding: 10px 0px 20px 15px;"|Order page view of a product with '' 'Allow clients to choose Class Of Service' '' option selected:
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE15_1.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Order page view of a product with '' 'Allow Clients to choose Class Of Service Quota Per Account' '' option selected:
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE15_2.png]]
|}

===Management===
{|
|style="padding: 10px 0px 15px 15px;"|Zimbra Email allows your customers to manage their zimbra email accounts from your WHMCS client area. 
This is how its management page looks like in the client area. Move to the below sections to learn more details.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE15.png]]
|}
====Email Accounts====
{|
|style="padding: 10px 0px 15px 15px;"|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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE16.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|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.''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE17_1.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|You can order various operations on a single account using the marked on the screen menu. 
Alternatively, you can select multiple accounts and issue any command using buttons above the list of accounts.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE18.png]]
|}

====Email Aliases====
{|
|style="padding: 10px 0px 15px 15px;"|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|Domain Aliases]]''' below.''
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE19.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Any alias can be quickly removed through pressing an adequate icon.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE20.png]]
|}

====Distribution Lists====
{|
|style="padding: 10px 0px 20px 15px;"|Distribution lists enable you to create and manage them without the necessity to log into Zimbra panel.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE21.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|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.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE22.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Remember that in order to enable the distribution list on its creation, you must select option '' 'Can Receive Mail' '' in '' 'Properties' '' section.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE23.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|Assign email aliases if you have any.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE24.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|You may also add/remove owners of the list.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE25.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|As soon as you set the last preferences, press '' 'Save' '' to finally create the distribution list.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE26.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|If you made a mistake while creating a list, you can quickly edit it or remove it completely.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE27.png]]
|}

====Domain Aliases====
{|
|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. 
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:ZE27_1.png]]
|}
{|
|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:ZE27_2.png]]
|}

==Management of Billing==
{|
|style="padding: 10px 0px 20px 15px;"|When you combine Zimbra Email For WHMCS with [https://www.modulesgarden.com/products/whmcs/advanced-billing Advanced Billing For WHMCS], you will be able to set up additional billing options.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE28.png]]
|}
{|
|style="padding: 0px 0px 15px 15px;"|Module allows you to charge your customers basing on the server resources used by them. 
For more detailed information on the configuration please refer to our [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS] documentation.
|}
{|
|style="padding: 0px 0px 20px 25px;"|[[File:ZE28_1.png]]
|}
{|
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display the current server resource usage and their cost and let your customers see it.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE29.png]]
|}

=Tips=
{|
|style="padding: 10px 0px 30px 15px;"|1. Zimbra Email For WHMCS requires SOAP installed on your server.
|}

=Update Instructions=
{|
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''. 
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! 
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. 
|}

=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: 0px 0px 10px 15px;"|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.
|}
{|
|style="padding: 0px 0px 15px 15px;"|
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.
|}
{|
|style="padding: 0px 0px 30px 25px;"|[[File:ZE30.png]]
|}

@@ Line 266: / Line 266: @@
 {|
 |style="padding: 10px 0px 20px 15px;"|Zimbra Email product management site:
 #Edit configurable options values - available options depend on configuration in '' 'Module Settings' ''
 #Module Commands:
@@ Line 272: / Line 273: @@
 #*Terminate
 #*Change Package
 |}
 {|

@@ Line 147: / Line 147: @@
 |}
 {|
-|style="padding: 0px 0px 20px 25px;"|[[File:ZE2_2.png]]
+|style="padding: 0px 0px 20px 25px;"|[[File:ZE2.png]]
 |}
 {|

Zimbra Email 1.X For WHMCS - Revision history

Gregor: /* Admin Area */

Gregor: /* Installation */