Personal tools
Namespaces

Variants
Actions

Rackspace Email Extended For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Rackspace Email Extended For WHMCS)
(→‎About Rackspace Email Extended For WHMCS)
Line 9: Line 9:
 
|}
 
|}
 
<!-- fixed -->
 
<!-- fixed -->
−
*'''Rackspace Email Extended Features - Exchange:'''
+
 
 +
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Manage Mailboxes
+
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Account
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Spam
+
|style="padding: 0px 0px 0px 30px;"|✔ Change Package And Password Of Account
 
|}
 
|}
 
{|
 
{|
−
|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 10px 30px;"|✔ Change Password
+
|style="padding: 0px 0px 0px 45px;"|✔ Mailboxes
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Spam
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 45px;"|✔ Contacts
 +
|}
 +
 
 +
*'''Available Configurable Options'''
 +
{|
 +
|style="padding: 10px 0px 0px 30px;"|✔ Max Mailboxes
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Mailbox Size
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Extra Storage
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Active Sync Licenses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ BlackBerry Licenses
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Exchange Max Mailboxes
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Exchange Extra Storage
 
|}
 
|}
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Flexible Settings With Configurable Options!
+
|style="padding: 10px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
 
|}
 
|}
 
{|
 
{|
Line 56: Line 85:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Advanced Billing For WHMCS</u> - Server Resource Usage Billing [http://www.modulesgarden.com/products/whmcs/advanced_billing/features (read more)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS Up To V5.3.14
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V5 and V6
 
|}
 
|}
  

Revision as of 10:12, 19 November 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.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Account
✔ Change Package And Password Of Account
✔ 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
  • General Info:
✔ Integrated With Advanced Billing For WHMCS - Server Resource Usage Billing (read more)
✔ Multi-Language Support
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V5 and V6

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.

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' .
Note: You need to be registered with Rackspace as a reseller for Rackspace Email Extended For WHMCS to work.
If you have a regular account with Rackspace, Rackspace Email Extended For WHMCS will not work.

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=21251"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Rackspace Email Extended For WHMCS