EnomService

PHP string addIDProtectService(string $domainName, integer $numYears)

PHP	string addIDProtectService(string $domainName, integer $numYears)

Add ID Protect service to a domain name

Executes the 'PurchaseServices' command on Enom's servers, to add the ID Protect service to an active domain name that belongs to your Enom Account.

Arguments

$domainName
Must be active and belongs to your Enom account.
$numYears
Number of years to subscribe to ID Protect. Permitted values are 1 to 10.

Return

Order ID, or false if failed.

Top

checkDomain

PHP array checkDomain(string $sld, string $tld, boolean $spinner, boolean $allowDash, string $word1, string $word2, string $word3)

PHP	array checkDomain(string $sld, string $tld, boolean $spinner, boolean $allowDash, string $word1, string $word2, string $word3)

Check domain availability

Executes the 'Check' command on Enom's servers to check domain availability. Top-level domain name (extension) Permitted values are:

Any single TLD, for example, com
* returns 11 of the most commonly used TLDs
*1 returns com, net, org, info, biz, us, ws
*2 returns com, net, org, info, biz, us

returns com, net, org - A comma-delimited list of TLDs to check, up to 30 names. Do not use with DomainSpinner.
Arguments
$sld
Second-level Domain
$tld
Top-level Domain (also known as Domain Extension).
$spinner [optional, default value = false]
If true, DomainSpinner (Domain Suggestion) will be enabled
$allowDash [optional, default value = true]
If DomainSpinner is enabled and $allowDash set to true, Suggested domain names may contain Dashes
$word1 [optional, default value = '']
If DomainSpinner is enabled and $word1 is set, Suggested domain names may contain this word
$word2 [optional, default value = '']
If DomainSpinner is enabled and $word2 is set, Suggested domain names may contain this word
$word3 [optional, default value = '']
If DomainSpinner is enabled and $word3 is set, Suggested domain names may contain this word
Return
An associative array containing the domain name as a key and a bool (true if domain is available, false otherwise) as a value. On error, it returns false
Top

getDomainContacts

PHP array getDomainContacts(string $domainName)

PHP	array getDomainContacts(string $domainName)

Get domain contacts for a domain name.

Executes the 'GetContacts' command on Enom's servers, to retrive the contacts information for a domain name that is active and belongs to your Enom account.

See also
EnomService::setDomainContacts()

Arguments

$domainName
Must be active and belongs to your Enom account.

Return

Associative array containing contacts information.

Top

getDomainHosts

PHP array getDomainHosts(string $domainName)

PHP	array getDomainHosts(string $domainName)

Get domain hosts (records) for a domain name.

Executes the 'GetHosts' command on Enom's servers, to get domain hosts (records) for a domain name that is active and belongs to your Enom account.

See also
EnomService::setDomainHosts()

Arguments

$domainName
Must be active and belongs to your Enom account.

Return

Associative array containing all Hosts being set. Array keys are name, type, address and pref.

Top

getDomainNameID

PHP long getDomainNameID(string $domainName)

PHP	long getDomainNameID(string $domainName)

Get domain name ID for a domain name.

Executes the 'GetDomainNameID' command on Enom's servers, to get the domain name ID number for a domain name that belongs to your Enom account. Can be used to verify that domain name belongs to your Enom's account.

Arguments

$domainName
Must be valid and belongs to your Enom account.

Return

Domain name ID number, or false if failed.

Top

getEmailForwarders

PHP array getEmailForwarders(string $domainName)

PHP	array getEmailForwarders(string $domainName)

Get email forwarders for a domain name.

Executes the 'GetForwarding' command on Enom's servers, to get email forwarders for a domain name that is active and belongs to your Enom account.

See also
EnomService::setEmailForwarders()

Arguments

$domainName
Must be active and belongs to your Enom account.

Return

Associative array containing 'Email account' as the key, and 'Forward To' as the value.

Top

getExpiryDate

PHP string getExpiryDate(string $domainName)

PHP	string getExpiryDate(string $domainName)

Get expiry date for a domain name

Executes the 'GetDomainExp' command on Enom's servers, to retrive the expiration date of a domain name that is active and belongs to your Enom account.

See also
EnomService::getDomainNameID()

Arguments

$domainName
Must be active and belongs to your Enom account.

Return

Expiration date, or false on fail

Top

getNameMyPhone

PHP array getNameMyPhone(string $domainName)

PHP	array getNameMyPhone(string $domainName)

Get the current name-my-phone settings.

