Personal tools
Namespaces

Variants
Actions

Rackspace Email Extended For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 62: Line 62:
 
|}
 
|}
  
−
=Installation=
+
=Installation & Configuration=
 
{|
 
{|
−
|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 30px 0px;"|'''In this tutorial we will show you how to successfully install and set up Rackspace Email Extended For WHMCS.'''<br />
 
We will guide you step by step through the whole installation process.
 
We will guide you step by step through the whole installation process.
 
|}
 
|}
 +
==Installation==
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to your client area and download Rackspace Email Extended.'''
+
|style="padding: 10px 0px 20px 15px;"|'''1. Log in to your client area and download Rackspace Email Extended.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE11.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_1.png]]
 
|}
 
|}
 
{|
 
{|
Line 78: Line 79:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_2.png]]
 
|}
 
|}
 
{|
 
{|
Line 85: Line 86:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE3.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_3.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key you have to edit a previously renamed '' 'license.php' '' file.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''4. 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 at your client area → '' 'My Products' ''.
+
Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → '' 'My Products' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_4.png]]
 
|}
 
|}
 +
==Server Configuration==
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''5. It's time to set up a server and product.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''5. It's time to set up a server and product.'''<br />
−
To do so log in into your WHMCS. Now press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' (or '' 'Setup' '' → '' 'Servers' '' in WHMCS v4.x).<br />
+
To do so, log in to your WHMCS. Now, press '' 'Setup' '' → '' 'Products/Services' '' → '' 'Servers' '' (or '' 'Setup' '' → '' 'Servers' '' in WHMCS v4.x).<br />
 
Afterwards, press '' 'Add New Server' ''.
 
Afterwards, press '' 'Add New Server' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE4_1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. To proceed you will need to obtain your Rackspace API keys. To do so, log in to your reseller Rackspace Account.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''6. To proceed you will need to obtain your Rackspace API keys. To do so, log in to your reseller '' 'Rackspace Account'.'' '''<br />
 
Afterwards, in '' 'My Account' '' section press '' 'Generate API Keys' ''.
 
Afterwards, in '' 'My Account' '' section press '' 'Generate API Keys' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RE5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_6.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. Next press '' 'Generate New Keys' '' as shown on the screen below.'''
+
|style="padding: 0px 0px 20px 15px;"|'''7. Next, press '' 'Generate New Keys' '' as shown on the screen below.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RE6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_7.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and choose '' 'RackspaceEmailExtended' '' from a '' 'Type' '' dropdown menu.<br />
 
|style="padding: 0px 0px 15px 15px;"|'''8. Enter your server name and choose '' 'RackspaceEmailExtended' '' from a '' 'Type' '' dropdown menu.<br />
 
Copy both '' 'User Key' '' and '' 'Secret Key' '' and paste them into '' 'Username' '' and '' 'Password' '' fields.<br />
 
Copy both '' 'User Key' '' and '' 'Secret Key' '' and paste them into '' 'Username' '' and '' 'Password' '' fields.<br />
−
Afterwards, press '' 'Save Changes' ''.
+
Afterwards, press '' 'Save Changes'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_8.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''9. After you configure your server correctly, you will see a following screen.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''9. 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' ''.
+
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:REE5.5.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_9.png]]
 
|}
 
|}
 
{|
 
{|
Line 134: Line 136:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE6_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_10.png]]
 
|}
 
|}
 +
 +
==Product Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''11. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services' ''.'''<br />
 
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 13.
 
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 13.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE6_2.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_11.png]]
 
|}
 
|}
 
{|
 
{|
Line 147: Line 151:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE7.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_12.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 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.'''<br />
 
|style="padding: 0px 0px 15px 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.'''<br />
−
To create a product click on '' 'Create a New Product' ''.
+
To create a product click on '' 'Create a New Product'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE8.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_13.png]]
 
|}
 
|}
 
