# Return cPanel account's mail domains

This function lists the account's mail domains.



  When you disable the  role, the system  this function.



  This function  returns the account's main domain first.



  By default, temporary domains (*.cpanel.site) are excluded. Use the  parameter to include them.

Endpoint: GET /Email/list_mail_domains
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `add_www` (integer)
    Whether to list  addresses.
*  — List  addresses.
*  — Do  list  addresses.
For example, if you specify , the function's output would include both  and . If you specify , the output would include  .
    Enum: 0, 1

  - `include_wildcard` (integer)
    Whether to list wildcard addresses.
*  — List wildcard addresses.
*  — Do  list wildcard addresses.
For example, if you specify , the function's output would include both  and . If you specify , the output would include  .
    Enum: 0, 1

  - `return_temporary_domain` (boolean)
    Whether to include temporary domains (*.cpanel.site) in the output.
By default, temporary domains are excluded.

  - `select` (string)
    The name of the domain that the function returns with the output parameter. If you do  use this parameter, the function will  return the  parameter with any domains.
    Example: "example.com"

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "list_mail_domains"

  - `module` (string)
    The name of the module called.
    Example: "Email"

  - `result` (object)

  - `result.data` (array)

  - `result.data.domain` (string)
    The domain name.
    Example: "example.com"

  - `result.data.select` (integer)
    The domain that you specified in the  input parameter. The function  returns this value if you included the  parameter when you called the function.



  Because this value  appears if you included the  input parameter, The value  defaults to .
    Example: 1

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    *  - Success.
*  - Failed. Check the  field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.