Personal tools
Namespaces

Variants
Actions

Rackspace Email Extended For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Common Problems)
(→‎About Rackspace Email Extended For WHMCS)
 
(149 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
<meta name="keywords" content="rackspace email extended for whmcs, rackspace email extended configuration, rackspace email extended management, rackspace email extended guide, modulesgarden rackspace email extended, rackspace email extended common problems, about rackspace email extended, rackspace email extended documentation, rackspace email extended faq, rackspace email extended wiki, rackspace email extended tutorial, rackspace email extended tips, rackspace module wiki, rackspace email extended installation, rackspace email extended help"></meta>
 
<meta name="keywords" content="rackspace email extended for whmcs, rackspace email extended configuration, rackspace email extended management, rackspace email extended guide, modulesgarden rackspace email extended, rackspace email extended common problems, about rackspace email extended, rackspace email extended documentation, rackspace email extended faq, rackspace email extended wiki, rackspace email extended tutorial, rackspace email extended tips, rackspace module wiki, rackspace email extended installation, rackspace email extended help"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Rackspace Email For WHMCS Module."></meta>
+
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Rackspace Email Extended For WHMCS Module."></meta>
  
−
=About Rackspace Email Extended For WHMCS=
+
=About [https://www.modulesgarden.com/products/whmcs/rackspace-email-extended Rackspace Email Extended For WHMCS]=
 
{|
 
{|
 
|style="padding: 10px 0px 10px 0px;"|'''Rackspace Email Extended for WHMCS''' is a fully featured addon module that allows you to resell and manage email accounts entirely from your WHMCS system!<br />
 
|style="padding: 10px 0px 10px 0px;"|'''Rackspace Email Extended for WHMCS''' is a fully featured addon module that allows you to resell and manage email accounts entirely from your WHMCS system!<br />
Line 8: Line 8:
 
As an administrator, you will be able to customize Rackspace products to meet the needs of your customers.
 
As an administrator, you will be able to customize Rackspace products to meet the needs of your customers.
 
|}
 
|}
−
*'''Rackspace Email Extended Features - Exchange:'''
+
<!-- fixed -->
 +
 
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Manage Mailboxes
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Terminate Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Spam
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Package And Account Password
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Aliases
+
|style="padding: 0px 0px 0px 30px;"|✔ Define Service Type Per Product
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Mobile Sync
+
|style="padding: 0px 0px 10px 30px;"|✔ Configure Resource Limits Per Product
 
|}
 
|}
 +
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Storage Notification
+
|style="padding: 10px 0px 0px 30px;"|✔ Email Hosting - Remote Access And Management Of:
 
|}
 
|}
−
*'''Rackspace Email Extended Features - Email:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Manage Mailboxes
+
|style="padding: 0px 0px 0px 45px;"|✔ Mailboxes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Spam
+
|style="padding: 0px 0px 0px 45px;"|✔ Spam
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Manage Contacts
+
|style="padding: 0px 0px 0px 45px;"|✔ Aliases
 
|}
 
|}
−
*'''General Features:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create Account
+
|style="padding: 0px 0px 0px 45px;"|✔ Mobile Sync
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Terminate Account
+
|style="padding: 0px 0px 0px 45px;"|✔ Storage Notification
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Package
+
|style="padding: 0px 0px 0px 30px;"|✔ Microsoft Exchange - Remote Access And Management Of:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Change Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Mailboxes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Flexible Settings With Configurable Options!
+
|style="padding: 0px 0px 0px 45px;"|✔ Spam
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ WHMCS V4 and V5 Compatibility
+
|style="padding: 0px 0px 10px 45px;"|✔ Contacts
 
|}
 
|}
  
−
=Installation=
+
*'''Available Configurable Options'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to successfully install and set up Rackspace Email Extended For WHMCS.'''<br />
+
|style="padding: 10px 0px 0px 30px;"|✔ Max Mailboxes
−
We will guide you step by step through the whole installation process.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your clientarea and download Rackspace Email Extended.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Mailbox Size
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE11.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Extra Storage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''2. Upload and extract the module into the main WHMCS directory.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Active Sync Licenses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Files in your WHMCS directory should look like this.
+
|style="padding: 0px 0px 0px 30px;"|✔ BlackBerry Licenses
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE12.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Exchange Max Mailboxes
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''3. When you install Rackspace Email Extended for the first time you have to rename '' 'license_RENAME.php' '' file.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Exchange Extra Storage
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|File is located at '' 'modules/servers/rackspace_email_extended/license_RENAME.php' ''. Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
+
|style="padding: 0px 0px 10px 30px;"|✔ Email Archiving
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE3.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/advanced-billing#features Advanced Billing For WHMCS] - Actual Server Resource Usage Billing
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''4. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/server-allocator Server Allocator For WHMCS] - Automatic Assignment Of Most Suitable Servers To Products
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Enter your licence key between quotation marks as presented on the following screen. You can find your license key at your clientarea → '' 'My Products' ''.
+
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE4.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 7.4
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''5. It's time to set up a server and product.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|To do so log in into your WHMCS. Now press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' (or '' 'Setup' '' → '' 'Servers' '' in WHMCS v4.x).
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.11 Back To WHMCS V8.6
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards press '' 'Add New Server' ''.
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP8.png]]
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/rackspace-email-extended#open-source-version Open Source Version]
 