{|
 
{|
Line 160: Line 164:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_14.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''15. Now go to '' 'Module Settings' '' section, choose both '' 'RackspaceEmailExtended' '' and your previously created server group from dropdown menus.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''15. Now, go to '' 'Module Settings' '' section, choose both '' 'RackspaceEmailExtended' '' and your previously created server group from dropdown menus.'''<br />
−
Decide which of the three service types you would like to use and choose it from a dropdown menu.<br />
+
Decide which of the service types would you like to use and choose it from a dropdown menu.<br />
−
Afterwards, enter your desired values in configuration fields and press '' 'Save Changes' ''.<br />
+
Afterwards, enter 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.<br />
+
Please note that values don't need to be constant. You can use configurable options to adjust the values.<br />
−
You can obtain more information about Configuration Options [http://docs.modulesgarden.com/Rackspace_Email_For_WHMCS#Configurable_Options here]
+
You can obtain more information about configurable options [http://docs.modulesgarden.com/Rackspace_Email_For_WHMCS#Configurable_Options here].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE6.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_15.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 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 15px 15px;"|'''16. In the last step you need to create a new client custom field.'''<br />
−
Enter '' 'EmailCustomerID' '' at field name, tick '' 'Admin Only'' ' and press '' 'Save Changes' ''.
+
To do so, proceed to '' 'Setup' '' → '' 'Custom Client Fields'.''<br />
 +
Fill in '' 'EmailCustomerID' '' into field name, tick '' 'Admin Only'' ' and press '' 'Save Changes' ''.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RE9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_16.png]]
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''17. Important! Our module does not automatically download '' 'EmailCustomerID' '' for the proper Rackspace customer.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''17. 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 set '' 'EmailCustomerID' '' values before running '' 'Create' '' function.<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 [http://www.docs.modulesgarden.com/Rackspace_Email_Extended_For_WHMCS#Management_of_Existing_Account here].
 
You can find more about it [http://www.docs.modulesgarden.com/Rackspace_Email_Extended_For_WHMCS#Management_of_Existing_Account here].
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''Good job! You have just correctly set up your first product with Rackspace Email.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''Good job! You have just correctly set up your first product with Rackspace Email.'''<br />
−
Successfully installed module will present similarly to the one presented on the screen below.
+
Successfully installed module presents similarly to the one presented on the screen below.
 
|}
 
|}
 
{|
 
{|
Line 192: Line 197:
 
|}
 
|}
  
−
=Configuration and Management=
+
=Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|
+
|style="padding: 10px 0px 30px 15px;"|Below we will present the possibilities of Rackspace Email Extended For WHMCS to you.
 
|}
 
|}
 
==Configuration of Orders==
 
==Configuration of Orders==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''Rackspace Email Extended allows you to create a very flexible orders dependent 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/Rackspace_Email_For_WHMCS#Configurable_Options here]'''<br />
 
'''If you are not yet familiar with configurable options you can read more about it [http://docs.modulesgarden.com/Rackspace_Email_For_WHMCS#Configurable_Options here]'''<br />
Line 204: Line 209:
 
|}
 
|}
 
{|
 
{|
−
|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;"|In the next step, proceed to your product '' 'Module Settings' '' tab.<br />
 +
Next,  you need to fill in marked fields with desired configurable option names as shown on the screen below.<br />
 
Afterwards, press '' 'Save Changes' ''.
 
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 does not 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 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 would look 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 matched to your customers needs.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEC4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_20.png]]
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''Let's see how it would look like from the perspective of your customers'''<br />
+
−
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]]
+
 
|}
 
|}
  
−
==Upgrading Product==
+
==Client Area==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''You can update Rackspace Email to Rackspace Email Extended with ease.'''<br />
+
|style="padding: 10px 0px 20px 15px;"|'''We will present you the possibilities of Rackspace Email Extended in your client area.'''
−
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' ''.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_21.png]]
 
|}
 
|}
 +
===Email Hosting===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''Let's start to upgrade the module. From client area select your Rackspace Email product (in our case it was '' 'A Fine Product' '').'''<br />
+
|style="padding: 10px 0px 20px 15px;"|'''Email Hosting is an internet hosting service that manages electronic messages through an email server.'''
−
In '' 'Management Actions' '' choose '' 'Upgrade/Downgrade' ''.
+
 
|}
 
|}
 +
====Mailboxes====
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU4.png]]
+
|style="padding: 10px 0px 20px 15px;"|'''Let's start by presenting to you the basic functionality of the module, that is the mailboxes management.'''
 
|}
 
|}
 
{|
 
{|
−
|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_22.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU2.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''Creating a mailbox is quick and easy.'''<br />
 +
The first step is filling out '' 'General' '' form, which allows you to can define user details, password and mailbox size.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''That's it. Choose the payment method, press '' 'Click to Continue' '' button and voila!'''
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_23.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEU3.png]]
+
|style="padding: 0px 0px 20px 15px;"|'''For the second step, proceed to '' 'Contact Info' '' tab and fill it out with it's user contact information.'''
 
