free_email

Description

Get the list of all the addons assigned to a particular email account. This will return only those addons which are applied to the email account.

Description

Assign email storage bock (5GB each) to an email account.

The following Services reside on separate servers from the ones you connect to, via the HTTP API, due to this, your Customers need to
login to their (individual) Control Panels, for managing such Services:

• DNS

• Email (Free Email Account [POP/IMAP] and Email Forwarding)

• Single Domain Hosting

• Multi Domain Hosting

• Reseller Hosting

• Dedicated Server

• Enterprise Email

• Business Email

• SiteLock

• CodeGuard

• Impress.ly

• Web Services (Legacy Web Hosting, Email Hosting, Website Builder)

now provides you with another method of directly allowing access to your Customer, to manage the above Products / Services from your interfaces itself.

To accomplish this, you need to pass the following parameters to the mentioned URL, via an HTTP POST method:

URL: https://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI

• auth-token: You need to generate an authentication token, that you need to pass as the value of this parameter for allowing the
  Customer to manage his Order. This can be accomplished by calling the HTTP API Generating a Token method. The generated authentication token will be valid for a very short period of time and you should use it immediately upon generating it.

• orderid: The Order ID of the Web Services (Legacy Web Hosting, Email Hosting, Website Builder) / Single Domain
  Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email / SiteLock / CodeGuard Order that your Customer wants to manage. In case of DNS, Email Service, the Order ID of the Product associated with the DNS / Email Service needs to be passed. Based on the orderid, the productCategory will be determined.

  Note

  For DNS / Email Service Orders that do not have any other Product associated with them, you can continue to pass the existing orderid to reach the
  DNS Management Console and Email Service Management interface respectively.

• service-name: This parameter needs to be passed to manage the specified service name. The value of this parameter needs to be
  either:

  • dns: For managing DNS Service.

  • mailfwd: For managing Email Forwarding Service.

  • free_email: For managing Free Email Account Service.

  • webhosting: For managing Web Hosting Service.

  • mailhosting: For managing Email Hosting Service.

  • websitebuilder: For managing Website Builder Service.

  
  

  • impressly: For managing an Impress.ly Order.

• url: This parameter needs to be passed to manage an Impress.ly order. The value of this parameter needs to be a URL on your server that accepts the app-id provided by Impress.ly. You can then retrieve the order details by using the app-id in the Get Callback URL call.

OR

panel: This parameter needs to be passed to manage WHM. The value of this parameter needs to be whm.

Note

For Single Domain
Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email / SiteLock / CodeGuard Orders, you can pass the corresponding Product Key as the value for this parameter.

Additional Information

Product Keys

You would need to create an intermediate interface, which should call the Generating a Token HTTP API method and build a URL
with orderid, auth-token and service-name/panel as parameters, and then redirect the Customer to this URL.

Java Example:

Let us call this interface a servlet named ManageOrderBoxControlPanel.

1. This interface would accept the Order ID of the Web Services (Legacy Web Hosting, Email Hosting, Website Builder) / Single Domain
   Hosting / Multi Domain Hosting / Reseller Hosting / Dedicated Server / Managed Server / Enterprise Email / SiteLock / CodeGuard Order or the Order ID of the Service associated with DNS or
   Email Service as a parameter. So, in order to manage a Service, you will call this interface with
   https://<Your-Server-URL>/ManageOrderBoxControlPanel?orderid=<orderid>.

2. This servlet would need to call the Generating a Token HTTP API method.

3. The final URL to which you would then redirect your Customer to, would look like:

   • For management of WHM:
     https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?auth-token=<auth-token>&orderid=<orderid>&panel=whm

   • For management of DNS Service, Email (Free Email Account [POP/IMAP] and Email Forwarding) Service, Web Services (Legacy Web Hosting, Email Hosting, Website Builder), Single Domain Hosting, Multi Domain Hosting, Reseller Hosting, Dedicated Server, Managed Server, Enterprise Email, SiteLock, CodeGuard:
     https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?auth-token=<auth-token>&orderid=<orderid>&service-name=<servicename>

