enterprisemail

Reseller should have signed up for enterpriseemailus or enterpriseemailin

How to install SSL certificate for your Email Hosting

You can install an SSL certificate to ensure the emails sent and received from your mail server are encrypted. Follow the steps below to install an SSL certificate for your Business or Email Hosting order. 

Step 1: Log in to your control panel. Learn how.

Step 2:  Navigate to the Order View.

Search the domain name for which you have purchased the Email Hosting order and select the domain to view the order information.

Setting up an Enterprise Email Account on iOS

Your Enterprise Email Account can be set up on iPhone's or iPad's iOS7 by referring to the below mentioned process:

  1. Go to your iPhone's Settings area.

  2. Tap on the Mail, Contacts, Calendars option.

  3. Choose Add Account.

  4. From the list of mail platforms shown, select Exchange.

  5. Fill in the details as mentioned below, and tap on the Next option on the right-top corner:

    • Email - Enter the complete email address for the Email Account which you wish to set up.

    • Password - Type your Email Account's password.

    • Description - Enter a distinguishing description for identifying it from the rest on your phone.

  6. This will further prompt you to manually fill the configuration details:

    • Email - This should be pre-filled from the previous page.

    • Server - Enter the webmail URL's FQDN here. For example, if your webmail URL is https://webmail.yourdomain.com, specify webmail.yourdomain.com as the Server.

    • Domain - Enter your domain name.

    • Username - This will be the part of your email address before the @ sign. For example, if the email address is [email protected], mention user in this field.

    • Password - Type your Email Account's password.

  7. Choose the data to be synchronized - Mail, Contacts, Calendars and/or Reminders. Only the selected options will be synchronized with the Server.

  8. You can now access your Enterprise Email Account from the Mail option on your iPhone.

  9. The iPhone Calendar now displays the events created through the Email Account's webmail. This also supports reverse synchronization, wherein creating an event from your iPhone will publish the information on the webmail's
    Calendar too.

  10. This configuration also synchronizes your contacts from the webmail's Address Book with your iPhone's Contacts.

Get DNS Records

Description

Gets the DNS records of an Enterprise Email Order.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order Id of the Enterprise Email Order

HTTP Method

GET

Example Test URL Request

US Server


https://test.httpapi.com/api/enterpriseemail/us/dns-record.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details of the DNS records associated with the Enterprise Email Order:

  • Type of DNS Record (type)

  • Name or the Fully Qualified Domain Name associated with the DNS record (host)

  • Data of Type-specific relevance, such as the IP Address for Address Records or Hostname for MX records (value)

  • Class of the DNS Record (class)

Get Reseller Pricing

Description

Use this method to get details of the Sub-Reseller Pricing for the Enterprise Email plans.

Response

Returns a map with the prices of the Enterprise Email plans along with the prices of the other products.

The response structure for the Enterprise Email will be:


"productkey":
{
"email_account_ranges":
{
"plan_specifications":
{
"action":
{
"tenure-in-months":price
}
}
}
}

Example:

US Server


"enterpriseemailus":
{
"email_account_ranges":
{
"1-5":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"6-10":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"11-15":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"16-25":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"26-35":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"36-55":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"56-65":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"66-75":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"76-85":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"86-100":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"101-10000":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
}
}

Get Customer Pricing

Description

Use this method to get details of the Customer Pricing for the Enterprise Email plans.

Response

Returns a map with the prices of the Enterprise Email plans along with the prices of the other products.

The response structure for the Enterprise Email will be:


"productkey":
{
"email_account_ranges":
{
"plan_specifications":
{
"action":
{
"tenure-in-months":price
}
}
}
}

Example:

US Server


"enterpriseemailus":
{
"email_account_ranges":
{
"1-5":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"6-10":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"11-15":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"16-25":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"26-35":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"36-55":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"56-65":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"66-75":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"76-85":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"86-100":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"101-10000":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
}
}

Search orders

Description

Gets a list and details of the Enterprise Email Orders matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Orders to be fetched.
page-no Integer Required Page number for which details are to be fetched.
order-id Array of Integers Optional Order Id(s) of the Enterprise Email Order(s) whose details need to be fetched.
reseller-id Array of Integers Optional Reseller Id(s) whose Orders need to be fetched.
customer-id Array of Integers Optional Customer Id(s) whose Orders need to be fetched.
show-child-orders Boolean Optional Whether Sub-Reseller Orders need to be fetched or not.
status Array of Strings Optional Status of the Order: Active, InActive, Deleted, etc.
domain-name String Optional Name of the Domain of the Enterprise Email Order.
creation-date-start String Optional UNIX TimeStamp for listing of the Enterprise Email Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of the Enterprise Email Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of the Enterprise Email Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of the Enterprise Email Orders whose expiry date is less than expiry-date-end.
order-by Array of Strings Optional One or more parameters by which you want to sort the Orders. Default is orderid.

Example:

If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid.
If page-no is 2, no-of-records is 30 and order-by is orderid; it will fetch the second batch of 30 Orders sorted by orderid

HTTP Method

GET

Example Test URL Request

US Server


https://test.httpapi.com/api/enterpriseemail/us/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map containing the below details of the Enterprise Email Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Addition Timestamp (orders.creationdt)

  • Order Creation Timestamp (orders.creationtime)

  • Expiry Timestamp (orders.endtime)

  • Current Order Status under the System (entity.currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

  • GEO Location (hosting_group_info.location)