We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • WHM API 1 Functions - normalize_user_email_configuration
Skip to end of metadata
Go to start of metadata

Description

This function fixes a user's misconfigured email settings. This includes any misconfigured email file and directory ownership and permissions.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/normalize_user_email_configuration?api.version=1&username=username
 Command Line
whmapi1 normalize_user_email_configuration username=username


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" : {
      "result" : 1,
      "command" : "normalize_user_email_configuration",
      "reason" : "OK",
      "version" : 1
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

Required

The cPanel account's username.

A valid cPanel account.username

Returns

This function only returns metadata.