Executes the 'GetDomainPhone' command on Enom's servers, to get current name-my-phone settings for a domain name that is active and belongs to your Enom account.

See also
EnomService::setNameMyPhone()

Arguments

$domainName
Must be valid and belongs to your Enom account.

Return

Associative array containing name-my-phone settings.

Top

getNameServers

PHP array getNameServers(string $domainName)

PHP	array getNameServers(string $domainName)

Get name servers for a domain name.

Executes the 'GetDNS' command on Enom's servers, to retrive the name servers for a domain name that is active and belongs to your Enom account.

See also
EnomService::getNameServers()

Arguments

$domainName
Must be active and belongs to your Enom account.

Return

An array containing name servers. If using Enom's name servers, the array will be empty.

Top

getRegistrarLock

PHP boolean getRegistrarLock(string $domainName)

PHP	boolean getRegistrarLock(string $domainName)

Get registrar lock status for a domain name

Executes the 'GetRegLock' command on Enom's servers.

See also
EnomService::setRegistrarLock()

Arguments

$domainName
Must be active and belongs to your Enom account.

Return

True if not locked, false otherwise. You should check for $this->isError if returned false, to make sure it's not an error flag not the registrar lock status.

Top

registerDomain

PHP long registerDomain(string $domainName, integer $numYears, array $contacts, array $nameServers, boolean $regLock)

PHP	long registerDomain(string $domainName, integer $numYears, array $contacts, array $nameServers, boolean $regLock)

Executes the 'Purchase' command on Enom's servers to register a new domain. Note that this command to not fail, it must meet the following requirements:

Your Enom account must have enough credits to cover the order amount.
The domain name must be valid and available.
Number of years must not be less than the minimum number of years required for the specified TLD.
Name Servers must be valid and registered.
Name servers for .us names must be located in the United States.
RegistrantJobTitle and RegistrantFax are required in the contacts array if RegistrantOrganizationName is set.

See also
EnomService::renewDomain()
EnomService::transferDomain()

Arguments

$domainName
Must be a valid domain name, that is currently available
$numYears
Some TLDs like .co.uk requires minimum of 2 years, Another may require 10 years
$contacts
Associative array containing Contacts as key and value.
$nameServers [optional, default value = null]
If not set, Enom's Default name servers will be used instead.
$regLock [optional, default value = true]
A flag that specifies if the domain should be locked or not. Default is true.

Return

Order ID, or false if failed.

Top

renewDomain

PHP long renewDomain(string $domainName, integer $numYears)

PHP	long renewDomain(string $domainName, integer $numYears)

Renew a domain name that belongs to your Enom account

Executes the 'Extend' command on Enom's servers to renew a domain name which was previously registered or transfered to your Enom account. Note that this command to not fail, it must meet the following requirements:

Your Enom account must have enough credits to cover the order amount.
The domain name must be valid and active and belongs to your Enom account.
The new expiration date cannot be more than 10 years in the future.

See also
EnomService::registerDomain()
EnomService::transferDomain()

Arguments

$domainName
Must be a valid and active domain name.
$numYears
The new expiration date cannot be more than 10 years in the future.

Return

Renewal Order ID, or false if failed.

Top

setDomainContacts

PHP boolean setDomainContacts(string $domainName, array $contacts)

PHP	boolean setDomainContacts(string $domainName, array $contacts)

Set domain contacts for a domain name.

Executes the 'Contacts' command on Enom's servers, to set the contacts information for a domain name that is active and belongs to your Enom account.

See also
EnomService::getDomainContacts()

Arguments

$domainName
Must be active and belongs to your Enom account.
$contacts
Associative array containing contacts information.

Return

True if succeed and false if failed.

Top

setDomainHosts

PHP boolean setDomainHosts(string $domainName, array $domainHosts)

PHP	boolean setDomainHosts(string $domainName, array $domainHosts)

Set domain hosts (records) for a domain name.

Executes the 'SetHosts' command on Enom's servers, to set domain hosts (records) for a domain name that is active and belongs to your Enom account.

See also
EnomService::getDomainHosts()

Arguments

$domainName
Must be active and belongs to your Enom account.
$domainHosts
Associative array containing all Hosts to set. Array keys are name, type, address and pref.

Return

True if succeed and False if failed.

Top

setEmailForwarders

PHP boolean setEmailForwarders(string $domainName, array $emailForwarders)

PHP	boolean setEmailForwarders(string $domainName, array $emailForwarders)

Set email forwarders for a domain name.