The Free Email Service comprises of the following services:

• Email Account: provides you
  Email Account(s) free with every domain purchase, alongwith POP/IMAP access. Each account comes with MB
  space.

• Email Forwarding: This service is provided free upon purchase of any Product/Service through
  .

In order to view the Free Email Service interface, you need to search for the Product/Service you have purchased and access its Order Information interface.

To List/Search and Manage the Free Email Service

1. Login to your Control Panel:

   For Resellers: See details

   For Customers: See details

2. Next, click

   For Resellers: Products -> List All Orders.

   For Customers: Manage Orders -> List/Search Orders.

3. Search for the Order for which you have activated the Free Email Service.

   Note

   For Resellers: You may search for Orders belonging to your Sub-Resellers by selecting the Include Sub-Reseller's results
   check box.

   Additional Information

   For Resellers: Instructions for Listing All Orders under your Reseller Account

   Instructions for Listing All Orders under your Customer Account

4. On the next page, you would see a list of all your Product/Service Orders bought through . Click any domain name to reach its Overview.

5. Click the Email tab. This will bring up the Free Email Service interface.

   Additional Information

   For Resellers: You can also use the Search Bar on the Control Panel home page to bring up the Free Email Service interface. This Search Bar will also be available on the topmost menu bar, in every page of the Reseller Control Panel.

   1. Provide the domain name in the search field.

   2. Select Order from the drop-down menu.

   3. Click the Search button.

   4. On the next page, click the Email tab.

6. Clicking the Manage Email link will open up the Email Hosting Management interface.

The following Services reside on separate servers from the ones you connect to, via the SOAP API Kits, due to which your Customers need to login to their (individual) Control Panels, for managing
them:

• DNS

• Email (Free Email Account [POP/IMAP] and Email Forwarding)

• Web Hosting

• Email Hosting

• Live Chat

• Website Builder

now provides you with another method of directly allowing access to your Customer, to manage their DNS, Email, Web Hosting,
Email Hosting, Live Chat and Website Builder Services from your interfaces itself.

To accomplish this, you need to use either of these 2 methods and pass the following parameters to the mentioned URL, via an HTTP POST method:

Method 1 (recommended)

URL: https://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI

• orderid: The Web Services (Email Hosting, Web Hosting, Website Builder), Live Chat Service Order Id that your Customer wants to
  manage. In case of DNS/Email Service, the Order ID of the Product associated with the DNS/Email Service needs to be passed. Based on the orderid,
  the productCategory will be determined.

  Note

  For DNS and Email (Free Email Account [POP/IMAP] and Email Forwarding) that do not have any other Product associated with them, you can
  continue to pass the existing orderid to reach the DNS Management Console and Email Forwarding Management interface respectively.

• loginid: You need to generate a Login ID, that you need to pass as the value of this parameter for allowing the Customer to
  manage his Order. This can be accomplished by calling the API method generateLoginID in the Customer class. In order to call generateLoginID, you will
  have to pass ipAddress as a parameter. This Login ID generated will be valid for a very short period of time and you should use it immediately upon generating it.

  Note

  While generating the Login ID, you need to use the Username and Password of the Customer, to whom the Order belongs.

• service-name: This parameter needs to be passed to manage the specified service name. The value of this
  parameter needs to be either:

  • dns: For managing DNS Service.

  • mailfwd: For managing Email Forwarding Service.

  • free_email: For managing Free Email Account Service.

  • mailhosting: For managing Email Hosting Plans.

  • webhosting: For managing Web Hosting Plans.

  • websitebuilder: For managing Website Builder Plans.

This method is the most secure method of allowing your Customers to manage their DNS, Email, Web Hosting, Email Hosting, Live Chat and Website Builder Services, since it does not
expose the Customer's Username and Password in your interface.

If you choose to use this method, then you would need to create an intermediate interface to which you can provide the required parameters, and which in-turn generates a valid URL and redirects your
Customer.