|}
 
|}
 
{|
 
{|
−
|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_24.png]]
 
|}
 
|}
−
==Management of The Client Area==
+
====Spam====
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''Email Hosting is an internet hosting service that manages electronic messages through an email server.'''<br />
+
|style="padding: 10px 0px 20px 15px;"|'''Spam filtering page allows you to set your preferences, edit blacklists and safelists.'''
−
'''We will present you the possibilities of Rackspace Email Extended within the scope of email hosting.'''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE10.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_25.png]]
 
|}
 
|}
−
===Management of Mailboxes===
+
====Aliases====
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''Basic function of Rackspace Email Extended is to create new email accounts.'''
+
|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:REEM1.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_26.png]]
 
|}
 
|}
 
{|
 
{|
−
|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 username, password and mailbox size.'''
+
|style="padding: 0px 0px 20px 15px;"|'''On the list of aliases you can find information about the amount of mailboxes in each alias.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM2.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_27.png]]
−
|}
+
−
{|
+
−
|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: 0px 0px 30px 25px;"|[[File:REEM3.png]]
+
−
|}
+
−
===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 30px 25px;"|[[File:REEM13.png]]
+
−
|}
+
−
===Management of Aliases===
+
−
{|
+
−
|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: 0px 0px 20px 25px;"|[[File:REEM5.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|'''There you go, here is your new alias.'''
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM6.png]]
+
 
|}
 
|}
  
−
===Management of Mobile Sync===
+
====Mobile Sync====
 
{|
 
{|
 
|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 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 30px 25px;"|[[File:REEM7.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_28.png]]
 
|}
 
|}
−
===Management of Storage Notification===
+
====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: 10px 0px 20px 15px;"|'''This page allows you to set up notifications send to your customers when mailbox reaches certain amount of capacity.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM8.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_29.png]]
 
|}
 
|}
−
===Management of Microsoft Exchange===
+
 
 +
===Microsoft Exchange===
 
{|
 
{|
 
|style="padding: 10px 0px 30px 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 30px 15px;"|'''Exchange Hosting is a server system, whereby software enables the sending and receiving of email and other types of interactive communications.'''<br />
−
'''It enables sharing of business critical information online or through enabled wireless devices also.'''<br />
+
It enables sharing of business critical information online or through enabled wireless devices.<br />
−
'''Let's see how our addon can you help you manage your Microsoft Exchange services.'''
+
Let's see how our addon can help you manage your Microsoft Exchange services.
 
|}
 
|}
−
===Management of Mailboxes===
+
====Mailboxes====
 
{|
 
{|
 
|style="padding: 10px 0px 20px 15px;"|'''As in Email Hosting you can create new email accounts and manage them.'''
 
|style="padding: 10px 0px 20px 15px;"|'''As in Email Hosting you can create new email accounts and manage them.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM9.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_30.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM10.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_31.png]]
 
|}
 
|}
−
===Management of Spam===
+
====Spam====
 
{|
 
{|
 
|style="padding: 10px 0px 20px 15px;"|'''And again similarly to Email Hosting you can manage your spam here.'''
 
|style="padding: 10px 0px 20px 15px;"|'''And again similarly to Email Hosting you can manage your spam here.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM14.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_32.png]]
 
|}
 
|}
−
===Management of Contacts===
+
====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: 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:REEM12.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_33.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|Adding a new contact consist of pressing '' 'Add Contact' '' and filling form shown on the following screen.
+
|style="padding: 0px 0px 20px 15px;"|Adding a new contact consist of pressing '' 'Add Contact' '' and filling out a form shown on the following screen.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM11.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_34.png]]
 
|}
 
|}
  
Line 372: Line 346:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REEM15.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_35.png]]
 
|}
 
|}
 
{|
 
{|
Line 378: Line 352:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:REEM16.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_36.png]]
 
|}
 
|}
 +
 
==Management of Existing Account==
 
==Management of Existing Account==
 
{|
 
{|
Line 390: Line 365:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:RE9.4.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:REE_16.png]]
 
|}
 
|}
 
{|
 
{|
Line 396: Line 371:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:RE9.5.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:REE_37.png]]
 +