Executes the 'Forwarding' command on Enom's servers, to set email forwarders for a domain name that is active and belongs to your Enom account.

See also
EnomService::getEmailForwarders()

Arguments

$domainName
Must be active and belongs to your Enom account.
$emailForwarders
Associative array containing 'Email account' as the key, and 'Forward To' as the value.

Return

True if succeed and False if failed.

Top

setNameMyPhone

PHP setNameMyPhone(string $domainName, string $phone, string $hostName, integer $serviceID, integer $templateID, boolean $emailAlias, string $ccEmail1, string $ccEmail2, string $ccEmail3)

PHP	setNameMyPhone(string $domainName, string $phone, string $hostName, integer $serviceID, integer $templateID, boolean $emailAlias, string $ccEmail1, string $ccEmail2, string $ccEmail3)

Arguments

$domainName
$phone
$hostName [optional, default value = 'phone']
$serviceID [optional, default value = NAMEMYPHONE_SERVICE_ATANDT]
$templateID [optional, default value = NAMEMYPHONE_TEMPLATE_WESTERN]
$emailAlias [optional, default value = false]
$ccEmail1 [optional, default value = '']
$ccEmail2 [optional, default value = '']
$ccEmail3 [optional, default value = '']

Top

setNameServers

PHP boolean setNameServers(string $domainName, array $nameServers)

PHP	boolean setNameServers(string $domainName, array $nameServers)

Set name servers for a domain name.

Executes the 'ModifyNS' command on Enom's servers, to set the name servers for a domain name that is active and belongs to your Enom account.

See also
EnomService::getNameServers()

Arguments

$domainName
Must be active and belongs to your Enom account.
$nameServers [optional, default value = null]
Array containing name servers. If not set, default Enom name servers will be used.

Return

True if succeed and false if failed.

Top

setRegistrarLock

PHP boolean setRegistrarLock(string $domainName, boolean $unlockRegistrar)

PHP	boolean setRegistrarLock(string $domainName, boolean $unlockRegistrar)

Set registrar lock status for a domain name

Executes the 'SetRegLock' command on Enom's servers.

See also
EnomService::getRegistrarLock()

Arguments

$domainName
Must be active and belongs to your Enom account.
$unlockRegistrar
If set to true, the domain will be unlocked.

Return

True if succeed, false on fail.

Top

synchronizeEPP

PHP boolean synchronizeEPP(string $domainName, bool $sendEmail [optional, default value = true], bool $runSynch [optional, default value = true])

PHP	boolean synchronizeEPP(string $domainName, bool $sendEmail [optional, default value = true], bool $runSynch [optional, default value = true])

Create a new EPP key, synchronize the key with the Registry, and email it to the registrant.

Executes the 'SynchAuthInfo' command on Enom's servers, to create a new EPP key for a domain name that belongs to your Enom account, synchronize the key with the Registry, and optionally email it to the registrant.

Arguments

$domainName
Must be valid and belongs to your Enom account.
$sendEmail
Should mail the EPP key to the registrant? (default is true).
$runSynch
Should synchronize the EPP key and make sure Enom's records are identical to the Registry's? (default is true).

Return

True if succeed and False if failed.

Top

transferDomain

PHP long transferDomain(string $domainName, array $contacts, string $authCode, boolean $regLock)

PHP	long transferDomain(string $domainName, array $contacts, string $authCode, boolean $regLock)

Transfer a domain name to your Enom account

Executes the 'TP_CreateOrder' command on Enom's servers to transfer a domain name to your Enom account. Note that this command to not fail, it must meet the following requirements:

Your Enom account must have enough credits to cover the order amount.
The domain name must be valid and already registered and not locked.
To transfer EPP names, the query must include the authorization key from the Registrar. On enom.com, the authorization key is displayed at the bottom of the Contact/WhoIs Information page, accessed from the Domain Control Panel.
RegistrantJobTitle and RegistrantFax are required in the contacts array if RegistrantOrganizationName is set. If $contacts is not set, existing WhoIs contacts will be used when the transfer is complete

See also
EnomService::registerDomain()
EnomService::renewDomain()

Arguments

$domainName
Must be a valid domain name, that is currently available
$contacts [optional, default value = null]
Associative array containing Contacts as key and value.
$authCode [optional, default value = null]
Authorization key from the Registrar. Required for EPP names.
$regLock [optional, default value = true]
A flag that specifies if the domain should be locked or not. Default is true.

Return

Transfer Order ID, or false if failed.

Top

EnomService Class v. 1.0.3 24 April 2007