Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves the destination to which the system forwards a system account's email.

Notes:

  • Usually, the system sends notices about the server's problems and activity to the root account.
  • If you do not use the suexec module, the nobody user receives bounce messages from email that CGI scripts send.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_user_email_forward_destination?api.version=1&user=root
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_user_email_forward_destination?api.version=1&user=root
 Command Line
whmapi1 get_user_email_forward_destination user=root 

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
  "data": {
    "forward_to": [
      "user@example.com",
      "user2"
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_user_email_forward_destination"
  }
}
 Output (XML)
<result>
    <data>
        <forward_to>user@example.com</forward_to>
        <forward_to>user2</forward_to>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>get_user_email_forward_destination</command>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The system account name.

A valid system account.

root

Returns

ReturnTypeDescriptionPossible valuesExample
forward_toarrayThe system accounts or email addresses to which the system forwards the account's email.
  • A valid system account.
  • A valid email address.
user@example.com