Provisioning and Managing Mailboxes via the API (Reseller) : Enom Customer Support

The Enom API lets you connect your own systems directly to Enom's email platform so you can manage mailboxes programmatically instead of through the control panel. Enom confirms that you can automatically provision, suspend, and restore mailboxes through the API. This article describes that workflow at a high level; the exact command names and parameters are flagged for confirmation against the Email API documentation.

What you can do with the email API

Using a direct connection between your site and Enom's systems, you can automate mailbox lifecycle management:

Provision new mailboxes on a customer's domain.
Suspend a mailbox (for example, for non-payment or at a customer's request).
Restore a previously suspended mailbox.

Each API request is a call to an Enom endpoint with a set of parameters; Enom returns a structured response indicating success or failure. For background on how Enom API requests and responses are structured, see Understanding API Calls and Responses.

Before you begin

Set up and enable your API access. See Managing Your API Access.
Confirm the domain on which the mailboxes will live is in your Enom account.
Test against the Enom test environment before running commands in production.

Step 1: Provision a mailbox

To create a mailbox, send the provisioning command with the parameters that identify the domain, the mailbox name, the mailbox size or plan, and the password.

Step 2: Suspend or restore a mailbox

To suspend an active mailbox, send the suspend command identifying the target mailbox. To bring a suspended mailbox back into service, send the restore command for the same mailbox.

Step 3: Verify the result

After each call, check the API response to confirm the action succeeded before updating your own records or customer-facing portal. Handle error responses according to the codes returned. See Understanding API Calls and Responses.