Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Include Page | ||||
---|---|---|---|---|
|
Description
Excerpt |
---|
This function lists the cPanel account's email addresses. |
Warning | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
We strongly recommend that you use the following UAPI function instead of this function:
|
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
|
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
regex | string | A Perl Compatible Regular Expression (PCRE) that filters the results. The system matches the PCRE to both the email address's username and domain. If you do not use this parameter, the function returns all of the cPanel account's email addresses. | A valid PCRE. | user |
Returns
Return | Type | Description | Possible values | Example | |||||
---|---|---|---|---|---|---|---|---|---|
email | string | The email address, or the main cPanel account username. | A valid email address, or the username for the main account. | user@example.com | |||||
login | string | The email address, or the string Main Account . | A valid email address, or the string | user@example.com | |||||
suspended_incoming | Boolean | Whether the email account's incoming email is suspended.
|
| 0 | |||||
suspended_login | Boolean | Whether the user's ability to log in to, send mail from, and read their email account is suspended.
|
| 0 | |||||
reason | string | A reason for failure.
| A string that describes the error. | This is an error message. | |||||
result | Boolean | Whether the function succeeded. |
| 1 |
Panel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Function information
About this moduleThe About cPanel API 2
Find a function
Related functions
|