Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Include Page | ||||
---|---|---|---|---|
|
Description
Excerpt |
---|
This function retrieves a domain's default address. |
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
|
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
domain | string | The domain. If you do not specify a value, the function lists default addresses for all of the cPanel account's domains. | A valid domain on the cPanel account. | example.com |
user | string | Required The user whose default addresses to list.
| A valid user on the cPanel account. | user |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
hash | A hash of data for a domain. | This hash includes the defaultaddress and domain returns. | ||
| string | The domain name. The function includes this value in the unnamed hash for each domain. | A valid domain on the cPanel account. |
|
| string | The domain's default address. The function includes this value in the unnamed hash for each domain. |
| user |
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Function information
About this moduleThe About UAPI
Find a function
Related functions
|