|}
 
|}
 +
 +
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''6. To proceed you will need to obtain your Rackspace API keys. To do so log in to your Rackspace Account.'''
+
|style="padding: 10px 0px 30px 0px;"|'''In this tutorial we will show you how to successfully install and set up [https://www.modulesgarden.com/products/whmcs/rackspace-email-extended Rackspace Email Extended For WHMCS.]'''<br />
 +
We will guide you step by step through the whole installation process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Afterwards in '' 'My Account' '' section press '' 'Generate API Keys' ''.
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RE5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. Next press '' 'Generate New Keys' '' as shown on the screen below.'''
+
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
 +
In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.<br/> <!--  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:RE6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP71_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''8. Copy both '' 'User Key' '' and '' 'Secret Key' '', and paste them into (1.)'' 'Username' '' and (2.)'' 'Password' '' fields during server configuration in your WHMCS system.
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
 +
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.<br/>
 +
'''''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 15px;"|Afterwards, choose '' 'Rackspace_email_extended' '' from a '' 'Type' '' dropdown menu and enter your admin area webmail URL to the (3.)'' 'Hostname' '' field.<br >
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_73.png]]
−
'''Enter your whitelabeled system URL into (4.)'' 'IP Address' '' field <span style="color: #ff0000;">ONLY IF</span> you are Rackspace reseller.'''<br />
+
−
In other case leave this field blank. Remember to save the changes.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE5.png]]
+
|style="padding: 0px 0px 10px 15px;"|<!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/rackspace-email-extended#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''
+
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory.
 +
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|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:dstfret.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP10.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Rackspace Email Extended For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 +
File is located in '' 'modules/servers/rackspaceEmailExtended/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes' ''.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP11.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.'''<br />
 +
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 0px 15px;"|'''11. In order to create and configure product click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_4.png]]
 
|}
 
|}
 +
 +
==Server Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|If you don't have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 13.
+
|style="padding: 0px 0px 15px 15px;"|'''6. Set up a new server and a product.'''<br />
 +
To do so, log in to your WHMCS. Move to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers'. ''<br />
 +
Afterwards, press '' 'Add New Server'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:CP12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''12. Enter product group name and press '' 'Create Group' ''.'''
+
|style="padding: 0px 0px 15px 15px;"|'''7. To proceed, you will need to obtain your Rackspace API keys. To do so, log in to your reseller '' 'Rackspace Account'.'' '''<br/>Find '' 'Manage Admins' '' in the Common Actions box on the top right corner. You will be moved to the '' 'Administartors' '' setion.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE2_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 15px;"|'''13. When you have a product group, you can create your product and assign it with Rackspace Email Extended. If you already have a product, go to step 15.'''
+
|style="padding: 0px 0px 20px 15px;"|'''8. When you are on the ' ''Administrators' '' page, click the '' 'API KEYS'.'' You will find it on the left, in navigation menu.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|To create a product click on '' 'Create a New Product' ''.
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE2_7.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE8.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''9. A popup with '' 'Your API Key' '' will appear. Copy your '' 'User' '' and '' 'Seccret Keys','' you will need them in the next part of the module configuration.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press '' 'Continue' ''.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE2_8.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE9.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''10. Enter your server name and choose '' 'RackspaceEmailExtended' '' from a '' 'Type' '' dropdown menu.<br />
 +
Paste the previously copied'' 'User Key' '' and '' 'Secret Key' '' into '' 'Username' '' and '' 'Password' '' fields.<br />
 +
Enter the '' 'Hostname' ''  address to your Webmail server - it is required for the '' 'Login to Webmail' '' function in the client area.<br />
 +
