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.

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:

  • 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. 

 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.