Zimbra Email For WHMCS
Line 1: | Line 1: | ||
<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="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> | <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]= | =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.<br /> | |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.<br /> | ||
− | Your clients will be able to conveniently manage mailboxes, aliases and quickly | + | Your clients will be able to conveniently manage mailboxes, email and domain aliases and quickly move to their webmails.<br /> |
Our product is simple in use and offers everything you need to conveniently manage Zimbra accounts. | Our product is simple in use and offers everything you need to conveniently manage Zimbra accounts. | ||
|} | |} | ||
Line 26: | Line 22: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Go To Zimbra Webmail |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Use | + | |style="padding: 0px 0px 0px 30px;"|✔ Use Class Of Service / Custom Settings |
|} | |} | ||
{| | {| | ||
Line 36: | Line 32: | ||
*'''Client Area Functionality:''' | *'''Client Area Functionality:''' | ||
{| | {| | ||
− | |style="padding: 10px 0px 0px 30px;"|✔ Manage Accounts | + | |style="padding: 10px 0px 0px 30px;"|✔ Manage Email Accounts |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Manage Aliases | + | |style="padding: 0px 0px 0px 30px;"|✔ Manage Email Aliases |
|} | |} | ||
{| | {| | ||
Line 45: | Line 41: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Manage Domain Aliases |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Upgrade / Downgrade Account |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 10px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Change Account Password |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Go To Zimbra Webmail | ||
|} | |} | ||
*'''Configurable Options:''' | *'''Configurable Options:''' | ||
{| | {| | ||
− | |style="padding: 10px 0px 0px 30px;"|✔ Accounts | + | |style="padding: 10px 0px 0px 30px;"|✔ Email Accounts Limit |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Account Size | + | |style="padding: 0px 0px 0px 30px;"|✔ Email Account Size |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 0px 30px;"|✔ Aliases Limit | + | |style="padding: 0px 0px 0px 30px;"|✔ Email Aliases Limit |
|} | |} | ||
{| | {| | ||
Line 67: | Line 66: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 10px 30px;"|✔ | + | |style="padding: 0px 0px 0px 30px;"|✔ Domain Aliases Limit |
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 10px 30px;"|✔ Class Of Service | ||
|} | |} | ||
*'''General Info:''' | *'''General Info:''' | ||
Line 75: | Line 77: | ||
{| | {| | ||
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Actual Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)] | |style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Actual Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Specified Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)] | ||
|} | |} | ||
{| | {| | ||
Line 89: | Line 94: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7 | + | |style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.2 And Later |
|} | |} | ||
Line 106: | Line 111: | ||
{| | {| | ||
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/> | |style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/> | ||
− | '' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' | + | '' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.''' |
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ZE2_1.png]] |
|} | |} | ||
{| | {| | ||
Line 116: | Line 121: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 25px;"|[[File: | + | |style="padding: 0px 0px 20px 25px;"|[[File:ZE2_2.png]] |
|} | |} | ||
{| | {| | ||
Line 144: | Line 149: | ||
|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.'''<br /> | |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.'''<br /> | ||
Choose '' 'ZimbraEmail' '' from a dropdown menu and press '' 'Save Changes'. ''<br /> | Choose '' 'ZimbraEmail' '' from a dropdown menu and press '' 'Save Changes'. ''<br /> | ||
− | Keep in mind that value of client area button '' ' | + | 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.<br /> |
− | Here you can also provide other server details like nameservers or maximum number of accounts. | + | Here you can also provide other server details like nameservers or maximum number of accounts.<br/> |
+ | Alternatively, custom ports may be set in Access Hash section. | ||
|} | |} | ||
{| | {| | ||
Line 163: | Line 169: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:ZE7.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:ZE7.png]] | ||
|} | |} | ||
+ | |||
==Product Configuration== | ==Product Configuration== | ||
{| | {| | ||
Line 198: | Line 205: | ||
{| | {| | ||
|style="padding: 0px 0px 15px 15px;"|'''15. Afterwards, define settings of the module and press '' 'Save Changes'.'' '''<br /> | |style="padding: 0px 0px 15px 15px;"|'''15. Afterwards, define settings of the module and press '' 'Save Changes'.'' '''<br /> | ||
− | ''Note 1: If you choose 'Use Custom Settings' from ' | + | '''''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.''<br/> |
− | ''Note 2: If you choose 'Allow clients to choose | + | '''''Note 2:''' If you choose 'Allow clients to choose Class Of Service', additional configurable options will be generated and clients will be allowed to set COS while ordering your product.'' |
|} | |} | ||
{| | {| | ||
Line 241: | Line 248: | ||
{| | {| | ||
|style="padding: 10px 0px 15px 15px;"|Zimbra Email allows your customers to manage their zimbra email accounts from your WHMCS client area.<br /> | |style="padding: 10px 0px 15px 15px;"|Zimbra Email allows your customers to manage their zimbra email accounts from your WHMCS client area.<br /> | ||
− | This is how | + | 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]] | |style="padding: 0px 0px 30px 25px;"|[[File:ZE15.png]] | ||
|} | |} | ||
− | ===Accounts=== | + | ===Email Accounts=== |
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|Accounts | + | |style="padding: 10px 0px 20px 15px;"|Email Accounts section enables full management of accounts associated with your domain.<br/> |
+ | You may edit existing accounts with a wide range of options and create new ones within defined limits. | ||
|} | |} | ||
{| | {| | ||
Line 254: | Line 262: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|Press | + | |style="padding: 0px 0px 15px 15px;"|Press '' 'Add Mailbox' '' to create a new account.<br /> |
− | + | Fill out the fields to provide any details on the account owner. | |
|} | |} | ||
{| | {| | ||
Line 261: | Line 269: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 15px 15px;"|You can order various operations on a single account | + | |style="padding: 0px 0px 15px 15px;"|You can order various operations on a single account using the marked on the screen menu.<br /> |
− | Alternatively, you can | + | Alternatively, you can select multiple accounts and issue any command using buttons above the list of accounts. |
|} | |} | ||
{| | {| | ||
Line 268: | Line 276: | ||
|} | |} | ||
− | ===Aliases=== | + | ===Email Aliases=== |
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|Aliases enable you to use additional address for the same e-mail account. | + | |style="padding: 10px 0px 20px 15px;"|Email Aliases enable you to create and use additional address for the same e-mail account.<br/> |
+ | ''Note: Email aliases are created within the same email domain.''<br/> | ||
+ | ''Read more about '''[[#Domain_Aliases|Domain Aliases]]''' below.'' | ||
|} | |} | ||
{| | {| | ||
Line 290: | Line 300: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Create them in the same way you would do that in Zimbra panel. | + | |style="padding: 0px 0px 20px 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.<br/> |
+ | Proceed with setting detailed options. | ||
|} | |} | ||
{| | {| | ||
|style="padding: 0px 0px 20px 25px;"|[[File:ZE22.png]] | |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 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 25px;"|[[File:ZE24.png]] | ||
+ | |} | ||
+ | {| | ||
+ | |style="padding: 0px 0px 20px 15px;"|You may also add/remove owners of the list. | ||
|} | |} | ||
{| | {| | ||
Line 305: | Line 325: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|As soon as you | + | |style="padding: 0px 0px 20px 15px;"|As soon as you set the last preferences, press '' 'Save' '' to finally create the distribution list. |
|} | |} | ||
{| | {| | ||
Line 316: | Line 336: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:ZE27.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:ZE27.png]] | ||
|} | |} | ||
+ | |||
+ | ===Domain Aliases=== | ||
+ | {| | ||
+ | |style="padding: 10px 0px 20px 15px;"|Domain Aliases option allows you to create more than one domain name that will refer to the same account.<br /> | ||
+ | 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== | ==Management of Billing== | ||
{| | {| | ||
− | |style="padding: 10px 0px 20px 15px;"|When you combine Zimbra Email For WHMCS with [ | + | |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. |
|} | |} | ||
{| | {| | ||
Line 324: | Line 360: | ||
|} | |} | ||
{| | {| | ||
− | |style="padding: 0px 0px 20px 15px;"|Module allows you to charge your customers basing on the server resources used by them. | + | |style="padding: 0px 0px 20px 15px;"|Module allows you to charge your customers basing on the server resources used by them.<br/> |
+ | 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 | + | |style="padding: 0px 0px 30px 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 20px 15px;"|With Advanced Billing module, you can also display the current server resource usage and their cost and let your customers see it. | ||
Line 335: | Line 373: | ||
|style="padding: 0px 0px 30px 25px;"|[[File:ZE29.png]] | |style="padding: 0px 0px 30px 25px;"|[[File:ZE29.png]] | ||
|} | |} | ||
+ | --> | ||
=Tips= | =Tips= |
Revision as of 15:49, 11 July 2018
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, email and domain aliases and quickly move to their webmails. |
- Admin Area Features:
✔ Create Account |
✔ Terminate Account |
✔ Change Package |
✔ Change Password |
✔ Go To Zimbra Webmail |
✔ Use Class Of Service / Custom Settings |
✔ Generate Default Configurable Options |
- Client Area Functionality:
✔ Manage Email Accounts |
✔ Manage Email Aliases |
✔ Manage Distribution Lists |
✔ Manage Domain Aliases |
✔ Upgrade / Downgrade Account |
✔ Change Account Password |
✔ 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 Specified Servers To Products (read more) |
✔ Multi-Language Support |
✔ Supports Zimbra 8.5.0 and Later |
✔ Supports PHP 5.6 Up To PHP 7.2 |
✔ Supports WHMCS Template Six |
✔ Supports WHMCS V7.2 And Later |
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 our client area and download the module. |
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 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2. It does not apply to open source versions. Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'. |
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. |
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'. |
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'. |
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'. |
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'. |
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'. |
9. Enter name, click on your previously created server, press 'Add' then 'Save Changes'. |
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. |
11. Enter product group name and press 'Create Group'. |
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'. |
13. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'. |
14. Now, go to 'Module Settings' section, choose both 'ZimbraEmail' and your previously created server group from dropdown menus. |
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. |
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. |
This is how a properly created and configured product should look like from the administrator site. |
Management
Let's customize your Zimbra Email For WHMCS and see what features it has in offer. |
Admin Area
Zimbra Email product management site:
|
Client Area
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. |
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. |
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. |
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. |
Any alias can be quickly removed through pressing an adequate icon. |
Distribution Lists
Distribution lists enable you to create and manage them without the necessity to log into Zimbra panel. |
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. |
Remember that in order to enable the distribution list on its creation, you must select option 'Can Receive Mail' in 'Properties' section. |
Assign email aliases if you have any. |
You may also add/remove owners of the list. |
As soon as you set the last preferences, press 'Save' to finally create the distribution list. |
If you made a mistake while creating a list, you can quickly edit it or remove it completely. |
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. |
When a domain alias is no longer needed, simply delete it by pressing an icon. |
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. |
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 Advanced Billing For WHMCS documentation. |
Tips
1. Zimbra Email For WHMCS requires SOAP installed on your server. |
Update Instructions
Essential guidance through the process of updating the module is offered 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! |
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. |