You need to provide orderid and any authentication details (optional) to this interface. This interface would then call the API method
generateLoginID of the Customer class and build a URL with orderid, loginid and service-name as parameters, and then
redirect the Customer to this URL.

Example:

Let us call this interface a servlet named ManageOrderBoxControlPanel (assuming that you are using our JAVA API Kit).

1. This interface would accept the Web Services (Email Hosting, Web Hosting, Website Builder)/Live Chat Service Order Id or the Order Id of the Product associated with DNS or Email Service as a
   parameter. So, in order to manage a Service, you will call this interface with https://<Your-Server-URL>/ManageOrderBoxControlPanel?orderid=<orderid>.

2. Now this servlet would need to call the API method generateLoginID of the Customer class like: String loginid = API call to
   generateLoginID(username,password,role,langpref,resellerid,ipAddress);where,

   • username: the Username of the Customer, to whom the Order belongs.

   • password: the Password of the Customer, to whom the Order belongs.

   • resellerid: the Reseller Id associated with your Reseller Account. You can find it by clicking the icon at the top right corner within your Reseller Control Panel.

   • role: customer

3. The final URL to which you would then redirect your Customer to, would look like:

   • For management of Live Chat Services:
     https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?loginid=<loginid>&orderid=<orderid>

   • For management of DNS Service/Email Forwarding Service/Email Hosting/Web Hosting/Website Builder/Free Email Account Service:
     https://<Your_Branded_URL>/servlet/ManageServiceServletForAPI?loginid=<loginid>orderid=<orderid>&service-name=<servicename>

Method 2

URL: https://<Your_Control Panel_Branded_URL>/servlet/ManageServiceServletForAPI

• orderid: The Web Services (Email Hosting, Web Hosting, Website Builder)/Email Hosting/Live Chat Service Order Id that your
  Customer wants to manage. In case of DNS/Email Service, the Order ID of the Product associated with the DNS/Email Service needs to be passed. Based on the orderid,
  the productCategory will be determined.

  Note

  For DNS and Email Forwarding Orders that do not have any other Product associated with them, you can continue to pass the existing orderid to reach the DNS Management
  Console and Email Forwarding Management interface respectively.

• username: The Username of the Customer, to whom the Order belongs.

• password: The Password of the Customer, to whom the Order belongs.

• resellerid: The Reseller Id associated with your Reseller Account. You can find it by clicking the icon at the top right corner within your Reseller Control Panel.

• service-name: This parameter needs to be passed to manage the specified
  service name.

The disadvantage of using this method is that it is a bit less secure as the Customer Username and Password along with your Reseller Id can be viewed in the source of the page, from where you
post to the ManageServiceServletForAPI servlet.

Once you have setup the Free Email Service for your domain name, you need to modify your Name Servers to the ones specified by .
Generally, the Free Email Service should start working within a span of 24-48 hours post modification of Name Servers.

Do not be confused when you an encounter an error while using some DNS Tools like DNSReport.com:

This does not indicate an error and will not affect the Email Service of your domain name.

Adding Accounts

1. Proceed to the Free Email Service interface. See details

2. Click the Manage Email link. This will bring up the Email Management interface.

   Note

   • The Free Email Service gets activated, when you click the Manage Email link for the first time.

   • For Resellers: The Email Management interface will be displayed only if the Order belongs to a Customer immediately under you. Otherwise, the below error message with be displayed:

     Attention

     You are not allowed to perform this action.

