Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - set_user_email_forward_destination - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - set_user_email_forward_destination
Skip to end of metadata
Go to start of metadata

Description

This function sets 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.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


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


Notes:

  • Unless otherwise noted, 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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "set_user_email_forward_destination"
  }
}
 Output (XML)
<result>
   <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>set_user_email_forward_destination</command>
    </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The system account name to forward.

A valid system account.

root
forward_tostring

Required

The system account name or email address to which you wish to forward email.

  • A valid system account.
  • A valid email address.

Note:

To forward messages to multiple accounts or email addresses, enter them in a comma-separated list.

user

Returns

This function only returns metadata.