Afterwards, press '' 'Save Changes'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''15. Now go to '' 'Module Settings' '' section, choose both '' 'Rackspace_email_extended' '' and your previously created server group from a dropdown menus.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_8.png]]
−
Decide which of the three service types you would like to use and choose it from a dropdown menu.<br />
+
−
Afterwards enter your desired values in configuration fields and press '' 'Save Changes' ''.<br />
+
−
Please note that values don't need to be constant. You can use Configurable Options to adjust the values. You can obtain more information about Configuration Options [http://docs.modulesgarden.com/index.php?title=Rackspace_Email_For_WHMCS#Configurable_Options here]
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE6.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''11. After you configure your server correctly, you will see a following screen.'''<br />
 +
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''16. In the last step you need to create new client field. For this purpose go to '' 'Setup' '' → '' 'Custom Client Fields' ''.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_9.png]]
−
Enter '' 'EmailCustomerID' '' at field name, tick '' 'Admin only'' ' and press '' 'Save Changes' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RE9.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''12. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''Well done! You have just successfully set up your first product with Rackspace Email Extended.'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_10.png]]
−
Correctly installed module will present similarly to the one presented on the screen below.
+
 
|}
 
|}
 +
 +
==Product Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE10.png]]
+
|style="padding: 10px 0px 15px 15px;"|'''12. In order to create and configure product, move to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. '''''<br />
 +
If you do not have a product group, '' 'Create a New Group'. '' If you do, simply go to step 13.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''Let's configure your freshly installed module.
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_11.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''13. Enter product group name and press '' 'Save Changes'. '''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''14. When you have a product group, you can create your product and assign it to Rackspace Email Extended. If you already have a product, go to step 15.'''<br />
 +
To create a product click on '' 'Create a New Product'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''15. 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:REE_14.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''16. Now, go to '' 'Module Settings' '' section, choose both '' 'RackspaceEmailExtended' '' and your previously created server group from dropdown menus.'''<br />
 +
Decide which of the service types you would like to use and choose it from a dropdown menu.<br />
 +
Afterwards, enter desired values in configuration fields and press '' 'Save Changes'.''<br />
 +
Please note that values do not need to be constant. You can use configurable options to adjust the values.<br />
 +
Obtain more information about configurable options [https://www.docs.modulesgarden.com/Rackspace_Email_Extended_For_WHMCS#Configuration_of_Orders here].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''17. In the last step you need to create a new client custom field.'''<br />
 +
To do so, proceed to '' 'System Settings' '' → '' 'Custom Fields/Custom Client Fields'.''<br />
 +
Fill in '' 'EmailCustomerID' '' into field name, tick '' 'Admin Only'' ' and press '' 'Save Changes'. ''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_15_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''18. Important! Our module does not automatically download '' 'EmailCustomerID' '' for the proper Rackspace customer.'''<br />
 +
To prevent duplicating accounts on Rackspace side you have to manually fill in '' 'EmailCustomerID' '' with appropriate value before running '' 'Create' '' function.<br />
 +
You can find more about it [https://www.docs.modulesgarden.com/Rackspace_Email_Extended_For_WHMCS#Management_of_Existing_Account here].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:REE_37.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''Good job! You have just correctly set up your first product with Rackspace Email.'''<br />
 +
Product after a successful activation presents similarly to the one presented on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:REE_16_1.png]]
 
|}
 
|}
  
−
=Configuration and Management=
+
=Management=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|'''In the following sections we will try to present all the possibilities of Rackspace Email Extended For WHMCS features.'''
 +
|}
 
==Configuration of Orders==
 
==Configuration of Orders==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''Rackspace Email Extended allows you to create a very flexible orders dependant on your customers needs. Let's create such an order.'''
+
|style="padding: 10px 0px 15px 15px;"|Rackspace Email Extended For WHMCS allows you to offer a product tailored to customers needs. Let's create such an order.
 
For this purpose you need to create at least one configurable option. In this guide we will create a few more to present you the possibilities of our module.<br />
 
For this purpose you need to create at least one configurable option. In this guide we will create a few more to present you the possibilities of our module.<br />
−
'''If you are not yet familiar with configurable options you can read more about it [http://docs.modulesgarden.com/index.php?title=Rackspace_Email_For_WHMCS#Configurable_Options here]'''<br />
+
'''If you are not familiar with configurable options yet, you can read more about them [https://www.docs.modulesgarden.com/General#How_To_Use_Configurable_Options here]'''<br />
−
These are configurable options fields created by us, connected with our rackspace email extended product.
+
These are configurable options fields created by us, connected with our Rackspace Email Extended product.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEC1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_17.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''In the next step, in your product module settings you need to enter particular configurable options fields into particular fields as shown on the screen below.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|Proceed to your product '' 'Module Settings' '' tab now.<br />
−
Afterwards press '' 'Save Changes' ''.
+
Here, you need to fill in the marked fields with desired configurable option names as shown on the screen below.<br />
 +
