latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Mail
cPanel Account Mail Management

Return cPanel account forward destination

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

Note:

  • 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.
get/get_user_email_forward_destination

Query parameters

userstring required
Example:root

The system account name.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "forward_to": [
      "user@example.com"
    ]
  },
  "metadata": {
    "command": "get_user_email_forward_destination",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}