|}
 +
 
 +
==Upgrading Product==
 +
{|
 +
|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:REE_38.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' ''.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_39.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'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:REE_40.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]]
 
|}
 
|}
  
Line 408: Line 416:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 5px 15px;"|2. If after install, you will get an ionCube encoder problem (wrong version), please open a support ticket.<br />
+
|style="padding: 0px 0px 20px 15px;"|'''2. If a strange numbers appears in your client area, similar to the one shown on the following screen, you can easily remove them.'''
−
We will provide you with different version of the module encrypted with the older version of ionCube.
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 15px;"|3. If in your clientarea will appear such or similar numbers as shown on the screen below, you can easily remove them.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:REE13.png]]
+
|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 followng code:
+
|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 428: Line 432:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|4. If customer rackspace accounts are duplicated go to step 17 of '' 'Installation' ''.
+
|style="padding: 0px 0px 30px 15px;"|'''3. If customer rackspace accounts are duplicated go to step 17 of '' 'Installation'.'' '''
 
|}
 
|}

Revision as of 12:31, 26 February 2015

Contents

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.

  • 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
  • General Info:
✔ Flexible Settings With Configurable Options!
✔ Multi-Language Support
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Supports WHMCS V4 and Later

Installation & 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.

Installation

1. Log in to your client area and download Rackspace Email Extended.
REE 1.png
2. Upload and extract the module into the main WHMCS directory.

Files in your WHMCS directory should look like this.

REE 2.png
3. When you install Rackspace Email Extended 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
4. In order to configure your license key you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in your client area → 'My Products' .

REE 4.png

Server Configuration

5. It's time to set up a server and product.

To do so, log in to your WHMCS. Now, press 'Setup' → 'Products/Services' → 'Servers' (or 'Setup' → 'Servers' in WHMCS v4.x).
Afterwards, press 'Add New Server' .

REE 5.png
6. To proceed you will need to obtain your Rackspace API keys. To do so, log in to your reseller 'Rackspace Account'.

Afterwards, in 'My Account' section press 'Generate API Keys' .

REE 6.png
7. Next, press 'Generate New Keys' as shown on the screen below.
REE 7.png
8. Enter your server name and choose 'RackspaceEmailExtended' from a 'Type' dropdown menu.

Copy both 'User Key' and 'Secret Key' and paste them into 'Username' and 'Password' fields.
Afterwards, press 'Save Changes'.

REE 8.png
9. 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
10. Enter name, click on your previously created server, press 'Add' then press 'Save Changes' .
REE 10.png

Product Configuration

11. 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 go to step 13.

REE 11.png
12. Enter product group name and press 'Save Changes' .
REE 12.png
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.

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

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

Decide which of the service types would you 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 don't need to be constant. You can use configurable options to adjust the values.
You can obtain more information about configurable options here.

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

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

REE 16.png
17. 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.

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

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

Let's configure your freshly installed module.

Management

Below we will present the possibilities of Rackspace Email Extended For WHMCS to you.

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 yet familiar with configurable options you can read more about it here
These are configurable options fields created by us, connected with our rackspace email extended product.

REE 17.png
In the next step, proceed to your product 'Module Settings' tab.

Next, you need to fill in 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 correctly.

REE 19.png
Let's see how it would look 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 matched to your customers needs.

REE 20.png

Client Area

We will present you the possibilities of Rackspace Email Extended in your client area.
REE 21.png

Email Hosting

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

Mailboxes

Let's start by presenting to you the 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, which allows you to can define user details, password and mailbox size.

REE 23.png
For the second step, proceed to 'Contact Info' tab and fill it out with it's user contact information.
REE 24.png

Spam

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

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

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

Storage Notification

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

Microsoft Exchange

Exchange Hosting is a server system, whereby software enables the sending and receiving of email 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.

Mailboxes

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

Spam

And again similarly to Email Hosting you can manage your spam here.
REE 32.png

Contacts

Within a few seconds you can add a new contact and manage existing ones.
REE 33.png
Adding a new contact consist of pressing 'Add Contact' and filling out a form shown on the following screen.
REE 34.png

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

Management of Existing Account

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

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

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

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

Tips

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If a strange numbers appears in your client area, similar to the one 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'.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Rackspace_Email_Extended_For_WHMCS&oldid=16991"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Rackspace Email Extended For WHMCS