Afterwards, press '' 'Save Changes'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEC2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_18.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''If you done this action correctly you will see a similar screen while trying to add new order in your WHMCS system.'''<br />  
+
|style="padding: 0px 0px 15px 15px;"|If you fill out '' 'Module Settings' '' with correct names, during order made from the admin area, you should see similar screen to the one below.<br />
−
If it doesn't work for you, please return to the previous steps, read them carefully once again and try to correct your mistakes.'''
+
Otherwise, ensure that configurable option names are filled out correctly.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEC3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_19.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''You can make an additional test. You can try to edit the order and see whether configurable options are working as they should.'''
+
|style="padding: 0px 0px 15px 15px;"|Let's see how it looks like from the perspective of your customers.<br />
 +
As you can see, owing to configurable options, they are now able to define mailbox size, amount of mailboxes, extra storage and many other options.<br />
 +
This makes each order perfectly suited to your customers needs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEC4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_20.png]]
 
|}
 
|}
 +
 +
==Client Area==
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''Let's see how it would look like from the perspective of your customers'''<br />
+
|style="padding: 10px 0px 20px 15px;"|Read through the below sections to see how Rackspace Email Extended For WHMCS is designed to work in the client area.
−
As you can see when they are placing new order they can adjust mailbox size, amount of mailboxes, extra storage and many other options.<br />
+
−
This makes each order can be perfectly matched to your customers needs.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEC5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_21.png]]
 
|}
 
|}
−
 
+
===Email Hosting===
−
==Upgrading Product==
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''You can update Rackspace Email to Rackspace Email Extended with ease.'''<br />
+
|style="padding: 10px 0px 20px 15px;"|Email Hosting is an internet hosting service that manages electronic messages through an email server.
−
For this purpose in your WHMCS system go to '' 'Product/Services' '' → '' 'Upgrades' '' section related with your existing Rackspace Email product.<br />
+
−
Afterwards select already existing Rackspace Email Extended product/s (in our case it was '' 'Email Accounts - Email Advanced' '').<br />
+
−
Tick the box below to allow upgrading/downgrading of configurable options. Next press '' 'Save Changes' ''.
+
 
|}
 
|}
 +
====Mailboxes====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU1.png]]
+
|style="padding: 10px 0px 20px 15px;"|Let's start with some basic functionality of the module, that is the mailboxes management.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''Let's start to upgrade the module. From clientarea select your Rackspace Email product (in our case it was '' 'A Fine Product' '').'''<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_22.png]]
−
In '' 'Management Actions'' choose '' 'Upgrade/Downgrade' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU4.png]]
+
|style="padding: 0px 0px 20px 15px;"|Creating a mailbox is quick and easy.<br />
 +
The first step is filling out '' 'General' '' form, where you can define user details, password and mailbox size.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''You will see a screen as shown below. Locate your Rackspace Email Extended product and press '' 'Choose Product' ''.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU2.png]]
+
|style="padding: 0px 0px 20px 15px;"|Proceed to '' 'Contact Info' '' tab and fill it out with its user contact information.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''That's it. Choose the payment method, press '' 'Click to Continue' '' button and voila!'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_24.png]]
 
|}
 
|}
 +
 +
====Spam====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU3.png]]
+
|style="padding: 10px 0px 20px 15px;"|Spam filtering page allows you to set your preferences, edit blacklists and safelists.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''Now it's time to see what our module is capable of.'''
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_25.png]]
 +
|}
 +
====Aliases====
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|With our module you can create aliases and assign chosen mailboxes to them.<br />
 +
To do so, press '' 'Add Alias', '' add email from '' 'Members inside this Domain' '' and press '' 'Save'.'' '''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_26.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|On the list of aliases you can find information about the amount of mailboxes in each alias.
 
|}
 
|}
−
 
−
==Management of Email Hosting==
 
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Email Hosting is an internet hosting service that manages electronic messages through an email server.'''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_27.png]]
−
'''We will present you the possibilities of Rackspace Email Extended within the scope of email hositng.'''
+
 
|}
 
|}
  
−
==Management of Mailboxes==
+
====Mobile Sync====
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''Basic function of Rackspace Email Extended is to create new email accounts.'''
+
|style="padding: 10px 0px 20px 15px;"|Mobile Sync allows your customers to synchronize their emails, calendars and contacts with their iPhones, Androids or Windows Mobile devices.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_28.png]]
 
|}
 
|}
 +
====Storage Notification====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''Whole operation is very easy and takes less than 1 minute. Firstly you need to provide information such a user name, password and mailbox size.'''
+
|style="padding: 10px 0px 20px 15px;"|This page allows you to set up notifications sent to your customers when mailbox reaches certain amount of capacity.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_29.png]]
 
