Personal tools
Namespaces

Variants
Actions

Rackspace Email Extended For WHMCS

From ModulesGarden Wiki
Revision as of 12:47, 27 June 2012 by Peter (Talk | contribs)

Jump to: navigation, search

Contents

About Rackspace Email For WHMCS

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

Our product provides comprehensive management within WHMCS by which facilitates use and saves you valuable time!

  • Rackspace Email Extended features - Exchange:
✔ Manage Mailboxes
✔ Spam
✔ Aliases
✔ Mobile Sync
✔ Storage Notification
  • Rackspace Email Extended features - Email:
✔ Manage Mailboxes
✔ Spam
✔ Manage Contacts
  • General features:
✔ Create Account
✔ Terminate Account
✔ Change Package
✔ Change Password
✔ Flexible Settings With Configurable Options!
✔ WHMCS v4 and v5 Compatibility

Installation

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

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

1. Login to your clientarea and download Rackspace Email.
File:RE1.png
2. Upload and extract the module into the main whmcs directory.
Files in your whmcs directory should look like this.
File:RE2.png
3. When you install rackspace Email for the first time you have to rename 'license_RENAME.php' file.
File is located at 'modules/servers/rackspace_email/license_RENAME.php' . Rename it from 'license_RENAME.php' to 'license.php' .
File:RE3.png
4. In order to configure your license key you have to edit a previously renamed 'license.php' file.
File is located at 'modules/servers/rackspace_email/license.php' . Enter your licence key between quotation marks as presented on the following screen.
You can find your license key at your clientarea -> 'My Products'.
File:RE4.png
5. Let's set up a server and product now.
To do so log in into your WHMCS. Now press 'Setup' -> 'Products/Services' -> 'Servers' (or 'Setup' -> 'Servers' in WHMCS v4.x).
Afterwards press 'Add New Server' .
CP8.png
6. To proceed you will need to obtain your Rackspace API keys. To do so log in to your Rackspace Account.
Afterwards in 'My Account' section press 'Generate API Keys' .
File:RE5.png
8. Next press 'Generate New Keys' as shown on the screen below.
File:RE6.png
9. Copy both 'User Key' and 'Secret Key' , and paste them into '(1.) Username' and '(2.) Password' fields during server configuration.
Next in your WHMCS system choose 'Rackspace_email' from a dropdown menu and paste your just obtained username and password.
Provide your webmail URL to the '(3.) Hostname' field and your whitelabeled system URL into '(4.) IP Adress' field ONLY IF you are Rackspace reseller.

In other case leave these fields blank.

Afterwards press 'Save Changes' .
File:RE7.png
10. 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' .
CP10.png
11. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .
CP11.png
12. In order to create and configure product click on 'Setup' -> 'Products/Services' -> 'Products/Services' .
If you don't have a product group, click on 'Create a New Group' . If you do, simply go to step 14.
CP12.png
13. Enter product group name and press 'Create Group' .
CP13.png
14. When you have a product group, you can create your product and assign it with Rackspace Email. If you already have a product, go to step 16.
To create a product click on 'Create a New Product' .
CP14.png
15. Afterwards choose your product type and product group from a dropdown menus, enter your product name and press 'Continue' .
CP15.png
16. Now go to 'Module Settings' section, choose both 'Rackspace_email' and your previously created server group from a dropdown menus.

Decide which of the three service types you would like to use and choose it from a dropdown menu.
Afterwards enter your desired values in configuration fields and press 'Save Changes' .
Please note that values don't need to be constant. You can use Configurable Options to adjust the values. We will show you how to perform this in Configuration section.

File:RE8.png
17. In the last step you need to create new client field. For this purpose go to 'Setup' -> 'Custom Client Fields' .

Enter 'EmailCustomerID' at field name, tick 'Admin only ' and press 'Save Changes' .

File:RE9.png
Good job! You have just correctly set up your first product with Rackspace Email.

Successfully installed module will present similarly to the one presented on the screen below.

File:RE10.png
Let's proceed to configuration of your just installed module.

Configuration

Configurable Options

In order to fully use the potential of Rackspace Email you can use Configurable Options.

Configurable Options allow you to adjust and change the values according to your customers needs.
Let's start. In your WHMCS system press 'Setup' -> 'Products/Services' -> 'Configurable Options' .
You need to create new configurable option group. To do so click at 'Create a New Group' .

File:REC1.png
Now enter your group name, choose assigned product and press 'Save Changes' .
File:REC2.png
Afterwards press 'Add New Configurable Option' .
File:REC3.png
Enter your option name which you will use in your product value configuration. Provide value for your new option. For example '100 MB' and press 'Save Changes' .
File:REC4.png
Now enter your desired price for option '100 MB' , e.g. $5, enter your new option name, e.g. '200 MB' and press 'Save Changes' .
File:REC5.png
When you are done with adding new options simply press 'Save Changes' and 'Close Window' .
File:REC6.png
Afterwards at your product 'Module Settings' you need to add field 'SIZE' (because this is how we named our configurable option) to the value you need.
File:REC8.png
From now on you can easily and quickly change value of your product. Remember that you can add more configurable options for other values.

Let's check your new configurable option field for your product. It should look like on the screen below.
If you would like to change the value, simply press e.g. '200 MB' and press 'Save Changes' . Great, that's everything you should know about configurable options!

File:REC7.png

Tips

Common Problems

Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Rackspace Email Extended For WHMCS