3. Here, you may:

   Note

   Prior to adding accounts, you need to ensure that ownership of your domain name is
   verified. See details

   Otherwise, the below error message will be displayed:

   Attention

   Please activate <domainame> before adding a user

   The system automatically verifies domain name ownership. You may manually verify domain name ownership by following the below mentioned process:

   1. Click the Click here to verify >> link.

   2. Click the Verify Ownership button.

   Adding an Email Account

   1. In the Menu, go to Mail -> Add User.

   2. Provide the following information and click Add User:

      • Name: Provide a First Name and Last Name for the User.

      • Desired Email Address: Provide an email address you wish to assign to this
        user

        Example:

        For John, you may set the email address as [email protected].

      • Alternate Email Address: Provide an alternate email address, where the system can send important communication, such as
        Password reminders.

      • Country of User: Choose the geographical location of this user.

      • Language of User: This will be the language used by the system for all communications with the user.

   Once the account is created, a success page will be displayed. This page will provide details of the account that you have added, including a password that is generated for the user
   and server details for configuring the account in a desktop email client such as Microsoft Outlook, Mozilla Thunderbird, etc.. This information will also be automatically emailed to
   the Alternate Email Address you have provided.

   Additional Information

   Refer the Email Administrator's guide to explore rest of the functionalities of the interface

   Adding an Email Forward

   1. In the Menu, go to Mail -> Add Forward Only Account.

   2. Provide the following details and click Add Account:

      • When a mail arrives at: Provide any user such as sales, support, YourName, etc..

      • Forward to: Provide one or more destination email addresses, each on a separate line.

   Examples

   • You may have [email protected] forwarded to [email protected].

   • Similarly you could have a copy of emails received at [email protected] forwarded to several people by specifying their email addresses on separate lines.

   Additional Information

   Refer the Email Administrator's guide to explore rest of the functionalities of the interface

   Note

   If you want to forward all emails coming to any user on your domain name, you can create a Catch-All Account by following the below mentioned instructions on Adding a Catch-All Account.

   Adding a Catch-All Account

   1. In the Menu, go to Mail -> Manage Catch-All.

   2. Here you have 2 options:

      • Bounce back to the sender: Select this radio button if you do not wish to receive email on any other email address on
        your domain name except the ones already created and simply want to return such mails to the email sender.

      • Forward to the following User/Account: Select this radio button if you wish to forward all emails except the ones
        already created to another email address on this domain name itself. Mention the destination email address in the box provided.

   3. Click Apply to submit your settings.

   Examples

   • If you have set individual Email Forwards for sales and support users on yourdomain.com and want emails being sent to all other users on yourdomain.com to be bounced back to
     the sender, simply select the Bounce back to the sender radio button.

   • If you do not wish to create individual Forwards for each user on yourdomain.com and simply want all emails forwarded to some email address on yourdomain.com, simply
     select the Forward to the following User/Account radio button and specify the destination email address on yourdomain.com.

Modifying, Deleting Email Account, Email Forwards, Catch-All Account and accessing the Email Account through
Webmail, Email client

Free Email Service comprises of the following services:

• Email Account: provides you
  with Email Account(s)
  free with every domain purchase, alongwith POP/IMAP access. Each account comes with MB space.

• Email Forwarding: This service is provided free upon purchase of any Product/Service
  through .

  Note

  Email Forwarding can not be activated if Email Hosting has been activated for the domain name.

Activate the Email Service

1. Proceed to the Free Email Service interface. See details

2. Click the Manage Email link.

   Note

   The Free Email Service will be activated when you click Manage Email for the first time.

Authorize our Email Server to Send/Receive Emails for your Domain Name

Upon activating your Free Email Service, you need to enable our Email Server to be able to send/receive mails for your domain name. The simplest method to allow this is to modify your
domain name's Name Servers
to ours.

You have the following options:

• Change your Domain Name's Name Servers: You would find the list of Name Servers you need to set for your domain name to use the Email Service by clicking on the Name Server Details link under the DNS Management section.

  Note

  If the domain name is not registered with , the Name Servers required to use the Email Service will be displayed.
  You need to set these Name Servers for your domain name through your domain name's registration service provider.

• Change your Domain Name's DNS Records: If you wish to retain the Name Servers of your domain name, instead of
  using 's Name Servers, you would need to create the DNS (MX, CNAME, TXT) Records on your
  existing Name Servers.

  The DNS records are listed in the Email Hosting Management interface under Mail > DNS Configuration.See details

Use the Email Service

You need to create the Free Email Account, Email Forwards and specify other settings through the Email Management
Interface. See details