|}
 
|}
 +
 +
===Microsoft Exchange===
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''Secondly you can add an additional contact information which will help you to recognize particular email account.'''
+
|style="padding: 10px 0px 30px 15px;"|Exchange Hosting is a server system, whereby software enables sending and receiving email messages and other types of interactive communications.<br />
 +
It enables sharing of business critical information online or through enabled wireless devices.<br />
 +
Let's see how our addon can help you manage your Microsoft Exchange services.
 
|}
 
|}
 +
====Mailboxes====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM3.png]]
+
|style="padding: 10px 0px 20px 15px;"|As in Email Hosting you can create new email accounts and manage them.
 
|}
 
|}
−
==Management of Spam==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''Managing your spam takes no more time than creating new email account. Here you can easily set your preferences, edit blacklists and safelists.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM13.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_31.png]]
 
|}
 
|}
−
==Management of Aliases==
+
====Spam====
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''With our addon module you can create aliases. To do so press '' 'Add Alias' '', add email from '' 'Members inside this Domain'' and press '' 'Save' '' - nothing easier.'''
+
|style="padding: 10px 0px 20px 15px;"|Again, similarly to Email Hosting, you can manage your spam here.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_32.png]]
 
|}
 
|}
 +
 +
====Contacts====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''There you go, here is your new alias.'''
+
|style="padding: 10px 0px 20px 15px;"|Within a few seconds you can add a new contact and manage existing ones.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_33.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|In order to add a new contact press '' 'Add Contact' '' and fill out a form shown on the following screen.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:REE_34.png]]
 
|}
 
|}
  
−
==Management of Mobile Sync==
+
==Management of Billing==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''Mobile Sync allows your customers to synchronize their emails, calendars and contacts with their iPhones, Androids or Windows Mobile devices.'''
+
|style="padding: 10px 0px 15px 15px;"|When you combine Rackspace Email Extended For WHMCS with [https://www.docs.modulesgarden.com/Advanced_Billing_For_WHMCS Advanced Billing For WHMCS], you will be able to set up additional billing options.<br />
 +
Module allows you to charge your customers based on the server resources used by them.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_35.png]]
 
|}
 
|}
−
==Management of Storage Notification==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''This is a very convenient tool. Storage Notification will send notification to your customers when mailbox reaches certain amount of capacity.'''
+
|style="padding: 0px 0px 20px 15px;"|With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_36.png]]
 
|}
 
|}
−
==Management of Microsoft Exchange==
+
 
 +
==Management of Existing Account==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''Exchange Hosting is a server system, whereby software enables the sending and receiving of email and other types of interactive communications.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|You can easily use Rackspace Email For WHMCS module with your already created rackspace account.<br />
−
'''It enables sharing of business critical information online or through enabled wireless devices also.<br />
+
Instructions below explain how to set it up:<br />
−
Let's see how our addon can you help you manage your Microsoft Exchange services.'''
+
1. Follow [https://www.docs.modulesgarden.com/Rackspace_Email_Extended_For_WHMCS#Installation Installation] instructions.<br />
 +
'''Remember not to click 'Create' button during the entire process. That would unnecessarily create a new rackspace email account.'''<br />
 +
2. Log in to your Rackspace Email server.<br />
 +
3. Look for '' 'Acct#' '' values, these are your clients IDs.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|4. Copy '' '#Acct' '' to the field marked on the screen below.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:REE_37.png]]
 
|}
 
|}
  
