eNom Email For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search

Contents

About eNom Email For WHMCS

eNom Email For WHMCS is a self-explanatory module created to automate provisioning and management of eNom email accounts in your WHMCS.

It allows your clients to manage their mailboxes and forwarders without accessing eNom Email, straight from your WHMCS client area.

  • Admin Area Features:
✔ Create Account
✔ Terminate Account
✔ Renew Account
  • Client Area Features:
✔ Create/Remove Mailbox
✔ Change Password
✔ Manage Mailbox Forwarding
✔ View Mailbox Quota
✔ Define Catch-All Email Forwarder
✔ Log In To Webmail
  • Available Configurable Options:
✔ Mailboxes Quantity
✔ Storage Capacity
  • General Info:
✔ Define Additional TLDs and gTLDs
✔ Multi-Language Support
✔ Supports PHP 5.3 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

Installation and Configuration

This tutorial will show you how to correctly install and configure eNom Email For WHMCS.

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

Installation

1. Log in to your client area and download the module.
EE 1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 7, while the second one is aimed at PHP 5.3 up to PHP 5.6.
It does not apply to open source versions.

Note: You can check current PHP version in your WHMCS. To do so proceed to 'Utilities' → 'System' → 'PHP Info'.

EE 2.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

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

The file is located in 'modules/servers/enomEmail/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

EE 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 your client area → 'My Products'.

EE 4.png

Configuration

6. Now we will show you how to configure a new product.

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

EE 5.png
7. Next, fill in your server name (or IP address), username and password. Choose 'EnomEmail' from a dropdown menu and press 'Save Changes'.

It is important to use username and password from your eNom account.
Since you leave hostname blank, module connects with eNom on http://www.enom.com/.
Username and password are the only means that will let you be recognized by eNom servers.

EE 6.png
8. After you configure your server correctly, you will see a following screen.

Now you need to create a new group for your server. For that purpose press 'Create New Group'.

EE 7.png
9. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
EE 8.png
10. In order to create and configure the product, click on 'Setup' 'Products/Services' 'Products/Services'.

Click on 'Create a New Group'.

EE 9.png
11. Fill in product group name and press 'Save Changes'.
EE 10.png
12. When you have a product group, you can create your product.

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

EE 11.png
13. Afterwards, choose your product group from a dropdown menu, enter your product name and press 'Continue'.
EE 12.png
14. Now, go to 'Module Settings' section, choose both 'EnomEmail' and your previously created server group from dropdown menus and press 'Save Changes'.
EE 13.png
15. Configure your product now:
  • Declare number of mail boxes per account - 'Quantity', '10' is a default value
  • Select unit for quantity: 'Mail Boxes' or ' Packs', 1 pack equals 10 mail boxes
  • Select storage capacity per account: '1' or '10'
  • Finally, if you wish you may automatically generate configurable options.
EE 26.png
If you have generated configurable options for your product, client while placing an order will be allowed to choose both 'Quantity' and 'Capacity' for their products:
EE 28.png
16. Good job! You have just correctly set up your first product with eNom Email.

A successfully installed module will present similarly to the screens below.

The client area view:

EE 14.png
The admin area product's details:
EE 27.png

Management

eNom Email allows your customers to manage their eNom Email accounts via client area in your WHMCS system.

In this short guide, you will learn about all of the email accounts management possibilities that our module has to offer.

Admin Area

As you can see on the following screen, you can create/terminate eNom Email accounts of your clients, manage 'Quantity' and 'Capacity' of the single product.

Note: visible on the screen 'Upgrade/Downgrade' option is not supported by the module, it is due to eNom API limitations.

EE 15.png

Client Area

Create A New Mailbox

To add an email, press 'Add Email', provide email name and password, then confirm the password. Afterwards press 'Add Email'.
EE 16.png
Instead of typing in a password you can also generate it. To do so, press 'Generate Password'.

The password, you have just generated, will be visible for you in the text box under 'Generate Password' button.

EE 17.png

Manage Existing Mailboxes

Our module allows your clients to manage their email addresses straight from WHMCS client area.

In order to change the password, press 'Change Password' button as shown on the screen below.
Afterwards, type in a new password manually or generate it through pressing 'Generate Password' button.
To confirm the changes, click on 'Save' button.

EE 18.png
To set up email forwarding, press the button marked on the following screen.

Afterwards, fill in email address to forward and 'Save' the changes.

EE 19.png
You can delete mailboxes by pressing a cross button as presented on the following screen.
EE 20.png
To confirm, press 'Delete' button.
EE 21.png

Log In To Webmail

In order to access Webmail, press 'Webmail' button as it is shown on the following screen.
EE 22.png

Catch-All Email Address

Catch-All functionality allows you to forward all messages sent to non-existing mail boxes on your domain to a selected email address.
EE 23.png

Configurable Options

If configurable options have been generated, an additional section should be visible.
You will find there, previously defined on the order form:
  • Quantity of mail boxes
  • Storage capacity
EE 29.png

Additional TLD & gTLDs

Due to eNom Email API limitations, we were forced to list all available TLDs.

If you receive 'The TLD you were trying to add is not recognized. Put it into '/modules/servers/enomEmail/tldList.csv' file.' during create, add the TLD you were trying to use as described below.
Edit 'tldList.csv' file located in 'your_whmcs/modules/servers/enomEmail/'.

EE 24.png
Add the TLD of the domain you wish to use at the end of 'tldList.csv' file.

Remember to place it between a dot and a semicolon as it is visible on the following screen.
Now you should be able to create eNom Email account for the domain.

EE 25.png

Tips

1. To use a connection with eNom test server, set up a server using 'dev' as a hostname and use your test account username and password.

You can create eNom test account here: https://resellertest.enom.com/signup/create-account.aspx

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social
ENom Email For WHMCS