−
==Management of Mailboxes==
+
==Upgrading Product==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''As in Email Hosting you can create new email accounts and manage them.'''
+
|style="padding: 10px 0px 15px 15px;"|You can offer an upgrade from ''Rackspace Email'' to ''Rackspace Email Extended''.<br />
 +
To set it up correctly, proceed to '' 'Setup' '' → '' 'Product/Services' '' → '' 'Product/Services' '' and edit your Rackspace Email product.<br />
 +
Now, proceed to '' 'Upgrades' '' tab and choose a previously configured '' 'Rackspace Email Extended' '' product (in our case it was '' 'Email Accounts - Email Advanced' '').<br />
 +
Additionally, if you wish to offer an upgrade along with possibility to define product resource, tick '' 'Configurable Options' '' checkbox.<br />
 +
Next, press '' 'Save Changes'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_38.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM10.png]]
+
|style="padding: 0px 0px 15px 15px;"|Let's upgrade a test product from Rackspace Email to Rackspace Email Extended.<br />
 +
To do so, go to the client area and proceed to the Rackspace Email product.<br />
 +
Choose '' 'Upgrade/Downgrade' '' from '' 'Management Actions'. ''
 
|}
 
|}
−
==Management of Spam==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''And again similarly to Email Hosting you can manage your spam here.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_39.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM14.png]]
+
|style="padding: 0px 0px 15px 15px;"|You should see a screen similar to the one shown below.<br />
 +
Choose a billing cycle for your Rackspace Email Extended product and press '' 'Choose Product'.''
 
|}
 
|}
−
==Management of Contacts==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''This function is very simple but very useful. Within a few seconds you can add a new contact and manage existing ones.'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_40.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM12.png]]
+
|style="padding: 0px 0px 20px 15px;"|That's it. Choose the payment method, press '' 'Click to Continue' '' button and voila!
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:REE_41.png]]
 
|}
 
|}
  
 
=Tips=
 
=Tips=
 +
{|
 +
|style="padding: 10px 0px 0px 15px;"|1. You need to be registered in Rackspace as a reseller, only then Rackspace Email Extended For WHMCS will work properly.<br />
 +
:If you have a regular account in Rackspace, Rackspace Email Extended For WHMCS will not work.
 +
|}
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|2. Please note that although action '' 'Suspend' '' is available in Module Commands, the action itself is not supported by Rackspace API.<br/>
 +
:It is not possible to call this action currently.
 +
|}
 +
 +
=Update Instructions=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|An essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.<br/> Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.
 +
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/rackspace-email-extended#open-source-version Open Source version] of your Rackspace Email Extended For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 +
|}
 +
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 15px;"|1. If after install, you will get an ionCube encoder problem (wrong version), please open a support ticket.<br />
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
−
We will provide you with different version of the module encrypted with the older version of ionCube.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|2. <br />
+
|style="padding: 0px 0px 20px 15px;"|2. If any undesired numbers appear in your client area, like the ones shown on the following screen, you can easily remove them.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_42.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|To do so, edit '' 'your_whmcs/templates/your_template/clientareaproductdetails.tpl' ''. Find and delete the following code:
 
<pre>{foreach from=$configurableoptions item=configoption}
 
<pre>{foreach from=$configurableoptions item=configoption}
 
<p><h4>{$configoption.optionname}:</h4> {if $configoption.optiontype eq 3}{if $configoption.selectedqty}{$LANG.yes}
 
<p><h4>{$configoption.optionname}:</h4> {if $configoption.optiontype eq 3}{if $configoption.selectedqty}{$LANG.yes}
Line 381: Line 524:
 
{else}{$configoption.selectedoption}{/if}</p>
 
{else}{$configoption.selectedoption}{/if}</p>
 
{/foreach}</pre>
 
{/foreach}</pre>
 +
Keep in mind that code may slightly differ from the one shown above.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|3. If customer rackspace accounts are duplicated go to step 17 of '' 'Installation'. '' You will find there a solution.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|4. If, after clicking on '' 'Login to Webmail' '', there is no correct redirection, make sure that the hostname address to your Webmail server is correctly entered in the WHMCS server configuration.
 
|}
 
|}

Latest revision as of 11:11, 2 October 2024

Contents

[edit] About Rackspace Email Extended For WHMCS

Rackspace Email Extended for WHMCS is a fully featured addon module that allows you to resell and manage email accounts entirely from your WHMCS system!

Owing to our product, your customers will be able to conveniently manage all aspects of Rackspace email accounts like e.g. mailboxes, aliases or mobile sync.
As an administrator, you will be able to customize Rackspace products to meet the needs of your customers.

  • Admin Area Features:
✔ Create/Terminate Account
✔ Change Package And Account Password
✔ Define Service Type Per Product
✔ Configure Resource Limits Per Product
  • Client Area Features:
✔ Email Hosting - Remote Access And Management Of:
✔ Mailboxes
✔ Spam
✔ Aliases
✔ Mobile Sync
✔ Storage Notification
✔ Microsoft Exchange - Remote Access And Management Of:
✔ Mailboxes
✔ Spam
✔ Contacts
  • Available Configurable Options
✔ Max Mailboxes
✔ Mailbox Size
✔ Extra Storage
✔ Active Sync Licenses
✔ BlackBerry Licenses
✔ Exchange Max Mailboxes
✔ Exchange Extra Storage
✔ Email Archiving
  • General Info:
✔ Integrated With Advanced Billing For WHMCS - Actual Server Resource Usage Billing
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products
✔ Multi-Language Support
✔ Supports PHP 8.2 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.11 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] Installation and Configuration

In this tutorial we will show you how to successfully install and set up Rackspace Email Extended For WHMCS.

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

[edit] Installation

1. Log in to our client area and download the module.
REE 1.png
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.

PHP71 74.png
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 here.

PHP56 73.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

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

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

REE 3.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 our client area → 'My Products'.

REE 4.png

[edit] Server Configuration

6. Set up a new server and a product.

To do so, log in to your WHMCS. Move to 'Setup' → 'Products/Services' → 'Servers'.
Afterwards, press 'Add New Server'.

REE 5.png
7. To proceed, you will need to obtain your Rackspace API keys. To do so, log in to your reseller 'Rackspace Account'.
Find 'Manage Admins' in the Common Actions box on the top right corner. You will be moved to the 'Administartors' setion.
REE2 6.png
8. When you are on the ' Administrators' page, click the 'API KEYS'. You will find it on the left, in navigation menu.
REE2 7.png
9. A popup with 'Your API Key' will appear. Copy your 'User' and 'Seccret Keys', you will need them in the next part of the module configuration.
REE2 8.png
10. Enter your server name and choose 'RackspaceEmailExtended' from a 'Type' dropdown menu.

Paste the previously copied 'User Key' and 'Secret Key' into 'Username' and 'Password' fields.
Enter the 'Hostname' address to your Webmail server - it is required for the 'Login to Webmail' function in the client area.
Afterwards, press 'Save Changes'.

REE 8.png
11. 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'.

REE 9.png
12. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
REE 10.png

[edit] Product Configuration

12. In order to create and configure product, move to 'Setup' → 'Products/Services' → 'Products/Services'.

If you do not have a product group, 'Create a New Group'. If you do, simply go to step 13.

REE 11.png
13. Enter product group name and press 'Save Changes'.
REE 12.png
14. When you have a product group, you can create your product and assign it to Rackspace Email Extended. If you already have a product, go to step 15.

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

REE 13.png
15. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press 'Continue'.
REE 14.png
16. Now, go to 'Module Settings' section, choose both 'RackspaceEmailExtended' and your previously created server group from dropdown menus.

Decide which of the service types you would like to use and choose it from a dropdown menu.
Afterwards, enter desired values in configuration fields and press 'Save Changes'.
Please note that values do not need to be constant. You can use configurable options to adjust the values.
Obtain more information about configurable options here.

REE 15.png
17. In the last step you need to create a new client custom field.

To do so, proceed to 'System Settings' → 'Custom Fields/Custom Client Fields'.
Fill in 'EmailCustomerID' into field name, tick 'Admin Only ' and press 'Save Changes'.

REE 15 1.png
18. Important! Our module does not automatically download 'EmailCustomerID' for the proper Rackspace customer.

To prevent duplicating accounts on Rackspace side you have to manually fill in 'EmailCustomerID' with appropriate value before running 'Create' function.
You can find more about it here.

REE 37.png
Good job! You have just correctly set up your first product with Rackspace Email.

Product after a successful activation presents similarly to the one presented on the screen below.

REE 16 1.png

[edit] Management

In the following sections we will try to present all the possibilities of Rackspace Email Extended For WHMCS features.

[edit] Configuration of Orders

Rackspace Email Extended For WHMCS allows you to offer a product tailored to customers needs. Let's create such an order.

For this purpose you need to create at least one configurable option. In this guide we will create a few more to present you the possibilities of our module.
If you are not familiar with configurable options yet, you can read more about them here
These are configurable options fields created by us, connected with our Rackspace Email Extended product.

REE 17.png
Proceed to your product 'Module Settings' tab now.

Here, you need to fill in the marked fields with desired configurable option names as shown on the screen below.
Afterwards, press 'Save Changes'.

REE 18.png
If you fill out 'Module Settings' with correct names, during order made from the admin area, you should see similar screen to the one below.

Otherwise, ensure that configurable option names are filled out correctly.

REE 19.png
Let's see how it looks like from the perspective of your customers.

As you can see, owing to configurable options, they are now able to define mailbox size, amount of mailboxes, extra storage and many other options.
This makes each order perfectly suited to your customers needs.

REE 20.png

[edit] Client Area

Read through the below sections to see how Rackspace Email Extended For WHMCS is designed to work in the client area.
REE 21.png

[edit] Email Hosting

Email Hosting is an internet hosting service that manages electronic messages through an email server.

[edit] Mailboxes

Let's start with some basic functionality of the module, that is the mailboxes management.
REE 22.png
Creating a mailbox is quick and easy.

The first step is filling out 'General' form, where you can define user details, password and mailbox size.

REE 23.png
Proceed to 'Contact Info' tab and fill it out with its user contact information.
REE 24.png

[edit] Spam

Spam filtering page allows you to set your preferences, edit blacklists and safelists.
REE 25.png

[edit] Aliases

With our module you can create aliases and assign chosen mailboxes to them.

To do so, press 'Add Alias', add email from 'Members inside this Domain' and press 'Save'.

REE 26.png
On the list of aliases you can find information about the amount of mailboxes in each alias.
REE 27.png

[edit] Mobile Sync

Mobile Sync allows your customers to synchronize their emails, calendars and contacts with their iPhones, Androids or Windows Mobile devices.
REE 28.png

[edit] Storage Notification

This page allows you to set up notifications sent to your customers when mailbox reaches certain amount of capacity.
REE 29.png

[edit] Microsoft Exchange

Exchange Hosting is a server system, whereby software enables sending and receiving email messages and other types of interactive communications.

It enables sharing of business critical information online or through enabled wireless devices.
Let's see how our addon can help you manage your Microsoft Exchange services.

[edit] Mailboxes

As in Email Hosting you can create new email accounts and manage them.
REE 30.png
REE 31.png

[edit] Spam

Again, similarly to Email Hosting, you can manage your spam here.
REE 32.png

[edit] Contacts

Within a few seconds you can add a new contact and manage existing ones.
REE 33.png
In order to add a new contact press 'Add Contact' and fill out a form shown on the following screen.
REE 34.png

[edit] Management of Billing

When you combine Rackspace Email Extended For WHMCS with Advanced Billing For WHMCS, you will be able to set up additional billing options.

Module allows you to charge your customers based on the server resources used by them.

REE 35.png
With Advanced Billing module, you can also display your customers the current server resource usage and their cost.
REE 36.png

[edit] Management of Existing Account

You can easily use Rackspace Email For WHMCS module with your already created rackspace account.

Instructions below explain how to set it up:
1. Follow Installation instructions.
Remember not to click 'Create' button during the entire process. That would unnecessarily create a new rackspace email account.
2. Log in to your Rackspace Email server.
3. Look for 'Acct#' values, these are your clients IDs.

REE 16.png
4. Copy '#Acct' to the field marked on the screen below.
REE 37.png

[edit] Upgrading Product

You can offer an upgrade from Rackspace Email to Rackspace Email Extended.

To set it up correctly, proceed to 'Setup' → 'Product/Services' → 'Product/Services' and edit your Rackspace Email product.
Now, proceed to 'Upgrades' tab and choose a previously configured 'Rackspace Email Extended' product (in our case it was 'Email Accounts - Email Advanced' ).
Additionally, if you wish to offer an upgrade along with possibility to define product resource, tick 'Configurable Options' checkbox.
Next, press 'Save Changes'.

REE 38.png
Let's upgrade a test product from Rackspace Email to Rackspace Email Extended.

To do so, go to the client area and proceed to the Rackspace Email product.
Choose 'Upgrade/Downgrade' from 'Management Actions'.

REE 39.png
You should see a screen similar to the one shown below.

Choose a billing cycle for your Rackspace Email Extended product and press 'Choose Product'.

REE 40.png
That's it. Choose the payment method, press 'Click to Continue' button and voila!
REE 41.png

[edit] Tips

1. You need to be registered in Rackspace as a reseller, only then Rackspace Email Extended For WHMCS will work properly.
If you have a regular account in Rackspace, Rackspace Email Extended For WHMCS will not work.
2. Please note that although action 'Suspend' is available in Module Commands, the action itself is not supported by Rackspace API.
It is not possible to call this action currently.

[edit] Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Rackspace Email Extended For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If any undesired numbers appear in your client area, like the ones shown on the following screen, you can easily remove them.
REE 42.png
To do so, edit 'your_whmcs/templates/your_template/clientareaproductdetails.tpl' . Find and delete the following code: 
{foreach from=$configurableoptions item=configoption}
<p><h4>{$configoption.optionname}:</h4> {if $configoption.optiontype eq 3}{if $configoption.selectedqty}{$LANG.yes}
{else}{$LANG.no}{/if}
{elseif $configoption.optiontype eq 4}{$configoption.selectedqty} x {$configoption.selectedoption}
{else}{$configoption.selectedoption}{/if}</p>
{/foreach}

Keep in mind that code may slightly differ from the one shown above.

3. If customer rackspace accounts are duplicated go to step 17 of 'Installation'. You will find there a solution.
4. If, after clicking on 'Login to Webmail' , there is no correct redirection, make sure that the hostname address to your Webmail server is correctly entered in the WHMCS server configuration.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Rackspace_Email_Extended_For_WHMCS&oldid=71442"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Rackspace Email Extended For WHMCS